如何模拟第三方包的方法

Question

我有一个简单的函数，可以连接到 mongoDB 并创建一个新文档。现在我如何在单元测试时模拟导入的 mongo 包的方法。

我尝试通过猴子补丁来模拟 GinContext。

但在导入包时无法继续模拟实际的 mongoClient。

func CreateUser(c GinContext) {
    var userdetail UserDetails
    binderr := c.ShouldBindJSON(&userdetail)
    fmt.Println(binderr)
    if binderr != nil {
        c.JSON(500, gin.H{
            "message": "Input payload not matching",
            "error":   binderr,
        })
        return
    }

    //-- Client if of type *mongo.Client. 

        //-- How do I mock the Client.Database, Client.Database.Connection

    collection := Client.Database("demo").Collection("users")
    ctx, err1 := context.WithTimeout(context.Background(), 10*time.Second)
    if err1 != nil {
    }
    response, err2 := collection.InsertOne(ctx, userdetail)
    if err2 != nil {
        log.Println("Some error inserting the document")
    }
    fmt.Println(response.InsertedID)
    c.JSON(200, gin.H{
        "message": "User created successfully",
    })
}

预期：我应该能够模拟或存根客户端并提供虚拟功能。就像我们在 NodeJS 中所做的那样

间谍On（客户端，'数据库'）.and.return（某事）

Answer 1

每次我想知道“如何模拟方法”时，这主要与我的代码架构有关。在大多数情况下，无法轻松测试某些代码意味着代码设计不当和/或与所使用的库/框架过于耦合。在这里，您想要模拟 Mongo 连接只是因为您的代码与 Mongo 太紧密相关（在函数中CreateUser）。重构可以帮助您测试代码（无需任何 Mongo 连接）。

我的经验是，使用接口和依赖注入可以简化 Go 中的测试过程，并阐明架构。这是我尝试帮助您测试您的应用程序的尝试。

代码重构

首先，定义你想用接口做什么。在这里，您要插入用户，所以让我们UserInserter现在使用单一方法创建一个界面（Insert插入单个用户）：

type UserInserter interface {
    Insert(ctx context.Context, userDetails UserDetails) (insertedID interface{}, err error)
}

在您提供的代码中，您仅使用insertedID，因此您可能只需要它作为此Insert方法的输出（如果出现问题，则可能会出现可选错误）。insertedID被定义为interface{}此处，但可以随意更改为您想要的任何内容。

然后，让我们修改您的CreateUser方法并将其UserInserter 作为参数注入：

func CreateUser(c *gin.Context, userInserter UserInserter) {
    var userdetail UserDetails
    binderr := c.ShouldBindJSON(&userdetail)
    fmt.Println(binderr)
    if binderr != nil {
        c.JSON(500, gin.H{
            "message": "Input payload not matching",
            "error":   binderr,
        })
        return
    }

    // this is the modified part
    insertedID, err2 := userInserter.Insert(c, userdetail)
    if err2 != nil {
        log.Println("Some error inserting the document")
    }
    fmt.Println(insertedID)

    c.JSON(200, gin.H{
        "message": fmt.Sprintf("User %s created successfully", insertedID),
    })
}

这个方法可以重构，但为了避免任何混乱，我不会碰它。

userInserter.Insert(c, userdetail)通过注入替换此方法中的 Mongo 依赖项userInserter。

您现在可以使用UserInserter您选择的后端（在您的例子中为 Mongo）来实现您的界面。插入 Mongo 需要一个Collection对象（我们将用户插入其中的集合），所以让我们将其添加为属性：

type MongoUserInserter struct {
    collection *mongo.Collection
}

方法的实现Insert如下（调用InsertOne方法*mongo.Collection）：

func (i MongoUserInserter) Insert(ctx context.Context, userDetails UserDetails) (insertedID interface{}, err error) {
    response, err := i.collection.InsertOne(ctx, userDetails)
    return response.InsertedID, err
}

该实现可以位于单独的包中，并且应该单独测试。

实现后，您可以MongoUserInserter在主应用程序中使用，其中 Mongo 是后端。MongoUserInserter在main函数中初始化，并注入到CreateUser方法中。路由器设置已分开（也用于测试目的）：

func setupRouter(userInserter UserInserter) *gin.Engine {
    router := gin.Default()

    router.POST("/createUser", func(c *gin.Context) {
        CreateUser(c, userInserter)
    })

    return router
}

func main() {
    client, _ := mongo.NewClient()
    collection := client.Database("demo").Collection("users")
    userInserter := MongoUserInserter{collection: collection}

    router := setupRouter(userInserter)
    router.Run(":8080")
}

请注意，如果有一天您想更改后端，您只需要更改userInsertermain 函数中的即可！

测试

从测试的角度来看，现在测试更容易了，因为我们可以创建一个 fake UserInserter，例如：

type FakeUserInserter struct{}

func (_ FakeUserInserter) Insert(ctx context.Context, userDetails UserDetails) (insertedID interface{}, err error) {
    return userDetails.Name, nil
}

（我想这里UserDetails有一个属性Name）。

如果你真的想模拟这个接口，你可以看看GoMock。但在这种情况下，我不确定是否需要使用模拟框架。

现在我们可以CreateUser使用简单的 HTTP 测试框架来测试我们的方法（请参阅https://github.com/gin-gonic/gin#testing），而不需要 Mongo 连接或模拟它。

import (
    "bytes"
    "net/http"
    "net/http/httptest"
    "testing"

    "github.com/stretchr/testify/assert"
)

func TestCreateUser(t *testing.T) {
    userInserter := FakeUserInserter{}
    router := setupRouter(userInserter)

    w := httptest.NewRecorder()
    body := []byte(`{"name": "toto"}`)
    req, _ := http.NewRequest("POST", "/createUser", bytes.NewBuffer(body))
    router.ServeHTTP(w, req)

    assert.Equal(t, 200, w.Code)
    assert.Equal(t, `{"message":"User toto created successfully"}`, w.Body.String())
}

请注意，这并不能免除对Insert的方法的测试MongoUserInserter，而是单独进行：这里，此测试涵盖CreateUser，而不是Insert方法。