Golden File 测试本质是比对文本快照，仅确认输出与 golden.txt 一字不差，不验证逻辑正确性；适合 CLI 帮助、YAML/JSON 模板等确定性输出，不适合含时间戳、随机 ID 等动态内容。
Golden File 测试本质是比对文本快照，不是“测试输出逻辑”
它不验证代码是否做对了事，只确认输出和上次保存的 golden.txt 是否一字不差。一旦格式、空格、换行、时间戳、随机 ID 变了，测试就炸——这不是 bug，是预期行为。
- 适合：CLI 命令帮助文案、生成的 YAML/JSON 配置模板、SQL 迁移脚本、OpenAPI spec 输出
- 不适合：含
time.Now()、uuid.NewString()、os.Getenv("HOST")的输出，除非你提前 stub 或清理 - 别把 Golden File 当单元测试用；它更像“版本控制下的输出存档”，每次变更都要人工确认差异
怎么写一个最小可运行的 Golden 测试（Go 1.21+）
不用第三方库，标准 testing 就够。核心就三步：读 golden、跑函数、比对结果。
- 把期望输出存在
testdata/example.golden（路径必须带testdata/，否则go test不打包） - 测试里用
os.ReadFile("testdata/example.golden")读基准，用你的函数生成实际输出 - 用
cmp.Equal(got, want)或直接bytes.Equal(got, want)比——别用strings.TrimSpace自作聪明，空行和缩进也是契约的一部分
func TestRenderConfig(t *testing.T) {want, _ := os.ReadFile("testdata/config.golden") got := RenderConfig(&Config{Port: 8080, Debug: true}) if !bytes.Equal(got, want) {t.Fatalf("output mismatch:n%s", cmp.Diff(string(want), string(got))) } }更新 Golden 文件时最容易手抖的三个地方
很多人写完发现测试挂了，第一反应是改代码，其实该更新 golden——但更新方式不对，会埋雷。
- 别手动编辑
testdata/*.golden：容易漏掉不可见字符（BOM、CRLF）、多删 / 少删空行 - 别用
go test -run=TestXxx -update这种“魔法 flag”：Go 标准库不支持，那是gotestsum或自定义 flag 的玩法，容易混淆 - 正确做法就一行命令：
go run -exec 'sh -c "go test -run TestRenderConfig | tail -n +2 > testdata/config.golden"' .，或者更稳：写个短脚本，先跑函数，再ioutil.WriteFile覆盖 golden
Windows 下换行符和 GOPATH 导致的“明明一样却报错”
Golden 文件在 Git 中默认按 LF 存储，但 Windows 上 os.Stdout 或某些模板引擎可能输出 CRLF，导致 bytes.Equal 失败。
立即学习 “go 语言免费学习笔记（深入）”；
- 统一用 LF：在
.gitattributes加testdata/**/*.golden text eol=lf - 检查你的渲染逻辑是否用了
fmt.Println（带换行）而非fmt.Fprint（无额外换行），后者更容易控制末尾 - 如果测试在 CI（Linux）通过，本地（Windows）失败，大概率是换行；加一行
t.Log("len:", len(got), "last byte:", got[len(got)-1])快速定位是不是r搞的鬼
Golden 文件不是银弹，它把“人眼确认输出”的动作延迟到了 git commit 前。每次 git diff 看到 testdata/ 变了，就得停下想：这个改动是功能演进，还是意外漂移？
