{{ message }}
Repository navigation
Expand file tree
/
Copy pathhandler_test.go
More file actions
610 lines (560 loc) · 17.6 KB
/
Copy pathhandler_test.go
File metadata and controls
610 lines (560 loc) · 17.6 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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
package handler_test
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/http/httptest"
"strings"
"testing"
handler "github.com/canpacis/handler"
)
// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------
// resetDefaults restores all package-level defaults that tests may overwrite.
// Call it via t.Cleanup so each sub-test starts clean.
func resetDefaults(t *testing.T) {
t.Helper()
t.Cleanup(func() {
handler.SetDefaultValidator(func(any) error { return nil })
handler.SetDefaultErrorWriter(handler.HTTPErrorWriter)
handler.SetDefaultPanicHandler(func(w http.ResponseWriter, r *http.Request, p any) {
panic(p) // restore default re-panic behaviour
})
})
}
func newGETRequest(t *testing.T) *http.Request {
t.Helper()
r, err := http.NewRequest(http.MethodGet, "/", nil)
if err != nil {
t.Fatalf("newGETRequest: %v", err)
}
return r
}
func newJSONRequest(t *testing.T, method string, body any) *http.Request {
t.Helper()
b, err := json.Marshal(body)
if err != nil {
t.Fatalf("newJSONRequest marshal: %v", err)
}
r, err := http.NewRequest(method, "/", bytes.NewReader(b))
if err != nil {
t.Fatalf("newJSONRequest: %v", err)
}
r.Header.Set("Content-Type", "application/json")
return r
}
// ---------------------------------------------------------------------------
// Of – core handler
// ---------------------------------------------------------------------------
type echoPayload struct {
Message string `json:"message"`
}
type echoResponse struct {
Echo string `json:"echo"`
}
func TestOf(t *testing.T) {
tests := []struct {
name string
method func(context.Context, *echoPayload) (*echoResponse, error)
buildRequest func(t *testing.T) *http.Request
wantStatus int
wantBodyJSON *echoResponse // non-nil → decode and compare
wantBodySubstr string // non-empty → check plain-text body
setupValidator func() // optional – called before ServeHTTP
}{
{
name: "happy path returns 200 with JSON body",
method: func(ctx context.Context, p *echoPayload) (*echoResponse, error) {
return &echoResponse{Echo: p.Message}, nil
},
buildRequest: func(t *testing.T) *http.Request {
return newJSONRequest(t, http.MethodPost, echoPayload{Message: "hello"})
},
wantStatus: http.StatusOK,
wantBodyJSON: &echoResponse{Echo: "hello"},
},
{
name: "nil response returns 204 No Content",
method: func(ctx context.Context, p *echoPayload) (*echoResponse, error) {
return nil, nil
},
buildRequest: func(t *testing.T) *http.Request {
return newJSONRequest(t, http.MethodPost, echoPayload{})
},
wantStatus: http.StatusNoContent,
},
{
name: "method error triggers error writer",
method: func(ctx context.Context, p *echoPayload) (*echoResponse, error) {
return nil, errors.New("something went wrong")
},
buildRequest: func(t *testing.T) *http.Request {
return newJSONRequest(t, http.MethodPost, echoPayload{})
},
wantStatus: http.StatusInternalServerError,
wantBodySubstr: "call method error",
},
{
name: "invalid JSON body triggers decode error",
method: func(ctx context.Context, p *echoPayload) (*echoResponse, error) {
return &echoResponse{Echo: "should not reach"}, nil
},
buildRequest: func(t *testing.T) *http.Request {
r, _ := http.NewRequest(http.MethodPost, "/", strings.NewReader("{bad json"))
r.Header.Set("Content-Type", "application/json")
return r
},
wantStatus: http.StatusInternalServerError,
wantBodySubstr: "decode payload error",
},
{
name: "validation failure triggers validate error",
method: func(ctx context.Context, p *echoPayload) (*echoResponse, error) {
return &echoResponse{Echo: p.Message}, nil
},
buildRequest: func(t *testing.T) *http.Request {
return newJSONRequest(t, http.MethodPost, echoPayload{Message: ""})
},
setupValidator: func() {
handler.SetDefaultValidator(func(v any) error {
if p, ok := v.(echoPayload); ok && p.Message == "" {
return errors.New("message is required")
}
return nil
})
},
wantStatus: http.StatusInternalServerError,
wantBodySubstr: "validate payload error",
},
{
name: "Content-Type header is set automatically",
method: func(ctx context.Context, p *echoPayload) (*echoResponse, error) {
return &echoResponse{Echo: "ct-test"}, nil
},
buildRequest: func(t *testing.T) *http.Request {
return newJSONRequest(t, http.MethodPost, echoPayload{Message: "ct-test"})
},
wantStatus: http.StatusOK,
},
{
name: "pre-set Content-Type is preserved",
method: func(ctx context.Context, p *echoPayload) (*echoResponse, error) {
// The handler should not overwrite a Content-Type already set by the method.
// We simulate that by having the method set the header via ResponseWriter.
return &echoResponse{Echo: "custom-ct"}, nil
},
buildRequest: func(t *testing.T) *http.Request {
return newJSONRequest(t, http.MethodPost, echoPayload{Message: "custom-ct"})
},
wantStatus: http.StatusOK,
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
resetDefaults(t)
if tc.setupValidator != nil {
tc.setupValidator()
}
h := handler.Of(tc.method)
w := httptest.NewRecorder()
h.ServeHTTP(w, tc.buildRequest(t))
if w.Code != tc.wantStatus {
t.Errorf("status = %d, want %d", w.Code, tc.wantStatus)
}
if tc.wantBodyJSON != nil {
var got echoResponse
if err := json.NewDecoder(w.Body).Decode(&got); err != nil {
t.Fatalf("decode response body: %v", err)
}
if got != *tc.wantBodyJSON {
t.Errorf("body = %+v, want %+v", got, *tc.wantBodyJSON)
}
}
if tc.wantBodySubstr != "" {
if body := w.Body.String(); !strings.Contains(body, tc.wantBodySubstr) {
t.Errorf("body %q does not contain %q", body, tc.wantBodySubstr)
}
}
})
}
}
// ---------------------------------------------------------------------------
// OfNoPayload
// ---------------------------------------------------------------------------
func TestOfNoPayload(t *testing.T) {
tests := []struct {
name string
method func(context.Context) (*echoResponse, error)
wantStatus int
wantBodyJSON *echoResponse
}{
{
name: "returns response without reading body",
method: func(ctx context.Context) (*echoResponse, error) {
return &echoResponse{Echo: "no-payload"}, nil
},
wantStatus: http.StatusOK,
wantBodyJSON: &echoResponse{Echo: "no-payload"},
},
{
name: "nil response returns 204",
method: func(ctx context.Context) (*echoResponse, error) {
return nil, nil
},
wantStatus: http.StatusNoContent,
},
{
name: "method error surfaces correctly",
method: func(ctx context.Context) (*echoResponse, error) {
return nil, errors.New("no-payload error")
},
wantStatus: http.StatusInternalServerError,
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
resetDefaults(t)
h := handler.OfNoPayload(tc.method)
w := httptest.NewRecorder()
h.ServeHTTP(w, newGETRequest(t))
if w.Code != tc.wantStatus {
t.Errorf("status = %d, want %d", w.Code, tc.wantStatus)
}
if tc.wantBodyJSON != nil {
var got echoResponse
if err := json.NewDecoder(w.Body).Decode(&got); err != nil {
t.Fatalf("decode response body: %v", err)
}
if got != *tc.wantBodyJSON {
t.Errorf("body = %+v, want %+v", got, *tc.wantBodyJSON)
}
}
})
}
}
// ---------------------------------------------------------------------------
// OfNoResponse
// ---------------------------------------------------------------------------
func TestOfNoResponse(t *testing.T) {
tests := []struct {
name string
method func(context.Context, *echoPayload) error
wantStatus int
wantBodySubstr string
}{
{
name: "successful call returns 204",
method: func(ctx context.Context, p *echoPayload) error {
return nil
},
wantStatus: http.StatusNoContent,
},
{
name: "method error surfaces correctly",
method: func(ctx context.Context, p *echoPayload) error {
return errors.New("no-response error")
},
wantStatus: http.StatusInternalServerError,
wantBodySubstr: "call method error",
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
resetDefaults(t)
h := handler.OfNoResponse(tc.method)
w := httptest.NewRecorder()
h.ServeHTTP(w, newJSONRequest(t, http.MethodPost, echoPayload{Message: "x"}))
if w.Code != tc.wantStatus {
t.Errorf("status = %d, want %d", w.Code, tc.wantStatus)
}
if tc.wantBodySubstr != "" {
if body := w.Body.String(); !strings.Contains(body, tc.wantBodySubstr) {
t.Errorf("body %q does not contain %q", body, tc.wantBodySubstr)
}
}
})
}
}
// ---------------------------------------------------------------------------
// OfAction
// ---------------------------------------------------------------------------
func TestOfAction(t *testing.T) {
tests := []struct {
name string
method func(context.Context) error
wantStatus int
}{
{
name: "successful action returns 204",
method: func(ctx context.Context) error { return nil },
wantStatus: http.StatusNoContent,
},
{
name: "action error returns 500",
method: func(ctx context.Context) error { return errors.New("action failed") },
wantStatus: http.StatusInternalServerError,
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
resetDefaults(t)
h := handler.OfAction(tc.method)
w := httptest.NewRecorder()
h.ServeHTTP(w, newGETRequest(t))
if w.Code != tc.wantStatus {
t.Errorf("status = %d, want %d", w.Code, tc.wantStatus)
}
})
}
}
// ---------------------------------------------------------------------------
// OfStream
// ---------------------------------------------------------------------------
func TestOfStream(t *testing.T) {
tests := []struct {
name string
method func(context.Context, *echoPayload, io.Writer) error
buildRequest func(t *testing.T) *http.Request
wantStatus int
wantBodySubstr string
}{
{
name: "streams content directly to response writer",
method: func(ctx context.Context, p *echoPayload, w io.Writer) error {
_, err := io.WriteString(w, "streamed: "+p.Message)
return err
},
buildRequest: func(t *testing.T) *http.Request {
return newJSONRequest(t, http.MethodPost, echoPayload{Message: "hello-stream"})
},
wantStatus: http.StatusOK,
wantBodySubstr: "streamed: hello-stream",
},
{
name: "method error surfaces correctly",
method: func(ctx context.Context, p *echoPayload, w io.Writer) error {
return errors.New("stream error")
},
buildRequest: func(t *testing.T) *http.Request {
return newJSONRequest(t, http.MethodPost, echoPayload{Message: "x"})
},
wantStatus: http.StatusInternalServerError,
wantBodySubstr: "call method error",
},
{
name: "invalid JSON body triggers decode error",
method: func(ctx context.Context, p *echoPayload, w io.Writer) error {
return nil
},
buildRequest: func(t *testing.T) *http.Request {
r, _ := http.NewRequest(http.MethodPost, "/", strings.NewReader("{bad"))
r.Header.Set("Content-Type", "application/json")
return r
},
wantStatus: http.StatusInternalServerError,
wantBodySubstr: "decode payload error",
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
resetDefaults(t)
h := handler.OfStream(tc.method)
w := httptest.NewRecorder()
h.ServeHTTP(w, tc.buildRequest(t))
if w.Code != tc.wantStatus {
t.Errorf("status = %d, want %d", w.Code, tc.wantStatus)
}
if tc.wantBodySubstr != "" {
if body := w.Body.String(); !strings.Contains(body, tc.wantBodySubstr) {
t.Errorf("body %q does not contain %q", body, tc.wantBodySubstr)
}
}
})
}
}
// ---------------------------------------------------------------------------
// OfActionStream
// ---------------------------------------------------------------------------
func TestOfActionStream(t *testing.T) {
tests := []struct {
name string
method func(context.Context, io.Writer) error
wantStatus int
wantBodySubstr string
}{
{
name: "writes streamed content without payload",
method: func(ctx context.Context, w io.Writer) error {
_, err := io.WriteString(w, "action-stream-ok")
return err
},
wantStatus: http.StatusOK,
wantBodySubstr: "action-stream-ok",
},
{
name: "method error surfaces correctly",
method: func(ctx context.Context, w io.Writer) error {
return errors.New("action-stream error")
},
wantStatus: http.StatusInternalServerError,
wantBodySubstr: "call method error",
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
resetDefaults(t)
h := handler.OfActionStream(tc.method)
w := httptest.NewRecorder()
h.ServeHTTP(w, newGETRequest(t))
if w.Code != tc.wantStatus {
t.Errorf("status = %d, want %d", w.Code, tc.wantStatus)
}
if tc.wantBodySubstr != "" {
if body := w.Body.String(); !strings.Contains(body, tc.wantBodySubstr) {
t.Errorf("body %q does not contain %q", body, tc.wantBodySubstr)
}
}
})
}
}
// ---------------------------------------------------------------------------
// SetDefaultErrorWriter
// ---------------------------------------------------------------------------
func TestSetDefaultErrorWriter(t *testing.T) {
tests := []struct {
name string
errorWriter handler.ErrorWriter
wantStatus int
wantBodySubstr string
}{
{
name: "custom error writer controls status and body",
errorWriter: func(w http.ResponseWriter, r *http.Request, err error) error {
w.WriteHeader(http.StatusBadRequest)
_, e := io.WriteString(w, `{"error":"`+err.Error()+`"}`)
return e
},
wantStatus: http.StatusBadRequest,
wantBodySubstr: `"error"`,
},
{
name: "default error writer returns 500",
errorWriter: handler.HTTPErrorWriter,
wantStatus: http.StatusInternalServerError,
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
resetDefaults(t)
handler.SetDefaultErrorWriter(tc.errorWriter)
h := handler.Of(func(ctx context.Context, p *echoPayload) (*echoResponse, error) {
return nil, errors.New("forced error")
})
w := httptest.NewRecorder()
h.ServeHTTP(w, newJSONRequest(t, http.MethodPost, echoPayload{}))
if w.Code != tc.wantStatus {
t.Errorf("status = %d, want %d", w.Code, tc.wantStatus)
}
if tc.wantBodySubstr != "" {
if body := w.Body.String(); !strings.Contains(body, tc.wantBodySubstr) {
t.Errorf("body %q does not contain %q", body, tc.wantBodySubstr)
}
}
})
}
}
// ---------------------------------------------------------------------------
// SetDefaultPanicHandler
// ---------------------------------------------------------------------------
func TestSetDefaultPanicHandler(t *testing.T) {
tests := []struct {
name string
panicValue any
wantRecovered any
}{
{
name: "panic handler receives the panicked value",
panicValue: "something exploded",
wantRecovered: "something exploded",
},
{
name: "panic handler receives error values",
panicValue: errors.New("panic error"),
wantRecovered: errors.New("panic error"),
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
resetDefaults(t)
var recovered any
handler.SetDefaultPanicHandler(func(w http.ResponseWriter, r *http.Request, p any) {
recovered = p
w.WriteHeader(http.StatusInternalServerError)
})
h := handler.Of(func(ctx context.Context, p *echoPayload) (*echoResponse, error) {
panic(tc.panicValue)
})
w := httptest.NewRecorder()
h.ServeHTTP(w, newJSONRequest(t, http.MethodPost, echoPayload{}))
if recovered == nil {
t.Fatal("panic handler was not called")
}
// Compare string representations for simplicity (covers both string and error).
if fmt.Sprint(recovered) != fmt.Sprint(tc.wantRecovered) {
t.Errorf("recovered = %v, want %v", recovered, tc.wantRecovered)
}
})
}
}
// ---------------------------------------------------------------------------
// ResponseWriter helper
// ---------------------------------------------------------------------------
func TestResponseWriter(t *testing.T) {
tests := []struct {
name string
wantNil bool
buildCtx func(w http.ResponseWriter) context.Context
}{
{
name: "returns writer stored by handler",
wantNil: false,
// The handler stores the writer; we verify indirectly by calling the handler.
},
{
name: "returns nil for plain background context",
wantNil: true,
buildCtx: func(_ http.ResponseWriter) context.Context {
return context.Background()
},
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
resetDefaults(t)
if tc.wantNil {
// Test the nil case directly.
got := handler.ResponseWriter(tc.buildCtx(nil))
if got != nil {
t.Errorf("expected nil ResponseWriter, got %v", got)
}
return
}
// Test the non-nil case via a real handler invocation.
var capturedWriter http.ResponseWriter
h := handler.Of(func(ctx context.Context, p *echoPayload) (*echoResponse, error) {
capturedWriter = handler.ResponseWriter(ctx)
return &echoResponse{Echo: "rw-test"}, nil
})
w := httptest.NewRecorder()
h.ServeHTTP(w, newJSONRequest(t, http.MethodPost, echoPayload{Message: "rw-test"}))
if capturedWriter == nil {
t.Error("ResponseWriter returned nil inside handler, want non-nil")
}
})
}
}
You can’t perform that action at this time.