用gomock進(jìn)行mock測(cè)試的方法示例
在開(kāi)發(fā)過(guò)程中往往需要配合單元測(cè)試,但是很多時(shí)候,單元測(cè)試需要依賴一些比較復(fù)雜的準(zhǔn)備工作,比如需要依賴數(shù)據(jù)庫(kù)環(huán)境,需要依賴網(wǎng)絡(luò)環(huán)境,單元測(cè)試就變成了一件非常麻煩的事情。舉例來(lái)說(shuō),比如我們需要請(qǐng)求一個(gè)網(wǎng)頁(yè),并將請(qǐng)求回來(lái)的數(shù)據(jù)進(jìn)行處理。在剛開(kāi)始的時(shí)候,我通常都會(huì)先啟動(dòng)一個(gè)簡(jiǎn)單的http服務(wù),然后再運(yùn)行我的單元測(cè)試??墒沁@個(gè)單元測(cè)試測(cè)起來(lái)似乎非常笨重。甚至在持續(xù)集成過(guò)程中,我還為了能夠自動(dòng)化測(cè)試,特意寫(xiě)了一個(gè)腳本自動(dòng)啟動(dòng)相應(yīng)的服務(wù)。事情似乎需要進(jìn)行一些改變。
mock對(duì)象就是為了解決上面的問(wèn)題而誕生的,mock(模擬)對(duì)象能夠模擬實(shí)際依賴對(duì)象的功能,同時(shí)又不需要非常復(fù)雜的準(zhǔn)備工作,你需要做的,僅僅就是定義對(duì)象接口,然后實(shí)現(xiàn)它,再交給測(cè)試對(duì)象去使用。
go-mock是專門(mén)為go語(yǔ)言開(kāi)發(fā)的mock庫(kù),該庫(kù)使用方式簡(jiǎn)單,支持自動(dòng)生成代碼,可以說(shuō)是不可多得的好工具。下面我就簡(jiǎn)單地展示一下go-mock是如何工作的:
首先你需要做的是將依賴下載到本地:
go get github.com/golang/mock/gomock go get github.com/golang/mock/mockgen
第一個(gè)是代碼依賴,第二個(gè)是命令行工具(特別好用)。
下面用一個(gè)非常簡(jiǎn)單的例子來(lái)說(shuō)明gomock是如何工作的:
我在$GOPATH/src目錄下新建一個(gè)項(xiàng)目:hellomock,在$GOPATH/src/hellomock目錄下新建hellomock.go,并定義一個(gè)接口Talker:
package hellomock
type Talker interface {
SayHello(word string)(response string)
}
然后我們需要一個(gè)實(shí)現(xiàn)了Talker功能的結(jié)構(gòu)體,假設(shè)我們有這樣的場(chǎng)景,我們現(xiàn)在有一個(gè)迎賓的崗位,需要一個(gè)能夠迎賓的迎賓員,當(dāng)然這個(gè)迎賓員可以是一個(gè)人,或者是一只鸚鵡。那么我們需要做的是,定義一個(gè)Persion結(jié)構(gòu)體(或者是鸚鵡或者是別的什么東西),并實(shí)現(xiàn)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)
}
現(xiàn)在我們的Person已經(jīng)實(shí)現(xiàn)了Talker接口,現(xiàn)在我們讓他發(fā)揮作用吧!
現(xiàn)在假設(shè),我們有一個(gè)公司,公司有一個(gè)迎賓員,也就是我們的前臺(tái)妹子,這個(gè)妹子實(shí)現(xiàn)了Talker接口.她能夠自動(dòng)向來(lái)的客人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)
}
我們的場(chǎng)景已經(jīng)設(shè)計(jì)好了,那么我們傳統(tǒng)的話,會(huì)如何實(shí)現(xiàn)單元測(cè)試呢?
company_test.go
package hellomock
import "testing"
func TestCompany_Meeting(t *testing.T) {
person := NewPerson("王尼美")
company := NewCompany(person)
t.Log(company.Meeting("王尼瑪"))
}
測(cè)試之:
/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
現(xiàn)在我們構(gòu)造一個(gè)王尼美還是很簡(jiǎn)單的,但是我們現(xiàn)在要用mock對(duì)象進(jìn)行模擬,這時(shí)mockgen就登場(chǎng)了:
➜ hellomock> mkdir mock
➜ hellomock> mockgen -source=hellomock.go > mock/mock_Talker.go
這個(gè)時(shí)候,將會(huì)生成mock/mock_Talker.go文件:
需要注意的是,自動(dòng)生成的文件同源文件在不同的包下,需要新建一個(gè)目錄存放
我們并不需要在意生成文件的內(nèi)容,我們只需要知道如何去使用即可
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)
}
接下來(lái)看看如何去使用這個(gè)mock對(duì)象,新建一個(gè)單元測(cè)試:
func TestCompany_Meeting2(t *testing.T) {
ctl := gomock.NewController(t)
mock_talker := mock_hellomock.NewMockTalker(ctl)
mock_talker.EXPECT().SayHello(gomock.Eq("王尼瑪")).Return("這是自定義的返回值,可以是任意類(lèi)型。")
company := NewCompany(mock_talker)
t.Log(company.Meeting("王尼瑪"))
//t.Log(company.Meeting("張全蛋"))
}
測(cè)試之:
/usr/local/go/bin/go test -v hellomock -run ^TestCompany_Meeting2$ company_test.go:21: 這是自定義的返回值,可以是任意類(lèi)型。 ok hellomock 0.015s
可以看到,返回的是我們?cè)趍ock對(duì)象上定義的返回值。
需要說(shuō)明的一點(diǎn)是,mock對(duì)象的SayHello可以接受的參數(shù)有g(shù)omock.Eq(x interface{})和gomock.Any(),前一個(gè)要求測(cè)試用例入餐嚴(yán)格符合x(chóng),第二個(gè)允許傳入任意參數(shù)。比如我們?cè)谧⑨尩舻臏y(cè)試中傳入了"張全蛋",結(jié)果報(bào)錯(cuò),測(cè)試失?。?/p>
/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還有很多高級(jí)用法,希望大家能夠自行探索。
參考文章:
https://github.com/golang/mock/blob/master/README.md
https://github.com/grpc/grpc-go/blob/master/Documentation/gomock-example.md
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
GO語(yǔ)言對(duì)數(shù)組切片去重的實(shí)現(xiàn)
本文主要介紹了GO語(yǔ)言對(duì)數(shù)組切片去重的實(shí)現(xiàn),主要介紹了幾種方法,文中通過(guò)示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-04-04
Go語(yǔ)言基礎(chǔ)go doc命令用法及示例詳解
這篇文章主要為大家介紹了Go語(yǔ)言基礎(chǔ)go doc命令的用法及示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助祝大家多多進(jìn)步2021-11-11
關(guān)于go語(yǔ)言載入json可能遇到的一個(gè)坑
Go 語(yǔ)言從新手到大神,每個(gè)人多少都會(huì)踩一些坑,那么下面這篇文章主要給大家介紹了關(guān)于go語(yǔ)言載入json可能遇到的一個(gè)坑,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面來(lái)一起看看吧。2017-07-07
Redis?BloomFilter布隆過(guò)濾器原理與實(shí)現(xiàn)
你在開(kāi)發(fā)或者面試過(guò)程中,有沒(méi)有遇到過(guò)?海量數(shù)據(jù)需要查重,緩存穿透怎么避免等等這樣的問(wèn)題呢?下面這個(gè)東西超棒,好好了解下,面試過(guò)關(guān)斬將,凸顯你的不一樣2022-10-10
Golang?Compare?And?Swap算法詳細(xì)介紹
CAS算法是一種有名的無(wú)鎖算法。無(wú)鎖編程,即不使用鎖的情況下實(shí)現(xiàn)多線程之間的變量同步,也就是在沒(méi)有線程被阻塞的情況下實(shí)現(xiàn)變量的同步,所以也叫非阻塞同步Non-blocking?Synchronization2022-10-10
golang利用unsafe操作未導(dǎo)出變量-Pointer使用詳解
這篇文章主要給大家介紹了關(guān)于golang利用unsafe操作未導(dǎo)出變量-Pointer使用的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),需要的朋友可以參考借鑒,下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2018-08-08
Go語(yǔ)言配置數(shù)據(jù)庫(kù)連接池的實(shí)現(xiàn)
本文內(nèi)容我們將解釋連接池背后是如何工作的,并探索如何配置數(shù)據(jù)庫(kù)能改變或優(yōu)化其性能。文中通過(guò)示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2021-12-12

