使用 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 模式运行失败的问题，可以参考：
golang使用gomonkey和monkey来mock方法或者函数时报panic: permission denied
使用 gomonkey 遇到非 debug 模式执行失败的问题及解决方法
到这里，本文就要结束了，希望对大家有所帮助。
到此这篇关于使用 gomonkey Mock 函数及方法的文章就介绍到这了,更多相关gomonkey Mock 函数内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章主要介绍了go程序员开发效率神器包含了go常用开发工具,go调试工具,go常用网站,golang常用库,需要的朋友可以参考下2022-11-11
这篇文章主要介绍了Go语言转换所有字符串为大写或者小写的方法,实例分析了ToLower和ToUpper函数的使用技巧,具有一定参考借鉴价值,需要的朋友可以参考下2015-02-02
对于无类型常量，可能大家是第一次听说，但我们每天都在用，每天都有无数潜在的坑被埋下。本文就来和大家聊聊它的相关注意事项吧，希望对大家有所帮助2023-03-03
创建一个新进程分为两个步骤，一个是fork系统调用，一个是execve 系统调用，本文将从源码的角度带大家剖析一下Golang是如何fork一个进程的2023-06-06
今天小编就为大家分享一篇关于Go语言range关键字循环时的坑，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧2019-03-03
这篇文章主要介绍了golang通过gorm操作sqlite设置主键自增的详细步骤,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下2023-09-09
单例是一种创建型设计模式，让你能够保证一个类只有一个实例，并提供一个访问该实例的全局节点，本文就通过代码示例给大家讲讲Go单例模式,需要的朋友可以参考下2023-07-07
Golang的log包短小精悍,可以非常轻松的实现日志打印转存功能,下面这篇文章主要给大家介绍了关于Go语言常用的打log方式的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下2022-10-10
在这个章节中,我们将会结合之前的知识点,实现一个简易的并发网页爬虫,我们的爬虫会先爬取一个起始页面,提取出所有的链接,然后并发地爬取这些链接,有需要的朋友可以借鉴参考下,希望能够有所帮助2023-08-08
为保证程序顺利高效的运行，编译器会把各种类型的数据安排到合适的地址，并占用合适的长度，这就是内存对齐。本文重点给大家介绍golang内存对齐的概念及案例详解，感兴趣的朋友一起看看吧2022-02-02
最新评论