golang单元测试之mock

最新推荐文章于 2024-05-19 16:46:54 发布
最新推荐文章于 2024-05-19 16:46:54 发布
阅读量1.6k 收藏 3
点赞数
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u014458692/article/details/106401904
版权

点击上方“黑光技术”，选择“设为星标”

完美之道,不在无可增加,而在无可删减！

黑光技术专栏

 

golang单元测试之mock

序言

前面介绍了golang的一般单元测试，以及如何使用vscode进行高效的go单元测试开发。同时也说过一般单元测试重点在于cpu和内存类型的测试，而对io类型的测试是比较敏感的。那么针对这类测试就没法做单元测试了吗？有的，肯定是有的，这就是mock技术。

mock测试不但可以支持io类型的测试，比如：数据库，网络API请求，文件访问等。mock测试还可以做为未开发服务的模拟、服务压力测试支持、对未知复杂的服务进行模拟，比如开发阶段我们依赖的服务还没有开发好，那么就可以使用mock方法来模拟一个服务，模拟的这个服务接收的参数和返回的参数和规划设计的服务是一致的，那我们就可以直接使用这个模拟的服务来协助开发测试了；再比如要对服务进行压力测试，这个时候我们就要把服务依赖的网络，数据等服务进行模拟，不然得到的结果不纯粹。总结一下，有以下几种情况下使用mock会比较好：

  1. IO类型的，本地文件，数据库，网络API，RPC等

  2. 依赖的服务还没有开发好，这时候我们自己可以模拟一个服务，加快开发进度提升开发效率

  3. 压力性能测试的时候屏蔽外部依赖，专注测试本模块

  4. 依赖的内部函数非常复杂，要构造数据非常不方便，这也是一种

mock测试，简单来说就是通过对服务或者函数发送设计好的参数，并且通过构造注入期望返回的数据来方便以上几种测试开发。

一般情况自己写mock服务是比较费事的事情，而且如果风格不统一，那么后期的管理维护将是软件开发的一个巨大坑，是开发给自己挖的一个坑。所以在就有了很多mock测试框架的出现，框架的出现首先提升了编写mock测试服务的效率，而且编写风格得到了比较好的统一。c/c++也有很多mock框架，Google Mock就是一个比较经典了，java也有很多mock框架，这里就不列举了，今天我们要介绍的是针对golang的mock测试框架。

GoMock是由Golang官方开发维护的测试框架，实现了较为完整的基于interface的Mock功能，能够与Golang内置的testing包良好集成，也能用于其它的测试环境中。GoMock测试框架包含了GoMock包和mockgen工具两部分，其中GoMock包完成对桩对象生命周期的管理，mockgen工具用来生成interface对应的Mock类源文件。

安装

GoMock官网：

https://github.com/golang/mock

GoMock安装：

go get github.com/golang/mock/gomock

mockgen代码生成工具安装：

go get github.com/golang/mock/mockgen

安装好之后，在$GOPATH/src目录下有了github.com/golang/mock子目录，且在该子目录下有GoMock包和mockgen工具。

cd $GOPATH/src/github.com/golang/mock/mockgen
go build

编译后在这个目录下会生成了一个可执行程序mockgen。将mockgen程序移动到$PATH可以找到的目录中： 下面我是在window下的路径，使用了git的shell环境，可以直接看PATH，找到合适的或者新加入进去都ok。

echo $PATH
.....
cp mockgen.exe C:\Users\helightxu\go\bin\

安装之后就可以在命令行直接运行了：mockgen

$ mockgen
mockgen has two modes of operation: source and reflect.

Source mode generates mock interfaces from a source file.
It is enabled by using the -source flag. Other flags that
may be useful in this mode are -imports and -aux_files.
Example:
        mockgen -source=foo.go [other options]
......

这里暂时先不细说。

GoMock文档：

GoMock框架安装完成后，可以使用go doc命令来获取文档：

go doc github.com/golang/mock/gomock

这个文件比较简短，但给出了核心的使用说明。 在GoPkgDoc上也有一个网页版的文档

使用方式介绍

mockgen模式介绍

mockgen有两种操作模式：source和reflect。

Source模式下会从源文件产生mock的interfaces文件。 使用-source参数即可。和这个模式配套使用的参数常有-imports和-aux_files。

mockgen -source=foo.go [other options]

Reflect模式是通过反射的方式来生成mock interfaces。它只需要两个非标志性参数：import路径和需要mock的interface列表，列表使用逗号分割。

例如：

mockgen database/sql/driver Conn,Driver

基本参数介绍

mockgen命令可以把一个包含要Mock的interface的源文件生成一个mock类的源文件。mockgen支持的参数有以下几种：

  • -source: 需要mock的文件，这个文件中有需要mock的接口

  • -destination: 生成mock代码的文件名。如果你没有设置，生成的代码会被打印到标准输出

  • -package: 指定生成的mock文件的包名。如果你没有设置，则包名由mock_和输入文件的包名级拼接而成

  • -imports: 生成代码中需要import的包名，形式如foo=bar/baz，并且用逗号分隔。bar/baz是要import的包，foo这个生成的源文件中包的标识。

  • -aux_files: 参看附加的文件列表是为了解析类似嵌套的定义在不同文件中的interface。指定元素列表以逗号分隔，元素形式为* foo=bar/baz.go，其中bar/baz.go是源文件，foo是-source选项指定的源文件用到的包名

  • -build_flags: 这个参数只在reflect模式下使用，用于go build的时候使用

  • -imports: 依赖的需要import的包

  • -mock_names：自定义生成mock文件的列表，使用逗号分割。如Repository=MockSensorRepository,Endpoint=MockSensorEndpoint。 Repository、Endpoint为接口，MockSensorRepository，MockSensorEndpoint为相应的mock文件。

在简单的场景下，你将只需使用-source选项。在复杂的情况下，比如一个文件定义了多个interface而你只想对部分interface进行mock，或者interface存在嵌套，这时你需要用反射模式。由于 -destination 选项输入太长，笔者一般不使用该标识符，而使用重定向符号 >，并且mock类代码的输出文件的路径必须是绝对路径。

想了解更多的指令符，可参见官方文档

mockgen工作模式适用场景

mockgen工作模式适用场景如下：

  1. 对于简单场景，只需使用-source选项。

  2. 对于复杂场景，如一个源文件定义了多个interface而只想对部分interface进行mock，或者interface存在嵌套，则需要使用反射模式。

测试示例

目录结构

D:\CODE_DEV\SRC\GOMOCKDEMO
│  student.go
│  student_test.go
│
└─mock
        mock_people.go

定义一个接口

我们先定义一个打算mock的接口Repository:

package gomockdemotype Ipeople interface {    GetName() string
    SetName(string) string}func GetPeopleName(mi Ipeople) string {
    mi.GetName()    return mi.GetName()
}func SetPeopleName(mi Ipeople, name string) string {     return  mi.SetName(name)
}

生成mock类文件

$ mockgen gomockdemo Ipeople > mock/mock_people.go

这里需要注意几点：

  1. mock_people.go文件的mock文件夹，必须先创建好，否则会失败

  2. go_mock一定在$GOPATH/src/的目录下 生成后的文件如下：

// Code generated by MockGen. DO NOT EDIT.// Source: gomockdemo (interfaces: Ipeople)// Package mock_gomockdemo is a generated GoMock package.package mock_gomockdemoimport (
	gomock "github.com/golang/mock/gomock"
	reflect "reflect")// MockIpeople is a mock of Ipeople interfacetype MockIpeople struct {
	ctrl     *gomock.Controller
	recorder *MockIpeopleMockRecorder
}// MockIpeopleMockRecorder is the mock recorder for MockIpeopletype MockIpeopleMockRecorder struct {
	mock *MockIpeople
}// NewMockIpeople creates a new mock instancefunc NewMockIpeople(ctrl *gomock.Controller) *MockIpeople {	mock := &MockIpeople{ctrl: ctrl}
	mock.recorder = &MockIpeopleMockRecorder{mock}	return mock
}// EXPECT returns an object that allows the caller to indicate expected usefunc (m *MockIpeople) EXPECT() *MockIpeopleMockRecorder {	return m.recorder}// GetName mocks base methodfunc (m *MockIpeople) GetName() string {
	m.ctrl.T.Helper()	ret := m.ctrl.Call(m, "GetName")	ret0, _ := ret[0].(string)	return ret0
}// GetName indicates an expected call of GetNamefunc (mr *MockIpeopleMockRecorder) GetName() *gomock.Call {
	mr.mock.ctrl.T.Helper()	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetName", reflect.TypeOf((*MockIpeople)(nil).GetName))
}// SetName mocks base methodfunc (m *MockIpeople) SetName(arg0 string) string {
	m.ctrl.T.Helper()	ret := m.ctrl.Call(m, "SetName", arg0)	ret0, _ := ret[0].(string)	return ret0
}// SetName indicates an expected call of SetNamefunc (mr *MockIpeopleMockRecorder) SetName(arg0 interface{}) *gomock.Call {
	mr.mock.ctrl.T.Helper()	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SetName", reflect.TypeOf((*MockIpeople)(nil).SetName), arg0)
}

测试用例

编写测试用例有一些基本原则，我们一起回顾一下：

  1. 每个测试用例只关注一个问题，不要写大而全的测试用例

  2. 测试用例是黑盒的

  3. 测试用例之间彼此独立，每个用例要保证自己的前置和后置完备

  4. 测试用例要对产品代码非入侵

package gomockdemoimport (	"fmt"
	"testing"
	"github.com/golang/mock/gomock"
	"gomockdemo/mock")func TestGetPeopleName(t *testing.T) {	mockCtl := gomock.NewController(t)    defer mockCtl.Finish()    // 构造mock类， mock_gomockdemo就是生成的mock代码，以包的形式存在
    mockpeople := mock_gomockdemo.NewMockIpeople(mockCtl)   
    //注入期望的返回值
    mockpeople.EXPECT().GetName().Return("helight")
    mockpeople.EXPECT().GetName().Return("helight")	
    mockedName := GetPeopleName(mockpeople)    if "helight" != mockedName {
        t.Error("Get wrong name1: ", mockedName)
    }    //指定输入参数，返回指定结果
	mockpeople.EXPECT().SetName(gomock.Eq("he")).Return("ok")    //输出参不做指定，但是指定返回结果
    mockpeople.EXPECT().SetName(gomock.Any()).Do(func(format string) {    
        fmt.Println("recv param2 :", format)
    }).Return("ok1")    mockedSetName := SetPeopleName(mockpeople,"he")
    fmt.Println("mockedSetName: ", mockedSetName)    if "ok" != mockedSetName{
        t.Error("Set wrong name2: ", mockedSetName)
    }

    mockedSetName = SetPeopleName(mockpeople,"al222")
    fmt.Println("mockedSetName: ", mockedSetName)    if "ok1" != mockedSetName{
        t.Error("Set wrong name2: ", mockedSetName)
    }    
}

  • gomock.NewController：返回gomock.Controller，它代表 mock 生态系统中的顶级控件。定义了 mock 对象的范围、生命周期和* 期待值。另外它在多个 goroutine 中是安全的

  • mockpeople := mock_gomockdemo.NewMockIpeople(mockCtl) // 构造mock实例， mock_gomockdemo就是生成的mock代码，以包的形式存在

  • defer mockCtl.Finish() 关闭mock测试

  • mockpeople.EXPECT().GetName().Return("helight") ：EXPECT()是期望拿到返回值，调用的方法是GetName，设定的返回值是“helight”，调用函数也可以指定参数，比如下面的mockpeople.EXPECT().SetName(gomock.Eq("he")).Return("ok")

  • mockedSetName := SetPeopleName(mockpeople,"he")，这里SetPeopleName函数是调用people类的函数，这时候我们传递mockpeople给SetPeopleName就可以测试了，SetPeopleName内部调用的mockpeople和调用真实的people的方式是一模一样的。

测试结果

$ go test -v
=== RUN   TestGetPeopleName
gomock.Any:  is anything
gomock.Eq:  is equal to he
gomock.Any:  is anything
mockedSetName:  ok
recv param2 : al222
mockedSetName:  ok1
--- PASS: TestGetPeopleName (0.00s)
PASS
ok      gomockdemo      0.485s

到此，我们的mock测试就算是ok了，可以再增加一些测试用例和测试值。

测试覆盖率

这里在介绍一下另外一个简单的测试功能，测试覆盖率的测试cover，只要在go test后面加上-cover就可以了，如下面的例子，这里还加了一个参数-coverprofile=cover.out，这个参数是把覆盖率测试数据导出到cover.out这个文件，然后我们可以使用图形化的方式来看具体的测试覆盖情况。

$ go test -v  -cover -coverprofile=cover.out
=== RUN   TestGetPeopleName
gomock.Any:  is anything
gomock.Eq:  is equal to he
gomock.Any:  is anything
mockedSetName:  ok
recv param2 : al222
mockedSetName:  ok1
--- PASS: TestGetPeopleName (0.00s)
PASS
coverage: 100.0% of statements
ok      gomockdemo      0.403s

运行下面这个工具就可以直接把覆盖率以网页的形式打开来看了。

go tool cover -html=cover.out

gomock的其它用法

常用 mock 方法

调用方法

  • Call.Do()：声明在匹配时要运行的操作

  • Call.DoAndReturn()：声明在匹配调用时要运行的操作，并且模拟返回该函* 数的返回值

  • Call.MaxTimes()：设置最大的调用次数为 n 次

  • Call.MinTimes()：设置最小的调用次数为 n 次

  • Call.AnyTimes()：允许调用次数为 0 次或更多次

  • Call.Times()：设置调用次数为 n 次 这里我展开分析了一下，其实gomock的实现上是这样的，以这个为例：

 mockpeople.EXPECT().GetName().Return("helight")

mockpeople的EXPECT方法如下：都在生成的mock文件中。

// EXPECT returns an object that allows the caller to indicate expected usefunc (m *MockIpeople) EXPECT() *MockIpeopleMockRecorder {	return m.recorder}

m.recorder是这个

// NewMockIpeople creates a new mock instancefunc NewMockIpeople(ctrl *gomock.Controller) *MockIpeople {	mock := &MockIpeople{ctrl: ctrl}
	mock.recorder = &MockIpeopleMockRecorder{mock}	return mock
}

所以这里调用的就是MockIpeopleMockRecorder的GetName方法。这个函数如下：

func (mr *MockIpeopleMockRecorder) GetName() *gomock.Call {
	mr.mock.ctrl.T.Helper()	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetName", reflect.TypeOf((*MockIpeople)(nil).GetName))
}

RecordCallWithMethodType是mock.ctrl的方法，这个方法是在gomock库里面的controller.go文件中，在看一下这个函数的实现：

// RecordCallWithMethodType is called by a mock. It should not be called by user code.func (ctrl *Controller) RecordCallWithMethodType(receiver interface{}, method string, methodType reflect.Type, args ...interface{}) *Call {
	ctrl.T.Helper()	call := newCall(ctrl.T, receiver, method, methodType, args...)

	ctrl.mu.Lock()	defer ctrl.mu.Unlock()
	ctrl.expectedCalls.Add(call)	return call
}

这里看到，其实就是在ctrl.expectedCalls中把新生成函数按照函数名，参数等生成一个call，在call.go中就有Return、Do、Times等函数。这里看一些简单的例子，有兴趣的同学可以继续深入看看call.go这个文件。

// AnyTimes allows the expectation to be called 0 or more timesfunc (c *Call) AnyTimes() *Call {
	c.minCalls, c.maxCalls = 0, 1e8 // close enough to infinity
	return c
}// MinTimes requires the call to occur at least n times. If AnyTimes or MaxTimes have not been called, MinTimes also// sets the maximum number of calls to infinity.func (c *Call) MinTimes(n int) *Call {
	c.minCalls = n	if c.maxCalls == 1 {
		c.maxCalls = 1e8
	}	return c
}// MaxTimes limits the number of calls to n times. If AnyTimes or MinTimes have not been called, MaxTimes also// sets the minimum number of calls to 0.func (c *Call) MaxTimes(n int) *Call {
	c.maxCalls = n	if c.minCalls == 1 {
		c.minCalls = 0
	}	return c
}

参数匹配

  • gomock.Any()：匹配任意参数值

  • gomock.Eq()：指定参数

  • gomock.Nil()：返回nil

行为调用的保序

  • gomock.InOrder：声明指定了调用顺序 默认情况下，行为调用顺序可以和mock对象行为注入顺序不一致，即不保序。如果要保序，有两种方法：

  1. 通过After关键字来实现保序

  2. 通过InOrder关键字来实现保序

	// call := mockpeople.EXPECT().GetName().Return("helight1")
    // mockpeople.EXPECT().GetName().Return("helight").After(call)   
    // gomock.InOrder(
        mockpeople.EXPECT().GetName().Return("helight")
        mockpeople.EXPECT().GetName().Return("helight")    // )

建议更多的方法可参见 官方文档

参见官方文档

总结

gomock是单元测试的升级，帮助我们可以把之前无法做单元测试又非常重要的模块能够进行单元测试。gomock整体功能还是非常强大的，更多的功能可以在实际使用中不断熟悉，另外也可以多看看官方文档和gomock的源码。

参考

  1. https://github.com/golang/mock

相关阅读：

看完本文有收获？请分享给更多人

关注「黑光技术」加星标，关注大数据+微服务

看完，赶紧点个“好看”呀

点这里

↓↓↓↓

七度黑光
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Golang单元测试快速上手 示例代码
10-11
在Golang中，单元测试是开发过程中的重要组成部分，它能帮助我们确保代码的质量和功能的正确性。本文将基于给定的标题“Golang单元测试快速上手 示例代码”和描述，深入讲解如何在Go语言中进行单元测试，并通过实际...
go mock使用介绍
daliucheng的博客
05-29 3556
go mock使用介绍 单元测试需要mock一些东西（比如，RPC的远程调用），这里介绍goMock的使用方式。 安装 需要安装两个东西 gomock的包 用来做mock代码库的。 仓库：github.com/golang/mock/gomock go get github.com/golang/mock/gomock gogen工具 仓库：github.com/golang/mock/mockgen 一个工具，用来帮助生成mock代码的。理论上来说，不用这个工具是可以的，自己用手写。 go版
Go 单元测试--Mock接口实现和对接口打桩
kevin_tech的博客，微信搜「网管叨bi叨」
04-21 4763
这是Go语言单元测试系列教程的第4篇，介绍了如何在单元测试中使用gomock和gostub工具mock接口和打桩。在上一篇《Go单元测试 — 数据库 CRUD 的 Mock 测试》中，我们介绍了如何使用go-sqlmock和miniredis工具进行数据库测试。除了网络和数据库等外部依赖之外，我们在开发中也会经常用到各种各样的接口类型。本文就举例来演示如何在编写单元测试的...
每天学习一个框架之： goMock
最新发布
斯是陋室，惟汝德馨
05-19 597
用 mock 对象模拟依赖项的行为，以屏蔽待测试方法对外部的依赖，会使得这个过程很简单
golang 打桩，mock 数据怎么玩？
m0_37322399的博客
03-22 655
工作中，很多公司都要求效能，要求自动化测试那么单测或者自动化的过程中，就可能会由于其他服务的原因或者环境因素导致测试失败，或者阻塞测试。
使用 Gomock 进行单元测试
weixin_34268310的博客
11-25 290
使用 Gomock 进行单元测试 原文地址：使用 Gomock 进行单元测试 前言 在实际项目中，需要进行单元测试的时候。却往往发现有一大堆依赖项。这时候就是 Gomock 大显身手的时候了 Gomock 是 Go 语言的一个 mock 框架，官方的那种
Go-Golang单元测试快速入门
08-14
对于Go（Golang）这种注重简洁、高效的语言来说，单元测试同样不可或缺。本教程将带你快速入门Go语言的单元测试，了解如何利用内置的`testing`包编写和运行测试用例。 Go语言的单元测试基于其标准库中的`testing`包...
redismock:Go在Go的单元测试中模拟Redis
05-17
软件包github.com/elliotchance/redismock对于与Redis交互的单元测试应用程序很有用。 它使用了。 与使用真实或伪造的Redis（在下文中有更多介绍）不同， redismock提供了正常且美观的redismock ，以提高控制行为...
httpmock:Golang的HTTP模拟
04-05
httpmock是一个实现的模拟库，以支持HTTP行为测试。 先决条件 Go >= 1.14 安装 go get github.com/nhatthm/httpmock 例子 func Test_Simple ( t * testing. T ) { mockServer := httpmock . New ( func ( s * ...
go-dynamock：用于Golang的Amazon Dynamo DB Mock驱动程序，用于测试数据库交互
02-03
炸药用于Golang的Amazon Dynamo DB Mock驱动程序以测试数据库交互安装go get github.com/gusaul/go-dynamock用法示例访问获取常规示例和公共api参考。DynamoDB配置首先，将dynamodb配置更改为使用dynamodb接口。 ...
Go语言工具包之gomock
YIYIYI
05-10 1742
Go语言工具包之gomock
Golang秒懂----Mock接口测试(gomock和mockgen)
unique_gjt的博客
10-11 2812
秒懂gomock
Golang单元测试、Mock测试以及基准测试
小菜鸡的博客
06-29 1734
Golang拥有一套单元测试和性能测试系统，仅需要添加很少的代码就可以快速测试一段需求代码。单元测试主要包括：输入、测试单元、输出、期望以及与期望的校对。测试单元包括函数或者结合了一些函数的模块等。我们通过将输出与期望值进行校对，来验证代码的正确性。通过单元测试，可以一方面保证质量，例如在覆盖率足够的情况下，如果在旧代码中添加了新的代码，通过单元测试可以验证新的代码是否破坏了功能正确性。另一方面，也提升了效率，例如代码中出现了bug，通过编写单元测试，我们能够在较短的时间内定位或修复问题。规则1：所有测试文
GoLang 单元测试打桩和 mock
程序猿的世界
09-06 4822
单元测试，顾名思义对某个单元函数进行测试，被测函数本身中用到的变量、函数、资源不应被测试代码依赖，所谓 mock，就是想办法通过 “虚拟” 代码替换掉依赖的方法和资源，一般需要 mock 掉以下依赖：变量函数/方法MySQLRedishttp 调用。
GoMock测试框架
m0_56869626的博客
08-01 343
GoMock测试框架
golang单元测试及mock总结
热门推荐
铁柱的博客
07-15 2万+
golang的单元测试实践总结，包括mock各种函数，http调用呢
go-单元测试和 mock测试
weixin_45149147的博客
02-02 527
测试的框架之一Mockgen go get github.com/golang/mock/gomock go install github.com/golang/mock/mockgen
通过Mock玩转Golang单元测试！
myh919的博客
12-08 1078
httptest可以帮助我们完成对Web服务器的Mock，sqlmock可以完成对数据库的Mock，这两个工具基本可以帮助我们完成绝大部分外部系统的Mock工作。但是，实际中的代码逻辑、层次等等都是多变的，我们很多情况下不能够很好的将httptest或是sqlmock的入口注入到代码中，这时候我们就需要用gomonkey动态的Mock一些函数、方法或是变量来帮助我们开启httptest或sqlmock的入口。而testify则是帮助我们在繁琐的判断和错误处理中脱离出来的一大利器。
golang 利用mock写单元测试
03-28
在 Golang 中，我们可以使用 Mock 对象来编写单元测试，Mock 对象可以模拟应用程序的行为，以便进行测试。 以下是使用 Golang 编写 Mock 单元测试的步骤： 1. 安装 Mock 库 在 Golang 中，我们可以使用各种 Mock ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值