Golang testing包中Test函数的命名规则

Go测试函数必须以大写Test开头后接大写字母,签名须为func TestXxx(t *testing.T),否则被静默忽略;子测试名无限制;TestMain是特例但需严格命名和签名。

Test函数名必须以Test开头

Go 的 testing 包只识别名称以 Test 为前缀、后跟**大写字母开头的驼峰式标识符**的函数。比如 TestAdd 合法,testAddTest_addTest123 都不会被 go test 执行。

这是硬性约定,不是配置项,不满足就直接被忽略——连编译错误都不会报,容易误以为测试“通过了”,其实是压根没跑。

  • Test 必须是大写 T,后面紧接一个大写字母(如 AHTTPURL
  • 函数签名必须是 func TestXxx(t *testing.T),参数名可以是任意合法标识符(t 是惯例,但 tt 也行),类型必须是 *testing.T
  • 不能有其他参数,不能返回值

子测试(t.Run)里的名字没有命名规则限制

TestXxx 函数内部调用 t.Run 定义的子测试,其字符串参数是纯描述性内容,不参与函数名解析,因此完全自由:

func TestHTTPClient(t *testing.T) {
    t.Run("timeout is set", func(t *testing.T) { /* ... */ })
    t.Run("when body is nil", func(t *testing.T) { /* ... */ })
    t.Run("GET /health returns 200", func(t *testing.T) { /* ... */ })
}

这些字符串只是用于输出和过滤(go test -run="TestHTTPClient/timeout"),不需符合 TestXXX 格式,也不区分大小写。

  • 子测试名中出现空格、斜杠、下划线、小写字母都完全没问题
  • 斜杠 / 会被 go test 解析为层级结构,影响 -run 过滤和输出缩进
  • 但注意:子测试名里不要用 \n 或控制字符,否则终端显示可能错乱

常见错误:Test+小写字母开头或含非法字符

以下函数定义看似合理,实则不会被发现:

func Testadd(t *testing.T) { ... }          // 小写 a → 被忽略
func Test_add(t *testing.T) { ... }         // 下划线 → 被忽略
func Test123(t *testing.T) { ... }          // 数字开头 → 被忽略
func TestAdd(t *testing.T) (int) { ... }    // 有返回值 → 编译失败
func TestAdd(t testing.T) { ... }           // 参数不是指针 → 编译失败

最隐蔽的问题是第一个:开发者写了 Testadd,运行 go test 显示 ok . 0.001s,误以为测试通过,实际一条都没执行。

  • go test -v 可看到实际运行了哪些测试;如果什么都没列出来,大概率是命名不合规
  • 编辑器(如 VS Code + Go extension)通常会在非法 Test 函数上标灰或提示 “not a test function”,但别依赖这个
  • CI 环境里更难察觉,建议加个简单检查脚本:用 go list -f '{{.TestGoFiles}}' . 确认测试文件被识别,再人工扫一眼函数名

TestMain 是特例,但也要遵守命名和签名

如果需要全局 setup/teardown,可定义 func TestMain(m *testing.M),它不受 TestXXX 命名约束,但名字必须**严格等于** TestMain,且参数类型必须是 *testing.M,否则会被当作普通测试函数处理(然后因签名不符而编译失败)。

它只允许在一个包里定义一次,且必须显式调用 m.Run(),否则所有测试都会卡住不执行。

  • 名字写成 TestmainTESTMAIN → 编译通过但无效,go test 仍会逐个跑普通 Test 函数
  • 忘记 os.Exit(m.Run()) → 测试结束后进程不退出,CI 可能超时
  • TestMain 不会出现在 -v 输出的测试列表中,它的日志需手动打印

Go 的测试发现机制极度简单粗暴:靠名字匹配 + 签名校验。没魔法,也没配置开关——写错一个字母,测试就静默消失。