Golang 函数测试的最佳实践

Go 函数测试的最佳实践：定义明确的测试用例。使用表驱动的测试。覆盖边界条件。嘲笑依赖关系。使用 subtest。衡量测试覆盖率。

Go 函数测试的最佳实践

Go 中的函数测试对于确保代码可靠性至关重要。这里有一些最佳实践，可帮助您编写强大的函数测试：

1. 定义清晰的测试用例：
对于每个函数，明确定义要测试的行为和预期结果。这将帮助您专注于编写满足特定测试目的的测试。

2. 使用表驱动的测试：
表驱动的测试允许您使用一组输入值对函数进行多次调用。这有助于减少重复代码并提高可读性。

func TestSum(t *testing.T) {
    type testInput struct {
        a, b int
        want int
    }

    tests := []testInput{
        {1, 2, 3},
        {-5, 10, 5},
        {0, 0, 0},
    }

    for _, tt := range tests {
        got := Sum(tt.a, tt.b)
        if got != tt.want {
            t.Errorf("got: %d, want: %d", got, tt.want)
        }
    }
}

3. 覆盖边界条件：
除了测试正常情况外，还要测试输入的边界条件。这有助于发现边界情况下的潜在问题。

4. 嘲笑依赖关系：
如果函数依赖外部依赖关系，请使用 mocking 技术对这些依赖关系进行隔离。这确保我们测试的是函数本身，而不是其依赖关系。

import (
    "testing"

    "github.com/golang/mock/gomock"
)

func TestGetUserData(t *testing.T) {
    ctrl := gomock.NewController(t)
    defer ctrl.Finish()

    mockUserDataRepository := mock_user_data_repository.NewMockUserDataRepository(ctrl)
    userDataService := NewUserDataService(mockUserDataRepository)

    userID := 10
    expectedData := user_data.UserData{Name: "John Doe"}

    mockUserDataRepository.EXPECT().Get(userID).Return(expectedData, nil)

    data, err := userDataService.GetUserData(userID)
    if err != nil {
        t.Errorf("unexpected error: %v", err)
    }
    if data != expectedData {
        t.Errorf("unexpected data: %v", data)
    }
}

5. 使用 subtest：
较大的函数测试可以分解为较小的 subtest。这有助于组织代码并提高可读性。

func TestSort(t *testing.T) {
    t.Run("empty array", func(t *testing.T) {
        arr := []int{}
        arrayCopy := Sort(arr)
        if !reflect.DeepEqual(arr, arrayCopy) {
            t.Errorf("sorting empty array results in a new array")
        }
    })
}

6. 衡量测试覆盖率：
使用覆盖率工具衡量测试对代码的覆盖情况。这有助于识别未测试的代码路径并提高测试覆盖率。

通过遵循这些最佳实践，您可以编写更有效和可靠的 Go 函数测试。