gomock 教程
gomock 教程
GoMock是Go官方出品的一款mock框架，可以Go語言內(nèi)置的testing包很好集成，并且提供EXCEPT方法去指定期待的值。
## 安裝
打開[https://github.com/golang/mock](https://github.com/golang/mock)
```sh
go install github.com/golang/mock/mockgen@v1.6.0
```
輸入mockgen查看是否下載在$GOPATH/bin 目錄下
## 基本用法步驟
首先選定一個mock的demo目錄
比如說叫g(shù)omock-learn,然后在此目錄下創(chuàng)建對應(yīng)的mod，然后引入對應(yīng)的gomock包
```
go mod init gomock-learn
go get github.com/golang/mock v1.6.0 // indirect
```
接下來創(chuàng)建兩個目錄person和student分別用來放對應(yīng)的接口和代碼。
```go
// person.go
package person
type Person interface {
Eat(food string) string
Sleep(name string) string
}
```
```
// student.go
package student
import "gomock-learn/person"
type Student struct {
p? ? person.Person
Name string
}
func (p *Student) Eat(food string) string {
return p.p.Eat(food)
}
func (p *Student) Sleep() string {
return p.p.Sleep(p.Name)
}
```
接著你要創(chuàng)建一個mocks目錄，不然如果沒有mock目錄的話用mockgen命令行會失敗
使用方法，直接在相應(yīng)的目錄下執(zhí)行以下命令
```
mockgen -destination mocks/mock_person.go -package=mocks gomock-learn/person Person
```
這里需要注意的是我們必須自己創(chuàng)建mocks目錄因為GoMock不會自動幫我們創(chuàng)建，當(dāng)它發(fā)現(xiàn)mocks目錄不存在時會返回一個錯誤。以下是對mockgen命令參數(shù)的說明：
````
?-destination=mocks/mock_person.go：將自動生成的mock代碼存儲到文件mocks/mock_person.go中。-
package=mocks：將生成的mock代碼放置到mocks包中。
gomock-learn/person：為這個包生成mock代碼。
Person：為這個接口生成mock代碼。這個參數(shù)是個必填參數(shù)，我們需要顯式地指定要生成mock代碼的接口。如果需要指定多個接口，可以將接口通過逗號連接起來，比如：Person1,Person2。
````
## 結(jié)合go-generate使用GoMock
在對應(yīng)的借口前加入注釋
```
//go:generate mockgen -destination mocks/mock_person.go -package=mocks gomock-learn/person Person
type Person interface {
Eat(food string) string
Sleep(name string) string
}
```
然后在對應(yīng)的目錄下輸入
```
go generate ./?
```
可以發(fā)現(xiàn)就在對應(yīng)的mocks目錄下里有一個mock_xx.go函數(shù)，這個函數(shù)里面就是我們可以Mock的數(shù)據(jù)。
## 使用參數(shù)匹配
有時候你可能不太確定調(diào)用mock時指定的參數(shù)，所以有一個對應(yīng)的Matcher來代表一個mock方法可以接受的參數(shù)范圍，比如gomock.Eq(x)指定傳入值必須等于x。
以下是GoMock中一些預(yù)定義的matcher：
```
? ? gomock.Any()：匹配任何類型的任何值
? ? gomock.Eq(x)：匹配使用反射reflect.DeepEqual與x相等的值gomock.Nil()：匹配等于nil的值
? ? gomock.Not(m)：（這里的m是一個Matcher）匹配同m不匹配的值
? ? gomock.Not(x)：（這里的x不是Matcher）匹配使用反射reflect.DeepEqual與x不相等的值
```
如果我們希望第一個參數(shù)必須是x，那么我們就用
```
mockDoer.EXPECT().DoSomething(gomock.Eq(x), "Hello GoMock")
```
具體例子
```go
func Test_Eat(t *testing.T) {
ctrl := gomock.NewController(t)
mockPerson := mocks.NewMockPerson(ctrl)
mockPerson.
EXPECT().
Eat("Apple").Times(1)
testStudent := Student{Name: "lixin", p: mockPerson}
testStudent.Eat("Apple")
}
```
```go
func Test_Sleep(t *testing.T) {
ctrl := gomock.NewController(t)
mockPerson := mocks.NewMockPerson(ctrl)
testStudent := Student{Name: "lixin", p: mockPerson}
mockPerson.
EXPECT().
Sleep("lixin").Return("lixin is sleep").Do(func(name string) {
fmt.Printf("%s is sleep!\n", name)
})
if testStudent.Sleep() != "lixin is sleep" {
t.Error("Error!!!!!")
}
}
```
## 斷言調(diào)用順序
有時候我們期望控制一些mock流程的順序，這里有一個例子調(diào)用After的方法
```go
func Test_Eat(t *testing.T) {
ctrl := gomock.NewController(t)
mockPerson := mocks.NewMockPerson(ctrl)
first := mockPerson.EXPECT().Eat("xxx")
mockPerson.
EXPECT().
Eat("Apple").
After(first)
testStudent := Student{Name: "lixin", p: mockPerson}
testStudent.Eat("xxx")
testStudent.Eat("Apple")
}
```
## 指定mock行為
比如說可以在執(zhí)行完畢后加一個Do函數(shù)去做一些事情。
## 總結(jié)
安裝
基本用法步驟
結(jié)合go-generate使用GoMock
使用參數(shù)匹配
斷言調(diào)用順序
指定mock的行為
