用 Jest 模拟服务

Question

尝试编写测试以提供以下代码的代码覆盖率：

注意：服务中还有其他功能，但为简洁起见仅列出一个。

export const service = {
     getById: async (id) => {
     const url = `/api/customers/${id}/names`
     const {data} = await axios.get(url, axiosOptions);
     return data;
}

我试图通过此测试简单地提供代码覆盖率：

注意：我试图使用 require 而不是 import 但这似乎不起作用。

import {service} from './requests';

it("mocks the getById function", () => {
     service.getById = jest.fn();

     expect(service.getById.mock).toBeTruthy();
}

然而，这个测试通过似乎没有提供代码覆盖率。

我试图模拟 axios 调用，但我似乎无处可去，因为我发现的实施示例目前对我不起作用。

有没有人有想法和示例，请问我如何为该服务提供代码覆盖率？

---

更新：对 sonEtLumiere 的回答

jest.mock('./service', () => ({
     getById: jest.fn().mockResolvedValue({ data : "hello"}),
}));

describe('test', () => {
     it('mocks the service", async () => {
     service.getById.mockResolvedValue({data: "hello});
     const data = await service.getById(1);
     expect(data).toEqual({data:"hello"});
   })
})

当前返回错误：

Cannot read properties of undefined (reading 'getById')

关于为什么我会收到此错误的任何想法？

Answer 1

要使用 Jest 模拟服务，您可以使用 jest.mock() function 创建服务的模拟版本。 例如：

 jest.mock('path/to/service', () => ({ getById: jest.fn().mockResolvedValue({ /* mocked data */ }), }));

然后，在您的测试文件中，您可以导入服务的模拟版本并使用 function 上的模拟属性来控制其行为。 例如，您可以使用.mockResolvedValue 设置function 的解析值，或者使用.mockRejectedValue 使function 抛出错误。

 import { service } from 'path/to/service'; describe('test', () => { it('mocks the service', async () => { service.getById.mockResolvedValue({ /* mocked data */ }); const data = await service.getById(1); expect(data).toEqual({ /* mocked data */ }); }); });

Answer 2

我同意@Lin Du的评论，如果你想测试service.getById ，你应该是 mocking 该方法所依赖的，在这种情况下axios.get 。

但是随着您的问题，问题是./requests中的命名导出是一个 object 包含getById属性，这是您要测试的方法。 所以jest.mock应该是这样的：

jest.mock("./requests.js", () => ({
  service: {
    getById: jest.fn(),
  },
}))

然后您的测试将按您的预期通过：

it("mocks the getById function", async () => {
  service.getById.mockResolvedValueOnce({ data: "hello" })
  const data = await service.getById(1)

  expect(data).toEqual({ data: "hello" })
})

但是同样，如果你想测试一个方法并有适当的覆盖率，你需要模拟的是方法的依赖，而不是方法本身，例如：

import { service } from "./requests"
import axios from "axios"

jest.mock("axios")

test("service.getById", async () => {
  axios.get.mockResolvedValueOnce({ data: "hello" })
  const result = await service.getById(1)

  expect(result).toBe("hello")
})