Go / 系统课时

管理 testdata 测试数据

管理 testdata 测试数据

当测试需要固定输入文件、协议样本或较长文本时,把数据直接塞进测试代码会降低可读性。本节使用 Go 约定的 testdata 目录保存资源,并建立不依赖仓库根目录的读取方式,让本地与 go test ./... 都能稳定复现。

学习目标

  • 使用 testdata 保存只服务于测试的固定输入与资源
  • 从测试代码可靠定位包内的 testdata 文件
  • 区分固定测试数据、临时文件与需要动态构造的数据

为什么使用 testdata

Go 工具链会忽略名为 testdata 的目录,不会把其中的普通文件当成待编译的 Go 包,因此它适合与 _test.go 文件放在同一个包目录中。测试数据与使用它的测试一起移动,也比依赖仓库根目录下的共享文件更容易维护。

常见内容包括 JSON 请求样本、解析器输入、证书测试文件以及预期固定资源。文件名应表达场景,例如 valid-user.json、invalid-header.txt,不要使用 1.txt 这类需要额外解释的名字。

从包内可靠读取文件

测试通常通过 go test 运行,此时可以让路径相对于当前被测试的包,而不是假设命令一定从仓库根目录启动。将路径拼装集中到辅助函数,还能在失败时立即报告具体文件。

下面的 normalize_test.go 是完整可运行示例。它读取 testdata/input.txt,压缩连续空白并验证结果:

go
package textutil

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

func normalize(s string) string {
    return strings.Join(strings.Fields(s), " ")
}

func readTestdata(t *testing.T, name string) []byte {
    t.Helper()
    // 路径只依赖当前包中的 testdata,不依赖仓库根目录。
    path := filepath.Join("testdata", name)
    data, err := os.ReadFile(path)
    if err != nil {
        t.Fatalf("read %s: %v", path, err)
    }
    return data
}

func TestNormalizeFromTestdata(t *testing.T) {
    input := string(readTestdata(t, "input.txt"))
    if got, want := normalize(input), "alpha beta gamma"; got != want {
        t.Fatalf("normalize() = %q, want %q", got, want)
    }
}

对应的 testdata/input.txt 内容为:

text
alpha   beta
gamma

在该包目录或仓库中运行测试:

bash
go test ./...

预期输出类似如下,包路径与耗时会因实际项目而不同:

text
ok  <PATH>  <TIME>

避免依赖调用者的工作目录

不要写成 ../../fixtures/input.txt,也不要先寻找仓库根目录再拼出共享路径。这类测试把包与外部目录结构绑定,包被移动、单独测试或复制到其他模块后很容易失效。

如果多个包确实需要同一份数据,应先判断它是否已经属于公共测试工具或生成逻辑。简单复制少量稳定样本往往比建立跨包隐式路径依赖更容易理解;大型公共语料则可以设计专门的测试辅助包或显式配置来源。

固定资源与临时数据分开

testdata 中的文件应具有确定内容,并随代码一起接受版本控制。测试若需要写文件,不要覆盖这些基准资源,而应复制到 t.TempDir() 返回的隔离目录后再操作。Go 会在测试结束时清理该目录,可以避免一次测试改变下一次测试的输入。

当输入只有几个简单字段时,直接在测试代码中构造通常更清晰;只有数据较长、需要保持原始格式或会被多个测试重复读取时,才值得放进 testdata。这样可以让测试数据既容易找到,又不会把文件系统依赖扩散到整个测试套件。

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

目录与阅读设置

记录一个想法

管理 testdata 测试数据

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

登录哪都通