补充测试用例

This commit is contained in:
2025-09-13 19:48:13 +08:00
parent ec2595a751
commit bd22e452d3
9 changed files with 353 additions and 117 deletions

View File

@@ -27,7 +27,7 @@ type Logger struct {
// 这是实现依赖注入的关键,在应用启动时调用一次。
func NewLogger(cfg config.LogConfig) *Logger {
// 1. 设置日志编码器
encoder := getEncoder(cfg.Format)
encoder := GetEncoder(cfg.Format)
// 2. 设置日志写入器 (支持文件和控制台)
writeSyncer := getWriteSyncer(cfg)
@@ -49,8 +49,8 @@ func NewLogger(cfg config.LogConfig) *Logger {
return &Logger{zapLogger.Sugar()}
}
// getEncoder 根据指定的格式返回一个 zapcore.Encoder。
func getEncoder(format string) zapcore.Encoder {
// GetEncoder 根据指定的格式返回一个 zapcore.Encoder。
func GetEncoder(format string) zapcore.Encoder {
encoderConfig := zap.NewProductionEncoderConfig()
encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder // 时间格式: 2006-01-02T15:04:05.000Z0700
encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder // 日志级别大写: INFO

View File

@@ -3,6 +3,7 @@ package logs_test
import (
"bytes"
"context"
"encoding/json"
"errors"
"strings"
"testing"
@@ -18,12 +19,8 @@ import (
// captureOutput 是一个辅助函数,用于捕获 logger 的输出到内存缓冲区
func captureOutput(cfg config.LogConfig) (*logs.Logger, *bytes.Buffer) {
var buf bytes.Buffer
// 使用一个简单的 Console Encoder 进行测试,方便断言字符串
encoderConfig := zap.NewDevelopmentEncoderConfig()
encoderConfig.EncodeTime = nil // 忽略时间,避免测试结果不一致
encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
encoderConfig.EncodeCaller = nil // 忽略调用者信息
encoder := zapcore.NewConsoleEncoder(encoderConfig)
encoder := logs.GetEncoder(cfg.Format)
writer := zapcore.AddSync(&buf)
@@ -31,29 +28,52 @@ func captureOutput(cfg config.LogConfig) (*logs.Logger, *bytes.Buffer) {
_ = level.UnmarshalText([]byte(cfg.Level))
core := zapcore.NewCore(encoder, writer, level)
// 在测试中我们直接操作 zap Logger而不是通过封装的 NewLogger以注入内存 writer
zapLogger := zap.New(core)
// 匹配 logs.go 中 NewLogger 的行为,添加调用者信息
zapLogger := zap.New(core, zap.AddCaller(), zap.AddCallerSkip(1))
logger := &logs.Logger{SugaredLogger: zapLogger.Sugar()}
return logger, &buf
}
func TestNewLogger(t *testing.T) {
t.Run("构造函数不会 panic", func(t *testing.T) {
// 测试 Console 格式
cfgConsole := config.LogConfig{Level: "info", Format: "console"}
assert.NotPanics(t, func() { logs.NewLogger(cfgConsole) })
t.Run("日志级别应生效", func(t *testing.T) {
// 1. 创建一个级别为 WARN 的 logger
logger, buf := captureOutput(config.LogConfig{Level: "warn", Format: "console"})
// 测试 JSON 格式
cfgJSON := config.LogConfig{Level: "info", Format: "json"}
assert.NotPanics(t, func() { logs.NewLogger(cfgJSON) })
// 2. 调用不同级别的日志方法
logger.Info("这条 info 日志不应被打印")
logger.Warn("这条 warn 日志应该被打印")
// 测试文件日志启用
// 不实际写入文件,只确保构造函数能正常运行
// 3. 断言输出
output := buf.String()
assert.NotContains(t, output, "这条 info 日志不应被打印")
assert.Contains(t, output, "这条 warn 日志应该被打印")
})
t.Run("JSON 格式应生效", func(t *testing.T) {
// 1. 创建一个格式为 JSON 的 logger
logger, buf := captureOutput(config.LogConfig{Level: "info", Format: "json"})
// 2. 打印一条日志
logger.Info("测试json输出")
// 3. 断言输出
output := buf.String()
// 验证它是否是合法的 JSON并且包含预期的键值对
var logEntry map[string]interface{}
// 注意:由于日志库可能会在行尾添加换行符,我们先 trim space
err := json.Unmarshal([]byte(strings.TrimSpace(output)), &logEntry)
assert.NoError(t, err, "日志输出应为合法的JSON")
assert.Equal(t, "INFO", logEntry["level"])
assert.Equal(t, "测试json输出", logEntry["msg"])
})
t.Run("文件日志构造函数不应 panic", func(t *testing.T) {
// 这个测试保持原样,只验证构造函数在启用文件时不会崩溃
// 注意:我们不在单元测试中实际写入文件
cfgFile := config.LogConfig{
Level: "info",
EnableFile: true,
FilePath: "test.log",
FilePath: "test.log", // 在测试环境中,这个文件不会被真正创建
}
assert.NotPanics(t, func() { logs.NewLogger(cfgFile) })
})
@@ -84,7 +104,7 @@ func TestGormLogger(t *testing.T) {
return sql, rows
}
t.Run("Slow Query", func(t *testing.T) {
t.Run("慢查询应记录为警告", func(t *testing.T) {
buf.Reset()
// 模拟一个耗时超过 200ms 的查询
begin := time.Now().Add(-300 * time.Millisecond)
@@ -96,7 +116,7 @@ func TestGormLogger(t *testing.T) {
assert.Contains(t, output, "SELECT * FROM users WHERE id = 1", "应包含 SQL 语句")
})
t.Run("Error Query", func(t *testing.T) {
t.Run("普通错误应记录为Error", func(t *testing.T) {
buf.Reset()
queryError := errors.New("syntax error")
gormLogger.Trace(ctx, time.Now(), fc, queryError)
@@ -106,8 +126,10 @@ func TestGormLogger(t *testing.T) {
assert.Contains(t, output, "[GORM] error: syntax error")
})
t.Run("Record Not Found Error is Skipped", func(t *testing.T) {
t.Run("当SkipErrRecordNotFound为true时应跳过RecordNotFound错误", func(t *testing.T) {
buf.Reset()
// 确保默认设置是 true
gormLogger.SkipErrRecordNotFound = true
// 错误必须包含 "record not found" 字符串以匹配 logs.go 中的判断逻辑
queryError := errors.New("record not found")
gormLogger.Trace(ctx, time.Now(), fc, queryError)
@@ -115,7 +137,24 @@ func TestGormLogger(t *testing.T) {
assert.Empty(t, buf.String(), "开启 SkipErrRecordNotFound 后record not found 错误不应产生任何日志")
})
t.Run("Normal Query", func(t *testing.T) {
t.Run("当SkipErrRecordNotFound为false时应记录RecordNotFound错误", func(t *testing.T) {
buf.Reset()
// 手动将 SkipErrRecordNotFound 设置为 false
gormLogger.SkipErrRecordNotFound = false
queryError := errors.New("record not found")
gormLogger.Trace(ctx, time.Now(), fc, queryError)
// 恢复设置,避免影响其他测试
gormLogger.SkipErrRecordNotFound = true
output := buf.String()
assert.NotEmpty(t, output, "关闭 SkipErrRecordNotFound 后record not found 错误应该产生日志")
assert.Contains(t, output, "ERROR")
assert.Contains(t, output, "[GORM] error: record not found")
})
t.Run("正常查询应记录为Debug", func(t *testing.T) {
buf.Reset()
// 模拟一个快速查询
gormLogger.Trace(ctx, time.Now(), fc, nil)