Question

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

我试图通过Monkeypatching模拟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中一样

spyOn（Client，'Database'）。and.return（Something）

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)通过注入userInserter代替了此方法中的Mongo依赖。

您现在可以使用所选的后端（在您的情况下为Mongo）实现UserInserter接口。插入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")
}

请注意，如果有一天您想更改后端，则只会需要更改主要功能中的userInserter！

测试

从测试的角度来看，现在可以更轻松地进行测试，因为我们可以创建伪造的UserInserter，例如：

type FakeUserInserter struct{}

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

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

如果您真的想模拟该界面，可以看看GoMock。不过，在这种情况下，我不确定是否需要使用模拟框架。

现在，我们可以使用简单的HTTP测试框架（请参阅https://github.com/gin-gonic/gin#testing）来测试CreateUser方法，而无需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的{{1}}方法，但要分开测试：这里，此测试覆盖MongoUserInserter，而不是CreateUser方法。

如何在golang中模拟第三方封装的方法

1 个答案:

代码重构

测试