如何使用 Jest 模拟 ES6 模块导入？

Question

我想测试我的一个 ES6 模块是否以特定方式调用另一个 ES6 模块。使用Jasmine，这非常简单--

申请代码：

// myModule.js
import dependency from './dependency';

export default (x) => {
  dependency.doSomething(x * 2);
}

以及测试代码：

//myModule-test.js
import myModule from '../myModule';
import dependency from '../dependency';

describe('myModule', () => {
  it('calls the dependency with double the input', () => {
    spyOn(dependency, 'doSomething');

    myModule(2);

    expect(dependency.doSomething).toHaveBeenCalledWith(4);
  });
});

Jest 的等价物是什么？我觉得这是一件很简单的事情，但我一直在努力解决这个问题。

我最接近的方法是将imports 替换为requires，并将它们移动到测试/函数中。这两件事都不是我想做的。

// myModule.js
export default (x) => {
  const dependency = require('./dependency'); // Yuck
  dependency.doSomething(x * 2);
}

//myModule-test.js
describe('myModule', () => {
  it('calls the dependency with double the input', () => {
    jest.mock('../dependency');

    myModule(2);

    const dependency = require('../dependency'); // Also yuck
    expect(dependency.doSomething).toBeCalledWith(4);
  });
});

对于奖励积分，当dependency.js 中的函数是默认导出时，我很乐意让整个事情正常工作。但是，我知道监视默认导出在 Jasmine 中不起作用（或者至少我永远无法让它起作用），所以我也不希望它在 Jest 中是可能的。

Answer 1

你必须自己模拟模块并设置间谍：

import myModule from '../myModule';
import dependency from '../dependency';
jest.mock('../dependency', () => ({
  doSomething: jest.fn()
}))

describe('myModule', () => {
  it('calls the dependency with double the input', () => {
    myModule(2);
    expect(dependency.doSomething).toBeCalledWith(4);
  });
});

Answer 2

编辑：几年过去了，这已经不再是正确的方法了（可能从来都不是，我的错）。

对导入的模块进行变异是令人讨厌的，并且可能会导致副作用，例如测试通过或失败取决于执行顺序。

出于历史目的，我将保留此答案的原始形式，但您确实应该使用jest.spyOn 或jest.mock。有关详细信息，请参阅本页上的笑话文档或其他答案。

原答案如下：

---

我已经能够通过使用涉及import * 的破解来解决这个问题。它甚至适用于命名和默认导出！

对于命名导出：

// dependency.js
export const doSomething = (y) => console.log(y)

// myModule.js
import { doSomething } from './dependency';

export default (x) => {
  doSomething(x * 2);
}

// myModule-test.js
import myModule from '../myModule';
import * as dependency from '../dependency';

describe('myModule', () => {
  it('calls the dependency with double the input', () => {
    dependency.doSomething = jest.fn(); // Mutate the named export

    myModule(2);

    expect(dependency.doSomething).toBeCalledWith(4);
  });
});

或者对于默认导出：

// dependency.js
export default (y) => console.log(y)

// myModule.js
import dependency from './dependency'; // Note lack of curlies

export default (x) => {
  dependency(x * 2);
}

// myModule-test.js
import myModule from '../myModule';
import * as dependency from '../dependency';

describe('myModule', () => {
  it('calls the dependency with double the input', () => {
    dependency.default = jest.fn(); // Mutate the default export

    myModule(2);

    expect(dependency.default).toBeCalledWith(4); // Assert against the default
  });
});

Answer 3

向Andreas' answer 添加更多内容。我对 ES6 代码也有同样的问题，但我不想改变导入。那看起来很老套。所以我这样做了：

import myModule from '../myModule';
import dependency from '../dependency';
jest.mock('../dependency');

describe('myModule', () => {
  it('calls the dependency with double the input', () => {
    myModule(2);
  });
});

并在与文件dependency.js平行的“__ mocks __”文件夹中添加了文件dependency.js。这对我有用。此外，这让我可以选择从模拟实现中返回合适的数据。确保为要模拟的模块提供正确的路径。

Answer 4

使用 Jest 模拟 ES6 依赖模块默认导出：

import myModule from '../myModule';
import dependency from '../dependency';

jest.mock('../dependency');

// If necessary, you can place a mock implementation like this:
dependency.mockImplementation(() => 42);

describe('myModule', () => {
  it('calls the dependency once with double the input', () => {
    myModule(2);

    expect(dependency).toHaveBeenCalledTimes(1);
    expect(dependency).toHaveBeenCalledWith(4);
  });
});

其他选项不适用于我的情况。

Answer 5

我用另一种方式解决了这个问题。假设你有你的dependency.js

export const myFunction = () => { }

我创建了一个 depdency.mock.js 文件，其中包含以下内容：

export const mockFunction = jest.fn();

jest.mock('dependency.js', () => ({ myFunction: mockFunction }));

在测试中，在导入具有依赖关系的文件之前，我使用：

import { mockFunction } from 'dependency.mock'
import functionThatCallsDep from './tested-code'

it('my test', () => {
    mockFunction.returnValue(false);

    functionThatCallsDep();

    expect(mockFunction).toHaveBeenCalled();

})

Answer 6

问题已经回答了，但你可以这样解决：

文件 dependency.js

const doSomething = (x) => x
export default doSomething;

文件 myModule.js

import doSomething from "./dependency";

export default (x) => doSomething(x * 2);

文件 myModule.spec.js

jest.mock('../dependency');
import doSomething from "../dependency";
import myModule from "../myModule";

describe('myModule', () => {
  it('calls the dependency with double the input', () => {
    doSomething.mockImplementation((x) => x * 10)

    myModule(2);

    expect(doSomething).toHaveBeenCalledWith(4);
    console.log(myModule(2)) // 40
  });
});

Answer 7

快进到 2020 年，我发现这篇博文是解决方案：Jest mock default and named export

仅使用 ES6 模块语法：

// esModule.js
export default 'defaultExport';
export const namedExport = () => {};

// esModule.test.js
jest.mock('./esModule', () => ({
  __esModule: true, // this property makes it work
  default: 'mockedDefaultExport',
  namedExport: jest.fn(),
}));

import defaultExport, { namedExport } from './esModule';
defaultExport; // 'mockedDefaultExport'
namedExport; // mock function

还有一件事你需要知道（我花了一段时间才弄清楚）是你不能在测试中调用 jest.mock() ；您必须在模块的顶层调用它。但是，如果您想为不同的测试设置不同的模拟，您可以在单独的测试中调用 mockImplementation()。

Answer 8

这里的答案似乎都不适合我，而且 Jest 中的 ESM 支持似乎仍然是 work in progress。

在发现this comment 之后，我发现jest.mock() 并不能真正用于常规导入，因为导入总是在模拟之前运行。因此，我使用async import() 导入我的依赖项：

import { describe, expect, it, jest } from '@jest/globals';

jest.mock('../dependency', () => ({
  doSomething: jest.fn()
}));

describe('myModule', async () => {
  const myModule = await import('../myModule');
  const dependency = await import('../dependency');

  it('calls the dependency with double the input', () => {
    myModule(2);
    expect(dependency.doSomething).toBeCalledWith(4);
  });
});