Go 测试怎样自动清理临时资源

Go 测试里最容易被忽略的不是断言，而是测试结束后的现场。临时文件留在系统目录、测试服务没有停止、环境变量被后一个测试继承，都会让本地测试和 CI 变得不稳定。

最小的做法是：临时目录优先使用 t.TempDir()，需要自己释放的文件、服务或连接则用 t.Cleanup() 登记清理函数。这样清理责任跟着测试生命周期走，不需要在每个失败分支里手写重复的回收代码。

官方资料：https://pkg.go.dev/testing

只要资源的生命周期不超过当前测试，就让 testing.T 持有清理责任；只有需要跨测试共享的资源，才放到更高层管理。

先把临时目录交给测试框架

t.TempDir() 返回一个测试专属的临时目录。目录会在当前测试及其子测试结束后自动移除，每次调用还会得到不同的目录。对于导入文件、缓存片段和测试生成物，这是比固定路径更稳妥的默认选择。

下面的例子把输入文件写到测试目录中。代码不关心系统临时目录的具体路径，因此在不同开发机和 CI 环境中都能保持一致。

package cleanup_test

import (
    "os"
    "path/filepath"
    "testing"
)

func TestReadConfig(t *testing.T) {
    // 目录由 testing.T 管理，测试和子测试结束后会自动删除。
    dir := t.TempDir()
    configPath := filepath.Join(dir, "config.txt")

    // 测试只关心文件内容，不把临时路径写死在仓库中。
    if err := os.WriteFile(configPath, []byte("mode=ci\n"), 0o600); err != nil {
        t.Fatalf("write config: %v", err)
    }

    data, err := os.ReadFile(configPath)
    if err != nil {
        t.Fatalf("read config: %v", err)
    }
    if string(data) != "mode=ci\n" {
        t.Fatalf("unexpected content: %q", data)
    }
}

这里没有调用 os.RemoveAll(dir)。如果再手动删除一次，通常不会带来收益，反而会让清理责任分散。对于单个临时文件，也可以把文件放进 t.TempDir()，统一由目录生命周期负责。

把文件和测试服务登记到 t.Cleanup

不是所有资源都由 TempDir 创建。例如测试可能启动一个本地 HTTP 服务、打开一个文件，或者创建一个带关闭方法的假客户端。这类资源在创建成功后，立即注册对应的清理函数。

func newTestFile(t *testing.T, name string) *os.File {
    t.Helper()

    // 文件位于测试专属目录，避免污染项目目录。
    path := filepath.Join(t.TempDir(), name)
    file, err := os.Create(path)
    if err != nil {
        t.Fatalf("create test file: %v", err)
    }

    // 注册成功后再登记清理，避免清理函数拿到无效句柄。
    t.Cleanup(func() {
        // 先关闭句柄，再由 TempDir 回收所在目录。
        if err := file.Close(); err != nil {
            t.Errorf("close test file: %v", err)
        }
    })
    return file
}

关键点是“创建成功后立即登记”。如果在创建资源和注册清理之间发生失败，资源就可能逃过回收。辅助函数还可以调用 t.Helper()，让失败位置更接近真正的测试调用点。

清理函数按后进先出执行

同一个测试注册多个清理函数时，执行顺序是后注册的先执行。这个规则适合处理有依赖关系的资源：先启动服务，再创建依赖服务的客户端，清理时就应该先关闭客户端，再停止服务。

func TestCleanupOrder(t *testing.T) {
    // 先注册底层服务的清理函数。
    t.Cleanup(func() {
        t.Log("stop server")
    })

    // 后注册客户端清理，因此客户端会先于服务关闭。
    t.Cleanup(func() {
        t.Log("close client")
    })
}

可以把注册顺序理解为一摞清理卡片：最后放上的卡片最先取走。不要在清理函数里依赖已经被更早执行的函数释放的对象；如果两个动作有明确依赖，先注册底层资源，再注册上层资源。

子测试中的资源不要越过边界

清理函数属于注册它的测试。父测试注册的清理函数会等父测试及其子测试都结束后执行；子测试自己注册的清理函数则在该子测试完成后执行。把资源创建放在实际使用它的层级，能避免并行子测试互相覆盖。

func TestCases(t *testing.T) {
    for _, name := range []string{"alpha", "beta"} {
        name := name
        t.Run(name, func(t *testing.T) {
            // 每个子测试都有独立目录，避免并行时共享临时文件。
            dir := t.TempDir()
            if err := os.WriteFile(filepath.Join(dir, "result"), []byte(name), 0o600); err != nil {
                t.Fatalf("write result: %v", err)
            }
        })
    }
}

如果资源确实需要被多个子测试共享，可以在父测试中创建，并由父测试注册清理；否则优先让每个子测试单独创建。特别是使用 t.Parallel() 时，不要让不同子测试写入同一个固定目录。

运行检查：用 go test 观察清理是否可重复

清理代码的目标不是打印很多日志，而是让测试重复运行时不依赖上一次留下的现场。可以先运行单个测试，再用竞态检测和重复执行观察是否存在共享状态。

# 先只运行资源清理相关测试，缩短反馈时间
go test ./... -run 'Test(ReadConfig|CleanupOrder|Cases)$' -count=1

# 重复运行同一组测试，避免偶然通过掩盖共享目录问题
go test ./... -run 'Test(ReadConfig|CleanupOrder|Cases)$' -count=20

# 并行测试涉及共享状态时，用竞态检测补充检查
go test -race ./...

如果重复运行后出现“文件已存在”或读取到上一次内容，优先检查是否使用了固定路径、包级变量或父测试共享目录。若清理函数本身报错，记录错误比静默忽略更有价值，但不要让清理函数再次修改测试主体正在验证的结果。

整理成可复用的测试资源辅助函数

当多个测试都需要同样的资源时，可以把“创建、登记、返回”封装为一个小辅助函数。辅助函数只负责生命周期，具体断言仍留在测试主体里，职责会更清楚。

type testResource struct {
    file *os.File
}

func newResource(t *testing.T) *testResource {
    t.Helper()

    // 先创建资源，成功后立即把关闭动作绑定到测试生命周期。
    file, err := os.CreateTemp(t.TempDir(), "input-")
    if err != nil {
        t.Fatalf("create resource: %v", err)
    }
    resource := &testResource{file: file}
    t.Cleanup(func() {
        // 清理函数只释放自己创建的资源，不隐藏业务断言失败。
        if err := resource.file.Close(); err != nil {
            t.Errorf("close resource: %v", err)
        }
    })
    return resource
}

可以用下面这张速查表决定放在哪里：

常见问题

t.TempDir 还需要手动 RemoveAll 吗？

通常不需要。它的目录由测试框架管理，测试及其子测试结束后会自动移除。只有资源并不位于这个目录，或者你需要在测试结束前主动删除某个对象时，才考虑额外清理。

清理函数里应该使用 t.Fatal 吗？

不建议把清理失败写成新的致命退出。清理阶段更适合用 t.Errorf 记录关闭失败，让测试结果包含这条信息，同时保留原始断言失败的上下文。

父测试和子测试各自调用 TempDir 会冲突吗？

不会。每次调用都会返回独立目录。真正需要避免的是把父测试生成的固定文件名当作所有子测试的共享输出，尤其是在并行子测试中。

总结

Go 测试自动清理临时资源可以归纳为三条：临时目录交给 t.TempDir()，手动创建的文件和服务在成功后立刻用 t.Cleanup() 登记，存在依赖关系的资源按“底层先注册、上层后注册”的顺序安排。这样即使断言失败，测试也会沿自己的生命周期回收现场，重复运行和 CI 执行都会更稳定。