package middleware import ( "net/http" "net/http/httptest" "testing" "github.com/gin-gonic/gin" "go.uber.org/zap" "go.uber.org/zap/zaptest/observer" ) // newObservedRouter 构建带请求日志中间件(观察器捕获)的测试引擎。 func newObservedRouter(t *testing.T) (*gin.Engine, *observer.ObservedLogs) { t.Helper() core, logs := observer.New(zap.InfoLevel) r := gin.New() r.Use(Logger(zap.New(core))) r.GET("/ping", func(c *gin.Context) { c.String(http.StatusOK, "pong") }) r.GET("/boom", func(c *gin.Context) { c.String(http.StatusInternalServerError, "err") }) return r, logs } // strField 从日志条目取字符串字段。 func strField(t *testing.T, e observer.LoggedEntry, key string) string { t.Helper() for _, f := range e.Context { if f.Key == key { return f.String } } t.Fatalf("日志缺少字段 %q", key) return "" } // intField 从日志条目取整型字段(zap.Int/Duration 存于 Integer)。 func intField(t *testing.T, e observer.LoggedEntry, key string) int64 { t.Helper() for _, f := range e.Context { if f.Key == key { return f.Integer } } t.Fatalf("日志缺少字段 %q", key) return 0 } // TestLogger_GeneratesTraceID 验证自动生成 trace_id 并回写响应头。 func TestLogger_GeneratesTraceID(t *testing.T) { r, logs := newObservedRouter(t) w := httptest.NewRecorder() req := httptest.NewRequest(http.MethodGet, "/ping", nil) r.ServeHTTP(w, req) if w.Code != http.StatusOK { t.Fatalf("状态码 = %d, 期望 200", w.Code) } traceID := w.Header().Get(TraceIDHeader) if len(traceID) != 16 { t.Errorf("响应头 X-Trace-Id = %q, 期望 16 字符 hex", traceID) } if logs.Len() != 1 { t.Fatalf("日志条数 = %d, 期望 1", logs.Len()) } e := logs.All()[0] if strField(t, e, "trace_id") != traceID { t.Errorf("日志 trace_id 与响应头不一致") } if intField(t, e, "status") != 200 { t.Errorf("日志 status = %d, 期望 200", intField(t, e, "status")) } if intField(t, e, "latency") <= 0 { t.Error("日志 latency 应大于 0") } if strField(t, e, "client_ip") == "" || strField(t, e, "method") == "" || strField(t, e, "path") == "" { t.Error("日志缺少 client_ip/method/path 字段") } } // TestLogger_PropagatesTraceID 验证上游 X-Trace-Id 透传一致。 func TestLogger_PropagatesTraceID(t *testing.T) { r, logs := newObservedRouter(t) w := httptest.NewRecorder() req := httptest.NewRequest(http.MethodGet, "/ping", nil) req.Header.Set(TraceIDHeader, "abc123def4567890") r.ServeHTTP(w, req) if got := w.Header().Get(TraceIDHeader); got != "abc123def4567890" { t.Errorf("X-Trace-Id 透传失败: %q", got) } if strField(t, logs.All()[0], "trace_id") != "abc123def4567890" { t.Error("日志应使用上游传入的 trace_id") } } // TestLogger_LevelByStatus 验证 5xx 走 Error 级别。 func TestLogger_LevelByStatus(t *testing.T) { r, logs := newObservedRouter(t) w := httptest.NewRecorder() r.ServeHTTP(w, httptest.NewRequest(http.MethodGet, "/boom", nil)) if logs.Len() != 1 || logs.All()[0].Level != zap.ErrorLevel { t.Errorf("5xx 请求应以 Error 级别记录,实际: %v", logs.All()) } if intField(t, logs.All()[0], "status") != 500 { t.Errorf("日志 status = %d, 期望 500", intField(t, logs.All()[0], "status")) } } // TestNewTraceID 验证追踪 ID 格式与唯一性。 func TestNewTraceID(t *testing.T) { seen := make(map[string]struct{}, 1000) for i := 0; i < 1000; i++ { id := NewTraceID() if len(id) != 16 { t.Fatalf("trace id 长度 = %d, 期望 16", len(id)) } if _, dup := seen[id]; dup { t.Fatalf("trace id 重复: %s", id) } seen[id] = struct{}{} } }