我正在使用一些代码，其中我需要测试由函数抛出的异常的类型(它是TypeError, ReferenceError等?)
我目前的测试框架是AVA，我可以测试它作为第二个参数t.throws方法，就像这里:
it('should throw Error with message \'UNKNOWN ERROR\' when no params were passed', (t) => {
const error = t.throws(() => {
throwError();
}, TypeError);
t.is(error.message, 'UNKNOWN ERROR');
});
我开始用Jest重写我的测试，但不知道如何轻松地做到这一点。这可能吗?
当前回答
我已经成功地使用了这个方法
await expect(
async () => await apiCalls()
).rejects.toThrow();
其他回答
我最终为我们的test-utils库编写了一个方便的方法
/**
* Utility method to test for a specific error class and message in Jest
* @param {fn, expectedErrorClass, expectedErrorMessage }
* @example failTest({
fn: () => {
return new MyObject({
param: 'stuff'
})
},
expectedErrorClass: MyError,
expectedErrorMessage: 'stuff not yet implemented'
})
*/
failTest: ({ fn, expectedErrorClass, expectedErrorMessage }) => {
try {
fn()
expect(true).toBeFalsy()
} catch (err) {
let isExpectedErr = err instanceof expectedErrorClass
expect(isExpectedErr).toBeTruthy()
expect(err.message).toBe(expectedErrorMessage)
}
}
我已经成功地使用了这个方法
await expect(
async () => await apiCalls()
).rejects.toThrow();
这有点奇怪，但它是有效的，以我之见是很好的可读性:
it('should throw Error with message \'UNKNOWN ERROR\' when no parameters were passed', () => {
try {
throwError();
// Fail test if above expression doesn't throw anything.
expect(true).toBe(false);
} catch (e) {
expect(e.message).toBe("UNKNOWN ERROR");
}
});
Catch块捕获您的异常，然后您可以测试您引发的Error。奇怪的期待(真正的).toBe(假);如果没有抛出预期的错误，则需要测试失败。否则，这一行永远无法到达(Error应该在它们之前引发)。
@Kenny Body提出了一个更好的解决方案，如果你使用expect.assertions()，可以提高代码质量:
it('should throw Error with message \'UNKNOWN ERROR\' when no parameters were passed', () => {
expect.assertions(1);
try {
throwError();
} catch (e) {
expect(e.message).toBe("UNKNOWN ERROR");
}
});
请参阅原始答案和更多解释:如何在Jest中测试抛出异常的类型
2022年编辑:
要使用这种方法而不触发no-conditional-expect规则(如果你使用eslint-plugin-jest)，该规则的文档建议使用错误包装器:
class NoErrorThrownError extends Error {}
const getError = async <TError>(call: () => unknown): Promise<TError> => {
try {
await call();
throw new NoErrorThrownError();
} catch (error: unknown) {
return error as TError;
}
};
describe('when the http request fails', () => {
it('includes the status code in the error', async () => {
const error = await getError(async () => makeRequest(url));
// check that the returned error wasn't that no error was thrown
expect(error).not.toBeInstanceOf(NoErrorThrownError);
expect(error).toHaveProperty('statusCode', 404);
});
});
参见:no-conditional-expect文档
检查toThrow方法。
您必须将代码包装在一个额外的回调函数中!
您应该同时检查错误消息及其类型。
例如:
expect(
() => { // additional function wrap
yourCodeToTest();
}
).toThrow(
new RangeError('duplicate prevArray value: A')
);
由于额外的回调换行，代码不会立即运行，因此jest将能够捕获它。
您应该始终检查错误消息，以确保您正在检查正确的抛出情况，而不会得到代码可能抛出的另一个错误。
检查错误类型也很好，因此客户端代码可以依赖它。
还有一种更简单的方法对错误消息进行断言。这种方法的美妙之处在于，您不需要重新构造错误对象或获得完整的错误消息。只要您的错误包含错误消息的一部分，我们就可以假设它的类型是正确的。即
const printOnlyString = (str) => {
if(typeof str !== "string"){
throw Error("I can only print strings ${typeof str) given");
}
else {
console.log(str);
}
}
expect(() => printOnlyString(123))。toThrow(/只能打印字符串/)
