go:极简上手使用 stretchr/testify 进行mock测试

库安装

首先,安装 Mock 类生成工具 Mockery:

bash 复制代码
go install github.com/vektra/mockery/v2@v2.45.1

实际上,你也可以手动创建 Mock 类。

生成 Mock 类

假设你在 internal/metrics 包下有如下定义的接口:

go 复制代码
package metrics

type Getter[T any] interface {
    Get() (T, error)
}

在项目根目录,可以使用以下命令生成 Mock 类:

bash 复制代码
mockery --name=Getter --dir=internal/metrics

生成的 Mock 类会在 mocks 目录下的 getter.go 文件中。

编写用例

go 复制代码
package metrics

import (
	"testing"

	mocks "xxx/mock/internal_/metrics"
	"github.com/stretchr/testify/suite"
)

type GetterTestSuite struct {
	suite.Suite
}

func TestGetter(t *testing.T) {
	suite.Run(t, new(GetterTestSuite))
}

func (t *GetterTestSuite) TestGetterInt() {
	t.T().Logf("TestGetterInt run")
	getter := new(mocks.Getter[int])
	getter.On("Get").Return(1, nil)

	val, err := getter.Get()
	t.Nil(err)
	t.Equal(1, val)
}

说明

  1. GetterTestSuite 是测试集的名称,每个method 都会作为测试用例调用。TestGetter 函数运行时,会调用 TestGetterInt
  2. TestGetterInt 中引用的 tTestSuite,包含许多有用的断言函数,如 EqualNil 等。
  3. 创建 Mock 实例后,可以使用 On 方法来标记方法对应的返回值。假设 Get 方法可以传递参数,则可以根据不同的参数选择不同的返回值。

Mock 常见用法

假设 mockObj 是 Mock 类的实例:

  1. mockObj.On("GetApiKey", mock.Anything).Return("dummy_api_key")GetApiKey 有一个参数,且无论传什么,都会返回 dummy_api_key
  2. mockObj.On("GetAllClusterInfo").Maybe().Return(GenerateTestClustersInfo()):如果使用 Maybe,则 GetAllClusterInfo 不一定必须被调用;如未使用 Maybe 且函数未被调用,则断言将失败。
  3. mockObj.On("RunCleanup", true, true).Once().Return(nil, nil)RunCleanup 有两个参数,所以需要传递两个 Mock 的值进入。Once 表示这个函数只应该被调用一次。
  4. mockObj.AssertNumberOfCalls(t.T(), "RunCleanup", 4):可以检查方法的调用次数。

通过这些用法,用户可以完全控制 Mock 类的每个方法的行为,并进行一些检查以完善整个测试。

相关推荐
zhuyasen2 小时前
Go 分布式任务和定时任务太难?sasynq 让异步任务从未如此简单
后端·go
同志们8 小时前
LiteLLM Go: 多平台LLM客户端统一接口实现
llm·go
用户89535603282208 小时前
LaPluma : 一个轻盈的 Go 数据流处理库
go
vv安的浅唱8 小时前
Golang基础笔记七之指针,值类型和引用类型
后端·go
猫头虎11 小时前
2025年02月11日 Go生态洞察:Go 1.24 发布亮点全面剖析
开发语言·后端·python·golang·go·beego·go1.19
DemonAvenger16 小时前
HTTP/2在Go中的实现与优化
网络协议·架构·go
程序员爱钓鱼17 小时前
Go语言实战案例-括号匹配算法
后端·google·go
程序员爱钓鱼17 小时前
Go语言实战案例-判断字符串是否由另一个字符串的字母组成
后端·google·go
ん贤1 天前
Zap日志库指南
后端·go
ん贤1 天前
GoWeb必备理论
go·web