今天golang学习网给大家带来了《模拟由 Golang 的 Swagger 生成的 API 处理程序》，其中涉及到的知识点包括等等，无论你是小白还是老手，都适合看一看哦~有好的建议也欢迎大家在评论留言，若是看完有所收获，也希望大家能多多点赞支持呀！一起加油学习~

我确实需要一些帮助来测试我的 api 的行为，让我解释一下上下文：

这个api是用swagger使用存储库模式生成的go编写的。在创建新对象的情况下，我需要检查该名称是否已存在于数据库中，因此我调用存储库的函数来按数据库中的名称获取应用程序（见下文）

func (a *mongoapplicationrepository) getapplicationbyname(name string, ctx context.context) (*models.application, error) {
    _, span := otel.tracer("getapplicationbyname").start(ctx, "getapplicationbyname")
    defer span.end()

    var application models.application

    err := a.mgconn.collection("applications").
        findone(context.todo(), bson.m{"name": name}).decode(&application)

    if err != nil {
        if err == mongo.errnodocuments {
            return &application, nil
        }
        return nil, err
    }
    return &application, nil
}

此函数由 api 处理程序调用，如下所示

type ApplicationCreateHandler struct {
    API       *operations.KubeesAPI
    repo      repo.ApplicationRepository
    statsRepo repo.StatsRepository
}

func NewApplicationCreateHandler(API *operations.KubeesAPI, repo repo.ApplicationRepository, statsRepo repo.StatsRepository) ApplicationCreateHandler {
    return ApplicationCreateHandler{
        API:       API,
        repo:      repo,
        statsRepo: statsRepo,
    }
}

// Handle is the HTTP handler for application creation
func (h *ApplicationCreateHandler) Handle(params application.AppCreateParams, principal *models.Principal) middleware.Responder {
    traceName := "application-create"
    ctx, span := otel.GetTracerProvider().Tracer(traceName).Start(context.TODO(), traceName)
    defer span.End()

    if params.Data == nil {
        err := "unable to validate input"
        logger().Errorln(err)
        return application.NewAppCreateBadRequest().WithPayload(&models.APIResponse{
            Msg: &err,
        })
    }

    if err := params.Data.Validate(h.API.Formats()); err != nil {
        err := fmt.Sprintf("unable to validate input: %v", err)
        logger().Errorln(err)
        return application.NewAppCreateBadRequest().WithPayload(&models.APIResponse{
            Msg: &err,
        })
    }

    app := models.Application{
        ID:       uuid.NewString(),
        Name:     params.Data.Name,
        Selector: params.Data.Selector,
    }

    c, err := h.repo.GetApplicationByName(*params.Data.Name, ctx)
    if err != nil {
        err := fmt.Sprintf("Unable to get Application: %v", err)
        logger().Errorln(err)
        return application.NewAppCreateInternalServerError().WithPayload(&models.APIResponse{
            Msg: &err,
        })
    }

    if c.ID != "" {
        r := "name already taken"
        logger().Errorln(r)
        return application.NewAppCreateInternalServerError().WithPayload(&models.APIResponse{
            Msg: &r,
        })
    }

    appDomain, err := app.ToDomainModel()
    if err != nil {
        err := fmt.Sprintf("Unable to convert application to domain model: %v", err)
        logger().Errorln(err)
        return application.NewAppCreateInternalServerError().WithPayload(&models.APIResponse{
            Msg: &err,
        })
    }

    err = h.repo.CreateApplication(appDomain, ctx)
    if err != nil {
        err := fmt.Sprintf("Unable to create Application: %v", err)
        logger().Errorln(err)
        return application.NewAppCreateInternalServerError().WithPayload(&models.APIResponse{
            Msg: &err,
        })
    }

    if err := h.statsRepo.UpdateApplicationsHistory(ctx); err != nil {
        err := fmt.Sprintf("unable to update applications history: %v", err)
        logger().Errorln(err)
        return application.NewAppCreateInternalServerError().WithPayload(&models.APIResponse{
            Msg: &err,
        })
    }

    return application.NewAppCreateCreated()
}

我只想检查此行为并测试是否我们已经有一个与新创建的应用程序名称相同的应用程序，这会引发错误，而不是相反的情况。但我不知道要模拟什么，因为存储库有一些外部依赖项

正确答案

我强烈建议确保您的 applicationcreatehandler 仅依赖于接口。在这种情况下，您可以通过编写模拟类或生成来模拟接口。您可以通过创建一个新实例并将模拟的依赖项传递给它来测试 applicationcreatehandler。然后执行 handle()` 方法并确保调用所有依赖项。

我强烈建议生成你的模拟类。当您自己编写模拟时，可能会在测试代码中引入错误。你不会想要这样，对吧？

模拟库的一个很好的例子是 mockgen。您可以按照他们的 github-readme 轻松安装它。

步骤

1. 为您的依赖项创建接口。
   最好在依赖接口的一侧定义接口。因此，在您的情况下，这将位于 applicationcreatehandler 文件中。接口应反映处理程序的需求。

type (
  applicationrepo interface {
    getapplicationbyname(name string, ctx context.context)
    createapplication(domain domain, ctx context.context)
  }

  // other dependencies here... 

)

1. 编写单元测试
   创建一个新的单元测试

// youfile_test.go

func TestApplicationHandler(t *testing.T) {
  ctrl := gomock.NewController(t)
  defer ctrl.Finish()

  mockRepo := NewMockRepository(ctrl)
  mockRepo.EXPECT().
    Handle(gomock.any(), gomock.any()). // name, ctx
    Return(nil, nil).  // c, err
    Once()

  // other mocks...
  // mockApi
  // mockStatsRepo

  h := NewApplicationHandler(mockApi, mockStats, mockRepo)
  h.Handle(/*your test input*/)

  // do checks

}

如果 mockrepo 没有被调用一次，测试将抛出错误。

今天关于《模拟由 Golang 的 Swagger 生成的 API 处理程序》的内容就介绍到这里了，是不是学起来一目了然！想要了解更多关于的内容请关注golang学习网公众号！