使用Gomock進(jìn)行單元測(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是專(zhuān)門(mén)為go語(yǔ)言開(kāi)發(fā)的mock庫(kù)，該庫(kù)使用方式簡(jiǎn)單，支持自動(dòng)生成代碼，可以說(shuō)是不可多得的好工具。

前言

在實(shí)際項(xiàng)目中，需要進(jìn)行單元測(cè)試的時(shí)候。卻往往發(fā)現(xiàn)有一大堆依賴項(xiàng)。這時(shí)候就是 Gomock 大顯身手的時(shí)候了

Gomock 是 Go 語(yǔ)言的一個(gè) mock 框架，官方的那種 🤪

安裝

$ go get -u github.com/golang/mock/gomock
$ go install github.com/golang/mock/mockgen

1、 第一步：我們將安裝 gomock 第三方庫(kù)和 mock 代碼的生成工具 mockgen。而后者可以大大的節(jié)省我們的工作量。只需要了解其使用方式就可以

2、 第二步：輸入 mockgen 驗(yàn)證代碼生成工具是否安裝正確。若無(wú)法正常響應(yīng)，請(qǐng)檢查 bin 目錄下是否包含該二進(jìn)制文件

用法

在 mockgen 命令中，支持兩種生成模式：

1、 source：從源文件生成 mock 接口（通過(guò) -source 啟用）

mockgen -source=foo.go [other options]

2、 reflect：通過(guò)使用反射程序來(lái)生成 mock 接口。它通過(guò)傳遞兩個(gè)非標(biāo)志參數(shù)來(lái)啟用：導(dǎo)入路徑和逗號(hào)分隔的接口列表

mockgen database/sql/driver Conn,Driver

從本質(zhì)上來(lái)講，兩種方式生成的 mock 代碼并沒(méi)有什么區(qū)別。因此選擇合適的就可以了

寫(xiě)測(cè)試用例

在本文將模擬一個(gè)簡(jiǎn)單 Demo 來(lái)編寫(xiě)測(cè)試用例，熟悉整體的測(cè)試流程

步驟

1. 想清楚整體邏輯
2. 定義想要（模擬）依賴項(xiàng)的 interface（接口）
3. 使用 mockgen 命令對(duì)所需 mock 的 interface 生成 mock 文件
4. 編寫(xiě)單元測(cè)試的邏輯，在測(cè)試中使用 mock
5. 進(jìn)行單元測(cè)試的驗(yàn)證

目錄

├── mock
├── person
│  └── male.go
└── user
  ├── user.go
  └── user_test.go

編寫(xiě)

interface 方法

打開(kāi) person/male.go 文件，寫(xiě)入以下內(nèi)容：

package person

type Male interface {
  Get(id int64) error
}

調(diào)用方法

打開(kāi) user/user.go 文件，寫(xiě)入以下內(nèi)容：

package user

import "github.com/EDDYCJY/mockd/person"

type User struct {
  Person person.Male
}

func NewUser(p person.Male) *User {
  return User{Person: p}
}

func (u *User) GetUserInfo(id int64) error {
  return u.Person.Get(id)
}

生成 mock 文件

回到 mockd/ 的根目錄下，執(zhí)行以下命令

在執(zhí)行完畢后，可以發(fā)現(xiàn) mock/ 目錄下多出了 male_mock.go 文件，這就是 mock 文件。那么命令中的指令又分別有什么用呢？如下：

• -source：設(shè)置需要模擬（mock）的接口文件
• -destination：設(shè)置 mock 文件輸出的地方，若不設(shè)置則打印到標(biāo)準(zhǔn)輸出中
• -package：設(shè)置 mock 文件的包名，若不設(shè)置則為 mock_ 前綴加上文件名（如本文的包名會(huì)為 mock_person）

想了解更多的指令符，可參見(jiàn) 官方文檔

輸出的 mock 文件

// Code generated by MockGen. DO NOT EDIT.
// Source: ./person/male.go

// Package mock is a generated GoMock package.
package mock

import (
  gomock "github.com/golang/mock/gomock"
  reflect "reflect"
)

// MockMale is a mock of Male interface
type MockMale struct {
  ctrl   *gomock.Controller
  recorder *MockMaleMockRecorder
}

// MockMaleMockRecorder is the mock recorder for MockMale
type MockMaleMockRecorder struct {
  mock *MockMale
}

// NewMockMale creates a new mock instance
func NewMockMale(ctrl *gomock.Controller) *MockMale {
  mock := MockMale{ctrl: ctrl}
  mock.recorder = MockMaleMockRecorder{mock}
  return mock
}

// EXPECT returns an object that allows the caller to indicate expected use
func (m *MockMale) EXPECT() *MockMaleMockRecorder {
  return m.recorder
}

// Get mocks base method
func (m *MockMale) Get(id int64) error {
  ret := m.ctrl.Call(m, "Get", id)
  ret0, _ := ret[0].(error)
  return ret0
}

// Get indicates an expected call of Get
func (mr *MockMaleMockRecorder) Get(id interface{}) *gomock.Call {
  return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Get", reflect.TypeOf((*MockMale)(nil).Get), id)
}

測(cè)試用例

打開(kāi) user/user_test.go 文件，寫(xiě)入以下內(nèi)容：

package user

import (
  "testing"

  "github.com/EDDYCJY/mockd/mock"

  "github.com/golang/mock/gomock"
)

func TestUser_GetUserInfo(t *testing.T) {
  ctl := gomock.NewController(t)
  defer ctl.Finish()

  var id int64 = 1
  mockMale := mock.NewMockMale(ctl)
  gomock.InOrder(
    mockMale.EXPECT().Get(id).Return(nil),
  )

  user := NewUser(mockMale)
  err := user.GetUserInfo(id)
  if err != nil {
    t.Errorf("user.GetUserInfo err: %v", err)
  }
}

1. gomock.NewController：返回 gomock.Controller，它代表 mock 生態(tài)系統(tǒng)中的頂級(jí)控件。定義了 mock 對(duì)象的范圍、生命周期和期待值。另外它在多個(gè) goroutine 中是安全的
2. mock.NewMockMale：創(chuàng)建一個(gè)新的 mock 實(shí)例
3. gomock.InOrder：聲明給定的調(diào)用應(yīng)按順序進(jìn)行（是對(duì) gomock.After 的二次封裝）
4. mockMale.EXPECT().Get(id).Return(nil)：這里有三個(gè)步驟，EXPECT()返回一個(gè)允許調(diào)用者設(shè)置期望和返回值的對(duì)象。Get(id) 是設(shè)置入?yún)⒉⒄{(diào)用 mock 實(shí)例中的方法。Return(nil) 是設(shè)置先前調(diào)用的方法出參。簡(jiǎn)單來(lái)說(shuō)，就是設(shè)置入?yún)⒉⒄{(diào)用，最后設(shè)置返回值
5. NewUser(mockMale)：創(chuàng)建 User 實(shí)例，值得注意的是，在這里注入了 mock 對(duì)象，因此實(shí)際在隨后的 user.GetUserInfo(id) 調(diào)用（入?yún)ⅲ篿d 為 1）中。它調(diào)用的是我們事先模擬好的 mock 方法
6. ctl.Finish()：進(jìn)行 mock 用例的期望值斷言，一般會(huì)使用 defer 延遲執(zhí)行，以防止我們忘記這一操作

測(cè)試

回到 mockd/ 的根目錄下，執(zhí)行以下命令

$ go test ./user 
ok   github.com/EDDYCJY/mockd/user

看到這樣的結(jié)果，就大功告成啦！你可以自己調(diào)整一下 Return() 的返回值，以此得到不一樣的測(cè)試結(jié)果哦 😄

查看測(cè)試情況

測(cè)試覆蓋率

$ go test -cover ./user
ok   github.com/EDDYCJY/mockd/user  (cached)  coverage: 100.0% of statements

可通過(guò)設(shè)置 -cover 標(biāo)志符來(lái)開(kāi)啟覆蓋率的統(tǒng)計(jì)，展示內(nèi)容為 coverage: 100.0%。

可視化界面

1、 生成測(cè)試覆蓋率的 profile 文件

$ go test ./... -coverprofile=cover.out

2、 利用 profile 文件生成可視化界面

$ go tool cover -html=cover.out

3、 查看可視化界面，分析覆蓋情況

更多

一、常用 mock 方法

調(diào)用方法

• Call.Do()：聲明在匹配時(shí)要運(yùn)行的操作
• Call.DoAndReturn()：聲明在匹配調(diào)用時(shí)要運(yùn)行的操作，并且模擬返回該函數(shù)的返回值
• Call.MaxTimes()：設(shè)置最大的調(diào)用次數(shù)為 n 次
• Call.MinTimes()：設(shè)置最小的調(diào)用次數(shù)為 n 次
• Call.AnyTimes()：允許調(diào)用次數(shù)為 0 次或更多次
• Call.Times()：設(shè)置調(diào)用次數(shù)為 n 次

參數(shù)匹配

• gomock.Any()：匹配任意值
• gomock.Eq()：通過(guò)反射匹配到指定的類(lèi)型值，而不需要手動(dòng)設(shè)置
• gomock.Nil()：返回 nil

建議更多的方法可參見(jiàn) 官方文檔

二、生成多個(gè) mock 文件

你可能會(huì)想一條條命令生成 mock 文件，豈不得崩潰？

當(dāng)然，官方提供了更方便的方式，我們可以利用 go:generate 來(lái)完成批量處理的功能

go generate [-run regexp] [-n] [-v] [-x] [build flags] [file.go... | packages]

修改 interface 方法

打開(kāi) person/male.go 文件，修改為以下內(nèi)容：

package person

//go:generate mockgen -destination=../mock/male_mock.go -package=mock github.com/EDDYCJY/mockd/person Male

type Male interface {
  Get(id int64) error
}

我們關(guān)注到 go:generate 這條語(yǔ)句，可分為以下部分：

1. 聲明 //go:generate （注意不要留空格）
2. 使用 mockgen 命令
3. 定義 -destination
4. 定義 -package
5. 定義 source，此處為 person 的包路徑
6. 定義 interfaces，此處為 Male

重新生成 mock 文件

回到 mockd/ 的根目錄下，執(zhí)行以下命令

$ go generate ./...

再檢查 mock/ 發(fā)現(xiàn)也已經(jīng)正確生成了，在多個(gè)文件時(shí)是不是很方便呢 🤩

總結(jié)

在單元測(cè)試這一環(huán)，gomock 給我們提供了極大的便利。能夠 mock 掉許許多多的依賴項(xiàng)

其中還有很多的使用方式和功能。你可以 mark 住后詳細(xì)閱讀下官方文檔，記憶會(huì)更深刻

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。