Go / 系统课时

测试文件系统交互

测试文件系统交互

文件系统测试最容易被真实目录、残留文件和机器差异污染。本课用 t.TempDir 创建独立临时目录,在其中完成写入、读取与断言,并验证子测试结束后目录已自动清理,让测试既接近真实 I/O,又保持可重复执行。

学习目标

  • 使用 t.TempDir 为每个测试建立隔离的文件系统边界
  • 对文件内容和错误进行可重复断言,不依赖固定绝对路径
  • 验证临时资源会随测试生命周期自动清理

把文件操作限制在临时目录

测试不应写入开发者桌面、项目根目录或固定的 /tmp/demo。这些位置可能已有同名文件,也可能因权限、并发测试或 CI 环境不同而失败。t.TempDir 会返回当前测试专属目录,并通过测试清理机制在测试结束后删除它。

因此,生产代码最好接收“目录或文件路径”作为参数,而不是在函数内部硬编码路径。测试只需要把临时目录传进去,就能控制全部副作用。

用受控数据完成写入与读取

下面的完整测试文件在子测试中创建临时目录,写入 report.txt,再读取并比较内容。父测试在子测试返回后检查目录是否已经被清理,因此同时覆盖了“读写正确”和“资源回收”两个边界。

go
package filestore

import (
	"errors"
	"io/fs"
	"os"
	"path/filepath"
	"testing"
)

func TestFileRoundTripAndCleanup(t *testing.T) {
	var tempDir string

	t.Run("write and read", func(t *testing.T) {
		tempDir = t.TempDir()
		path := filepath.Join(tempDir, "report.txt")
		want := []byte("status=ready\n")

		// 所有副作用都限制在当前子测试的临时目录中。
		if err := os.WriteFile(path, want, 0o600); err != nil {
			t.Fatalf("write report: %v", err)
		}

		got, err := os.ReadFile(path)
		if err != nil {
			t.Fatalf("read report: %v", err)
		}
		if string(got) != string(want) {
			t.Fatalf("content mismatch: got %q want %q", got, want)
		}
	})

	// 子测试结束时,t.TempDir 注册的清理逻辑已经执行。
	if _, err := os.Stat(tempDir); !errors.Is(err, fs.ErrNotExist) {
		t.Fatalf("temporary directory still exists: %v", err)
	}
}

预期结果

text
测试通过;子测试内可以正常读回 report.txt,子测试结束后临时目录不存在。

在包含该测试文件的 Go 模块中运行:

bash
go test -run TestFileRoundTripAndCleanup -v .

预期输出

text
=== RUN   TestFileRoundTripAndCleanup
=== RUN   TestFileRoundTripAndCleanup/write_and_read
--- PASS: TestFileRoundTripAndCleanup (<TIME>)
    --- PASS: TestFileRoundTripAndCleanup/write_and_read (<TIME>)
PASS
ok      <PATH>  <TIME>

<PATH> 是当前包路径,<TIME> 是实际执行耗时,不同环境会变化。

让断言关注业务结果

文件系统测试应优先检查业务可观察结果:目标文件是否存在、内容是否正确、权限或错误是否符合约定。不要把临时目录的随机名称、系统根路径或目录枚举顺序写进断言,否则测试会把环境实现细节误当成业务契约。

测试错误分支时,也应制造受控条件。例如需要验证“文件不存在”,就在临时目录中读取一个从未创建的文件,并用 errors.Is(err, fs.ErrNotExist) 判断错误类别,而不是比较操作系统相关的完整错误字符串。

避免留下跨测试状态

t.TempDir 适合绝大多数文件读写测试,因为它将创建和清理绑定到测试生命周期。需要预置多份文件时,可以在测试开始后写入固定内容;需要多个场景时,让每个子测试拥有自己的临时目录,避免一个场景修改的数据泄漏到另一个场景。

只有当被测逻辑必须访问真实挂载点、文件锁或操作系统特有能力时,才需要单独的集成测试环境。普通单元与组件测试应尽量把路径注入并收口到临时目录,这样本地、CI 和并发执行都能得到一致结果。

按自己的节奏,确认真正理解。

目录与阅读设置

记录一个想法

测试文件系统交互

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通