Golang 单元测试中的常见陷阱和如何避免？-Golang-PHP中文网

在 golang 单元测试中，常见的陷阱包括：1. 缺乏断言；2. 使用 t.error() 而不是 t.fail() 标记失败；3. 使用非确定性测试；4. 测试私有函数；5. 连续运行测试。避免这些陷阱的方法包括：1. 始终包含断言；2. 使用 t.fail() 标记失败；3. 隔离测试或使用模拟固定随机性；4. 将测试文件与私有函数放在同一包中；5. 限制测试运行次数。

Golang 单元测试中的常见陷阱和如何避免？

Golang 单元测试中的常见陷阱及避免方法

单元测试是确保代码准确性的关键，但在使用 Golang 进行单元测试时，存在一些常见的陷阱。本文将探讨这些陷阱并提供如何避免它们的指导。

陷阱 1：缺乏断言

Golang 中的测试函数没有隐式断言。这意味着，即使你的测试执行了预期的操作，如果没有明确断言，它仍然会被标记为通过。要避免此陷阱：

始终在测试中包含断言，以验证预期结果。
使用 assert 包中的断言函数，如 Equal() 和 True()。

import (
    "testing"
    "math/rand"
)

func TestSomething(t *testing.T) {
    rand.Seed(42) // 设置固定的随机数种子
    got := RandomNumber()
    want := 23
    t.Logf("Got: %v, Want: %v\n", got, want)
    require.Equal(t, want, got)
}

陷阱 2：使用 `t.Error()` 而不是 `t.Fail()`

t.Error() 将一条消息记录到测试日志中，但不会导致测试失败。t.Fail() 会导致测试失败并将其标记为错误。避免此陷阱：

使用 t.Fail() 标记测试失败，而不是 t.Error()。
仅当测试实际失败时才使用 t.Fail()。

func TestSomething(t *testing.T) {
    // ...
    if got != want {
        t.Fail() // 标记测试失败
    }
}

陷阱 3：使用非确定性测试

非确定性测试会根据外部因素进行变化，例如时间或网络连接。它们可能难以调试，应避免使用。如何避免此陷阱：

Golang Uber Dig

使用 uber-go/dig 在 Golang 中实现依赖注入——基于反射容器，提供 Provide/Invoke、dig.In/dig.Out 参数与结果对象，支持命名依赖等

下载

尽可能隔离测试，使它们不受外部因素影响。
通过设置种子或使用模拟来使随机性固定。

陷阱 4：测试私有函数

私有函数不在测试包之外可见，这可能会使单元测试变得困难。要避免此陷阱：

将测试文件放在同一包中，使它们可以访问私有函数。
使用 reflection 或依赖注入等技术来测试私有函数。

陷阱 5：连续运行测试

连续运行测试会导致代码覆盖率过高。要避免此陷阱：

将测试运行次数限制为必要的最少次数。
使用覆盖率工具来确保所有必要的分支都已覆盖。

实战案例

以下是一个实战案例，展示了如何避免单元测试中的陷阱：

package main

import (
    "errors"
    "testing"
)

func Div(a, b int) (int, error) {
    if b == 0 {
        return 0, errors.New("cannot divide by 0")
    }
    return a / b, nil
}

func TestDiv(t *testing.T) {
    tests := []struct {
        a, b int
        want int
    }{
        {21, 3, 7},
        {10, -2, -5},
        {42, 0, 0}, // 陷阱 1：没有断言
    }

    for _, tt := range tests {
        t.Run("div", func(t *testing.T) {
            got, err := Div(tt.a, tt.b)
            if err != nil {
                t.Fail() // 陷阱 2：使用 t.Fail() 标记失败
                return  // 陷阱 3：非确定性测试：不测试错误
            }
            require.Equal(t, tt.want, got) // 陷阱 5：连续运行测试
        })
    }
}