使用 gomonkey Mock 函数及方法
文章目录
前言
在 Golang 语言中，写单元测试的时候，不可避免的会涉及到对其他函数及方法的 Mock，即在假设其他函数及方法响应预期结果的同时，校验被测函数的响应是否符合预期。
其中，在 Mock 其他函数及方法的时候，我们常用到的一个测试类库是「gomonkey」。特别地，对于方法和函数的 Mock，略有差异，在这里我们就分别给出函数和方法 Mock 示例，方便大家参考。
函数
在 Golang 语言中，函数是没有接受者的方法，其形式为
func function_name([parameter list]) [return_types] {
函数体
}对于函数的 Mock 相对来说比较简单，假设我们对 A 函数进行单元测试，且 A 函数里面又调用了 B 函数，例如
func A(ctx context.Context, str string) error {
if len(str) == 0 {
return errors.New("str is empty")
}
return test_package_name.B(ctx, str)
}为了将 A 函数的每一行代码都覆盖到，则其单元测试可以写为：
func TestA(t *testing.T) {
type args struct {
ctx context.Context
str string
}
tests := []struct {
name string
args args
Setup func(t *testing.T)
wantErr error
}{
{
name: "len(str) == 0",
wantErr: errors.New("str is empty")
},
{
name: "正常响应",
Setup: func(t *testing.T) {
patches := gomonkey.ApplyFunc(test_package_name.B, func(_ context.Context, _ string) error {
return nil
})
t.Cleanup(func() {
patches.Reset()
})
},
args: args{
ctx: context.Background(),
str: "test",
},
wantErr: nil,
},
}
// 执行测试用例
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if tt.Setup != nil {
tt.Setup(t)
}
err := A(tt.args.ctx, tt.args.str)
if err != nil {
assert.EqualError(t, err, tt.wantErr.Error(), "error 不符合预期")
}
})
}
}其中，ApplyFunc函数是用来 Mock 函数的，其第一个参数为需要 Mock 的函数名称（不需要写参数列表），第二个参数为需要 Mock 的函数结果；特别地，在Setup里面，我们要记得显式调用Cleanup对patches进行Reset操作，防止该 Mock 影响其他测试用例。
方法
在 Golang 语言中，方法是含有接受者的函数，其形式为
func (variable_name variable_data_type) function_name([parameter list]) [return_type]{
函数体
}对于方法的 Mock 相对来说复杂一下，假设我们对 A 函数进行单元测试，且 A 函数里面又调用了结构 C 的 B 方法，例如
func A(ctx context.Context, str string) error {
if len(str) == 0 {
return errors.New("str is empty")
}
c := &test_package_name.C{}
return c.B(ctx, str)
}为了将 A 函数的每一行代码都覆盖到，则其单元测试可以写为：
func TestA(t *testing.T) {
// 初始化C结构
var c *test_package_name.C
type args struct {
ctx context.Context
str string
}
tests := []struct {
name string
args args
Setup func(t *testing.T)
wantErr error
}{
{
name: "len(str) == 0",
wantErr: errors.New("str is empty")
},
{
name: "正常响应",
Setup: func(t *testing.T) {
patches := gomonkey.ApplyMethod(reflect.TypeOf(c), "B", func(_ *test_package_name.C, _ context.Context, _ string) error {
return nil
})
t.Cleanup(func() {
patches.Reset()
})
},
args: args{
ctx: context.Background(),
str: "test",
},
wantErr: nil,
},
}
// 执行测试用例
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if tt.Setup != nil {
tt.Setup(t)
}
err := A(tt.args.ctx, tt.args.str)
if err != nil {
assert.EqualError(t, err, tt.wantErr.Error(), "error 不符合预期")
}
})
}
}其中，ApplyMethod函数是用来 Mock 方法的，其第一个参数为需要 Mock 的方法的接受者类型，第二个参数为需要 Mock 的方法名称（字符串类型），第三个参数为需要 Mock 的方法的定义及 Mock 结果；特别地，第一个参数和第三个参数需要我们注意：
- 第一个参数，需要使用
reflect.TypeOf获取接受者的类型，初始化的接受者必须是真正的类型，如结构 C 组合了结构 D，而B方法是通过组合 D 得到的，则初始化的时候需要定义结构 D，而不是结构 C，否则会报空指针异常； - 第三个参数，虽然
B方法的声明是func(ctx context.Context, str string)，但是在使用ApplyMethod的时候，需要将B方法的声明修改为func(c *test_package_name.C, ctx context.Context, str string)，即需要将方法的接受者置为方法的第一个参数。
参考
还有就是，大家在使用gomonkey的时候，有可能遇到权限校验的问题以及非 Debug 模式运行失败的问题，可以参考：
到这里，本文就要结束了，希望对大家有所帮助。
腾讯云开发者
