Jest - 模拟从被测函数调用的函数答案

【问题标题】：Jest - mock a function being called from the function under testJest - 模拟从被测函数调用的函数
【发布时间】：2021-04-21 12:46:37
【问题描述】：

我有一个 utils.js 文件，其中的一个函数调用同一文件中的另一个函数。像这样：

// utils.js    
async function originalFunc (params) {
    ...

    await anotherFunc(arg1, arg2)
}

在另一个文件中，我正在使用 jest 来测试 originalFunc

// utils.test.js
test('should test orginalFunc', async () => {
    const params = {
        arg1: 'data1',
        arg2: 'data2',
    }

    const anotherFunc = jest.fn()

    await util.originalFunc(params)

    // todo: expect anotherFunc to be called with correct params
})

但是，当使用此配置时，调用的是真正的 anotherFunc，而不是模拟的 jest.fn() 版本。

我也尝试过像这样模拟模块：

jest.mock('../src/util', () => ({
    ...jest.requireActual('../src/util'),
    anotherFunc: jest.fn(),
}));

但这也不起作用。

如何强制originalFunc 使用anotherFunc 的模拟实现？

【问题讨论】：

有一个论据表明您不能通过设计来测试它——在任何其他语言中，您通常不会对私有方法进行单元测试。验证结果不是一样好吗？

标签： javascript node.js unit-testing jestjs mocking

【解决方案1】：

使用exports.anotherFunc 对anotherFunc 函数保持相同的引用。然后，您可以使用jest.spyOn() 模拟它。

例如

utils.js:

async function originalFunc(params) {
  await exports.anotherFunc(params.arg1, params.arg2);
}

async function anotherFunc(arg1, arg2) {
  console.log('real anotherFunc implementation');
}

exports.originalFunc = originalFunc;
exports.anotherFunc = anotherFunc;

utils.test.js:

const utils = require('./utils');

describe('67189137', () => {
  it('should pass', async () => {
    const params = {
      arg1: 'data1',
      arg2: 'data2',
    };
    const anotherFuncSpy = jest
      .spyOn(utils, 'anotherFunc')
      .mockImplementation(() => console.log('mock anotherFunc implementation'));
    await utils.originalFunc(params);
    expect(anotherFuncSpy).toBeCalledWith('data1', 'data2');
  });
});

单元测试结果：

 PASS  examples/67189137/utils.test.js (8.324 s)
  67189137
    ✓ should pass (20 ms)

  console.log
    mock anotherFunc implementation

      at Object.<anonymous> (examples/67189137/utils.test.js:11:41)

Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        9.347 s

另一种方法是使用依赖注入，将anotherFunc 作为参数传递给originalFunc 函数，如下所示：

async function originalFunc(params, anotherFunc) {
  await anotherFunc(params.arg1, params.arg2);
}

【讨论】：