Go中测试错误日志需捕获输出并验证关键错误细节,包括错误链、底层原因、结构化字段等;用bytes.Buffer重定向日志,结合testify/assert检查内容,mock错误场景,解析JSON验证字段。

在 Go 中测试错误日志记录,核心是捕获日志输出并验证其内容是否包含预期的错误信息、堆栈(如需)、上下文字段等。不能只测“有没有 log”,而要测“log 里有没有关键错误细节”。
使用 testify/assert + bytes.Buffer 捕获日志
Go 标准库 log 和主流日志库(如 zap、zerolog、logrus)都支持将输出重定向到任意 io.Writer。用 bytes.Buffer 是最轻量、最可控的方式:
- 初始化一个
buf := &bytes.Buffer{} - 把 logger 的输出设为该 buffer(例如:
log.SetOutput(buf)或zap.New(zapcore.NewCore(encoder, zapcore.AddSync(buf), level))) - 触发被测函数(含错误路径)
- 用
assert.Contains(t, buf.String(), "expected error message")验证关键文本
验证错误链与底层原因(Go 1.13+)
仅检查 err.Error() 输出可能遗漏根本原因。若日志中调用了 fmt.Errorf("failed to open file: %w", err),应确保日志里能体现原始错误(比如文件名、权限拒绝):
- 对标准
log:避免直接log.Printf("%v", err),改用log.Printf("%+v", err)(需配合github.com/pkg/errors或 Go 1.20+ 的fmt增强) - 对
zap:使用logger.Error("operation failed", zap.Error(err))—— 它会自动展开错误链并记录errorVerbose字段 - 测试时检查日志字符串是否包含
"permission denied"或具体文件路径等底层线索
注入可控制的错误以覆盖不同场景
不要依赖真实 I/O 或网络错误(难复现、不稳定)。用接口抽象 + mock 实现精准控制:
立即学习“go语言免费学习笔记(深入)”;
- 定义
type Reader interface { Read([]byte) (int, error) } - 在被测函数中接收该接口,而非硬编码
os.File - 测试时传入自定义 struct:
type mockReader struct{ err error }; func (m mockReader) Read(p []byte) (int, error) { return 0, m.err } - 分别传入
os.ErrNotExist、io.EOF、fmt.Errorf("timeout: %w", context.DeadlineExceeded),验证每种情况下日志是否含对应关键词
检查结构化日志字段(如用 zap/zerolog)
结构化日志不靠字符串匹配,而靠解析 JSON 输出或检查字段键值:
- 启用 JSON encoder:
zapcore.NewJSONEncoder(zapcore.EncoderConfig{...}) - 捕获 buffer 内容后,用
json.Unmarshal解析为map[string]interface{} - 断言关键字段存在且正确:
assert.Equal(t, "file_not_found", fields["error_type"])、assert.Contains(t, fields["error"].(string), "/tmp/missing.txt") - 对
zerolog,可用zerolog.New(&buf).With().Str("service", "api").Logger(),再用相同方式解析 JSON
不复杂但容易忽略:日志测试的关键不是“有没有打日志”,而是“日志有没有把人需要排查问题的信息,不多不少、准确清晰地吐出来”。










