用gomock进行mock测试

mock对象就是为了解决上面的问题而诞生的,mock(模拟)对象能够模拟实际依赖对象的功能,同时又不需要非常复杂的准备工作,你需要做的,仅仅就是定义对象接口,然后实现它,再交给测试对象去使用。

go-mock是专门为go语言开发的mock库,该库使用方式简单,支持自动生成代码,可以说是不可多得的好工具。下面我就简单地展示一下go-mock是如何工作的:

首先你需要做的是将依赖下载到本地:

1
2
go get github.com/golang/mock/gomock
go get github.com/golang/mock/mockgen

第一个是代码依赖,第二个是命令行工具(特别好用)。

下面用一个非常简单的例子来说明gomock是如何工作的:

我在$GOPATH/src目录下新建一个项目:hellomock,在$GOPATH/src/hellomock目录下新建hellomock.go,并定义一个接口Talker:

1
2
3
4
5
package hellomock

type Talker interface {
    SayHello(word string)(response string)
}

然后我们需要一个实现了Talker功能的结构体,假设我们有这样的场景,我们现在有一个迎宾的岗位,需要一个能够迎宾的迎宾员,当然这个迎宾员可以是一个人,或者是一只鹦鹉。那么我们需要做的是,定义一个Persion结构体(或者是鹦鹉或者是别的什么东西),并实现Talker接口:

person.go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
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

1
2
3
4
5
6
7
8
9
package hellomock

import "testing"

func TestCompany_Meeting(t *testing.T) {
    person := NewPerson("王尼美")
    company := NewCompany(person)
    t.Log(company.Meeting("王尼玛"))
}

测试之:

1
2
3
4
5
/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就登场了:

1
2
➜  hellomock> mkdir mock                                        
➜  hellomock> mockgen -source=hellomock.go > mock/mock_Talker.go

这个时候,将会生成mock/mock_Talker.go文件:

需要注意的是,自动生成的文件同源文件在不同的包下,需要新建一个目录存放

我们并不需要在意生成文件的内容,我们只需要知道如何去使用即可

mock_Talker.go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
// 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对象,新建一个单元测试:

1
2
3
4
5
6
7
8
9
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("张全蛋"))
}

测试之:

1
2
3
/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,第二个允许传入任意参数。比如我们在注释掉的测试中传入了”张全蛋”,结果报错,测试失败:

1
2
3
4
/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/mock/blob/master/README.md

https://github.com/grpc/grpc-go/blob/master/Documentation/gomock-example.md

转载请注明出处