如何使用 Jest 在 TypeScript 中模拟导入的函数？答案

【问题标题】：How can you mock imported functions in TypeScript using Jest?如何使用 Jest 在 TypeScript 中模拟导入的函数？
【发布时间】：2018-11-09 06:16:45
【问题描述】：

我有一个名为 map-creation.service.ts 的模块：

export const createMap = (asyncJobId: string, resourceUrl: string, s3DestFolder: string) => {

};

在我的端点中使用：

import {createMap} from './services/map-creation.service';

const router = express.Router();
const routePrefix = config.get('server.routePrefix');

router.post(`/${routePrefix}`, validate(validation), (req: express.Request, res: express.Response) => {
    createMap(req.body.asyncJobId, req.body.resourceUrl, req.body.s3DestFolder);
    res.status(201).json({message: 'Created'});
});

当我试图在我的测试中模拟这个模块，并想测试它是否在请求端点时被调用时，我仍然得到：Expected mock function to have been called with: ... But it was not called.

jest.mock('../../../src/services/map-creation.service');
import {createMap} from '../../../src/services/map-creation.service';

这是我的测试：

it('should call the map-creation service', () => {
        return request(server)
            .post(`/${routePrefix}`)
            .send({
                asyncJobId,
                resourceUrl,
                s3DestFolder
            })
            .then(res => {
                expect(createMap).toBeCalledWith(asyncJobId, resourceUrl, s3DestFolder);
            });
    });

如果我像这样模拟方法：

import {createMap} from '../../../src/services/map-creation.service';
createMap = jest.fn();

测试通过，但 tslint 抱怨：Cannot assign to 'createMap' because it is not a variable。那么在 TypeScript 和 Jest 中模拟这个方法的正确方法是什么？

【问题讨论】：

我相信你必须打电话给jest.mock，给它与导入时相同的参数。因此，如果使用import {createMap} from './services/map-creation.service'; 然后将其模拟为jest.mock('./services/map-creation.service');，这会迫使您将测试与模块放在同一目录中（这是常见的做法）。
另一种选择是将 TS 配置为使用非相对模块导入 link （背后的想法是 jest 实际上并不了解您用于导入和模拟的这两个路径是相同的）
除了DI还有什么办法吗？
ts-mock-imports 是我创建的一个库，允许您使用 typescript 模拟类导入。

标签： typescript unit-testing mocking jestjs

【解决方案1】：

那么在 TypeScript 和 Jest 中模拟这个方法的正确方法是什么？

根据需要使用依赖注入来注入模拟和真实版本的函数。

推荐的 DI 框架：http://inversify.io/

但 tslint 抱怨：无法分配给“createMap”，因为它不是变量

请不要这样做。导入应该被认为是不可变的。你也会得到一个编译时 TypeScript 错误，当模块支持变成原生时，你会得到一个运行时错误。

【讨论】：

我遇到了类似的问题，并且能够使用 jest 的 spyOn 模拟模块，同时仍然能够跟踪对从模块导出的函数的调用并模拟其实现。有关文档，请参阅 jestjs.io/docs/en/jest-object#jestspyonobject-methodname。测试代码最终看起来像： ``` import * as ModuleName from 'path/to/module'; ... methodSpy = jest.spyOn(ModuleName, 'methodName').mockImplementation(jest.fn()); ...期望（methodSpy）.toBeCalled（）； ```

【解决方案2】：

依赖注入的问题在于，它要求您重新构建所有现有解决方案，以便您的代码在测试中能够正常运行。它也忽略了一个事实，即 ES6 已经有一个可以被劫持的导入/导出系统。

ts-mock-imports 是一个库，旨在处理模拟导入而无需依赖注入。

在您的测试文件中：

import * as createMapModule from '../../../src/services/map-creation.service';
import { ImportMock } from 'ts-mock-imports';

const mockHandler = ImportMock.mockOther(createMapModule, 'createMap', jest.fn());

<-- Test Code Here --->

// Ensure you restore the mock once the tests are complete
mockHandler.restore()

【讨论】：