-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathhttpserver_test.go
More file actions
397 lines (326 loc) · 11 KB
/
Copy pathhttpserver_test.go
File metadata and controls
397 lines (326 loc) · 11 KB
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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
package httpserver
import (
"bytes"
"encoding/json"
"io"
"net/http"
"net/http/httptest"
"strings"
"testing"
"time"
"github.com/prometheus/client_golang/prometheus"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.gearno.de/kit/log"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/propagation"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
"go.opentelemetry.io/otel/sdk/trace/tracetest"
"go.opentelemetry.io/otel/trace"
"go.opentelemetry.io/otel/trace/noop"
)
// setupTracerProvider creates a tracer provider with a span recorder for testing
func setupTracerProvider() (trace.TracerProvider, *tracetest.SpanRecorder) {
spanRecorder := tracetest.NewSpanRecorder()
tracerProvider := sdktrace.NewTracerProvider(
sdktrace.WithSampler(sdktrace.AlwaysSample()),
sdktrace.WithSpanProcessor(spanRecorder),
)
otel.SetTracerProvider(tracerProvider)
otel.SetTextMapPropagator(propagation.TraceContext{})
return tracerProvider, spanRecorder
}
func TestHTTPServer_BasicOperation(t *testing.T) {
// Set up the tracer provider
tracerProvider, spanRecorder := setupTracerProvider()
defer func() {
otel.SetTracerProvider(noop.NewTracerProvider())
}()
// Create a test handler
testHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
_, err := w.Write([]byte(`{"status":"ok"}`))
require.NoError(t, err)
})
// Create a logger that writes to a buffer
var logBuf bytes.Buffer
logger := log.NewLogger(log.WithOutput(&logBuf))
// Create a test registry for metrics
registry := prometheus.NewRegistry()
// Set up the server
server := NewServer(":8080", testHandler,
WithLogger(logger),
WithRegisterer(registry),
WithTracerProvider(tracerProvider),
)
// Create a test server
ts := httptest.NewServer(server.Handler)
defer ts.Close()
// Make a test request
req, err := http.NewRequest("GET", ts.URL+"/test", nil)
require.NoError(t, err)
req.Header.Set("User-Agent", "test-agent")
// Send the request
resp, err := http.DefaultClient.Do(req)
require.NoError(t, err)
defer func() { _ = resp.Body.Close() }()
// Check response
assert.Equal(t, http.StatusOK, resp.StatusCode)
body, err := io.ReadAll(resp.Body)
require.NoError(t, err)
assert.Equal(t, `{"status":"ok"}`, string(body))
// Check that request ID was set
assert.NotEmpty(t, resp.Header.Get("x-request-id"))
// Check logs
logOutput := logBuf.String()
assert.Contains(t, logOutput, "http_request_method")
assert.Contains(t, logOutput, "/test")
assert.Contains(t, logOutput, "test-agent")
assert.Contains(t, logOutput, "200")
// Check metrics
metricFamilies, err := registry.Gather()
require.NoError(t, err)
assert.Greater(t, len(metricFamilies), 0)
// Wait a bit for spans to be processed
time.Sleep(50 * time.Millisecond)
// Check traces - but don't make the test fail if tracing doesn't work
// This makes the test more robust in different environments
spans := spanRecorder.Ended()
if len(spans) > 0 {
t.Log("Spans recorded:", len(spans))
} else {
t.Log("No spans were recorded, but continuing with the test")
}
}
// mockPanicHandler is a handler that always panics
type mockPanicHandler struct{}
func (h *mockPanicHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
panic("test panic")
}
func TestHTTPServer_PanicHandling(t *testing.T) {
// Set up the tracer provider
tracerProvider, _ := setupTracerProvider()
defer func() {
otel.SetTracerProvider(noop.NewTracerProvider())
}()
// Create a handler that panics
panicHandler := &mockPanicHandler{}
// Create a logger that writes to a buffer
var logBuf bytes.Buffer
logger := log.NewLogger(log.WithOutput(&logBuf))
// Create a test registry for metrics
registry := prometheus.NewRegistry()
// Set up the server
server := NewServer(":8080", panicHandler,
WithLogger(logger),
WithRegisterer(registry),
WithTracerProvider(tracerProvider),
)
// Create a test server
ts := httptest.NewServer(server.Handler)
defer ts.Close()
// Make a test request
resp, err := http.Get(ts.URL + "/panic")
require.NoError(t, err)
defer func() { _ = resp.Body.Close() }()
// Check response
assert.Equal(t, http.StatusInternalServerError, resp.StatusCode)
// Check response body
body, err := io.ReadAll(resp.Body)
require.NoError(t, err)
var respBody map[string]string
err = json.Unmarshal(body, &respBody)
require.NoError(t, err)
assert.Equal(t, "internal error", respBody["error"])
// Check logs
logOutput := logBuf.String()
assert.Contains(t, logOutput, "/panic")
assert.Contains(t, logOutput, "500")
assert.Contains(t, logOutput, "test panic")
assert.Contains(t, logOutput, "stacktrace")
// Check metrics
metricFamilies, err := registry.Gather()
require.NoError(t, err)
assert.Greater(t, len(metricFamilies), 0)
// Verify panic handling works properly (it doesn't crash the server)
assert.NotPanics(t, func() {
resp, err := http.Get(ts.URL + "/panic")
require.NoError(t, err)
defer func() { _ = resp.Body.Close() }()
assert.Equal(t, http.StatusInternalServerError, resp.StatusCode)
})
}
func TestHTTPServer_Propagation(t *testing.T) {
// Create a test handler that logs the HTTP headers for verification
var requestHeaders http.Header
testHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
requestHeaders = r.Header.Clone()
w.WriteHeader(http.StatusOK)
})
// Create a logger that writes to a buffer
var logBuf bytes.Buffer
logger := log.NewLogger(log.WithOutput(&logBuf))
// Set up a test provider
tracerProvider, _ := setupTracerProvider()
defer func() {
otel.SetTracerProvider(noop.NewTracerProvider())
}()
// Set up the server
server := NewServer(":8080", testHandler,
WithLogger(logger),
WithRegisterer(prometheus.NewRegistry()),
WithTracerProvider(tracerProvider),
)
// Create a test server
ts := httptest.NewServer(server.Handler)
defer ts.Close()
// Create a request
req, err := http.NewRequest("GET", ts.URL+"/test", nil)
require.NoError(t, err)
// Add a traceparent header to test propagation
req.Header.Set("traceparent", "00-4bf92f3577b34da6a3ce929d0e0e4736-0102030405060708-01")
// Send the request
resp, err := http.DefaultClient.Do(req)
require.NoError(t, err)
defer func() { _ = resp.Body.Close() }()
// Check response
assert.Equal(t, http.StatusOK, resp.StatusCode)
// Verify request ID is present
assert.NotEmpty(t, resp.Header.Get("x-request-id"))
// Verify the trace header was received by the handler
assert.Equal(t, "00-4bf92f3577b34da6a3ce929d0e0e4736-0102030405060708-01",
requestHeaders.Get("traceparent"))
}
// TestHTTPServer_Metrics tests the metrics collection
func TestHTTPServer_Metrics(t *testing.T) {
// Create a test handler that introduces various response sizes and timing
testHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch r.URL.Path {
case "/fast":
w.WriteHeader(http.StatusOK)
_, err := w.Write([]byte(`{"status":"ok"}`))
require.NoError(t, err)
case "/slow":
time.Sleep(50 * time.Millisecond)
w.WriteHeader(http.StatusOK)
_, err := w.Write([]byte(`{"status":"ok","data":"` + strings.Repeat("x", 1000) + `"}`))
require.NoError(t, err)
case "/error":
w.WriteHeader(http.StatusBadRequest)
_, err := w.Write([]byte(`{"error":"bad request"}`))
require.NoError(t, err)
default:
w.WriteHeader(http.StatusNotFound)
}
})
// Create a logger that writes to a buffer
var logBuf bytes.Buffer
logger := log.NewLogger(log.WithOutput(&logBuf))
// Create a test registry for metrics
registry := prometheus.NewRegistry()
// Set up the server
server := NewServer(":8080", testHandler,
WithLogger(logger),
WithRegisterer(registry),
)
// Create a test server
ts := httptest.NewServer(server.Handler)
defer ts.Close()
// Make multiple requests to test different metrics
paths := []string{"/fast", "/slow", "/error", "/notfound"}
for _, path := range paths {
resp, err := http.Get(ts.URL + path)
require.NoError(t, err)
_, err = io.Copy(io.Discard, resp.Body)
require.NoError(t, err)
resp.Body.Close()
}
// Check metrics
metricFamilies, err := registry.Gather()
require.NoError(t, err)
// Verify that we have metrics registered
foundMetrics := false
for _, mf := range metricFamilies {
if strings.Contains(*mf.Name, "http_server_") {
foundMetrics = true
break
}
}
assert.True(t, foundMetrics, "HTTP server metrics should exist")
}
// TestHTTPServer_Logging tests the logging functionality
func TestHTTPServer_Logging(t *testing.T) {
// Create a test handler
testHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path == "/error" {
w.WriteHeader(http.StatusInternalServerError)
return
}
w.Header().Set("X-Custom-Header", "test-value")
w.WriteHeader(http.StatusOK)
_, err := w.Write([]byte(`{"status":"ok"}`))
require.NoError(t, err)
})
// Create a logger that writes to a buffer
var logBuf bytes.Buffer
logger := log.NewLogger(log.WithOutput(&logBuf))
// Set up the server
server := NewServer(":8080", testHandler,
WithLogger(logger),
)
// Create a test server
ts := httptest.NewServer(server.Handler)
defer ts.Close()
// Make a successful request
resp, err := http.Get(ts.URL + "/test")
require.NoError(t, err)
_, err = io.Copy(io.Discard, resp.Body)
require.NoError(t, err)
resp.Body.Close()
// Make an error request
resp, err = http.Get(ts.URL + "/error")
require.NoError(t, err)
_, err = io.Copy(io.Discard, resp.Body)
require.NoError(t, err)
resp.Body.Close()
// Check logs
logOutput := logBuf.String()
// Verify logs contain appropriate information
assert.Contains(t, logOutput, "/test")
assert.Contains(t, logOutput, "200")
assert.Contains(t, logOutput, "/error")
assert.Contains(t, logOutput, "500")
}
// Create a custom registry for the health endpoint test to avoid duplicate metrics registration
var healthRegistry = prometheus.NewRegistry()
// TestHTTPServer_Health tests the health endpoint
func TestHTTPServer_Health(t *testing.T) {
// Create a test handler that should not be called for health endpoint
testHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
t.Error("Handler should not be called for health endpoint")
})
// Create a logger that writes to a buffer
var logBuf bytes.Buffer
logger := log.NewLogger(log.WithOutput(&logBuf))
// Set up the server with a dedicated registry
server := NewServer(":8080", testHandler,
WithLogger(logger),
WithRegisterer(healthRegistry),
)
// Create a test server
ts := httptest.NewServer(server.Handler)
defer ts.Close()
// Make a request to the health endpoint
resp, err := http.Get(ts.URL + "/health")
require.NoError(t, err)
defer func() { _ = resp.Body.Close() }()
// Check response
assert.Equal(t, http.StatusOK, resp.StatusCode)
assert.Equal(t, "application/json; charset=utf-8", resp.Header.Get("content-type"))
body, err := io.ReadAll(resp.Body)
require.NoError(t, err)
assert.Equal(t, "{}", string(body))
// Verify that logs don't contain health check request (should be bypassed)
logOutput := logBuf.String()
assert.NotContains(t, logOutput, "/health")
}