Go / 系统课时

完成项目测试体系改造

完成项目测试体系改造

一次有效的测试改造要把功能正确性、性能基线和异常输入验证放进同一条可持续链路,而不是临时补几个测试文件。本节用一个可运行的 Go 模块完成最小改造:先建立行为契约,再加入 benchmark 和 fuzz,最后用统一脚本形成质量门禁。

学习目标

  • 为已有函数补齐正常、边界和错误输入的功能测试
  • 用 benchmark 建立可重复采集的性能基线,并用 fuzz 验证异常输入性质
  • 把测试、竞态、覆盖率、基准和模糊测试组合成可持续执行的项目门禁

先确定需要守住的行为契约

假设项目已有一个“把用户输入规范化为 slug”的函数。改造前先写清楚契约:字母和数字保留,空格、下划线和连字符统一为单个 -,空输入与不支持字符返回错误;成功结果再次规范化时必须保持不变。功能测试验证明确样例,fuzz 验证大量未知输入下“不崩溃且成功结果幂等”,benchmark 则记录同一热路径的性能。

项目测试体系的质量证据闭环

补齐实现与三类测试

下面给出一个最小模块。以下三个文件均属于片段示例,依赖同一 Go 模块上下文,不能作为单文件独立执行;真正的执行命令与预期结果统一放在后面的门禁脚本中。slug/slug.go 是被测实现,slug/slug_test.go 同时包含表驱动测试、benchmark 和 fuzz target。

go.mod:

text
module example.com/qualitydemo

go 1.22

slug/slug.go:

go
package slug

import (
	"errors"
	"fmt"
	"strings"
	"unicode"
)

func Normalize(input string) (string, error) {
	s := strings.TrimSpace(strings.ToLower(input))
	if s == "" {
		return "", errors.New("empty input")
	}

	var b strings.Builder
	prevDash := false

	for _, r := range s {
		switch {
		case unicode.IsLetter(r) || unicode.IsDigit(r):
			b.WriteRune(r)
			prevDash = false
		case r == ' ' || r == '_' || r == '-':
			// 只在已有正文且前一个字符不是分隔符时写入连字符。
			if b.Len() > 0 && !prevDash {
				b.WriteByte('-')
				prevDash = true
			}
		default:
			return "", fmt.Errorf("unsupported character %q", r)
		}
	}

	out := strings.Trim(b.String(), "-")
	if out == "" {
		return "", errors.New("empty output")
	}
	return out, nil
}

slug/slug_test.go:

go
package slug

import "testing"

func TestNormalize(t *testing.T) {
	tests := []struct {
		name    string
		input   string
		want    string
		wantErr bool
	}{
		{name: "normal", input: " Go_Test Benchmark ", want: "go-test-benchmark"},
		{name: "dedupe separators", input: "a--b__c", want: "a-b-c"},
		{name: "empty", input: "  ", wantErr: true},
		{name: "only separators", input: "___", wantErr: true},
		{name: "unsupported", input: "bad!", wantErr: true},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got, err := Normalize(tt.input)
			if (err != nil) != tt.wantErr {
				t.Fatalf("Normalize(%q) error = %v, wantErr = %v", tt.input, err, tt.wantErr)
			}
			if !tt.wantErr && got != tt.want {
				t.Fatalf("Normalize(%q) = %q, want %q", tt.input, got, tt.want)
			}
		})
	}
}

func BenchmarkNormalize(b *testing.B) {
	for i := 0; i < b.N; i++ {
		if _, err := Normalize(" Go_Test Benchmark "); err != nil {
			b.Fatal(err)
		}
	}
}

func FuzzNormalize(f *testing.F) {
	f.Add(" Go_Test ")
	f.Add("a--b")
	f.Add("!")

	f.Fuzz(func(t *testing.T, input string) {
		got, err := Normalize(input)
		if err != nil {
			return
		}
		if got == "" {
			t.Fatal("successful normalization returned empty string")
		}

		// 成功结果必须满足幂等性,这是比枚举输入更稳定的性质。
		again, err := Normalize(got)
		if err != nil {
			t.Fatalf("normalized value %q failed again: %v", got, err)
		}
		if again != got {
			t.Fatalf("Normalize(%q) = %q, want idempotent result", got, again)
		}
	})
}

这些文件本身定义测试资产;是否改造成功,要通过实际运行结果验收,而不是只看测试文件数量。

用统一脚本完成验收

将下面脚本保存为 ci/quality-gate.sh。它先执行功能测试和竞态检查,再计算覆盖率;随后采集 benchmark 结果,最后对明确的 fuzz target 运行 5 秒主动模糊测试。项目扩大后,可以把后两项移到主干或定时任务,但命令仍应由仓库维护。

bash
#!/usr/bin/env bash
set -euo pipefail

go test ./...
go test -race ./...
go test -coverprofile=coverage.out ./...

coverage="$(go tool cover -func=coverage.out | awk '/^total:/ {gsub("%", "", $3); print $3}')"
awk -v c="$coverage" 'BEGIN { if (c + 0 < 80) exit 1 }'
printf 'coverage %s%% >= 80%%\n' "$coverage"

go test -run '^$' -bench '^BenchmarkNormalize$' -benchmem ./slug | tee bench-current.txt
go test -run '^$' -fuzz '^FuzzNormalize$' -fuzztime=5s ./slug

预期输出

text
ok   example.com/qualitydemo/slug   <TIME>s
ok   example.com/qualitydemo/slug   <TIME>s
ok   example.com/qualitydemo/slug   <TIME>s   coverage: <COVERAGE>% of statements
coverage <COVERAGE>% >= 80%
BenchmarkNormalize-<N>   <ITERATIONS>   <TIME> ns/op   <BYTES> B/op   <ALLOCS> allocs/op
PASS
fuzz: elapsed: <TIME>, execs: <N> (...)
PASS
ok   example.com/qualitydemo/slug   <TIME>s

<TIME>、<COVERAGE>、<N>、<ITERATIONS>、<BYTES> 和 <ALLOCS> 都是运行环境相关值,实际结果会不同。门禁成功的最低验收标准是所有测试返回零状态、覆盖率不低于项目阈值、race 不报告数据竞争、benchmark 能稳定产出结果、fuzz 在预算时间内没有触发崩溃或测试断言。

把一次改造变成长期机制

功能测试和 fuzz 发现的失败输入应留下来:表驱动测试中的业务回归样例直接进入 _test.go;fuzz 自动写出的失败语料保存在 testdata/fuzz/FuzzNormalize/ 后提交仓库。这样以后即使不主动 fuzz,普通 go test 也会回放这些语料。

性能基线要保存“可比较的原始结果”,而不是把某次 ns/op 写成永久硬阈值。固定 runner、相同 Go 版本和相同 benchmark 输入后,再比较多次样本;只有统计上稳定的回退才升级为阻断条件。至此,测试体系的关键不是某个工具,而是形成“发现缺陷 → 固化证据 → 自动回归 → 持续比较”的闭环。

按自己的节奏,确认真正理解。

目录与阅读设置

记录一个想法

完成项目测试体系改造

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通