用gomock進行mock測試的方法示例

更新時間：2018年11月26日 09:55:15 作者：terasum

go-mock是專門為go語言開發(fā)的mock庫，該庫使用方式簡單，支持自動生成代碼，這篇文章主要介紹了用gomock進行mock測試的方法示例，感興趣的小伙伴們可以參考一下

在開發(fā)過程中往往需要配合單元測試，但是很多時候，單元測試需要依賴一些比較復雜的準備工作，比如需要依賴數(shù)據(jù)庫環(huán)境，需要依賴網(wǎng)絡環(huán)境，單元測試就變成了一件非常麻煩的事情。舉例來說，比如我們需要請求一個網(wǎng)頁，并將請求回來的數(shù)據(jù)進行處理。在剛開始的時候，我通常都會先啟動一個簡單的http服務，然后再運行我的單元測試。可是這個單元測試測起來似乎非常笨重。甚至在持續(xù)集成過程中，我還為了能夠自動化測試，特意寫了一個腳本自動啟動相應的服務。事情似乎需要進行一些改變。

mock對象就是為了解決上面的問題而誕生的，mock(模擬)對象能夠模擬實際依賴對象的功能，同時又不需要非常復雜的準備工作，你需要做的，僅僅就是定義對象接口，然后實現(xiàn)它，再交給測試對象去使用。

go-mock是專門為go語言開發(fā)的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)
}

然后我們需要一個實現(xiàn)了Talker功能的結構體，假設我們有這樣的場景，我們現(xiàn)在有一個迎賓的崗位，需要一個能夠迎賓的迎賓員，當然這個迎賓員可以是一個人，或者是一只鸚鵡。那么我們需要做的是，定義一個Persion結構體（或者是鸚鵡或者是別的什么東西），并實現(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)實現(xiàn)了Talker接口，現(xiàn)在我們讓他發(fā)揮作用吧！

現(xiàn)在假設，我們有一個公司，公司有一個迎賓員，也就是我們的前臺妹子，這個妹子實現(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)設計好了，那么我們傳統(tǒng)的話，會如何實現(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)在我們構造一個王尼美還是很簡單的，但是我們現(xiàn)在要用mock對象進行模擬,這時mockgen就登場了：

➜ hellomock> mkdir mock
➜ hellomock> mockgen -source=hellomock.go > mock/mock_Talker.go

這個時候，將會生成mock/mock_Talker.go文件：

需要注意的是，自動生成的文件同源文件在不同的包下，需要新建一個目錄存放

我們并不需要在意生成文件的內(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)
}

接下來看看如何去使用這個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可以接受的參數(shù)有gomock.Eq(x interface{})和gomock.Any()，前一個要求測試用例入餐嚴格符合x，第二個允許傳入任意參數(shù)。比如我們在注釋掉的測試中傳入了"張全蛋"，結果報錯，測試失?。?/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)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: