Go testing.T.TempDir 怎么隔离文件测试的临时目录

文件型测试最容易留下两类隐患：多个测试把数据写进同一个目录，或者每个测试都自己创建目录、忘记清理。testing.T.TempDir 的用途就是把这段生命周期交给测试框架。每次调用都会得到一个新的临时目录，测试及其子测试结束后目录会自动删除；即使测试使用 t.Parallel()，也不应该因此改成共享目录。

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

最小写法是先取得目录，再把所有测试文件放到它下面。不要把当前工作目录、仓库里的固定 testdata/tmp 或系统临时目录直接当成共享写入点。

func TestConfigFile(t *testing.T) {
	// 测试框架负责创建目录，并在测试及其子测试完成后清理。
	dir := t.TempDir()
	configPath := filepath.Join(dir, "config.json")

	// 文件只属于当前测试，测试之间不会抢同一个路径。
	if err := os.WriteFile(configPath, []byte(`{"debug":true}`), 0o600); err != nil {
		t.Fatalf("写入配置文件失败: %v", err)
	}

	data, err := os.ReadFile(configPath)
	if err != nil {
		t.Fatalf("读取配置文件失败: %v", err)
	}
	if string(data) != `{"debug":true}` {
		t.Fatalf("配置内容不符合预期: %s", data)
	}
}

示例中的目录名不是测试契约的一部分，真正稳定的边界是“本测试拿到的目录”。因此断言文件内容和行为即可，不要把临时目录的绝对路径写死在断言里。

让文件路径从目录边界派生

隔离真正有效的前提，是被测函数接收的路径来自当前测试目录。可以把路径作为参数传入，而不是让生产代码偷偷写固定位置。

func TestStore(t *testing.T) {
	// 每个测试实例都从自己的根目录派生数据文件。
	root := t.TempDir()
	storePath := filepath.Join(root, "items", "store.json")
	if err := os.MkdirAll(filepath.Dir(storePath), 0o700); err != nil {
		t.Fatalf("创建数据目录失败: %v", err)
	}

	if err := saveStore(storePath, []byte(`{"items":1}`)); err != nil {
		t.Fatalf("保存测试数据失败: %v", err)
	}
}

这样做还有一个排错好处：失败时只需要检查当前测试的输入路径和清理前的目录结构。若测试函数会启动后台 goroutine，必须先让 goroutine 停止，再等待测试返回；不要把后台写入拖到清理之后。

检查子测试与 t.Parallel 的隔离关系

t.Parallel() 只改变调度，不会替你复制共享状态。每个并行子测试都应在自己的回调里调用 t.TempDir()，并把目录传给后续操作。

func TestReaders(t *testing.T) {
	for _, name := range []string{"a", "b"} {
		name := name
		t.Run(name, func(t *testing.T) {
			// 并行子测试各自拥有独立目录，避免文件名冲突。
			t.Parallel()
			dir := t.TempDir()
			path := filepath.Join(dir, "input.txt")
			if err := os.WriteFile(path, []byte(name), 0o600); err != nil {
				t.Fatalf("写入 %s 失败: %v", name, err)
			}
		})
	}
}

如果父测试先准备了一份只读样例，子测试可以读取它；但只要子测试会修改文件，就应复制到自己的 TempDir。特别要留意包级变量、共享缓存和固定文件名，它们仍然可能造成数据竞争或相互覆盖。

处理清理时机、失败行为与 GOTMPDIR

不要再为 TempDir 额外注册删除回调。官方约定是测试及其所有子测试完成后自动删除；目录创建失败时，TempDir 会直接终止当前测试。设置 GOTMPDIR 可以改变临时目录所在的上层位置，但不会改变“每次调用独立、测试结束清理”的语义。

最后检查三件事：测试是否只使用自己的目录，后台任务是否在测试返回前结束，断言是否依赖了随机目录名。满足这三个条件后，t.TempDir 才真正解决了文件测试的隔离问题。

相关问题

t.TempDir 和 os.MkdirTemp 有什么区别？

os.MkdirTemp 只负责创建目录，清理和失败处理要由调用方安排；t.TempDir 绑定测试生命周期，更适合测试专属文件。

同一个测试可以多次调用 t.TempDir 吗？

可以。每次调用都会返回新的目录，适合把不同资源的文件生命周期分开，但不要因此把目录路径写进固定断言。