Golang 函数测试中的 mocks 和 stubs

在 Go 函数测试中，Mocks 和 Stubs 允许隔离和验证外部依赖项。Mocks 模拟依赖项的行为，而 Stubs 提供固定值。使用 Mocks，需要使用 mockgen 生成 mock 文件，在测试中引入 mock，并设置 mock 期望值。使用 Stubs，需要引入 stub 包，创建 stub，并断言 stub 是否被调用。通过使用 Mocks 和 Stubs，我们可以提高函数测试的鲁棒性和可信度。

如何在 Go 函数测试中使用 Mocks 和 Stubs

在 Go 中进行函数测试时，Mock 和 Stub 是隔离和验证外部依赖项的有效技术。下面我们将探讨如何在测试中使用这些技术。

什么是 Mocks 和 Stubs？

Mock 是一个模拟外部依赖项的替代品，允许您在测试中指定其行为和特性。相反，Stub 是一种提供固定值的替代品，而不会模拟依赖项的行为。

使用 Mocks：

使用 mockgen 生成 mock 文件：

go get github.com/golang/mock/mockgen
mockgen -package=api -destination=mocks/customer_mock.go github.com/your-org/your-repo/api CustomerService

在测试函数中引入 Mock：

import mocks "github.com/your-org/your-repo/api/mocks"

func TestFunctionWithCustomerService(t *testing.T) {
    mockCustomerService := &mocks.CustomerService{}
}

设置 Mock 期望值：

// 设置客户创建方法的预期行为
mockCustomerService.On("CreateCustomer", mock.Anything).Return(nil, nil)

使用 Stubs：

引入 Stub 包：

import "github.com/stretchr/testify/stub"

在测试函数中创建 Stub：

// 创建一个提供固定数字值的 `Stub`，作为 avg 升序的占位符
stubAvg := stub.On(ioutil, "ReadFile").Return([]byte("80"), nil)

实战案例：

假设我们有一个函数 GetCustomerAge，它从依赖项 CustomerService 获取客户数据。

func GetCustomerAge(customerID int64) (int, error) {
    customer, err := service.GetCustomer(customerID)
    if err != nil {
        return 0, err
    }
    return customer.Age, nil
}

使用 Mock 测试：

func TestGetCustomerAgeWithMock(t *testing.T) {
    mockCustomerService := &mocks.CustomerService{}

    // 设置 Mock 期望值
    mockCustomerService.On("GetCustomer", mock.Anything).Return(&models.Customer{Age: 25}, nil)

    age, err := GetCustomerAge(1)
    assert.NoError(t, err)
    assert.Equal(t, 25, age)
}

使用 Stub 测试：

func TestGetCustomerAgeWithStub(t *testing.T) {
    stubCustomerService := stub.On(service, "GetCustomer").Return(&models.Customer{Age: 25}, nil)

    age, err := GetCustomerAge(1)
    assert.NoError(t, err)
    assert.Equal(t, 25, age)

    // 断言 Stub 是否被调用
    assert.True(t, stubCustomerService.Called())
}

通过使用 Mock 和 Stub，我们可以将函数与外部依赖项隔离，并验证它们在实际环境中的行为，从而提高函数测试的鲁棒性和可信度。