用gomock进行mock测试的方法示例
在开发过程中往往需要配合单元测试,但是很多时候,单元测试需要依赖一些比较复杂的准备工作,比如需要依赖数据库环境,需要依赖网络环境,单元测试就变成了一件非常麻烦的事情。举例来说,比如我们需要请求一个网页,并将请求回来的数据进行处理。在刚开始的时候,我通常都会先启动一个简单的http服务,然后再运行我的单元测试。可是这个单元测试测起来似乎非常笨重。甚至在持续集成过程中,我还为了能够自动化测试,特意写了一个脚本自动启动相应的服务。事情似乎需要进行一些改变。
mock对象就是为了解决上面的问题而诞生的,mock(模拟)对象能够模拟实际依赖对象的功能,同时又不需要非常复杂的准备工作,你需要做的,仅仅就是定义对象接口,然后实现它,再交给测试对象去使用。
go-mock是专门为go语言开发的mock库,该库使用方式简单,支持自动生成代码,可以说是不可多得的好工具。下面我就简单地展示一下go-mock是如何工作的:
首先你需要做的是将依赖下载到本地:
go get github.com/golang/mock/gomock go get github.com/golang/mock/mockgen
第一个是代码依赖,第二个是命令行工具(特别好用)。
下面用一个非常简单的例子来说明gomock是如何工作的:
我在$gopath/src
目录下新建一个项目:hellomock
,在$gopath/src/hellomock
目录下新建hellomock.go
,并定义一个接口talker
:
package hellomock type talker interface { sayhello(word string)(response string) }
然后我们需要一个实现了talker功能的结构体,假设我们有这样的场景,我们现在有一个迎宾的岗位,需要一个能够迎宾的迎宾员,当然这个迎宾员可以是一个人,或者是一只鹦鹉。那么我们需要做的是,定义一个persion结构体(或者是鹦鹉或者是别的什么东西),并实现talker接口:
person.go
package hellomock import "fmt" type person struct{ name string } func newperson(name string)*person{ return &person{ name:name, } } func (p *person)sayhello(name string)(word string) { return fmt.sprintf("hello %s, welcome come to our company, my name is %s",name,p.name) }
现在我们的person
已经实现了talker
接口,现在我们让他发挥作用吧!
现在假设,我们有一个公司,公司有一个迎宾员,也就是我们的前台妹子,这个妹子实现了talker
接口.她能够自动向来的客人sayhello
:
company.go
package hellomock type company struct { usher talker } func newcompany(t talker) *company{ return &company{ usher:t, } } func ( c *company) meeting(gusetname string)string{ return c.usher.sayhello(gusetname) }
我们的场景已经设计好了,那么我们传统的话,会如何实现单元测试呢?
company_test.go
package hellomock import "testing" func testcompany_meeting(t *testing.t) { person := newperson("王尼美") company := newcompany(person) t.log(company.meeting("王尼玛")) }
测试之:
/usr/local/go/bin/go test -v hellomock -run ^testcompany_meeting$ company_test.go:8: hello 王尼玛, welcome come to our company, my name is 王尼美 ok hellomock 0.013s
现在我们构造一个王尼美还是很简单的,但是我们现在要用mock对象进行模拟,这时mockgen就登场了:
➜ hellomock> mkdir mock
➜ hellomock> mockgen -source=hellomock.go > mock/mock_talker.go
这个时候,将会生成mock/mock_talker.go
文件:
需要注意的是,自动生成的文件同源文件在不同的包下,需要新建一个目录存放
我们并不需要在意生成文件的内容,我们只需要知道如何去使用即可
mock_talker.go
// automatically generated by mockgen. do not edit! // source: hellomock.go package mock_hellomock import ( gomock "github.com/golang/mock/gomock" ) // mocktalker is a mock of talker interface type mocktalker struct { ctrl *gomock.controller recorder *mocktalkermockrecorder } // mocktalkermockrecorder is the mock recorder for mocktalker type mocktalkermockrecorder struct { mock *mocktalker } // newmocktalker creates a new mock instance func newmocktalker(ctrl *gomock.controller) *mocktalker { mock := &mocktalker{ctrl: ctrl} mock.recorder = &mocktalkermockrecorder{mock} return mock } // expect returns an object that allows the caller to indicate expected use func (_m *mocktalker) expect() *mocktalkermockrecorder { return _m.recorder } // sayhello mocks base method func (_m *mocktalker) sayhello(name string) string { ret := _m.ctrl.call(_m, "sayhello", name) ret0, _ := ret[0].(string) return ret0 } // sayhello indicates an expected call of sayhello func (_mr *mocktalkermockrecorder) sayhello(arg0 interface{}) *gomock.call { return _mr.mock.ctrl.recordcall(_mr.mock, "sayhello", arg0) }
接下来看看如何去使用这个mock对象,新建一个单元测试:
func testcompany_meeting2(t *testing.t) { ctl := gomock.newcontroller(t) mock_talker := mock_hellomock.newmocktalker(ctl) mock_talker.expect().sayhello(gomock.eq("王尼玛")).return("这是自定义的返回值,可以是任意类型。") company := newcompany(mock_talker) t.log(company.meeting("王尼玛")) //t.log(company.meeting("张全蛋")) }
测试之:
/usr/local/go/bin/go test -v hellomock -run ^testcompany_meeting2$ company_test.go:21: 这是自定义的返回值,可以是任意类型。 ok hellomock 0.015s
可以看到,返回的是我们在mock对象上定义的返回值。
需要说明的一点是,mock对象的sayhello可以接受的参数有gomock.eq(x interface{})和gomock.any(),前一个要求测试用例入餐严格符合x,第二个允许传入任意参数。比如我们在注释掉的测试中传入了"张全蛋",结果报错,测试失败:
/usr/local/go/bin/go test -v hellomock -run ^testcompany_meeting2$ controller.go:113: no matching expected call: *mock_hellomock.mocktalker.sayhello([张全蛋]) exit status 1 fail hellomock 0.007s
本文作为抛砖引玉,gomock还有很多高级用法,希望大家能够自行探索。
参考文章:
https://github.com/golang/mock/blob/master/readme.md
https://github.com/grpc/grpc-go/blob/master/documentation/gomock-example.md
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
上一篇: 熟冻虾怎么吃,给你介绍好吃的做法
下一篇: 南瓜酥条怎么做酥脆又好吃