go测试框架Convey + Monkey的使用

最新推荐文章于 2024-08-23 22:53:09 发布

原创最新推荐文章于 2024-08-23 22:53:09 发布 · 1.6w 阅读

12 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#go #Convey #Monkey #测试

go 专栏收录该内容

10 篇文章

订阅专栏

本文介绍了Go语言测试中Convey和Monkey框架的结合使用，讲解了如何安装这两个库，并通过实例展示了为函数打桩的常见场景。在测试代码中，Monkey用于替换目标函数，创建不同的测试条件，如模拟ReadMockFile函数抛出错误、正常运行及Unmarshal异常情况。

前言

常用的go语言测试框架包括Convey、Stub、Mock、Monkey等，用过之后发现比较好用的是Convey+Monkey，Convey是作为外层框架，Monkey可以为函数、方法等打桩，这里介绍几个Convey+Monkey的使用例子。

安装

go get github.com/smartystreets/goconvey
go get github.com/bouk/monkey
运行完后你会发现，在$GOPATH/src/目录下，新增了github.com/smartystreets/goconvey、
github.com/bouk/monkey框架源代码。

使用场景

使用场景主要包括：
基本场景：为一个函数打桩；
基本场景：为一个过程打桩；
基本场景：为一个方法打桩；

为一个函数打桩：

对我来说，为一个函数打桩应该是最常用的场景。
例子：
MockJson是一个工具函数，读取对应的json文件反序列化，实现很简单，代码如下所示：

func MockJson(filename string, m interface{}) (err error) {
    var buf []byte
    buf, err = ReadMockFile(filename)
    if err != nil {
        fmt.Printf("[Mock] read json file:[%s] error:[%s]", filename, err.Error())
        return
    }
    err = json.Unmarshal(buf, m)
    if err != nil {
        fmt.Printf("[Mock] unmarshal:[%s] error:[%s]", filename, err.Error())
        return
    }
    return
  }
}

MockJson函数中调用了ReadMockFile函数和Unmarshal函数。在UT中，如果被测函数调用了MockJson函数，则应根据用例的场景对MockJson函数打桩。
Monkey的API非常简单和直接，我们直接看打桩代码下面是测试代码：

func TestMockJson(t *testing.T) {
    Convey("TestMockJson", t, func() {
        Convey("Should be return error when ReadMockFile error", func() {
            Patch(ReadMockFile, func(string) ([]byte, error) {
                return nil, fmt.Errorf("ReadMockFile panic")
            })
            defer UnpatchAll()
            var ret []string
            err := MockJson("abc", &ret)
            ShouldNotBeNil(err)
        })
        Convey("Should be return nil when ReadMockFile success & unmarshal success", func() {
            var ret struct{ msg string }
            err := MockJson("test.json", &ret)
            ShouldBeNil(err)
        })
        Convey("Should be return nil when ReadMockFile success & unmarshal error", func() {
            Patch(json.Unmarshal, func([]byte, interface{}) error {
                return errors.New("unmarshal panic")
            })
            var ret struct{ msg string }
            err := MockJson("test.json", &ret)
            ShouldNotBeNil(err)
        })
    })
}

上面的UT代码测试了三种场景，第一种对ReadMockFile进行打桩，抛出错误，第二种测试正常场景，第三种测试Unmarshal异常。
打桩的过程十分简单，使用Patch，最后需要defer UnpatchAll来删除当前打桩：
Patch中
第一个参数是目标函数的函数名
第二个参数是桩函数的函数名，习惯用法是匿名函数或闭包
返回值是一个PatchGuard对象指针，主要用于在测试结束时删除当前的补丁