gomock使用

安装

// go 1.16之后版本
go install github.com/golang/mock/mockgen@v1.6.0

安装好后，可以使用mockgen -version查看版本。

接口mock生成

mockgen有两种使用模式，一种时source模式，一种是reflect模式。

source模式

mockgen -source=xxx.go [other options]

• -source指定生成mock函数的文件。该文件需要包含相关的接口。

reflect模式

mockgen 包 接口，如mockgen net/http RoundTripper。
多个接口用,分隔，如mockgen database/sql/driver Conn,Driver。
.表示当前路径下的包mockgen . Conn,Driver

通常情况下，还需要带上几个其他参数。
mockgen -build_flags=--mod=mod -destination=mock/mockhttp.go -package=mock net/http RoundTripper

• -build_flags表示编译参数，会直接传递给go build。go build --mod=mod
• -destination表示生成的mock函数存放的位置。
• -package表示mock文件的包名，建议和-destination中的目录名字一致。

使用反射模式的时候，如果出现以下报错，可以通过以下三种方法解决。

cannot find package "."
... github.com/golang/mock/mockgen/model

• 使用source模式。
• 导入包import _ "github.com/golang/mock/mockgen/model"
• mockgen命令加上--build_flags=--mod=mod选项

接口mock使用

func TestGetFromDB(t *testing.T) {
    // 创建gomock控制器，用来记录后续的操作信息
    ctrl := gomock.NewController(t)
    defer ctrl.Finish()
    // 调用mockgen生成代码中的NewMockTi方法，Ti是一个接口类型
    m := mock.NewMockTi(ctl)
    ...
}

接口mock的使用场景是我们在调用其他接口函数的时候，不真正调用该函数而直接拿到函数返回值。此时有多种情况：

• 无论请求是什么都返回相同的内容。

m.EXPECT().YourFunc(gomock.Any()).Return(yourReturn)

• 根据接口函数的不同入参，返回不同的返回值。此时需要用到gomock的比较函数。

m.EXPECT().YourFunc(gomock.Eq(yourInput)).Return(yourReturn)

还有其他几个比较函数

• gomock.Eq(value)：表示一个等价于value值的参数
• gomock.Not(value)：表示一个非value值的参数
• gomock.Any()：表示任意值的参数
• gomock.Nil()：表示空值的参数
• SetArg(n, value)：设置第n（从0开始）个参数的值，通常用于指针参数或切片。
  这里单独说一下SetArg的适用场景，假设你有一个需要mock的接口如下：

type YourInterface {
  SetValue(arg *int)
}

此时，打桩的时候就可以使用SetArg来修改参数的值。
m.EXPECT().SetValue(gomock.Any()).SetArg(0, 7) // 将SetValue的第一个参数设置为7

• 根据调用该接口函数的次数，按照事先填充的返回值顺序，每次调用返回对应顺序的返回值。如第一次调用返回a，第二次调用返回b。此处需要设置每个接口可调用的次数。

first := m.EXPECT().YourFunc(gomock.Eq(yourInput)).Return(yourReturn1)
second := m.EXPECT().YourFunc(gomock.Eq(yourInput)).Return(yourReturn2)
gomock.InOrder(first, second)
# 第一次调用返回结果1，第二次调用返回结果2

• Call.Do()：声明在匹配时要运行的操作

m.EXPECT().Get(gomock.Any()).Do(func(key string) {
    t.Logf("input key is %v\n", key)
})

• Call.DoAndReturn()：声明在匹配调用时要运行的操作，并且模拟返回该函数的返回值

m.EXPECT().Get(gomock.Any()).DoAndReturn(func(key string)(int, error) {
    t.Logf("input key is %v\n", key)
    return 10, nil
})

• Call.MaxTimes()：设置最大的调用次数为 n 次
• Call.MinTimes()：设置最小的调用次数为 n 次
• Call.AnyTimes()：允许调用次数为 0 次或更多次
• Call.Times()：设置调用次数为 n 次

默认Mock接口只能调用一次，如果要多次调用，需要设置调用次数。m.EXPECT().YourFunc(gomock.Eq(yourInput)).Return(yourReturn).AnyTimes()

完整的例子

• 源代码(mocksdk.go)

type Ti interface {
    Get(i int) int
}

type Num struct {
    num int
}

func (n Num) Get(i int) int {
    return n.num + i
}

• 生成mock代码：mockgen -destination mock/mockget.go -package mock -source ./mocksdk.go
• 测试代码

func TestGet(t *testing.T) {
    ctl := gomock.NewController(t)
    defer ctl.Finish()
    mockTi := mock.NewMockTi(ctl)
    mockTi .EXPECT().Get(gomock.Eq(2)).Return(1)
        
    // 初始化接口实例
    ti := Ti(mockTi)
    fmt.Println(ti.Get(2))
}

执行单测

go test ./user

• 查看测试覆盖率
  go test -cover ./user
• 可视化覆盖内容

1. 生成测试覆盖率的 profile 文件
   go test ./. -coverprofile=cover.out
2. 利用 profile 文件生成可视化界面
   go tool cover -html=cover.out

生成多个接口的mock

我们可以利用 go:generate 来完成批量生成接口mock。
在接口文件中，给接口添加对应的注释，然后运行go generate即可。

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
}

go generate ./...

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