package logger import ( "strings" "testing" "time" "github.com/sirupsen/logrus" ) func newEntry(level logrus.Level, msg string, data logrus.Fields) *logrus.Entry { e := logrus.NewEntry(logrus.New()) e.Time = time.Date(2026, 5, 21, 10, 20, 30, 123_000_000, time.UTC) e.Level = level e.Message = msg e.Data = data return e } func TestFormat_DefaultModeUnchanged(t *testing.T) { f := &CustomFormatter{} // no template, no color entry := newEntry(logrus.InfoLevel, "hello", logrus.Fields{ "request_id": "req-1", "caller": "logger_test.go:1[Test]", "k1": "v1", }) out, err := f.Format(entry) if err != nil { t.Fatalf("Format returned error: %v", err) } got := string(out) if !strings.HasPrefix(got, "INFO ") { t.Errorf("expected INFO-prefixed default output, got %q", got) } for _, want := range []string{"2026-05-21 10:20:30.123", "req-1", "k1=v1", "logger_test.go:1[Test]", "hello"} { if !strings.Contains(got, want) { t.Errorf("default output missing %q: %s", want, got) } } if !strings.HasSuffix(got, "\n") { t.Errorf("default output should end with newline, got %q", got) } } func TestFormat_TemplateReplacesAllPlaceholders(t *testing.T) { f := &CustomFormatter{ Template: "[%d] %level %thread %logger %traceId | %msg", threadNeeded: true, } entry := newEntry(logrus.WarnLevel, "boom", logrus.Fields{ "request_id": "req-42", "caller": "x.go:9[Fn]", "extra": "ok", }) out, err := f.Format(entry) if err != nil { t.Fatalf("Format error: %v", err) } got := string(out) for _, want := range []string{ "[2026-05-21 10:20:30.123]", "WARNING", "x.go:9[Fn]", "req-42", "boom", "extra=ok", } { if !strings.Contains(got, want) { t.Errorf("template output missing %q: %s", want, got) } } for _, placeholder := range []string{"%d", "%level", "%thread", "%logger", "%traceId", "%msg"} { if strings.Contains(got, placeholder) { t.Errorf("placeholder %q not substituted: %s", placeholder, got) } } } func TestFormat_TemplateGoroutineIDSkippedWhenNotReferenced(t *testing.T) { // 模板未引用 %thread 时,threadNeeded 应为 false,运行时不应取 goroutine ID。 // 这里通过观察输出中不含数字-only goroutine ID 段来间接验证;更重要的是确保不 panic。 f := &CustomFormatter{ Template: "[%d] %level | %msg", threadNeeded: false, } entry := newEntry(logrus.InfoLevel, "no-thread", nil) if _, err := f.Format(entry); err != nil { t.Fatalf("Format error: %v", err) } } // TestFormat_ColorDoesNotPolluteMessage 是修复 colorize 误染 bug 的回归测试。 // 旧实现对整行做 ReplaceAll(line, "INFO", colored),会把消息正文里的 "INFO" // 一并染色;新实现只在 %level 替换位置注入颜色。 func TestFormat_ColorDoesNotPolluteMessage(t *testing.T) { f := &CustomFormatter{ ForceColor: true, Template: "%level | %msg", threadNeeded: false, } entry := newEntry(logrus.InfoLevel, "user INFO loaded", nil) out, err := f.Format(entry) if err != nil { t.Fatalf("Format error: %v", err) } got := string(out) // 输出中 ANSI 序列总数应恰好为 2(开头一对 color + reset), // 而非旧实现下消息里的 "INFO" 也被替换导致出现 4 段。 const ansiOpen = "\033[32m" // green for INFO const ansiReset = "\033[0m" if strings.Count(got, ansiOpen) != 1 { t.Errorf("expected exactly 1 green-open sequence, got %d in %q", strings.Count(got, ansiOpen), got) } if strings.Count(got, ansiReset) != 1 { t.Errorf("expected exactly 1 reset sequence, got %d in %q", strings.Count(got, ansiReset), got) } // 消息正文中的 "INFO" 字面串应保持未染色(其前驱字符不是 ANSI 开头)。 idx := strings.Index(got, "user INFO loaded") if idx < 0 { t.Fatalf("message body not found verbatim in output: %q", got) } } // TestFormat_TemplateNoCascadingReplace 验证使用 NewReplacer 单趟替换, // 字段值里含有占位符字面串(例如 traceId 值为 "%msg")时不会被二次替换。 func TestFormat_TemplateNoCascadingReplace(t *testing.T) { f := &CustomFormatter{ Template: "%traceId>%msg", threadNeeded: false, } entry := newEntry(logrus.InfoLevel, "actual-msg", logrus.Fields{ "request_id": "%msg", // 恶意/巧合的字段值 }) out, err := f.Format(entry) if err != nil { t.Fatalf("Format error: %v", err) } got := strings.TrimRight(string(out), "\n") want := "%msg>actual-msg" if got != want { t.Errorf("cascading-replace regression: got %q, want %q", got, want) } } func TestLevelColorFor(t *testing.T) { cases := map[logrus.Level]string{ logrus.DebugLevel: colorCyan, logrus.InfoLevel: colorGreen, logrus.WarnLevel: colorYellow, logrus.ErrorLevel: colorRed, logrus.FatalLevel: colorPurple, logrus.TraceLevel: "", } for lvl, want := range cases { if got := levelColorFor(lvl); got != want { t.Errorf("levelColorFor(%v) = %q, want %q", lvl, got, want) } } }