Go / 系统课时

使用子测试定位用例

使用子测试定位用例

表驱动测试把多组场景集中到一个测试函数后,如果只在循环里直接断言,失败仍会归到同一个测试名下。本课使用 t.Run 为每个场景建立子测试,让输出包含场景名称,并支持用 -run 精确筛选某一组用例。

学习目标

  • 能使用 t.Run 为测试场景命名并分组
  • 能从 go test -v 输出中快速定位失败的子测试
  • 能使用 -run 只执行指定测试或指定子测试

用 t.Run 给每个场景一个名字

t.Run(name, func(t *testing.T) {...}) 会在父测试下面创建一个独立子测试。它不会改变被测逻辑,但会改变测试报告的粒度,因此特别适合与表驱动测试配合。

下面的示例把字符串规范化场景写入测试表,并用 name 字段作为子测试名称。场景名应描述行为或输入特征,而不是写成 case1、case2 这种需要回头查表才能理解的编号。

go
package normalize

import (
	"strings"
	"testing"
)

func normalize(s string) string {
	return strings.ToLower(strings.TrimSpace(s))
}

func TestNormalize(t *testing.T) {
	tests := []struct {
		name  string
		input string
		want  string
	}{
		{name: "trim spaces", input: "  Go  ", want: "go"},
		{name: "lowercase", input: "GOPHER", want: "gopher"},
		{name: "empty", input: "   ", want: ""},
	}

	for _, tt := range tests {
		// 固定当前迭代值,避免闭包意外引用到其他用例。
		tt := tt
		// name 同时用于测试报告和 -run 筛选,因此使用稳定的行为名称。
		t.Run(tt.name, func(t *testing.T) {
			got := normalize(tt.input)
			if got != tt.want {
				t.Fatalf("normalize(%q) = %q, want %q", tt.input, got, tt.want)
			}
		})
	}
}

预期结果:将代码保存为 normalize_test.go 后执行详细模式,父测试和每个子测试都会单独显示;实际耗时会不同。

bash
go test -v normalize_test.go

预期输出

text
=== RUN   TestNormalize
=== RUN   TestNormalize/trim_spaces
=== RUN   TestNormalize/lowercase
=== RUN   TestNormalize/empty
--- PASS: TestNormalize (<TIME>)
    --- PASS: TestNormalize/trim_spaces (<TIME>)
    --- PASS: TestNormalize/lowercase (<TIME>)
    --- PASS: TestNormalize/empty (<TIME>)
PASS
ok  	command-line-arguments	<TIME>

Go 会把子测试名称中的空格转换为下划线,因此输出中看到的是 trim_spaces。命名应保持短小且稳定,因为这些名称还会用于筛选执行和 CI 日志定位。

用 -run 精确筛选失败场景

-run 接收正则表达式,并按斜杠分隔测试层级。只想运行 TestNormalize 下的 empty 子测试时,可以直接指定父测试和子测试名称。

bash
go test -v -run '^TestNormalize$/^empty$' normalize_test.go

预期输出

text
=== RUN   TestNormalize
=== RUN   TestNormalize/empty
--- PASS: TestNormalize (<TIME>)
    --- PASS: TestNormalize/empty (<TIME>)
PASS
ok  	command-line-arguments	<TIME>

这类筛选非常适合复现 CI 中的单个失败场景。若只写父测试表达式,会运行其全部子测试;若表达式过宽,也可能匹配其他测试,因此在精确复现时应给出完整层级。

子测试边界与循环变量

示例中的 tt := tt 会为当前循环迭代创建独立变量。在 Go 1.22 及之后,range 变量按迭代重新创建,这个写法通常不再是必须的;保留它仍能清楚表达“闭包只使用当前用例”的意图,并兼容较旧的 Go 版本。

当子测试内部调用 t.Parallel() 时,循环变量、共享缓冲区和外部可变状态尤其需要谨慎。并行子测试应尽量只读取当前用例数据,避免多个子测试同时修改同一对象,否则失败会从“可定位”变成“偶发且难复现”。

什么时候应该拆成子测试

只要多个场景共享父级准备逻辑,但希望分别展示状态、单独筛选或独立并行,就适合使用子测试。反过来,如果场景之间没有共同结构,拆成多个顶层 TestXxx 往往更直接。

t.Run 的价值不在于增加层级,而在于让测试报告的名称与业务场景对齐。配合稳定的场景名和 -run,一次失败可以直接定位到具体输入,而不必先从整个测试函数中人工搜索。

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

目录与阅读设置

记录一个想法

使用子测试定位用例

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

登录哪都通