middleware_test.go

299 lines
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
package application

import (
	"bufio"
	"bytes"
	"fmt"
	"log"
	"net"
	"net/http"
	"net/http/httptest"
	"os"
	"strings"
	"testing"
)

func TestLoggingMiddleware_CapturesStatusCode(t *testing.T) {
	handler := LoggingMiddleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusNotFound)
	}))

	rec := httptest.NewRecorder()
	req := httptest.NewRequest("GET", "/test", nil)
	handler.ServeHTTP(rec, req)

	if rec.Code != http.StatusNotFound {
		t.Errorf("expected status 404, got %d", rec.Code)
	}
}

func TestLoggingMiddleware_DefaultStatus(t *testing.T) {
	// When handler does not call WriteHeader, status should default to 200
	var buf bytes.Buffer
	log.SetOutput(&buf)
	defer log.SetOutput(os.Stderr)

	handler := LoggingMiddleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		w.Write([]byte("ok"))
	}))

	rec := httptest.NewRecorder()
	req := httptest.NewRequest("GET", "/default", nil)
	handler.ServeHTTP(rec, req)

	if rec.Code != http.StatusOK {
		t.Errorf("expected status 200, got %d", rec.Code)
	}

	output := buf.String()
	if !strings.Contains(output, "200") {
		t.Errorf("log should contain status 200, got: %s", output)
	}
}

func TestLoggingMiddleware_ClientIPFromRemoteAddr(t *testing.T) {
	var buf bytes.Buffer
	log.SetOutput(&buf)
	defer log.SetOutput(os.Stderr)

	handler := LoggingMiddleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusOK)
	}))

	rec := httptest.NewRecorder()
	req := httptest.NewRequest("GET", "/test", nil)
	req.RemoteAddr = "192.168.1.1:12345"
	handler.ServeHTTP(rec, req)

	// In dev mode, the log won't include IP in the simple format,
	// but we verify the middleware ran without error.
	if rec.Code != http.StatusOK {
		t.Errorf("expected status 200, got %d", rec.Code)
	}
}

func TestLoggingMiddleware_XForwardedForFirstIP(t *testing.T) {
	t.Setenv("ENV", "production")

	var buf bytes.Buffer
	log.SetOutput(&buf)
	defer log.SetOutput(os.Stderr)

	handler := LoggingMiddleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusOK)
	}))

	rec := httptest.NewRecorder()
	req := httptest.NewRequest("GET", "/test", nil)
	req.Header.Set("X-Forwarded-For", "10.0.0.1, 10.0.0.2, 10.0.0.3")
	handler.ServeHTTP(rec, req)

	output := buf.String()
	if !strings.Contains(output, "10.0.0.1") {
		t.Errorf("expected log to contain first IP 10.0.0.1, got: %s", output)
	}
	if strings.Contains(output, "10.0.0.2") {
		t.Errorf("log should not contain proxy IP 10.0.0.2, got: %s", output)
	}
}

func TestLoggingMiddleware_XForwardedForSingleValue(t *testing.T) {
	t.Setenv("ENV", "production")

	var buf bytes.Buffer
	log.SetOutput(&buf)
	defer log.SetOutput(os.Stderr)

	handler := LoggingMiddleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusOK)
	}))

	rec := httptest.NewRecorder()
	req := httptest.NewRequest("GET", "/test", nil)
	req.Header.Set("X-Forwarded-For", "172.16.0.5")
	handler.ServeHTTP(rec, req)

	output := buf.String()
	if !strings.Contains(output, "172.16.0.5") {
		t.Errorf("expected log to contain single IP 172.16.0.5, got: %s", output)
	}
}

func TestLoggingMiddleware_ProductionJSON(t *testing.T) {
	t.Setenv("ENV", "production")

	var buf bytes.Buffer
	log.SetOutput(&buf)
	defer log.SetOutput(os.Stderr)

	handler := LoggingMiddleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusCreated)
	}))

	rec := httptest.NewRecorder()
	req := httptest.NewRequest("POST", "/api/items", nil)
	req.RemoteAddr = "1.2.3.4:9999"
	handler.ServeHTTP(rec, req)

	output := buf.String()
	// Production mode should output JSON with structured fields
	if !strings.Contains(output, `"method":"POST"`) {
		t.Errorf("expected JSON method field, got: %s", output)
	}
	if !strings.Contains(output, `"path":"/api/items"`) {
		t.Errorf("expected JSON path field, got: %s", output)
	}
	if !strings.Contains(output, `"status":201`) {
		t.Errorf("expected JSON status 201, got: %s", output)
	}
	if !strings.Contains(output, `"ip":"1.2.3.4:9999"`) {
		t.Errorf("expected JSON ip field, got: %s", output)
	}
}

func TestLoggingMiddleware_DevHumanReadable(t *testing.T) {
	t.Setenv("ENV", "development")

	var buf bytes.Buffer
	log.SetOutput(&buf)
	defer log.SetOutput(os.Stderr)

	handler := LoggingMiddleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusOK)
	}))

	rec := httptest.NewRecorder()
	req := httptest.NewRequest("GET", "/home", nil)
	handler.ServeHTTP(rec, req)

	output := buf.String()
	// Dev mode should be human-readable (not JSON)
	if strings.Contains(output, `"method"`) {
		t.Errorf("dev mode should not output JSON, got: %s", output)
	}
	if !strings.Contains(output, "GET") {
		t.Errorf("dev mode should contain method, got: %s", output)
	}
	if !strings.Contains(output, "/home") {
		t.Errorf("dev mode should contain path, got: %s", output)
	}
	if !strings.Contains(output, "200") {
		t.Errorf("dev mode should contain status code, got: %s", output)
	}
}

func TestResponseWriter_CapturesWriteHeader(t *testing.T) {
	rec := httptest.NewRecorder()
	rw := &responseWriter{ResponseWriter: rec, status: http.StatusOK}

	rw.WriteHeader(http.StatusForbidden)

	if rw.status != http.StatusForbidden {
		t.Errorf("expected captured status 403, got %d", rw.status)
	}
	if rec.Code != http.StatusForbidden {
		t.Errorf("expected underlying recorder status 403, got %d", rec.Code)
	}
}

// flusherRecorder is an httptest.ResponseRecorder that also implements http.Flusher.
type flusherRecorder struct {
	*httptest.ResponseRecorder
	flushed bool
}

func (f *flusherRecorder) Flush() {
	f.flushed = true
}

func TestResponseWriter_FlushDelegates(t *testing.T) {
	fr := &flusherRecorder{ResponseRecorder: httptest.NewRecorder()}
	rw := &responseWriter{ResponseWriter: fr, status: http.StatusOK}

	rw.Flush()

	if !fr.flushed {
		t.Error("expected Flush to delegate to underlying Flusher")
	}
}

func TestResponseWriter_FlushNoopWhenNotFlusher(t *testing.T) {
	// A plain ResponseWriter that does not implement http.Flusher
	rec := httptest.NewRecorder()
	// Wrap in a non-flusher wrapper
	rw := &responseWriter{ResponseWriter: nonFlusherWriter{rec}, status: http.StatusOK}

	// Should not panic
	rw.Flush()
}

type nonFlusherWriter struct {
	http.ResponseWriter
}

func TestResponseWriter_HijackError(t *testing.T) {
	rec := httptest.NewRecorder()
	rw := &responseWriter{ResponseWriter: rec, status: http.StatusOK}

	conn, brw, err := rw.Hijack()

	if err == nil {
		t.Error("expected error from Hijack when underlying writer does not support it")
	}
	if conn != nil {
		t.Error("expected nil conn")
	}
	if brw != nil {
		t.Error("expected nil bufio.ReadWriter")
	}
	if !strings.Contains(err.Error(), "http.Hijacker") {
		t.Errorf("error should mention http.Hijacker, got: %v", err)
	}
}

// hijackableWriter implements http.Hijacker for testing.
type hijackableWriter struct {
	http.ResponseWriter
	conn net.Conn
}

func (h *hijackableWriter) Hijack() (net.Conn, *bufio.ReadWriter, error) {
	rw := bufio.NewReadWriter(bufio.NewReader(h.conn), bufio.NewWriter(h.conn))
	return h.conn, rw, nil
}

func TestResponseWriter_HijackDelegates(t *testing.T) {
	server, client := net.Pipe()
	defer client.Close()

	hw := &hijackableWriter{
		ResponseWriter: httptest.NewRecorder(),
		conn:           server,
	}
	rw := &responseWriter{ResponseWriter: hw, status: http.StatusOK}

	conn, brw, err := rw.Hijack()
	if err != nil {
		t.Fatalf("unexpected error: %v", err)
	}
	if conn == nil {
		t.Error("expected non-nil conn")
	}
	if brw == nil {
		t.Error("expected non-nil bufio.ReadWriter")
	}

	// Write + read concurrently to avoid net.Pipe deadlock
	go func() {
		fmt.Fprint(brw, "hello")
		brw.Flush()
		server.Close()
	}()

	buf := make([]byte, 5)
	n, _ := client.Read(buf)
	got := string(buf[:n])
	if got != "hello" {
		t.Errorf("expected 'hello', got %q", got)
	}
}