Twilio API 使用 Jest 在 Nestjs 中模拟单元测试
Twilio API mocking unit testing in Nestjs using Jest
我有这个 twilio.service.ts
文件。我想在 twilio.service.spec.ts
中针对验证 OTP 已成功发送或因缺少参数而失败的两种情况编写单元测试。
twilio.services.ts:
async startVerification(
startVerificationDto: StartVerificationDto
) {
try {
const verificationResponse = await this.twilioClient.verify
.services("TWILIO_VERIFY_SERVICE_SID")
.verifications.create({
to: `+91${sendVerificationCodeDto.phoneNumber}`,
channel: "sms",
locale: "en",
});
return verificationResponse;
} catch (error) {
throw new BadRequestException("Failed sending OTP");
}
}
到目前为止已经尝试过:
it("Should be able to send verification code on mobile number", async () => {
const actualRes = await controller.startVerification({
phoneNumber: "xxxxxxxxxxx",
});
expect(twilioService.twilioClient.verify.services).toBeCalledWith(
"TWILIO_VERIFY_SERVICE_SID"
);
expect(actualRes).toEqual({
sid: "VA_TWILIO_VERIFY_SERVICE_SID",
});
});
it("Should return error if required parameters are missing", async () => {
expect(twilioService.twilioClient.verify.services).not.toBeCalledWith(
"TWILIO_VERIFY_SERVICE_SID"
);
try {
await controller.startVerification({
phoneNumber: "xxxxxxxxxxx",
});
} catch (e) {
expect(e.message).toBe("Failed sending OTP");
}
});
我主要关心的是:如何模拟 Twilio 的嵌套函数(验证>服务>验证>创建)。
另外,在模拟之后我如何在 spec.ts 文件中调用或使用它。
这里是 Twilio 开发人员布道者。
模拟嵌套对象和函数调用比困难更烦人。我认为这样的东西应该适合你:
(我不确定你的例子中 controller
和 twilioService
之间的关系。我试图在 twilioService
上模拟 twilioClient
在这里,但您可能需要根据事物的组合方式对其进行调整。)
it("Should be able to send verification code on mobile number", async () => {
const mockVerificationCreate = jest.fn().mockResolvedValue({
sid: "VA_TWILIO_VERIFY_SERVICE_SID"
})
const mockVerifyService = jest.fn().mockReturnValue({
verifications: {
create: mockVerificationCreate
}
})
twilioService.twilioClient = {
verify: {
services: mockVerifyService
}
}
const actualRes = await controller.startVerification({
phoneNumber: "xxxxxxxxxxx",
});
expect(twilioService.twilioClient.verify.services).toBeHaveBeenCalledWith(
"TWILIO_VERIFY_SERVICE_SID"
);
expect(mockVerificationCreate).toHaveBeenCalledWith({
to: "+91xxxxxxxxxxx",
channel: "sms",
locale: "en",
});
expect(actualRes).toEqual({
sid: "VA_TWILIO_VERIFY_SERVICE_SID",
});
});
如果有帮助请告诉我。
我有这个 twilio.service.ts
文件。我想在 twilio.service.spec.ts
中针对验证 OTP 已成功发送或因缺少参数而失败的两种情况编写单元测试。
twilio.services.ts:
async startVerification(
startVerificationDto: StartVerificationDto
) {
try {
const verificationResponse = await this.twilioClient.verify
.services("TWILIO_VERIFY_SERVICE_SID")
.verifications.create({
to: `+91${sendVerificationCodeDto.phoneNumber}`,
channel: "sms",
locale: "en",
});
return verificationResponse;
} catch (error) {
throw new BadRequestException("Failed sending OTP");
}
}
到目前为止已经尝试过:
it("Should be able to send verification code on mobile number", async () => {
const actualRes = await controller.startVerification({
phoneNumber: "xxxxxxxxxxx",
});
expect(twilioService.twilioClient.verify.services).toBeCalledWith(
"TWILIO_VERIFY_SERVICE_SID"
);
expect(actualRes).toEqual({
sid: "VA_TWILIO_VERIFY_SERVICE_SID",
});
});
it("Should return error if required parameters are missing", async () => {
expect(twilioService.twilioClient.verify.services).not.toBeCalledWith(
"TWILIO_VERIFY_SERVICE_SID"
);
try {
await controller.startVerification({
phoneNumber: "xxxxxxxxxxx",
});
} catch (e) {
expect(e.message).toBe("Failed sending OTP");
}
});
我主要关心的是:如何模拟 Twilio 的嵌套函数(验证>服务>验证>创建)。 另外,在模拟之后我如何在 spec.ts 文件中调用或使用它。
这里是 Twilio 开发人员布道者。
模拟嵌套对象和函数调用比困难更烦人。我认为这样的东西应该适合你:
(我不确定你的例子中 controller
和 twilioService
之间的关系。我试图在 twilioService
上模拟 twilioClient
在这里,但您可能需要根据事物的组合方式对其进行调整。)
it("Should be able to send verification code on mobile number", async () => {
const mockVerificationCreate = jest.fn().mockResolvedValue({
sid: "VA_TWILIO_VERIFY_SERVICE_SID"
})
const mockVerifyService = jest.fn().mockReturnValue({
verifications: {
create: mockVerificationCreate
}
})
twilioService.twilioClient = {
verify: {
services: mockVerifyService
}
}
const actualRes = await controller.startVerification({
phoneNumber: "xxxxxxxxxxx",
});
expect(twilioService.twilioClient.verify.services).toBeHaveBeenCalledWith(
"TWILIO_VERIFY_SERVICE_SID"
);
expect(mockVerificationCreate).toHaveBeenCalledWith({
to: "+91xxxxxxxxxxx",
channel: "sms",
locale: "en",
});
expect(actualRes).toEqual({
sid: "VA_TWILIO_VERIFY_SERVICE_SID",
});
});
如果有帮助请告诉我。