gomock menyediakan panggilan hilang untuk semua subkaedah kecuali yang pertama dalam kaedah utama

PHP editor strawberry memperkenalkan anda kepada gomock, iaitu alat ujian berkuasa yang boleh memberikan panggilan hilang untuk semua subkaedah dalam kaedah utama kecuali yang pertama. Ini bermakna anda boleh menggunakan gomock untuk mensimulasikan tingkah laku subkaedah untuk menguji kefungsian kaedah utama dengan lebih baik. Gomock sangat mudah untuk digunakan, menjadikannya mudah untuk mencipta dan mengkonfigurasi objek olok-olok dan menetapkan nilai panggilan dan pulangan yang dijangkakan. Sama ada anda berada dalam ujian unit atau ujian integrasi, gomock boleh membantu anda menguji dan mengesahkan dengan lebih baik. Sama ada anda seorang pemula atau pembangun berpengalaman, gomock ialah alat yang sangat baik yang patut diterokai dan digunakan.

Kandungan soalan

Saya mempunyai kaedah go yang bertanggungjawab untuk menghantar mesej OTP kepada pengguna. Ia memanggil empat kaedah dalaman (saya bercakap tentang sub-kaedah) RemoveOTP, GetOneTimePassCode, SaveOTP dan SendOTP.

Nama fail: 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
}

Fail kes ujian: user_usecase_test.go dan kaedah ralat kes ujian unit

// 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)
}

Kini apabila melaksanakan kes ujian, ia tidak menimbulkan sebarang ralat untuk RemoveOTP tetapi memberikan tiga kaedah yang tinggal. Ini adalah kesilapan yang tepat

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)

Saya tidak mahu menggunakan penyelesaian seperti AnyTimes() kerana saya pasti semua sub-kaedah akan dipanggil sekali. Apakah penyelesaian yang ideal untuk ini? Sila buat cadangan.

Penyelesaian

Masalahnya ialah fungsi RemoveOTP() anda mengembalikan ralat, jadi kod anda tidak melaksanakan sebarang kaedah lain. (Seperti namanya, panggilan tidak dijawab)

Berikan AnyTimes() untuk berjalan dengan jayanya kerana ia boleh berjalan 0 hingga berkali-kali.

Jika anda benar-benar ingin menguji bahawa semua kaedah dilaksanakan sekali, mungkin anda boleh mengejek semua fungsi tanpa mengembalikan ralat supaya ia melaksanakan semua kod anda

Atas ialah kandungan terperinci gomock menyediakan panggilan hilang untuk semua subkaedah kecuali yang pertama dalam kaedah utama. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!