第11章：Testing

为什么 Testing 要把“通过”拆成不同证据

一个 test pass 只说明特定 setup/input/oracle 在当前运行成立。coverage 说明 statements 被执行，benchmark 衡量特定 workload，profile 解释成本落点，example 验证公开用法。把这些信号混成单一“质量分”会遗漏错误类别。

先预测：same-package 与 external test package 各能发现什么，100% statement coverage 是否代表所有 branches 正确，benchmark setup 应否计时，CPU profile 是否能解释 allocation，以及 example output 注释是否参与 test。

11.1 The go test Tool：按 package 构建测试 binary

go test 扫描 package 的 _test.go files，生成/编译 test binary，运行 Test/Benchmark/Example discovery。正常 source 与 test variants可能形成 internal/external packages；test result cache 只在 inputs/flags相容时复用。

go test ./...
go test -run '^TestReverse/spacing$' -count=1 ./word
go test -race -shuffle=on ./...

默认成功 output简洁，失败给 package和logs。-run是 regex过滤，-count=1可禁用 result cache用于重跑，-v显示测试名/logs。timeout、parallelism与环境依赖需明确；test 不应依赖运行顺序、当前时间、外网或全局 mutable leftovers。

11.2 Test Functions：inputs、oracle 与 failure context

Test function 名以 Test 开头并接 *testing.T。failure 用 Error/Errorf继续当前 test以收集更多独立断言，Fatal/Fatalf停止当前 goroutine的test；helper 调 t.Helper() 让位置指向 caller。Cleanup 注册资源回收，TempDir 管理临时目录。

func TestReverse(t *testing.T) {
    tests := []struct{ name, input, want string }{
        {"ascii", "hello world", "world hello"},
        {"single", "go", "go"},
        {"spaces", "a  b", "b  a"},
    }
    for _, test := range tests {
        t.Run(test.name, func(t *testing.T) {
            if got := ReverseWords(test.input); got != test.want {
                t.Fatalf("ReverseWords(%q) = %q; want %q", test.input, got, test.want)
            }
        })
    }
}

Randomized Testing：properties 与 reproducible seed

randomized test 生成大量 inputs并验证 property，例如 Decode(Encode(x)) == x、sort后有序且multiset不变。失败必须输出 seed/input以复现；generator覆盖domain边界，不把 random噪声当 coverage。independent slow implementation 可作 differential oracle。

Testing a Command：隔离 parse、run 与 process exit

command 应把 logic提取为 run(args, stdin, stdout, stderr) error，test 使用 bytes.Buffer/temp files，不 fork process即可检查 output/error。只有 exit code/signal/environment必须 end-to-end 时才启动 subprocess。main 负责把 error映射为 stderr/exit status，不在 library调用 os.Exit。

White-Box Testing 与 External Test Packages

same-package tests 可访问 unexported state，适合复杂 invariant或故障注入；external package x_test 只看 exported surface，揭示 API是否自洽。两者可并存：多数 behavior用 external，少量精确内部测试用 white-box。

Writing Effective Tests：失败信息是诊断接口

test 应小而独立，但按 behavior而非函数机械一一对应。优先测试边界、error、ownership、concurrency与 regression。failure message 给 operation/input/context/want/got，避免只写“failed”。比较 complex structs可输出 focused diff而非无意义 pointer addresses。

Avoiding Brittle Tests：断言 contract，不断言偶然 representation

不要依赖 map iteration、goroutine schedule、exact whitespace（除非就是 contract）、temporary path、current timezone、private field layout。time用 injected clock/deadline，concurrency用 synchronization而非 sleep。golden files适合 large stable output，但更新必须人工 review semantic diff。

11.3 Coverage：哪里执行过，不是哪里正确

Go coverage instrumentation 记录 statements execution，-coverprofile写 profile，go tool cover生成 function/text/HTML views。它帮助发现未触达 branches/error paths，但不能判断 assertions是否有力或 input space是否充分。

go test -coverprofile=coverage.out ./...
go tool cover -func=coverage.out
go tool cover -html=coverage.out -o coverage.html

跨 package integration coverage、subprocess、build tags可能需要额外配置。coverage threshold 可防明显退化，但不应鼓励 low-value tests；review 同时看 mutation/fault detection、failure diagnostics与重要 contracts。

11.4 Benchmark Functions：由 harness 校准 b.N

Benchmark 名以 Benchmark 开头并接 *testing.B。harness 自动选择 b.N，使测量足够长；loop内执行被测 operation。setup若不属于每次 operation，放 loop外或使用 timer controls；ReportAllocs输出 B/op与allocs/op。

func BenchmarkEncode(b *testing.B) {
    input := makeInput(1024)
    b.ReportAllocs()
    b.ResetTimer()
    for i := 0; i < b.N; i++ {
        output = Encode(input)
    }
}

用 sub-benchmarks比较 sizes/implementations，报告 bytes可算 throughput。benchmark结果受 CPU frequency、thermal、background load、toolchain影响；保存多次 samples，用 benchstat等统计比较，不凭单次小差异。优化后仍先通过 correctness tests。

11.5 Profiling：解释资源成本落在哪

CPU profile采样 on-CPU stacks，heap/allocation profile定位 retained/allocated memory，block/mutex profile看 synchronization waits。profile workload必须代表真实热点，先确认总量和采样窗口，再读 top/call graph/flame view。

go test -bench BenchmarkEncode -benchmem -cpuprofile cpu.out -memprofile mem.out ./codec
go tool pprof -top ./codec.test cpu.out
go tool pprof -http=:0 ./codec.test mem.out

profile是attribution，不自动给修复。先找dominant cost，理解call path与correctness constraints，做一项改变，再用相同 benchmark/workload复测。避免优化不在 profile中的漂亮代码。

11.6 Example Functions：可执行文档与 output oracle

Example function 名为 Example、ExampleType、ExampleType_Method 等，展示 public API。若包含 // Output: comment，go test执行并比较 stdout；// Unordered output:允许行顺序无关。无 output comment的 example只编译/展示，不执行比较。

func ExampleReverseWords() {
    fmt.Println(ReverseWords("hello world"))
    // Output:
    // world hello
}

example 保持短、deterministic、聚焦 common path；complex edge cases仍放 Test functions。不要依赖 network/time/random/map order。package docs中的example名称决定关联展示位置，运行失败说明文档与行为已漂移。

本章回顾：每种工具回答一个窄问题

1. go test 按 package构建测试 binary；table-driven/subtests让 case与 harness分离。
2. randomized test验证 properties，command test隔离process shell，white-box/external tests覆盖不同边界。
3. coverage 标出 executed statements，不证明 assertions、branches或interleavings正确。
4. Benchmark 校准 b.N并报告time/allocations；profile解释 CPU/memory/block成本归属。
5. Example 是 executable documentation，Output comment同时成为 regression oracle。

术语表