用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/moc...

https://github.com/grpc/grpc-...

轉載請註明出處 http://www.chenquan.me