-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathcontext_test.go
More file actions
677 lines (532 loc) · 14.1 KB
/
context_test.go
File metadata and controls
677 lines (532 loc) · 14.1 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
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
package fox
import (
"context"
"net/http"
"net/http/httptest"
"strings"
"testing"
"time"
"github.com/fox-gonic/fox/logger"
"github.com/gin-gonic/gin"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// Test RequestBody method
func TestContext_RequestBody_FirstRead(t *testing.T) {
engine := New()
body := "test request body"
req := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(body))
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
// First read should read from request body
result, err := ctx.RequestBody()
require.NoError(t, err)
assert.Equal(t, body, string(result))
// Body should be cached
cachedBody, exists := ctx.Get(gin.BodyBytesKey)
require.True(t, exists)
assert.Equal(t, []byte(body), cachedBody)
}
func TestContext_RequestBody_CachedRead(t *testing.T) {
engine := New()
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ctx := &Context{
Context: ginCtx,
engine: engine,
}
// Pre-set cached body
cachedBody := []byte("cached body")
ctx.Set(gin.BodyBytesKey, cachedBody)
// Should return cached body
result, err := ctx.RequestBody()
require.NoError(t, err)
assert.Equal(t, cachedBody, result)
}
func TestContext_RequestBody_CachedValueNotByteSlice(t *testing.T) {
engine := New()
body := "test body"
req := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(body))
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
// Set cached value that is not []byte
ctx.Set(gin.BodyBytesKey, "not a byte slice")
// Should read from request body since cached value is not []byte
result, err := ctx.RequestBody()
require.NoError(t, err)
assert.Equal(t, body, string(result))
}
func TestContext_RequestBody_MultipleReads(t *testing.T) {
engine := New()
body := "test body"
req := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(body))
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
// First read
result1, err := ctx.RequestBody()
require.NoError(t, err)
assert.Equal(t, body, string(result1))
// Second read should return cached body
result2, err := ctx.RequestBody()
require.NoError(t, err)
assert.Equal(t, body, string(result2))
// Both should be equal
assert.Equal(t, result1, result2)
}
func TestContext_RequestBody_EmptyBody(t *testing.T) {
engine := New()
req := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(""))
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
result, err := ctx.RequestBody()
require.NoError(t, err)
assert.Equal(t, []byte{}, result)
}
func TestContext_RequestBody_NilRequest(t *testing.T) {
engine := New()
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: nil,
}
result, err := ctx.RequestBody()
require.NoError(t, err)
assert.Nil(t, result)
}
func TestContext_RequestBody_NilBody(t *testing.T) {
engine := New()
req := httptest.NewRequest(http.MethodGet, "/", nil)
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
result, err := ctx.RequestBody()
require.NoError(t, err)
// When body is nil, result can be nil or empty slice
assert.Empty(t, result)
}
func TestContext_RequestBody_LargeBody(t *testing.T) {
engine := New()
largeBody := strings.Repeat("a", 10000)
req := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(largeBody))
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
result, err := ctx.RequestBody()
require.NoError(t, err)
assert.Equal(t, largeBody, string(result))
assert.Len(t, result, 10000)
}
// Test TraceID method
func TestContext_TraceID_FromContext(t *testing.T) {
engine := New()
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ctx := &Context{
Context: ginCtx,
engine: engine,
}
// Set TraceID in context
expectedID := "context-trace-123"
ctx.Set(logger.TraceID, expectedID)
traceID := ctx.TraceID()
assert.Equal(t, expectedID, traceID)
}
func TestContext_TraceID_FromRequestHeader(t *testing.T) {
engine := New()
req := httptest.NewRequest(http.MethodGet, "/", nil)
req.Header.Set(logger.TraceID, "header-trace-456")
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
traceID := ctx.TraceID()
// TraceID should read from request header
assert.Equal(t, "header-trace-456", traceID)
}
func TestContext_TraceID_FromResponseHeader(t *testing.T) {
engine := New()
req := httptest.NewRequest(http.MethodGet, "/", nil)
w := httptest.NewRecorder()
w.Header().Set(logger.TraceID, "response-trace-789")
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
traceID := ctx.TraceID()
assert.Equal(t, "response-trace-789", traceID)
}
func TestContext_TraceID_Generated(t *testing.T) {
engine := New()
req := httptest.NewRequest(http.MethodGet, "/", nil)
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
traceID := ctx.TraceID()
// Should generate a new ID
assert.NotEmpty(t, traceID)
assert.Len(t, traceID, 16) // Default ID length
// Should be set in context and response header
storedID, exists := ctx.Get(logger.TraceID)
assert.True(t, exists)
assert.Equal(t, traceID, storedID)
assert.Equal(t, traceID, w.Header().Get(logger.TraceID))
}
func TestContext_TraceID_Consistency(t *testing.T) {
engine := New()
req := httptest.NewRequest(http.MethodGet, "/", nil)
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
// Multiple calls should return the same ID
id1 := ctx.TraceID()
id2 := ctx.TraceID()
id3 := ctx.TraceID()
assert.Equal(t, id1, id2)
assert.Equal(t, id2, id3)
}
// Test context.Context interface methods
func TestContext_Done(t *testing.T) {
engine := New()
ctx, cancel := context.WithCancel(context.Background())
req := httptest.NewRequest(http.MethodGet, "/", nil).WithContext(ctx)
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
foxCtx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
// Channel should not be closed
select {
case <-foxCtx.Done():
t.Fatal("Done channel should not be closed")
default:
// Expected
}
// Cancel context
cancel()
// Channel should be closed now
select {
case <-foxCtx.Done():
// Expected
case <-time.After(100 * time.Millisecond):
t.Fatal("Done channel should be closed after cancel")
}
}
func TestContext_Err(t *testing.T) {
engine := New()
t.Run("no error", func(t *testing.T) {
req := httptest.NewRequest(http.MethodGet, "/", nil)
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
assert.NoError(t, ctx.Err())
})
t.Run("canceled", func(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
cancel()
req := httptest.NewRequest(http.MethodGet, "/", nil).WithContext(ctx)
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
foxCtx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
assert.Equal(t, context.Canceled, foxCtx.Err())
})
t.Run("deadline exceeded", func(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 1*time.Nanosecond)
defer cancel()
time.Sleep(2 * time.Millisecond)
req := httptest.NewRequest(http.MethodGet, "/", nil).WithContext(ctx)
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
foxCtx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
assert.Equal(t, context.DeadlineExceeded, foxCtx.Err())
})
}
func TestContext_Value(t *testing.T) {
engine := New()
type testKey string
key := testKey("test-key")
value := "test-value"
ctx := context.WithValue(context.Background(), key, value)
req := httptest.NewRequest(http.MethodGet, "/", nil).WithContext(ctx)
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
foxCtx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
result := foxCtx.Value(key)
assert.Equal(t, value, result)
// Non-existent key should return nil
assert.Nil(t, foxCtx.Value(testKey("non-existent")))
}
func TestContext_Deadline(t *testing.T) {
engine := New()
t.Run("with deadline", func(t *testing.T) {
deadline := time.Now().Add(1 * time.Hour)
ctx, cancel := context.WithDeadline(context.Background(), deadline)
defer cancel()
req := httptest.NewRequest(http.MethodGet, "/", nil).WithContext(ctx)
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
foxCtx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
dl, ok := foxCtx.Deadline()
assert.True(t, ok)
assert.WithinDuration(t, deadline, dl, 1*time.Second)
})
t.Run("without deadline", func(t *testing.T) {
req := httptest.NewRequest(http.MethodGet, "/", nil)
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
_, ok := ctx.Deadline()
assert.False(t, ok)
})
}
// Test Next method
func TestContext_Next(t *testing.T) {
engine := New()
req := httptest.NewRequest(http.MethodGet, "/", nil)
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
// Test that Next syncs the request
ctx.Next()
// Request should be synced to gin.Context
assert.Equal(t, req, ginCtx.Request)
}
// Test Copy method
func TestContext_Copy(t *testing.T) {
engine := New()
req := httptest.NewRequest(http.MethodGet, "/test", nil)
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
// Create a logger (use default logger)
testLogger := logger.NewWithoutCaller()
ctx := &Context{
Context: ginCtx,
engine: engine,
Logger: testLogger,
Request: req,
}
// Set some values
ctx.Set("key1", "value1")
ctx.Set("key2", 123)
// Copy context
copied := ctx.Copy()
// Verify copied context
assert.NotNil(t, copied)
assert.NotSame(t, ctx, copied)
assert.NotSame(t, ctx.Context, copied.Context)
// Verify fields are copied
assert.Equal(t, ctx.engine, copied.engine)
assert.Equal(t, ctx.Logger, copied.Logger)
assert.Equal(t, ctx.Request, copied.Request)
// Verify context values are copied
val1, exists := copied.Get("key1")
assert.True(t, exists)
assert.Equal(t, "value1", val1)
val2, exists := copied.Get("key2")
assert.True(t, exists)
assert.Equal(t, 123, val2)
// Verify Request is set correctly
assert.Equal(t, req, copied.Context.Request)
}
func TestContext_Copy_Independence(t *testing.T) {
engine := New()
req := httptest.NewRequest(http.MethodGet, "/", nil)
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
ctx.Set("original", "value")
// Copy context
copied := ctx.Copy()
// Modify original
ctx.Set("new-key", "new-value")
// Copied should not have new key
_, exists := copied.Get("new-key")
assert.False(t, exists)
// But should still have original key
val, exists := copied.Get("original")
assert.True(t, exists)
assert.Equal(t, "value", val)
}
// Benchmark tests
func BenchmarkContext_RequestBody_FirstRead(b *testing.B) {
engine := New()
body := strings.Repeat("test data ", 100)
b.ResetTimer()
for i := 0; i < b.N; i++ {
req := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(body))
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
_, _ = ctx.RequestBody()
}
}
func BenchmarkContext_RequestBody_CachedRead(b *testing.B) {
engine := New()
body := []byte(strings.Repeat("test data ", 100))
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ctx := &Context{
Context: ginCtx,
engine: engine,
}
ctx.Set(gin.BodyBytesKey, body)
b.ResetTimer()
for i := 0; i < b.N; i++ {
_, _ = ctx.RequestBody()
}
}
func BenchmarkContext_TraceID_Generated(b *testing.B) {
engine := New()
b.ResetTimer()
for i := 0; i < b.N; i++ {
req := httptest.NewRequest(http.MethodGet, "/", nil)
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
_ = ctx.TraceID()
}
}
func BenchmarkContext_TraceID_Cached(b *testing.B) {
engine := New()
req := httptest.NewRequest(http.MethodGet, "/", nil)
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
ctx := &Context{
Context: ginCtx,
engine: engine,
Request: req,
}
// First call to generate and cache
_ = ctx.TraceID()
b.ResetTimer()
for i := 0; i < b.N; i++ {
_ = ctx.TraceID()
}
}
func BenchmarkContext_Copy(b *testing.B) {
engine := New()
req := httptest.NewRequest(http.MethodGet, "/", nil)
w := httptest.NewRecorder()
ginCtx, _ := gin.CreateTestContext(w)
ginCtx.Request = req
testLogger := logger.NewWithoutCaller()
ctx := &Context{
Context: ginCtx,
engine: engine,
Logger: testLogger,
Request: req,
}
ctx.Set("key1", "value1")
ctx.Set("key2", 123)
b.ResetTimer()
for i := 0; i < b.N; i++ {
_ = ctx.Copy()
}
}