[英]Jest TypeScript Error 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
作為返回的 object ,其中包含post
並且不測試jest.fn()
而是使用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
isn't fully handled by Jest auto-mock because axios
is a function and not an object, its methods like axios.post
are ignored.
__mocks__
(不是__mock__
)的使用對於手動模擬是可選的。 它們可以就地模擬,盡管使用__mocks__
進行重用是有意義的:
jest.mock('axios', () => {
return Object.assign(jest.fn(), {
get: jest.fn(),
post: jest.fn(),
...
});
});
axios-mock-adapter
和toHaveBeenCalledWith
沒有問題,因為使用真正的 Axios 和自定義適配器允許監視方法(但不是axios()
function 本身):
jest.spyOn(axios, 'post');
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.