在线文档  >   Golang练习   >   单元测试和基准测试

单元测试是编写有原则的 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` 开头并带参数 `t *testing.T` 的函数就是一个测试。
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},
    }

    for _, tt := range tests {
        // t.Run 允许运行“子测试”,每个表格条目都有一个子测试。
        // 这些在执行 `go test -v` 时会分别显示。
        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