golang-使用go mock编写业务测试

参考资料
官方git地址和示例

一、应用场景

服务在进行单元测试的时候,由于测试环境和生产环境不同,可能第三方接口的返回也会不同,无法完全模拟生产环境的条件。这就需要通过模拟输入、输出来测试完整的业务逻辑了。

二、基本用法

1、安装 mockgen 工具

Windows:
SET GO111MODULE=on
go get github.com/golang/mock/[email protected]

正常安装完成后,可在$GOPATH/bin 目录下找到 mockgen

2、自动生成mock 代码

只有Interface 类型才能生成mock,因此我们要先定义接口,如下:
golang-使用go mock编写业务测试
那么可以直接通过mockgen 指令生成mock 代码:
mockgen -source=studentinterface.go -destination=studentmock.go

3、编写接口mock

基本格式:
golang-使用go mock编写业务测试
其中,ctrl.Finish 在go 1.14 及之后的版本不再需要手动触发。

4、编写接口stub

Mock 写好了,当然接下来就是调用了,紧接着刚才的mock,直接调用即可:
golang-使用go mock编写业务测试

三、一些复杂场景

1、设置不同入参下的返回值

前面我们已经知道可通过特定的输入,设定特定的返回值。但是如果需要测试的入参取值范围比较大,每种取值都mock 一次就有点麻烦了。可通过DoAndReturn 来设置特定取值范围的返回值:
golang-使用go mock编写业务测试

2、调用次数限制

默认一个mock 只能调用一次,多次调用我们需要通过 time/AnyTime 来配置:
golang-使用go mock编写业务测试

3、设置调用顺序

场景:比如需要测试一个添加接口的完整功能:查 -> 插入 -> 查。查询会调用两次,但是入参不同,有顺序性。可通过mock.InOrder方法设置:
golang-使用go mock编写业务测试

4、并发测试

官方示例

基本场景:测试用例也需要设置并发+合并多个测试用例结果后总和处理。这种情况下,为了防止测试用例执行过久,我们可以结合context来实现超时退出goroutine。

示例:
golang-使用go mock编写业务测试golang-使用go mock编写业务测试

5、mock 其他配置

Any
当我们对需要测试方法的入参没有要求,只是想跑下单元测试过程的话,可直接在Expect 后设置Any,表示可以接收任何入参。
golang-使用go mock编写业务测试

四、总结

只要在测试代码中重新编写业务逻辑就可以了,但是无法直接调用业务代码中的逻辑也是有点麻烦,因此最好将业务代码多拆解,尽量按小功能分多个不同的方法,这样才能更好地利用mock,对业务逻辑进行划分并测试。