在開發(fā)過程中往往需要配合單元測試,但是很多時(shí)候,單元測試需要依賴一些比較復(fù)雜的準(zhǔn)備工作,比如需要依賴數(shù)據(jù)庫環(huán)境,需要依賴網(wǎng)絡(luò)環(huán)境,單元測試就變成了一件非常麻煩的事情。舉例來說,比如我們需要請求一個(gè)網(wǎng)頁,并將請求回來的數(shù)據(jù)進(jìn)行處理。在剛開始的時(shí)候,我通常都會先啟動一個(gè)簡單的http服務(wù),然后再運(yùn)行我的單元測試。可是這個(gè)單元測試測起來似乎非常笨重。甚至在持續(xù)集成過程中,我還為了能夠自動化測試,特意寫了一個(gè)腳本自動啟動相應(yīng)的服務(wù)。事情似乎需要進(jìn)行一些改變。
mock對象就是為了解決上面的問題而誕生的,mock(模擬)對象能夠模擬實(shí)際依賴對象的功能,同時(shí)又不需要非常復(fù)雜的準(zhǔn)備工作,你需要做的,僅僅就是定義對象接口,然后實(shí)現(xiàn)它,再交給測試對象去使用。
go-mock是專門為go語言開發(fā)的mock庫,該庫使用方式簡單,支持自動生成代碼,可以說是不可多得的好工具。下面我就簡單地展示一下go-mock是如何工作的:
首先你需要做的是將依賴下載到本地:
go get github.com/golang/mock/gomock
go get github.com/golang/mock/mockgen
第一個(gè)是代碼依賴,第二個(gè)是命令行工具(特別好用)。
下面用一個(gè)非常簡單的例子來說明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è)我們有這樣的場景,我們現(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è)迎賓員,也就是我們的前臺妹子,這個(gè)妹子實(shí)現(xiàn)了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)
}
我們的場景已經(jīng)設(shè)計(jì)好了,那么我們傳統(tǒng)的話,會如何實(shí)現(xiàn)單元測試呢?
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
現(xiàn)在我們構(gòu)造一個(gè)王尼美還是很簡單的,但是我們現(xiàn)在要用mock對象進(jìn)行模擬,這時(shí)mockgen就登場了:
➜ hellomock> mkdir mock
➜ hellomock> mockgen -source=hellomock.go > mock/mock_Talker.go
這個(gè)時(shí)候,將會生成mock/mock_Talker.go
文件:
需要注意的是,自動生成的文件同源文件在不同的包下,需要新建一個(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)
}
接下來看看如何去使用這個(gè)mock對象,新建一個(gè)單元測試:
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對象上定義的返回值。
需要說明的一點(diǎn)是,mock對象的SayHello可以接受的參數(shù)有g(shù)omock.Eq(x interface{})和gomock.Any(),前一個(gè)要求測試用例入餐嚴(yán)格符合x,第二個(gè)允許傳入任意參數(shù)。比如我們在注釋掉的測試中傳入了"張全蛋",結(jié)果報(bào)錯(cuò),測試失?。?/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還有很多高級用法,希望大家能夠自行探索。
參考文章:
https://github.com/golang/mock/blob/master/README.md
https://github.com/grpc/grpc-go/blob/master/Documentation/gomock-example.md
以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。