php小编草莓为您介绍gomock,它是一个强大的测试工具,可以为主方法中的除第一个之外的所有子方法提供缺少的调用。这意味着,您可以使用gomock来模拟子方法的行为,从而更好地测试主方法的功能。gomock的使用非常简单,可以轻松创建和配置模拟对象,并设置预期的调用和返回值。无论您是在单元测试中还是集成测试中,gomock都能帮助您更好地进行测试和验证。无论您是初学者还是有经验的开发者,gomock都是一个值得探索和使用的优秀工具。
问题内容
我有一个 go 方法,负责向用户发送 OTP 消息。它调用内部的四个方法(我说的是子方法)RemoveOTP、GetOneTimePassCode、SaveOTP和SendOTP。
文件名:user_usecase.go
func (u *UserUseCase) SendUserOTP(ctx context.Context, user *domain.User, mobileNumber string) error {
var err error
var OTPNumber string
var expiration time.Time
//Remove previous OTP if any in DB
if err = u.Repo.RemoveOTP(ctx, user.ID, mobileNumber); err != nil {
return err
}
//Generate OTP
OTPNumber, expiration, err = u.TokenService.GetOneTimePassCode()
if err != nil {
return err
}
//Save Code in Database and then send
otpDataInput := domain.UserMobileOtps{
UserID: user.ID,
MobileNumber: mobileNumber,
Email: user.Email,
OtpCode: OTPNumber,
ExpiredAt: expiration,
}
if err = u.Repo.SaveOTP(ctx, otpDataInput); err != nil {
return err
}
if err = u.SMSService.SendOTP(ctx, mobileNumber, OTPNumber); err != nil {
return err
}
return nil
}
测试用例文件:user_usecase_test.go 和单元测试用例错误方法
// setup initializes common variables and returns them.
func setup(t *testing.T) (context.Context,
*gomock.Controller,
*mocks.MockUserRepository,
usecase.UserUseCase,
domain.User,
*mocks.MockTokenService,
*mocks.MockSMSService,
) {
ctx := context.Background()
ctrl := gomock.NewController(t)
mockRepo := mocks.NewMockUserRepository(ctrl)
mockTokenService := mocks.NewMockTokenService(ctrl)
mockSmsService := mocks.NewMockSMSService(ctrl)
uc := usecase.UserUseCase{Repo: mockRepo, TokenService: mockTokenService, SMSService: mockSmsService}
user := domain.User{ID: 1}
return ctx, ctrl, mockRepo, uc, user, mockTokenService, mockSmsService
}
func TestSendUserOTP_Error(t *testing.T) {
ctx, ctrl, mockRepo, uc, user, mockTokenService, mockSmsService := setup(t)
otpExpiration := time.Now().Add(time.Minute * 5)
defer ctrl.Finish()
someError := errors.New("some issue")
mockRepo.EXPECT().RemoveOTP(ctx, user.ID, "XXXXXYYYYY").Return(someError).Times(1)
mockTokenService.EXPECT().GetOneTimePassCode().Return("XXXYYY", otpExpiration, someError).Times(1)
mockRepo.EXPECT().SaveOTP(ctx, domain.UserMobileOtps{UserID: user.ID, MobileNumber: "XXXXXYYYYY", Email: user.Email, OtpCode: "XXXYYY", ExpiredAt: otpExpiration}).Return(someError).Times(1)
mockSmsService.EXPECT().SendOTP(ctx, "XXXXXYYYYY", "XXXYYY").Return(someError).Times(1)
err := uc.SendVerificationOTP(ctx, &user, "XXXXXYYYYY")
assert.Error(t, err)
assert.Equal(t, someError, err)
}
现在在执行测试用例时,它不会为RemoveOTP抛出任何错误,但给出了其余的三个方法。这是确切的错误
TestSendUserOTP_Error
controller.go:310: missing call(s) to *mocks.MockTokenService.GetOneTimePassCode() /project_path/user/usecase/user_usecase_test.go
controller.go:310: missing call(s) to *mocks.MockUserRepository.SaveOTP(is equal to context.Background (*context.emptyCtx), is equal to {{0 0001-01-01 00:00:00 +0000 UTC 0001-01-01 00:00:00 +0000 UTC {0001-01-01 00:00:00 +0000 UTC false}} 0 4 XXXXXYYYYY XXXYYY 0001-01-01 00:00:00 +0000 UTC 0001-01-01 00:00:00 +0000 UTC {2023-10-06 10:34:25.951558924 +0530 IST m=+600.001514851 true} {0001-01-01 00:00:00 +0000 UTC false}} /project_path/user/usecase/user_usecase_test.go
controller.go:310: missing call(s) to *mocks.MockSMSService.SendOTP(is equal to context.Background (*context.emptyCtx), is equal to XXXXXYYYYY (string), is equal to XXXYYY (string)) /project_path/user/usecase/user_usecase_test.go
controller.go:310: aborting test due to missing call(s)
--- FAIL: TestSendUserOTP_Error (0.00s)
我不想使用像 AnyTimes() 这样的解决方案,因为我确信所有子方法都会被调用一次。对此的理想解决方案应该是什么?请提出建议。
解决方法
问题是您的RemoveOTP()函数返回错误,因此您的代码不执行任何其他方法。 (如名称所示,未接来电)
给 AnyTimes() 使其运行成功,因为它可以运行 0 次到多次。
如果你真的想测试所有方法都执行一次,也许你可以模拟所有函数不返回错误,以便它执行你的所有代码