gomock stellt fehlende Aufrufe für alle Untermethoden außer der ersten in der Hauptmethode bereit

Der PHP-Editor Strawberry stellt Ihnen Gomock vor, ein leistungsstarkes Testtool, das fehlende Aufrufe für alle Untermethoden in der Hauptmethode außer der ersten ermitteln kann. Dies bedeutet, dass Sie mit gomock das Verhalten von Untermethoden simulieren können, um die Funktionalität der Hauptmethode besser zu testen. Gomock ist sehr einfach zu verwenden und erleichtert das Erstellen und Konfigurieren von Scheinobjekten sowie das Festlegen der erwarteten Aufruf- und Rückgabewerte. Ganz gleich, ob Sie Unit-Tests oder Integrationstests durchführen, gomock kann Ihnen dabei helfen, besser zu testen und zu verifizieren. Egal, ob Sie Anfänger oder erfahrener Entwickler sind, Gomock ist ein hervorragendes Tool, das es wert ist, erkundet und verwendet zu werden.

Frageninhalt

Ich habe eine Go-Methode, die für das Senden von OTP-Nachrichten an Benutzer verantwortlich ist. Es werden vier interne Methoden aufgerufen (ich spreche von Untermethoden): RemoveOTP, GetOneTimePassCode, SaveOTP und SendOTP.

Dateiname: 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
}

Testfalldatei: user_usecase_test.go und Unit-Testfall-Fehlermethode

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

Beim Ausführen des Testfalls wird jetzt kein Fehler für RemoveOTP ausgegeben, sondern es werden die verbleibenden drei Methoden angezeigt. Das ist der genaue Fehler

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)

Ich möchte keine Lösung wie AnyTimes() verwenden, da ich sicher bin, dass alle Untermethoden einmal aufgerufen werden. Was wäre hierfür die ideale Lösung? Bitte machen Sie Vorschläge.

Workaround

Das Problem besteht darin, dass Ihre RemoveOTP()-Funktion einen Fehler zurückgibt, sodass Ihr Code keine andere Methode ausführt. (Wie der Name schon sagt, verpasste Anrufe)

Geben Sie AnyTimes() für eine erfolgreiche Ausführung an, da es null bis viele Male ausgeführt werden kann.

Wenn Sie wirklich testen möchten, dass alle Methoden einmal ausgeführt werden, können Sie vielleicht alle Funktionen simulieren, ohne einen Fehler zurückzugeben, sodass Ihr gesamter Code ausgeführt wird

Das obige ist der detaillierte Inhalt vongomock stellt fehlende Aufrufe für alle Untermethoden außer der ersten in der Hauptmethode bereit. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!