使用jest模拟在typescript测试中从另一个文件调用的函数

在使用Jest进行TypeScript测试时，你可能需要模拟（mock）从另一个文件中调用的函数。Jest 提供了多种方法来模拟模块和函数。以下是一个详细的步骤指南，展示如何在TypeScript测试中模拟从另一个文件调用的函数。

1. 项目结构

假设你的项目结构如下：

/project
  /src
    - main.ts
    - utils.ts
  /tests
    - main.test.ts
  - tsconfig.json
  - jest.config.js
  - package.json

2. 示例代码

假设你有一个utils.ts文件，其中包含一个函数fetchData：

// src/utils.ts
export const fetchData = async (): Promise<string> => {
  // Simulate an API call
  return "real data";
};

在main.ts文件中，你调用了fetchData函数：

// src/main.ts
import { fetchData } from './utils';

export const getData = async (): Promise<string> => {
  const data = await fetchData();
  return `Processed ${data}`;
};

3. 安装依赖

确保你已经安装了必要的依赖：

npm install --save-dev jest ts-jest @types/jest

4. 配置Jest

在jest.config.js中配置Jest以支持TypeScript：

module.exports = {
  preset: 'ts-jest',
  testEnvironment: 'node',
  moduleNameMapper: {
    '^src/(.*)$': '<rootDir>/src/$1',
  },
};

5. 编写测试

在tests/main.test.ts中编写测试，并模拟fetchData函数：

// tests/main.test.ts
import { getData } from '../src/main';
import * as utils from '../src/utils';

jest.mock('../src/utils');

describe('getData', () => {
  it('should return processed data', async () => {
    // Mock the fetchData function
    const mockFetchData = jest.spyOn(utils, 'fetchData').mockResolvedValue('mock data');

    const result = await getData();

    expect(result).toBe('Processed mock data');

    // Restore the original implementation
    mockFetchData.mockRestore();
  });
});

6. 运行测试

运行测试以确保一切正常：

npm test

解释

jest.mock('../src/utils')：这行代码告诉Jest自动模拟../src/utils模块中的所有导出。
jest.spyOn(utils, 'fetchData').mockResolvedValue('mock data')：使用jest.spyOn来创建一个模拟函数，并指定它的返回值。mockResolvedValue用于模拟一个返回Promise的异步函数。
expect(result).toBe('Processed mock data')：断言getData函数的返回值是否符合预期。
mockFetchData.mockRestore()：在测试结束后恢复fetchData函数的原始实现。