Go 示例: 测试和基准测试

单元测试是编写原则性 Go 程序的重要组成部分。testing 包提供了编写单元测试所需的工具,go test 命令运行测试。

为了演示,此代码位于 main 包中,但它可以是任何包。测试代码通常与它测试的代码位于同一个包中。

package main
import (
    "fmt"
    "testing"
)

我们将测试这个简单的整数最小值实现。通常,我们测试的代码会放在一个名为 intutils.go 的源文件中,它的测试文件将命名为 intutils_test.go

func IntMin(a, b int) int {
    if a < b {
        return a
    }
    return b
}

测试是通过编写以 Test 开头的函数来创建的。

func TestIntMinBasic(t *testing.T) {
    ans := IntMin(2, -2)
    if ans != -2 {

t.Error* 会报告测试失败,但会继续执行测试。t.Fatal* 会报告测试失败并立即停止测试。

        t.Errorf("IntMin(2, -2) = %d; want -2", ans)
    }
}

编写测试可能很重复,因此使用表驱动风格是惯用的,其中测试输入和预期输出列在一个表中,一个循环遍历它们并执行测试逻辑。

func TestIntMinTableDriven(t *testing.T) {
    var tests = []struct {
        a, b int
        want int
    }{
        {0, 1, 0},
        {1, 0, 0},
        {2, -2, -2},
        {0, -1, -1},
        {-1, 0, -1},
    }

t.Run 允许运行“子测试”,每个表条目一个。在执行 go test -v 时,这些将单独显示。

    for _, tt := range tests {
        testname := fmt.Sprintf("%d,%d", tt.a, tt.b)
        t.Run(testname, func(t *testing.T) {
            ans := IntMin(tt.a, tt.b)
            if ans != tt.want {
                t.Errorf("got %d, want %d", ans, tt.want)
            }
        })
    }
}

基准测试通常放在 _test.go 文件中,并以 Benchmark 开头命名。testing 运行器多次执行每个基准测试函数,在每次运行时增加 b.N,直到它收集到精确的测量值。

func BenchmarkIntMin(b *testing.B) {

通常,基准测试在一个循环中运行我们正在基准测试的函数 b.N 次。

    for i := 0; i < b.N; i++ {
        IntMin(1, 2)
    }
}

以详细模式运行当前项目中的所有测试。

$ go test -v
== RUN   TestIntMinBasic
--- PASS: TestIntMinBasic (0.00s)
=== RUN   TestIntMinTableDriven
=== RUN   TestIntMinTableDriven/0,1
=== RUN   TestIntMinTableDriven/1,0
=== RUN   TestIntMinTableDriven/2,-2
=== RUN   TestIntMinTableDriven/0,-1
=== RUN   TestIntMinTableDriven/-1,0
--- PASS: TestIntMinTableDriven (0.00s)
    --- PASS: TestIntMinTableDriven/0,1 (0.00s)
    --- PASS: TestIntMinTableDriven/1,0 (0.00s)
    --- PASS: TestIntMinTableDriven/2,-2 (0.00s)
    --- PASS: TestIntMinTableDriven/0,-1 (0.00s)
    --- PASS: TestIntMinTableDriven/-1,0 (0.00s)
PASS
ok      examples/testing-and-benchmarking    0.023s

运行当前项目中的所有基准测试。所有测试都在基准测试之前运行。bench 标志使用正则表达式过滤基准测试函数名称。

$ go test -bench=.
goos: darwin
goarch: arm64
pkg: examples/testing
BenchmarkIntMin-8 1000000000 0.3136 ns/op
PASS
ok      examples/testing-and-benchmarking    0.351s

下一个示例:命令行参数.