GoMock 教程

GoMock是go官方提供的一款Mock工具，方便開發(fā)人員模擬接口行為做測(cè)試的工具。

官方文檔在這里

https://github.com/golang/mock

比如我們有一個(gè)Person接口下的Eat方法，我們就可以模擬這個(gè)接口

ctrl := gomock.NewController(t)

mockPerson := mocks.NewMockPerson(ctrl)

mockPerson. EXPECT(). Eat().Return("lixin is sleep")

在這里我們就使用gomock創(chuàng)建一個(gè)mockPerson，去模擬person接口的行為 后續(xù)方便去做單測(cè)

安裝

打開https://github.com/golang/mock?sh go install github.com/golang/mock/mockgen@v1.6.0

輸入mockgen查看是否下載在$GOPATH/bin 目錄下

基本用法步驟

首先選定一個(gè)mock的demo目錄

比如說叫g(shù)omock-learn,然后在此目錄下創(chuàng)建對(duì)應(yīng)的mod，然后引入對(duì)應(yīng)的gomock包

go mod init gomock-learn
go get github.com/golang/mock 

接下來創(chuàng)建兩個(gè)目錄person和student分別用來放對(duì)應(yīng)的接口和代碼。

// 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)
}

接著你要?jiǎng)?chuàng)建一個(gè)mocks目錄，不然如果沒有mock目錄的話用mockgen命令行會(huì)失敗

使用方法，直接在相應(yīng)的目錄下執(zhí)行以下命令

mockgen -destination mocks/mock_person.go -package=mocks gomock-learn/person Person

這里需要注意的是我們必須自己創(chuàng)建mocks目錄因?yàn)镚oMock不會(huì)自動(dòng)幫我們創(chuàng)建，當(dāng)它發(fā)現(xiàn)mocks目錄不存在時(shí)會(huì)返回一個(gè)錯(cuò)誤。以下是對(duì)mockgen命令參數(shù)的說明：

 -destination=mocks/mock_person.go：將自動(dòng)生成的mock代碼存儲(chǔ)到文件mocks/mock_person.go中。-

package=mocks：將生成的mock代碼放置到mocks包中。

gomock-learn/person：為這個(gè)包生成mock代碼。

Person：為這個(gè)接口生成mock代碼。這個(gè)參數(shù)是個(gè)必填參數(shù)，我們需要顯式地指定要生成mock代碼的接口。如果需要指定多個(gè)接口，可以將接口通過逗號(hào)連接起來，比如：Person1,Person2。

結(jié)合go-generate使用GoMock

在對(duì)應(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
}

然后在對(duì)應(yīng)的目錄下輸入?go generate ./

可以發(fā)現(xiàn)就在對(duì)應(yīng)的mocks目錄下里有一個(gè)mock_xx.go函數(shù)，這個(gè)函數(shù)里面就是我們可以Mock的數(shù)據(jù)。

此時(shí)的目錄是這樣的

├── go.mod
├── go.sum
├── mocks
│   └── mock_person.go
├── person
│   └── person.go
└── student
    ├── student.go
    └── student_test.go

使用參數(shù)匹配

有時(shí)候你可能不太確定調(diào)用mock時(shí)指定的參數(shù)，所以有一個(gè)對(duì)應(yīng)的Matcher來代表一個(gè)mock方法可以接受的參數(shù)范圍，比如gomock.Eq(x)指定傳入值必須等于x。

以下是GoMock中一些預(yù)定義的matcher：?

gomock.Any()：匹配任何類型的任何值

gomock.Eq(x)：匹配使用反射reflect.DeepEqual與x相等的值

gomock.Nil()：匹配等于nil的值

gomock.Not(m)：（這里的m是一個(gè)Matcher）匹配同m不匹配的值

gomock.Not(x)：（這里的x不是Matcher）匹配使用反射reflect.DeepEqual與x不相等的值

如果我們希望第一個(gè)參數(shù)必須是x，那么我們就用mockDoer.EXPECT().DoSomething(gomock.Eq(x), "Hello GoMock")

具體例子

 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")

}

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)用順序

有時(shí)候我們期望控制一些mock流程的順序，這里有一個(gè)例子調(diào)用After的方法

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í)行完畢后加一個(gè)Do函數(shù)去做一些事情。

總結(jié)

安裝 基本用法步驟 結(jié)合go-generate使用GoMock 使用參數(shù)匹配 斷言調(diào)用順序 指定mock的行為