Go测试指南：使用testify mock模块隔离依赖进行单元测试

在测试某个组件时，如果该组件依赖于其他组件，一个理想的策略是在测试过程中隔离这个依赖，并使用 Mock 功能来模拟它的行为，从而实现替换。这种方式可以确保你在测试核心组件时，不受外界依赖的干扰。

testify 框架中的 mock 模块正是为此而生。它允许你定义一个预期行为，比如 Mock 对象应该如何被调用，以及应该返回什么结果。

简单来说，Mock 就是构造一个模拟对象，它能提供和原对象一样的接口并返回预定义的数据。这在原对象构造复杂、无法访问外部资源（如数据库、网络）、或不同开发模块进度不一致但需要联调的场景中尤其有用。通过 Mock，我们可以快速推进集成测试。

下面，我们通过一个示例来演示如何使用 Mock 测试一个用户服务及其依赖的数据存储服务。

user.go

package user

type User struct {
    Id    string
    Name  string
    Email string
}

type DataStore interface {
    GetUser(id string) (*User, error)
    SaveUser(user *User) error
}

type UserService struct {
    store DataStore
}

func NewUserService(store DataStore) *UserService {
    return &UserService{store: store}
}

func (us *UserService) GetUserById(id string) (*User, error) {
    return us.store.GetUser(id)
}

func (us *UserService) UpdateUserEmail(id, newEmail string) error {
    user, err := us.store.GetUser(id)
    if err != nil {
        return err
    }
    user.Email = newEmail
    return us.store.SaveUser(user)
}

接下来是使用 testify 进行 Mock 测试的代码。

package user

import (
    "testing"

    "github.com/stretchr/testify/assert"
    "github.com/stretchr/testify/mock"
)

// 创建一个Mock并实现DataStore接口
type MockDataStore struct {
    mock.Mock
}

// 使用Mock实现DataStore接口的GetUser方法
func (m *MockDataStore) GetUser(id string) (*User, error) {
    args := m.Called(id)

    // 如果第一个返回值为 nil，则返回 nil,args.Error(1)
    if args.Get(0) == nil {
        return nil, args.Error(1)
    }
    // 否则返回 User
    return args.Get(0).(*User), args.Error(1)
}

// 使用Mock实现DataStore接口的SaveUser方法
func (m *MockDataStore) SaveUser(user *User) error {
    args := m.Called(user)
    return args.Error(0)
}

// 开始执行测试：测试GetUserById方法
func TestUserServiceGetUserById(t *testing.T) {
    // 创建一个Mock DataStore
    mockStore := new(MockDataStore)
    // 创建一个userService，并注入mockStore
    service := NewUserService(mockStore)

    // 设置预期结果：当GetUser被以参数“1”调用时，返回testUser
    testUser := &User{Id: "1", Name: "Surpass", Email: "surpassme@surpass.net"}
    mockStore.On("GetUser", "1").Return(testUser, nil)

    // 调用被测方法
    user, err := service.GetUserById("1")

    // 断言
    assert.NoError(t, err, "应该没有错误返回")
    assert.Equal(t, testUser, user, "应该返回testUser")

    // 校验所有期望是否都按预期被调用
    mockStore.AssertExpectations(t)
}

// 开始执行测试：测试UpdateUserEmail方法
func TestUserServiceUpdateUserEmail(t *testing.T) {
    // 创建一个Mock DataStore
    mockStore := new(MockDataStore)
    // 创建一个userService，并注入mockStore
    service := NewUserService(mockStore)

    // 设置预期结果
    testUser := &User{Id: “1”， Name: "Surpass", Email: "surpassme@surpass.net"}
    // 期望GetUser被调用一次，参数为“1”
    mockStore.On("GetUser", "1").Return(testUser, nil)
    // 期望SaveUser被调用一次，参数需满足自定义匹配条件
    mockStore.On("SaveUser", mock.MatchedBy(func(u *User) bool {
        return u.Id == “1” && u.Email == “new_email@surpass.net”
    })).Return(nil)

    // 调用被测方法
    err := service.UpdateUserEmail(“1”， “new_email@surpass.net”)

    // 断言
    assert.NoError(t, err, "应该没有错误返回")

    // 校验所有期望是否都按预期被调用
    mockStore.AssertExpectations(t)
}

通过上面的测试代码，我们可以总结出使用 testify/mock 的基本模式：

1. 创建Mock结构体：创建一个结构体，并将 mock.Mock 嵌入其中。
2. 实现接口方法：为这个结构体实现你需要模拟的接口方法，在方法内部通过嵌入的 mock.Mock 的 Called 方法来记录调用。
3. 设置期望：在测试用例中，使用 On 方法为Mock对象的方法调用设置预期（参数和返回值）。
4. 执行与校验：运行你的业务代码，然后使用 AssertExpectations 来验证所有预设的期望是否都得到了满足。

对于更复杂的参数匹配需求，mock 模块还提供了诸如 mock.Anything、mock.AnythingOfType 和 MatchedBy 等匹配器，让你能够更灵活地定义调用预期。

希望这篇关于如何在Go中使用 testify/mock 的指南对你有帮助。如果你在实践单元测试中遇到其他问题，欢迎来云栈社区与我们一起交流探讨。