Go TestMain 初始化失败后如何让测试退出

我遇到过一次很隐蔽的 CI 绿灯：测试输出里明明写着配置初始化失败，流水线却继续执行。检查后发现，TestMain 没有返回 error 的位置，失败分支只是打印日志后 return，测试进程没有拿到明确的非零退出码。

初始化失败时，不要从 TestMain 静默返回。先释放已经准备好的资源，再调用 os.Exit(1)；初始化成功后调用 m.Run()，保存它返回的退出码，清理资源后再退出。

为什么 TestMain 初始化失败后不能只写 return

Go 官方文档把 TestMain(m *testing.M) 定义为包级测试的 setup/teardown 入口。正常路径应该围绕 m.Run() 展开；它返回的整数就是应该交给 os.Exit 的测试结果。这个回调本身没有 error 返回值，所以“初始化失败后 return”并不会自动把错误传给 go test。

更麻烦的是，生成的测试包装程序在 TestMain 返回后仍需要一个退出结果。也就是说，日志里出现失败并不等于 shell 能看到失败。CI 真正关心的是进程退出码。

把初始化错误变成明确的非零退出码

我更愿意让初始化函数只负责准备资源，并返回一个可调用的清理函数。这样失败发生在半途时，可以在初始化函数内部处理部分资源；TestMain 只负责决定退出路径。

package example_test

import (
    "flag"
    "fmt"
    "os"
    "testing"
)

// initResources 只准备测试依赖；半途失败时应自行回滚已创建的资源。
func initResources() (func(), error) {
    // 这里替换成配置读取、临时目录、测试服务等初始化逻辑。
    cleanup := func() { fmt.Fprintln(os.Stderr, "cleanup test resources") }
    return cleanup, nil
}

func TestMain(m *testing.M) {
    // TestMain 中若读取命令行参数，要显式解析 flag。
    flag.Parse()

    cleanup, err := initResources()
    if err != nil {
        fmt.Fprintln(os.Stderr, "test init failed:", err)
        // os.Exit 不会执行 defer，所以失败路径也要显式清理。
        if cleanup != nil {
            cleanup()
        }
        os.Exit(1)
    }

    // 保存测试结果，清理完成后把原始结果交给测试进程。
    code := m.Run()
    cleanup()
    os.Exit(code)
}

这里的关键不是把所有错误都写成 1，而是把不同阶段分开：依赖准备失败属于入口失败，用固定的非零值阻断流水线；测试用例失败则保留 m.Run() 的结果。若初始化函数在返回错误时已经创建了资源，应在它内部完成回滚，避免 TestMain 拿到一个不完整的 cleanup。

成功、测试失败和初始化失败要怎样区分

可以用一张小表检查退出路径。尤其不要在 m.Run() 后无条件写 os.Exit(0)，那会把失败测试伪装成成功。

排查时我会把错误写到标准错误，并在 CI 中直接观察命令状态，而不是只搜索日志关键字：

# 用 shell 保存 go test 的真实退出码，避免只看日志颜色。
go test ./...
status=$?
echo "go test exit code: $status"
test "$status" -eq 0

如果初始化失败时仍然返回 0，优先检查失败分支是否只是 return，以及是否有统一的 defer 在函数结束时把错误吞掉。若测试失败却返回 0，通常是 m.Run() 的结果没有保存，或后面的固定退出语句覆盖了它。

常见问题

TestMain 一定要调用 os.Exit 吗？

不是。最小场景可以直接调用 m.Run()，但需要在清理后保留它的退出码时，显式保存并退出更清楚。

为什么不能只依赖 defer 清理资源？

因为 os.Exit 不会执行当前 goroutine 中尚未运行的 defer。要么让初始化函数在失败时回滚，要么在两条退出路径中显式调用 cleanup。

初始化失败时能不能继续执行测试？

如果测试依赖没有建立，继续执行往往只会制造更多噪声。应先返回明确的非零退出码；只有初始化是可选能力时，才把它设计成测试内部可感知的降级分支。