Golang自动生成Go接口的测试替身插件库mockery的使用

简介

mockery是一个用于自动生成Golang接口mock实现的工具，它基于stretchr/testify/mock包，可以显著减少编写mock代码的样板代码量。

安装

首先需要安装mockery工具：

go install github.com/vektra/mockery/v3@latest

使用示例

1. 定义接口

假设我们有一个简单的接口定义在user.go中：

package user

// UserService 用户服务接口
type UserService interface {
    GetUser(id int) (*User, error)
    CreateUser(user *User) error
}

// User 用户结构体
type User struct {
    ID   int
    Name string
}

2. 生成mock代码

在项目根目录下运行以下命令为UserService接口生成mock实现：

mockery --name=UserService --output=mocks --case=underscore

这将在mocks目录下生成一个名为UserService.go的mock实现文件。

3. 使用mock进行测试

下面是一个使用生成的mock进行测试的示例：

package user_test

import (
    "testing"
    "yourproject/mocks"
    "yourproject/user"
    
    "github.com/stretchr/testify/assert"
    "github.com/stretchr/testify/mock"
)

func TestGetUser(t *testing.T) {
    // 创建mock实例
    mockUserService := &mocks.UserService{}
    
    // 设置预期行为和返回值
    expectedUser := &user.User{ID: 1, Name: "John Doe"}
    mockUserService.On("GetUser", 1).Return(expectedUser, nil)
    
    // 调用被测试代码
    result, err := mockUserService.GetUser(1)
    
    // 验证结果
    assert.NoError(t, err)
    assert.Equal(t, expectedUser, result)
    
    // 验证mock的预期调用是否发生
    mockUserService.AssertExpectations(t)
}

func TestCreateUser(t *testing.T) {
    mockUserService := &mocks.UserService{}
    
    testUser := &user.User{Name: "Jane Doe"}
    
    // 设置预期行为
    mockUserService.On("CreateUser", testUser).Return(nil)
    
    // 调用被测试代码
    err := mockUserService.CreateUser(testUser)
    
    // 验证结果
    assert.NoError(t, err)
    
    // 验证mock的预期调用是否发生
    mockUserService.AssertCalled(t, "CreateUser", testUser)
}

常用命令选项

• --name: 指定要生成mock的接口名称
• --output: 指定生成mock文件的输出目录
• --case: 指定生成文件的命名风格(underscore, camel等)
• --dir: 指定包含接口定义的目录
• --recursive: 递归查找子目录中的接口
• --all: 为所有找到的接口生成mock

高级用法

1. 使用Expecter接口

mockery可以生成带有Expecter接口的mock，提供更类型安全的方式来设置期望：

func TestWithExpecter(t *testing.T) {
    mockUserService := &mocks.UserService{}
    
    // 使用Expecter设置期望
    mockUserService.EXPECT().
        GetUser(mock.AnythingOfType("int")).
        Run(func(id int) {
            assert.Equal(t, 1, id)
        }).
        Return(&user.User{ID: 1, Name: "Test User"}, nil)
    
    result, err := mockUserService.GetUser(1)
    
    assert.NoError(t, err)
    assert.NotNil(t, result)
}

2. 生成整个包的mock

要为包中所有接口生成mock，可以使用：

mockery --dir=./user --all --output=mocks

总结

mockery是一个强大的Golang mock生成工具，它可以：

• 自动为接口生成mock实现
• 减少测试中的样板代码
• 提供丰富的断言功能
• 支持多种配置选项

通过使用mockery，开发者可以更专注于测试逻辑本身，而不是手动编写mock实现。