node.js - 开玩笑 TypeScript 错误 axios_1.default.post.mockImplementation is not a function
问题描述
请参阅下面的更新:
笔记:
我没有使用axios-mock-adapter
,除非有人可以指出我可以测试的示例toHaveBeenCalledWith
。
我还想避免创建一个 ̶_̶_̶m̶o̶c̶k̶_̶_̶
__mocks__
( 文件夹来模拟整个模块。
错误:
我所有的测试都通过了,但我仍然收到这种类型的错误。
TypeError: axios_1.default.post.mockImplementation is not a function
28 | const axiosPost = jest.fn(() => ({ success: true }));
29 | jest.mock('axios');
> 30 | (axios as jest.Mocked<any>).post.mockImplementation(
| ^
31 | jest.fn().mockImplementation(axiosPost),
32 | );
代码:
文件: __tests__/index.ts
import axios from 'axios';
// ...
// Before Tests
const axiosPost = jest.fn();
jest.mock('axios');
(axios as jest.Mocked<typeof axios>).post.mockImplementation(
jest.fn().mockImplementation(axiosPost),
);
// ...
beforeEach(() => {
jest.clearAllMocks();
});
// Test Performed & Passes
/**
* Validates send email request
*/
test('test - sendEmail - hello@email.com, some@email.com, my subject, hello there!', async () => {
// Setup
const from = 'hello@email.com';
const to = 'some@email.com';
const subject = 'my subject';
const body = 'hello there!';
const basicAuth = Buffer.from(`api:secret`).toString('base64');
process.env.MAILGUN_API_URL = 'url';
process.env.MAILGUN_DOMAIN = 'domain';
process.env.MAILGUN_SECRET_KEY = 'secret';
// Pre Expectations
expect(formData).not.toHaveBeenCalled();
expect(axiosPost).not.toHaveBeenCalled();
// Init
const result = await sendEmail(from, to, subject, body);
// Post Expectations
// Form Data
expect(formData).toHaveBeenCalledTimes(1);
expect(formDataAppend).toHaveBeenCalledTimes(4);
expect(formDataAppend.mock.calls[0][0]).toEqual('from');
expect(formDataAppend.mock.calls[0][1]).toEqual(from);
expect(formDataAppend.mock.calls[1][0]).toEqual('to');
expect(formDataAppend.mock.calls[1][1]).toEqual(to);
expect(formDataAppend.mock.calls[2][0]).toEqual('subject');
expect(formDataAppend.mock.calls[2][1]).toEqual(subject);
expect(formDataAppend.mock.calls[3][0]).toEqual('html');
expect(formDataAppend.mock.calls[3][1]).toEqual(body);
expect(formDataGetHeaders).toHaveBeenCalledTimes(1);
// Axios
expect(axiosPost).toHaveBeenCalledTimes(1);
expect(axios.post).toHaveBeenCalledWith(
'url/domain/messages',
{ append: formDataAppend, getHeaders: formDataGetHeaders },
{
headers: {
Authorization: `Basic ${basicAuth}`,
'Content-Type': 'multipart/form-data',
},
},
);
expect(result).toStrictEqual({ success: true });
});
更新
根据@estus-flask的建议和指导,我修改了代码以模拟axios
为返回的对象,其中包含post
并且不测试 ajest.fn()
而是使用 a spyOn
。
修改文件: __tests__/index.ts
// Mocks
// ========================================================
// ̶c̶o̶n̶s̶t̶ ̶a̶x̶i̶o̶s̶P̶o̶s̶t̶ ̶=̶ ̶j̶e̶s̶t̶.̶f̶n̶(̶)̶;̶
jest.mock('axios', () => {
return Object.assign(jest.fn(), {
post: jest.fn().mockReturnValue({ success: true }),
});
});
// ...
/**
* Validates send email request
*/
test('test - sendEmail - hello@email.com, some@email.com, my subject, hello there!', async () => {
// Setup
const spyOnAxiosPost = jest.spyOn(axios, 'post');
// ...
// Pre Expectations
expect(formData).not.toHaveBeenCalled();
// ̶e̶x̶p̶e̶c̶t̶(̶a̶x̶i̶o̶s̶P̶o̶s̶t̶)̶.̶n̶o̶t̶.̶t̶o̶H̶a̶v̶e̶B̶e̶e̶n̶C̶a̶l̶l̶e̶d̶(̶)̶;̶
expect(spyOnAxiosPost).not.toBeCalled();
// Init
const result = await sendEmail(from, to, subject, body);
// Post Expectations
// ...
// Axios
// ̶e̶x̶p̶e̶c̶t̶(̶a̶x̶i̶o̶s̶P̶o̶s̶t̶)̶.̶t̶o̶H̶a̶v̶e̶B̶e̶e̶n̶C̶a̶l̶l̶e̶d̶T̶i̶m̶e̶s̶(̶1̶)̶;̶
expect(spyOnAxiosPost).toBeCalledTimes(1);
// ...
expect(result).toStrictEqual({ success: true });
});
解决方案
axios
Jest 自动模拟没有完全处理,因为axios
它是一个函数而不是一个对象,它的方法像axios.post
被忽略了。
__mocks__
(not )的使用__mock__
对于手动模拟是可选的。它们可以就地模拟,尽管__mocks__
用于重用是有意义的:
jest.mock('axios', () => {
return Object.assign(jest.fn(), {
get: jest.fn(),
post: jest.fn(),
...
});
});
没有问题,axios-mock-adapter
因为toHaveBeenCalledWith
使用带有自定义适配器的真实 Axios 允许监视方法(但不能监视axios()
函数本身):
jest.spyOn(axios, 'post');
推荐阅读
- delete-file - 删除使用 xorriso 提取的文件
- arangodb - 在 ArangoDB 中的大型二分图上使用 AQL 进行高效路径遍历
- sql-server - 数据仓库 从 Oracle 到 SQL Server 的初始加载
- xpages - 绑定 xPages 组合框无法正常工作
- c# - 从基类继承实例值
- javascript - 如何在 post.message 中检测 null var?
- javascript - 如何使用 Javascript 函数的输出更改 HTML 元素的 CSS?
- javascript - 反应,无法正确使用我的配置
- python - 过滤器链的任意深度
- java - 是否可以在没有 setZOrderOnTop(true) 的情况下使 SurfaceView 透明?