How can I mock an ES6 module import using Jest?

In JavaScript unit testing, mocking ES6 module imports with Jest is a common requirement, especially when you want to isolate modules, control dependencies, or simply replace certain functions for testing purposes. Next, I'll walk you through how to use Jest to mock ES6 module imports, providing a concrete example to demonstrate the process.

Step 1: Configure Jest

First, ensure that Jest is installed in your project. If not installed, you can install it using the following command:

bash
npm install --save-dev jest

Step 2: Create your module and test files

Assume we have a module math.js with the following content:

javascript
// math.js
export const add = (a, b) => a + b;
export const subtract = (a, b) => a - b;

We want to test another file app.js, which depends on math.js:

javascript
// app.js
import { add, subtract } from './math';

export const doAdd = (a, b) => add(a, b);
export const doSubtract = (a, b) => subtract(a, b);

Step 3: Mock the math.js module

Create a test file app.test.js:

javascript
// app.test.js
import * as app from './app';
import * as math from './math';

// Use jest.mock() to automatically mock the math module
jest.mock('./math');

test('Test doAdd function', () => {
  // Set the return value of the mocked add function
  math.add.mockImplementation(() => 5);

  expect(app.doAdd(3, 2)).toBe(5);
  // Verify that add was called correctly
  expect(math.add).toHaveBeenCalledWith(3, 2);
});

test('Test doSubtract function', () => {
  // Set the return value of the mocked subtract function
  math.subtract.mockImplementation(() => 1);

  expect(app.doSubtract(3, 2)).toBe(1);
  // Verify that subtract was called correctly
  expect(math.subtract).toHaveBeenCalledWith(3, 2);
});

Step 4: Run the tests

Execute Jest to run the tests:

bash
npx jest

Explanation

In this example, we use jest.mock() to automatically mock the entire math.js module. Jest intercepts all calls to the math module and replaces them with mock functions. By using mockImplementation(), we define the specific behavior of the mock function when it is called.

This mocking technique is very useful as it allows you to test interactions between modules without depending on specific implementations, focusing instead on the correctness of the logic.