未模拟模块时如何在 Jest 中模拟导入的命名函数

Question

我尝试在 Jest 中测试以下模块：

// myModule.js

export function otherFn() {
  console.log('do something');
}

export function testFn() {
  otherFn();

  // do other things
}

如上所示，它导出了一些命名函数，重要的是testFn 使用了otherFn。

在我为testFn 编写单元测试时开玩笑，我想模拟otherFn 函数，因为我不希望otherFn 中的错误影响我对testFn 的单元测试。我的问题是我不确定最好的方法：

// myModule.test.js
jest.unmock('myModule');

import { testFn, otherFn } from 'myModule';

describe('test category', () => {
  it('tests something about testFn', () => {
    // I want to mock "otherFn" here but can't reassign
    // a.k.a. can't do otherFn = jest.fn()
  });
});

感谢任何帮助/见解。

Answer 1

在jest.mock() 中使用jest.requireActual()

jest.requireActual(moduleName)

返回实际模块而不是模拟，绕过对模块是否应该接收模拟实现的所有检查。

示例

我更喜欢这种简洁的用法，你需要并在返回的对象中传播：

// myModule.test.js

import { otherFn } from './myModule.js'

jest.mock('./myModule.js', () => ({
  ...(jest.requireActual('./myModule.js')),
  otherFn: jest.fn()
}))

describe('test category', () => {
  it('tests something about otherFn', () => {
    otherFn.mockReturnValue('foo')
    expect(otherFn()).toBe('foo')
  })
})

在 Jest 的 Manual Mocks 文档中也引用了此方法（接近 Examples 的末尾）：

为确保手动模拟与其实际实现保持同步，在手动模拟中要求使用jest.requireActual(moduleName) 的真实模块并在导出之前使用模拟函数对其进行修改可能会很有用。

Answer 2

看来我参加这个聚会迟到了，但是是的，这是可能的。

testFn 只需调用otherFn 使用模块。

如果testFn 使用模块调用otherFn，则可以模拟otherFn 的模块导出，testFn 将调用模拟。

---

这是一个工作示例：

myModule.js

import * as myModule from './myModule';  // import myModule into itself

export function otherFn() {
  return 'original value';
}

export function testFn() {
  const result = myModule.otherFn();  // call otherFn using the module

  // do other things

  return result;
}

myModule.test.js

import * as myModule from './myModule';

describe('test category', () => {
  it('tests something about testFn', () => {
    const mock = jest.spyOn(myModule, 'otherFn');  // spy on otherFn
    mock.mockReturnValue('mocked value');  // mock the return value

    expect(myModule.testFn()).toBe('mocked value');  // SUCCESS

    mock.mockRestore();  // restore otherFn
  });
});

Answer 3

import m from '../myModule';

对我不起作用，我确实使用过：

import * as m from '../myModule';

m.otherFn = jest.fn();

Answer 4

我知道很久以前有人问过这个问题，但我只是遇到了这种情况，终于找到了一个可行的解决方案。所以我想我会在这里分享。

对于模块：

// myModule.js

export function otherFn() {
  console.log('do something');
}

export function testFn() {
  otherFn();

  // do other things
}

您可以更改为以下内容：

// myModule.js

export const otherFn = () => {
  console.log('do something');
}

export const testFn = () => {
  otherFn();

  // do other things
}

将它们导出为常量而不是函数。我相信这个问题与 JavaScript 中的提升有关，使用 const 可以防止这种行为。

然后在你的测试中你可以有如下的东西：

import * as myModule from 'myModule';


describe('...', () => {
  jest.spyOn(myModule, 'otherFn').mockReturnValue('what ever you want to return');

  // or

  myModule.otherFn = jest.fn(() => {
    // your mock implementation
  });
});

您的模拟现在应该可以正常工作了。

Answer 5

转译后的代码将不允许 babel 检索 otherFn() 所指的绑定。如果你使用函数表达式，你应该可以实现模拟otherFn()。

// myModule.js
exports.otherFn = () => {
  console.log('do something');
}

exports.testFn = () => {
  exports.otherFn();

  // do other things
}

 

// myModule.test.js
import m from '../myModule';

m.otherFn = jest.fn();

但是正如@kentcdodds 在之前的评论中提到的，你可能不想模拟otherFn()。相反，只需为 otherFn() 编写一个新规范并模拟它正在进行的任何必要调用。

例如，如果otherFn() 正在发出一个 http 请求...

// myModule.js
exports.otherFn = () => {
  http.get('http://some-api.com', (res) => {
    // handle stuff
  });
};

在这里，您需要模拟 http.get 并根据您模拟的实现更新您的断言。

// myModule.test.js
jest.mock('http', () => ({
  get: jest.fn(() => {
    console.log('test');
  }),
}));

Answer 6

基于Brian Adams' answer，这就是我能够在 TypeScript 中使用相同方法的方式。此外，使用jest.doMock() 可以仅在测试文件的某些特定测试中模拟模块功能，并为每个模块提供单独的模拟实现。

src/module.ts

import * as module from './module';

function foo(): string {
  return `foo${module.bar()}`;
}

function bar(): string {
  return 'bar';
}

export { foo, bar };

test/module.test.ts

import { mockModulePartially } from './helpers';

import * as module from '../src/module';

const { foo } = module;

describe('test suite', () => {
  beforeEach(function() {
    jest.resetModules();
  });

  it('do not mock bar 1', async() => {
    expect(foo()).toEqual('foobar');
  });

  it('mock bar', async() => {
    mockModulePartially('../src/module', () => ({
      bar: jest.fn().mockImplementation(() => 'BAR')
    }));
    const module = await import('../src/module');
    const { foo } = module;
    expect(foo()).toEqual('fooBAR');
  });

  it('do not mock bar 2', async() => {
    expect(foo()).toEqual('foobar');
  });
});

test/helpers.ts

export function mockModulePartially(
  modulePath: string,
  mocksCreator: (originalModule: any) => Record<string, any>
): void {
  const testRelativePath = path.relative(path.dirname(expect.getState().testPath), __dirname);
  const fixedModulePath = path.relative(testRelativePath, modulePath);
  jest.doMock(fixedModulePath, () => {
    const originalModule = jest.requireActual(fixedModulePath);
    return { ...originalModule, ...mocksCreator(originalModule) };
  });
}

模块的模拟函数被移动到位于单独文件中的辅助函数mockModulePartially，因此可以从不同的测试文件中使用它（通常可以位于其他目录中）。它依赖expect.getState().testPath 来修复被模拟的模块（modulePath）的路径（使其相对于包含mockModulePartially 的helpers.ts）。 mocksCreator 函数作为第二个参数传递给 mockModulePartially 应该返回模块的模拟。此函数接收originalModule，并且模拟实现可以选择依赖它。

Answer 7

我通过在这里找到的各种答案解决了我的问题：

myModule.js

import * as myModule from './myModule';  // import myModule into itself

export function otherFn() {
  return 'original value';
}

export function testFn() {
  const result = myModule.otherFn();  // call otherFn using the module

  // do other things

  return result;
}

myModule.test.js

import * as myModule from './myModule';

describe('test category', () => {
  let otherFnOrig;

  beforeAll(() => {
    otherFnOrig = myModule.otherFn;
    myModule.otherFn = jest.fn();
  });

  afterAll(() => {
    myModule.otherFn = otherFnOrig;
  });

  it('tests something about testFn', () => {
    // using mock to make the tests
  });
});

Answer 8

除了这里的第一个答案，您还可以使用babel-plugin-rewire 来模拟导入的命名函数。您可以从表面上查看该部分 named function rewiring。

对您的情况而言，其中一个直接好处是您无需更改从函数中调用其他函数的方式。