Golang接口模拟测试与Mock生成插件minimock的使用

概述

Minimock可以从Go接口声明生成mock对象。minimock的主要特性包括：

• 生成静态类型的mock和辅助工具，使用minimock时不需要类型断言
• 完全集成标准Go的"testing"包
• 支持Go模块
• 支持泛型
• 适合表驱动测试，可以使用构建器模式在一行代码中为多个方法设置mock
• 可以一次生成多个mock
• 可以从接口别名生成mock
• 生成的代码能通过golangci-lint的默认检查集
• 在生成的代码中添加//go:generate指令，当源接口更新时只需在项目目录中运行go generate ./...命令
• 确保所有mock方法在测试期间被调用，保持测试代码整洁和最新
• 提供When和Then辅助工具为任何方法设置多个期望和结果
• 生成并发安全的mock和mock调用计数器，可用于根据调用次数管理mock行为
• 可与GoUnit工具一起使用，后者生成使用minimock的表驱动测试

安装

如果你使用go模块，请下载最新二进制文件或从源码安装minimock：

go install github.com/gojuno/minimock/v3/cmd/minimock@latest

使用

基本命令

minimock [-i source.interface] [-o output/dir/or/file.go] [-g]
  -g    不将go:generate指令放入生成的代码中
  -h    显示帮助信息
  -i string
       要mock的接口名称，逗号分隔，如fmt.Stringer,io.Reader
       使用io.*表示法为"io"包中的所有接口生成mock（默认为"*"）
  -o string
       逗号分隔的目标文件名或包名，用于放置生成的mock，
       默认情况下生成的mock放在源包目录中
  -p string 
       逗号分隔的包名，
       默认情况下生成的包名取自目标目录名
  -pr string
       mock文件前缀
  -s string
       mock文件后缀（默认为"_mock_test.go"）
  -gr
       将go:generate行从"//go:generate minimock args..."更改为
       "//go:generate go run github.com/gojuno/minimock/v3/cmd/minimock"，
       在使用go mod控制minimock版本时很有用

示例

假设我们在github.com/gojuno/minimock/tests包中有以下接口声明：

type Formatter interface {
    Format(string, ...interface{}) string
}

要为"tests"包中的所有接口生成mock：

$ cd ~/go/src/github.com/gojuno/minimock/tests
$ minimock 

只为"Formatter"接口生成mock：

$ cd ~/go/src/github.com/gojuno/minimock/tests
$ minimock -i Formatter 

使用相对包表示法：

$ minimock -i ./tests.Formatter

使用源包的完整导入路径：

$ minimock -i github.com/gojuno/minimock/tests.Formatter -o ./tests/

使用生成的mock

有几种方法可以使用生成的mock。

使用构建器模式和Expect/Return方法设置mock

mc := minimock.NewController(t)
formatterMock := NewFormatterMock(mc).FormatMock.Expect("hello %s!", "world").Return("hello world!")

使用When/Then辅助工具设置mock

mc := minimock.NewController(t)
formatterMock := NewFormatterMock(mc)
formatterMock.FormatMock.When("Hello %s!", "world").Then("Hello world!")
formatterMock.FormatMock.When("Hi %s!", "there").Then("Hi there!")

或者使用一行代码：

formatterMock = NewFormatterMock(mc).FormatMock.When("Hello %s!", "world").Then("Hello world!").FormatMock.When("Hi %s!", "there").Then("Hi there!")

使用Set方法设置mock

mc := minimock.NewController(t)
formatterMock := NewFormatterMock(mc).FormatMock.Set(func(string, ...interface{}) string {
  return "minimock"
})

设置mock预期被调用的次数

假设你期望mock被精确调用10次：

mc := minimock.NewController(t)
formatterMock := NewFormatterMock(mc).FormatMock.Times(10).Expect("hello %s!", "world").Return("hello world!")

测试并发代码

测试并发代码很困难。幸运的是，minimock.Controller提供了一个辅助方法，使测试并发代码变得容易：

func TestSomething(t *testing.T) {
  mc := minimock.NewController(t)

  // Wait确保所有mock方法在给定时间跨度内被调用
  // 如果有任何mock方法未被调用，Wait将测试标记为失败
  defer mc.Wait(time.Second)

  formatterMock := NewFormatterMock(mc)
  formatterMock.FormatMock.Return("minimock")

  // 被测代码可以在goroutine中运行mock方法
  go formatterMock.Format("hello world!")
}

完整示例

下面是一个完整的示例，展示如何使用minimock进行接口模拟测试：

package main

import (
	"testing"
	"github.com/gojuno/minimock/v3"
)

// 定义接口
type StringFormatter interface {
	Format(format string, args ...interface{}) string
}

// 被测函数
func Greet(formatter StringFormatter, name string) string {
	return formatter.Format("Hello, %s!", name)
}

func TestGreet(t *testing.T) {
	mc := minimock.NewController(t)
	defer mc.Finish() // 确保所有期望都被满足

	// 创建mock对象
	mockFormatter := NewStringFormatterMock(mc)
	
	// 设置期望行为
	mockFormatter.FormatMock.Expect("Hello, %s!", "World").Return("Hello, World!")

	// 调用被测函数
	result := Greet(mockFormatter, "World")

	// 验证结果
	if result != "Hello, World!" {
		t.Errorf("Unexpected result: %s", result)
	}
}

在这个示例中：

1. 首先定义了一个StringFormatter接口
2. 然后有一个Greet函数使用这个接口
3. 在测试中，我们使用minimock创建了一个mock对象
4. 设置了期望的行为（当使用特定参数调用Format时返回特定值）
5. 调用被测函数并验证结果

要生成mock，你需要先运行：

minimock -i StringFormatter

这将在当前目录生成一个stringformatter_mock_test.go文件，包含StringFormatterMock的实现。

minimock是一个功能强大且灵活的mock生成工具，可以大大简化Go中的接口测试工作。通过其丰富的功能集，你可以轻松地为各种测试场景创建和管理mock对象。