在执行单元测试时如何模拟第三方结构并测试依赖于它的端点？

Golang小白一枚，正在不断学习积累知识，现将学习到的知识记录一下，也是将我的所得分享给大家！而今天这篇文章《在执行单元测试时如何模拟第三方结构并测试依赖于它的端点？》带大家来了解一下##content_title##，希望对大家的知识积累有所帮助，从而弥补自己的不足，助力实战开发！

我正在 gin gonic 中使用 getstream 的 go 库，并意识到我的端点将严重依赖于 stream_chat.client。

例如，在以下端点 (/v1/chat/test-token) 中，必须创建 stream_chat.client，因此在单元测试中测试此端点意味着创建和维护一个记录我使用的所有方法的接口来自 stream_chat.client ，以便我可以使用满足相同接口的 mockclient 执行依赖项注入，然后在编写单元测试时可以模拟方法 chatclient.upsertuser 和 chatclient.createtoken 。

func main() {
    config.Load()

    server := gin.New()

    chatClient, err := stream_chat.NewClient(config.StreamApiKey, config.StreamApiSecret)
    if err != nil {
        log.Err(err)
        os.Exit(2)
    }

    v1 := server.Group("/v1")
    {
        v1.GET("/chat/test-token/", func(c *gin.Context) {
            _, err := chatClient.UpsertUser(&stream.User{
                ID:   "test-user",
                Role: "admin",
            })

            if err != nil {
                c.JSON(http.StatusInternalServerError, gin.H{})
            }

            token, _ := chatClient.CreateToken("test-user", time.Time{})
            c.JSON(http.StatusOK, gin.H{
                "token": token,
            })
        })
    }
    
    server.Run(fmt.Sprintf(":%s", config.Port))
}

在我看来，记录 stream_chat.client 中使用的每种方法是相当费力的，以便在端点上保持良好的测试覆盖率，所以我想知道在这种情况下应该做什么？

1. 维护 stream_chat.client 的接口是正确的方法吗？
2. 不太相关：有没有办法正确地将 gin.handlerfunc（即 func(c *gin.context)）与 stream_chat.client 的创建分离？
3. 甚至不太相关：创建单例 stream_chat.client 更好，还是应该为每个需要客户端的端点创建一个新客户端？

正确答案

维护stream_chat.Client的接口是正确的方法吗？

如果您有非接口依赖项并且您希望使用它对处理程序进行单元测试，那么可以。您需要将 stream_chat.Client 包装在接口中。

如果第三方结构有很多方法，您可以将接口拆分为逻辑单元，并仅在每个处理程序中注入实际需要的方法。底层 stream_chat.Client 实现了所有这些，但各个模拟可以保持很小并且更容易推理。就我个人而言，我认为不值得为此付出代价。有很多开源模拟生成器，尤其是 mock and mockgen，还有从结构生成接口的工具。

有没有办法正确地将 gin.HandlerFunc（即 func(c *gin.Context)）与stream_chat.Client的创建分离？

您有多种选择，可以在这里找到：How to pass arguments to router handlers in Golang using Gin web framework?

简而言之，由于具有更好的单元可测试性，我更喜欢的选项是：

1. 创建结构体的处理程序方法以及该结构体的依赖项字段。
2. 使用提供程序模式并将提供程序设置到中间件的 Gin 上下文中

今天带大家了解了的相关知识，希望对你有所帮助；关于Golang的技术知识我们会一点点深入介绍，欢迎大家关注golang学习网公众号，一起学习编程~