模拟第三方库的实现方法

怎么入门Golang编程？需要学习哪些知识点？这是新手们刚接触编程时常见的问题；下面golang学习网就来给大家整理分享一些知识点，希望能够给初学者一些帮助。本篇文章就来介绍《模拟第三方库的实现方法》，涉及到，有需要的可以收藏一下

我有一个简单的函数，可以连接到 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 中我们所做的那样

spyon(client,'database').and.return(something)

解决方案

每次我想知道“如何模拟方法”时，这主要与我的代码架构有关。在大多数情况下，无法轻松测试某些代码意味着代码设计不当和/或与所使用的库/框架过于耦合。在这里，您想要模拟 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 方法的实现如下（在 *mongo.collection 上调用 insertone 方法）：

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

请注意，如果有一天您想更改后端，您只需 需要更改main函数中的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())
}

请注意，这并不免除测试 mongouserinserter 的 insert 方法，但要单独测试：这里，此测试涵盖 createuser，而不是 insert 方法。

今天关于《模拟第三方库的实现方法》的内容就介绍到这里了，是不是学起来一目了然！想要了解更多关于的内容请关注golang学习网公众号！