使用Gomock怎么進行單元測試-創(chuàng)新互聯(lián)

本篇文章為大家展示了使用Gomock怎么進行單元測試,內(nèi)容簡明扼要并且容易理解,絕對能使你眼前一亮,通過這篇文章的詳細介紹希望你能有所收獲。

創(chuàng)新互聯(lián)專注于龍門網(wǎng)站建設(shè)服務(wù)及定制,我們擁有豐富的企業(yè)做網(wǎng)站經(jīng)驗。 熱誠為您提供龍門營銷型網(wǎng)站建設(shè),龍門網(wǎng)站制作、龍門網(wǎng)頁設(shè)計、龍門網(wǎng)站官網(wǎng)定制、重慶小程序開發(fā)服務(wù),打造龍門網(wǎng)絡(luò)公司原創(chuàng)品牌,更為您提供龍門網(wǎng)站排名全網(wǎng)營銷落地服務(wù)。

安裝

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

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

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

用法

在 mockgen 命令中,支持兩種生成模式:

1、 source:從源文件生成 mock 接口(通過 -source 啟用)

mockgen -source=foo.go [other options]

2、 reflect:通過使用反射程序來生成 mock 接口。它通過傳遞兩個非標志參數(shù)來啟用:導入路徑和逗號分隔的接口列表

mockgen database/sql/driver Conn,Driver

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

寫測試用例

在本文將模擬一個簡單 Demo 來編寫測試用例,熟悉整體的測試流程

步驟

  1. 想清楚整體邏輯

  2. 定義想要(模擬)依賴項的 interface(接口)

  3. 使用 mockgen 命令對所需 mock 的 interface 生成 mock 文件

  4. 編寫單元測試的邏輯,在測試中使用 mock

  5. 進行單元測試的驗證

目錄

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

編寫

interface 方法

打開 person/male.go 文件,寫入以下內(nèi)容:

package person

type Male interface {
  Get(id int64) error
}

調(diào)用方法

打開 user/user.go 文件,寫入以下內(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í)行以下命令

復制代碼 代碼如下:

$ mockgen -source=./person/male.go -destination=./mock/male_mock.go -package=mock

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

  • -source:設(shè)置需要模擬(mock)的接口文件

  • -destination:設(shè)置 mock 文件輸出的地方,若不設(shè)置則打印到標準輸出中

  • -package:設(shè)置 mock 文件的包名,若不設(shè)置則為 mock_ 前綴加上文件名(如本文的包名會為 mock_person)

想了解更多的指令符,可參見 官方文檔

輸出的 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)
}

測試用例

打開 user/user_test.go 文件,寫入以下內(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)中的頂級控件。定義了 mock 對象的范圍、生命周期和期待值。另外它在多個 goroutine 中是安全的

  2. mock.NewMockMale:創(chuàng)建一個新的 mock 實例

  3. gomock.InOrder:聲明給定的調(diào)用應(yīng)按順序進行(是對 gomock.After 的二次封裝)

  4. mockMale.EXPECT().Get(id).Return(nil):這里有三個步驟,EXPECT()返回一個允許調(diào)用者設(shè)置期望和返回值的對象。Get(id) 是設(shè)置入?yún)⒉⒄{(diào)用 mock 實例中的方法。Return(nil) 是設(shè)置先前調(diào)用的方法出參。簡單來說,就是設(shè)置入?yún)⒉⒄{(diào)用,最后設(shè)置返回值

  5. NewUser(mockMale):創(chuàng)建 User 實例,值得注意的是,在這里注入了 mock 對象,因此實際在隨后的 user.GetUserInfo(id) 調(diào)用(入?yún)ⅲ篿d 為 1)中。它調(diào)用的是我們事先模擬好的 mock 方法

  6. ctl.Finish():進行 mock 用例的期望值斷言,一般會使用 defer 延遲執(zhí)行,以防止我們忘記這一操作

測試

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

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

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

查看測試情況

測試覆蓋率

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

可通過設(shè)置 -cover 標志符來開啟覆蓋率的統(tǒng)計,展示內(nèi)容為 coverage: 100.0%。

可視化界面

1、 生成測試覆蓋率的 profile 文件

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

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

$ go tool cover -html=cover.out

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

使用Gomock怎么進行單元測試

更多

一、常用 mock 方法

調(diào)用方法

  • Call.Do():聲明在匹配時要運行的操作

  • Call.DoAndReturn():聲明在匹配調(diào)用時要運行的操作,并且模擬返回該函數(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():通過反射匹配到指定的類型值,而不需要手動設(shè)置

  • gomock.Nil():返回 nil

建議更多的方法可參見 官方文檔

二、生成多個 mock 文件

你可能會想一條條命令生成 mock 文件,豈不得崩潰?

當然,官方提供了更方便的方式,我們可以利用 go:generate 來完成批量處理的功能

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

修改 interface 方法

打開 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 這條語句,可分為以下部分:

  1. 聲明 //go:generate (注意不要留空格)

  2. 使用 mockgen 命令

  3. 定義 -destination

  4. 定義 -package

  5. 定義 source,此處為 person 的包路徑

  6. 定義 interfaces,此處為 Male

重新生成 mock 文件

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

$ go generate ./...

上述內(nèi)容就是使用Gomock怎么進行單元測試,你們學到知識或技能了嗎?如果還想學到更多技能或者豐富自己的知識儲備,歡迎關(guān)注創(chuàng)新互聯(lián)成都網(wǎng)站設(shè)計公司行業(yè)資訊頻道。

另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)scvps.cn,海內(nèi)外云服務(wù)器15元起步,三天無理由+7*72小時售后在線,公司持有idc許可證,提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國服務(wù)器、虛擬主機、免備案服務(wù)器”等云主機租用服務(wù)以及企業(yè)上云的綜合解決方案,具有“安全穩(wěn)定、簡單易用、服務(wù)可用性高、性價比高”等特點與優(yōu)勢,專為企業(yè)上云打造定制,能夠滿足用戶豐富、多元化的應(yīng)用場景需求。

文章題目:使用Gomock怎么進行單元測試-創(chuàng)新互聯(lián)
文章地址:http://www.muchs.cn/article34/dsocse.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供網(wǎng)頁設(shè)計公司、網(wǎng)站制作服務(wù)器托管、網(wǎng)站內(nèi)鏈、做網(wǎng)站外貿(mào)網(wǎng)站建設(shè)

廣告

聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時需注明來源: 創(chuàng)新互聯(lián)

成都定制網(wǎng)站建設(shè)