登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  Golang >  Go教程

Go testing.TB.TempDir 如何隔离测试文件:生命周期、并发与清理顺序

来源:17golang原创

时间:2026-08-28 14:54:37 379浏览 收藏

CI 里偶尔出现一类很烦的失败:单测单独运行没问题,和其他测试一起跑却读到了上一轮留下的 JSON。根因通常不是断言,而是多个测试共用了一个固定目录。Go 的 testing.TB.TempDir 把目录创建、唯一命名和测试结束后的清理交给测试框架,正适合这类文件型测试。

要点速览
  • t.TempDir() 返回当前测试专属目录,目录在测试结束后自动清理。
  • 子测试和并发测试应在各自的测试上下文里获取目录,不要把一个固定路径分给所有用例。
  • 把目录路径传给被测函数,测试只校验结果;不要让业务代码猜测试目录。
  • 需要观察失败现场时,先理解清理时序,再决定是否临时复制证据。

先把固定目录问题复现出来

假设被测函数会把配置写到目录下的 result.json。下面这个测试把所有用例都指向 testdata/runtime,顺序一变就可能互相覆盖。这里先不急着改业务代码,先让测试暴露出“共享目录”这个变量。

func writeResult(dir string, value string) error {
    return os.WriteFile(filepath.Join(dir, "result.json"), []byte(value), 0o600)
}

func TestWriteResult(t *testing.T) {
    dir := filepath.Join("testdata", "runtime")
    if err := os.MkdirAll(dir, 0o755); err != nil {
        t.Fatal(err)
    }
    if err := writeResult(dir, "case-a"); err != nil {
        t.Fatal(err)
    }
    got, err := os.ReadFile(filepath.Join(dir, "result.json"))
    if err != nil {
        t.Fatal(err)
    }
    if string(got) != "case-a" {
        t.Fatalf("result = %q", got)
    }
}

这个例子还有一个隐藏成本:测试失败后,testdata/runtime 会留在仓库工作区,下一次运行继续读取它。文件内容即使正确,也不能证明测试之间没有耦合。

用 t.TempDir 建立测试专属目录

改造的关键只有一处:目录由 t.TempDir() 创建,再作为参数传入 writeResultTempDirtesting.TB 提供的测试辅助方法,因此在普通测试、基准测试和示例测试的兼容辅助代码里,都可以通过对应的测试对象取得目录。

func TestWriteResult(t *testing.T) {
    dir := t.TempDir()
    if err := writeResult(dir, "case-a"); err != nil {
        t.Fatal(err)
    }

    got, err := os.ReadFile(filepath.Join(dir, "result.json"))
    if err != nil {
        t.Fatal(err)
    }
    if string(got) != "case-a" {
        t.Fatalf("result = %q", got)
    }
}
Go testing.TB.TempDir 从固定目录切换到专属目录并完成 result.json 校验的控制台流程

运行 go test ./... 后,测试框架会在测试上下文结束时清理这个目录。这里的目录就是测试专属的隔离目录,测试代码不需要再写 os.RemoveAll,也不会把运行产物混进项目的 testdata

目录路径应该由谁负责

让测试负责准备目录,让业务函数只接收 dir string,边界会比较干净。这样生产代码不依赖 testing 包,测试也能明确控制输入位置。若函数内部偷偷拼接固定目录,TempDir 只能掩盖问题,不能真正隔离。

在子测试和并发测试里保持隔离

表驱动测试常常会进一步使用 t.Run。每个子测试都从自己的测试对象取得目录,避免把父测试创建的路径共享给多个并发分支。

func TestWriteResultCases(t *testing.T) {
    cases := []struct {
        name  string
        value string
    }{
        {name: "empty", value: ""},
        {name: "unicode", value: "订单-上海"},
    }

    for _, tc := range cases {
        tc := tc
        t.Run(tc.name, func(t *testing.T) {
            t.Parallel()
            dir := t.TempDir()
            if err := writeResult(dir, tc.value); err != nil {
                t.Fatal(err)
            }
            got, err := os.ReadFile(filepath.Join(dir, "result.json"))
            if err != nil {
                t.Fatal(err)
            }
            if string(got) != tc.value {
                t.Fatalf("result = %q, want %q", got, tc.value)
            }
        })
    }
}
Go t.Run 与 t.Parallel 为每个子测试分配 TempDir 并在测试结束后清理的生命周期

这里的核对点有两个:第一,tc := tc 让闭包捕获当前用例;第二,dir := t.TempDir() 必须位于子测试函数内部。若把目录放在父测试中,路径虽然只创建了一次,写入仍会重新产生竞争。

失败现场、清理时序和几个常见坑

失败时目录还在吗

不要把“测试失败时一定能看到目录”当成契约。TempDir 的职责是测试结束后清理;如果需要保留证据,应在断言失败前把关键文件复制到明确的诊断目录,或通过日志打印路径。诊断逻辑不能改变被测函数的目录参数。

为什么不能复用父测试的 TempDir

父测试目录适合放置所有子测试都只读的公共输入,但不适合承载每个子测试都会写入的结果文件。只要子测试可能并行,写入结果就应使用各自的 t.TempDir()

TempDir 能替代所有清理逻辑吗

它只负责测试目录本身。数据库连接、临时端口、环境变量和 goroutine 仍需要各自的清理方式,例如 t.Cleanup 或关闭函数。把不同资源都塞进一个目录,并不会自动关闭其他资源。

把这条边界固化进测试习惯

只要测试会写文件,优先让测试上下文创建目录,再把路径显式传给被测函数。单测先用 go test -run TestWriteResult 验证结果,再用 go test ./... 检查包之间的组合;如果并发模式下仍失败,优先排查是否还有固定路径、全局文件名或进程级缓存。

TempDir 的价值不在于少写一行删除代码,而在于把“谁拥有这个目录”说清楚:测试创建,函数使用,测试结束后由框架回收。这个边界稳定下来,文件测试才真正具备可重复运行的条件。

相关问题

t.TempDir 会在测试失败后自动删除吗

会。它的目录生命周期绑定测试上下文,测试结束后由测试框架清理;需要失败证据时,应在结束前复制到单独的诊断位置。

并发子测试能共用一个 TempDir 吗

可以共用只读输入,但不建议共用会写入的结果目录。使用各自子测试的 t.TempDir(),更容易保证文件名和内容互不覆盖。

TempDir 和手写 os.MkdirTemp 有什么区别

os.MkdirTemp 只负责创建目录,清理仍由调用方负责;t.TempDir() 还把清理注册到测试生命周期,适合测试代码的临时文件。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>