-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathbdd_metrics_debug_test.go
More file actions
627 lines (540 loc) · 17.9 KB
/
bdd_metrics_debug_test.go
File metadata and controls
627 lines (540 loc) · 17.9 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
package reverseproxy
import (
"encoding/json"
"fmt"
"io"
"net/http"
"net/http/httptest"
"strings"
"time"
"github.com/GoCodeAlone/modular"
)
// Metrics Scenarios
func (ctx *ReverseProxyBDDTestContext) iHaveAReverseProxyWithMetricsEnabled() error {
// Fresh app with metrics enabled
ctx.resetContext()
// Create new application
app, err := modular.NewApplication(modular.WithLogger(&testLogger{}))
if err != nil {
return fmt.Errorf("failed to create application: %w", err)
}
ctx.app = app
// Simple backend
backend := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
w.Write([]byte("ok"))
}))
ctx.testServers = append(ctx.testServers, backend)
ctx.config = &ReverseProxyConfig{
DefaultBackend: "b1",
BackendServices: map[string]string{
"b1": backend.URL,
},
Routes: map[string]string{
"/api/*": "b1",
},
BackendConfigs: map[string]BackendServiceConfig{
"b1": {URL: backend.URL},
},
MetricsEnabled: true,
MetricsEndpoint: "/metrics/reverseproxy",
HealthCheck: HealthCheckConfig{
Enabled: false,
Interval: 30 * time.Second,
},
CircuitBreakerConfig: CircuitBreakerConfig{
Enabled: false,
FailureThreshold: 5,
OpenTimeout: 30 * time.Second,
},
}
ctx.metricsEndpointPath = ctx.config.MetricsEndpoint
return ctx.setupApplicationWithConfig()
}
func (ctx *ReverseProxyBDDTestContext) whenRequestsAreProcessedThroughTheProxy() error {
// Make a couple requests to generate metrics
for i := 0; i < 2; i++ {
resp, err := ctx.makeRequestThroughModule("GET", "/api/ping", nil)
if err != nil {
return err
}
io.Copy(io.Discard, resp.Body)
resp.Body.Close()
}
return nil
}
func (ctx *ReverseProxyBDDTestContext) thenMetricsShouldBeCollectedAndExposed() error {
// Hit metrics endpoint
resp, err := ctx.makeRequestThroughModule("GET", ctx.metricsEndpointPath, nil)
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return fmt.Errorf("expected metrics 200, got %d", resp.StatusCode)
}
var data map[string]interface{}
if err := json.NewDecoder(resp.Body).Decode(&data); err != nil {
return fmt.Errorf("invalid metrics json: %w", err)
}
if _, ok := data["backends"]; !ok {
return fmt.Errorf("metrics missing backends section")
}
return nil
}
func (ctx *ReverseProxyBDDTestContext) metricValuesShouldReflectProxyActivity() error {
// Verify metrics reflect actual proxy activity
resp, err := ctx.makeRequestThroughModule("GET", ctx.metricsEndpointPath, nil)
if err != nil {
return err
}
defer resp.Body.Close()
var data map[string]interface{}
if err := json.NewDecoder(resp.Body).Decode(&data); err != nil {
return fmt.Errorf("invalid metrics json: %w", err)
}
// Check for request count metrics
if _, ok := data["total_requests"]; !ok {
return fmt.Errorf("metrics missing total_requests field")
}
return nil
}
// Custom metrics endpoint path
func (ctx *ReverseProxyBDDTestContext) iHaveAReverseProxyWithCustomMetricsEndpoint() error {
// This is an alternate setup that creates a fresh reverse proxy with a custom metrics endpoint
ctx.resetContext()
// Create new application
app, err := modular.NewApplication(modular.WithLogger(&testLogger{}))
if err != nil {
return fmt.Errorf("failed to create application: %w", err)
}
ctx.app = app
// Simple backend
backend := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
w.Write([]byte("ok"))
}))
ctx.testServers = append(ctx.testServers, backend)
ctx.config = &ReverseProxyConfig{
DefaultBackend: "b1",
BackendServices: map[string]string{
"b1": backend.URL,
},
Routes: map[string]string{
"/api/*": "b1",
},
BackendConfigs: map[string]BackendServiceConfig{
"b1": {URL: backend.URL},
},
MetricsEnabled: true,
MetricsEndpoint: "/custom/metrics/path",
HealthCheck: HealthCheckConfig{
Enabled: false,
Interval: 30 * time.Second,
},
CircuitBreakerConfig: CircuitBreakerConfig{
Enabled: false,
FailureThreshold: 5,
OpenTimeout: 30 * time.Second,
},
}
ctx.metricsEndpointPath = ctx.config.MetricsEndpoint
return ctx.setupApplicationWithConfig()
}
func (ctx *ReverseProxyBDDTestContext) iHaveACustomMetricsEndpointConfigured() error {
if ctx.service == nil {
return fmt.Errorf("service not initialized")
}
ctx.service.config.MetricsEndpoint = "/metrics/custom"
ctx.metricsEndpointPath = "/metrics/custom"
return nil
}
func (ctx *ReverseProxyBDDTestContext) whenTheMetricsEndpointIsAccessed() error {
resp, err := ctx.makeRequestThroughModule("GET", ctx.metricsEndpointPath, nil)
if err != nil {
return err
}
ctx.lastResponse = resp
return nil
}
func (ctx *ReverseProxyBDDTestContext) thenMetricsShouldBeAvailableAtTheConfiguredPath() error {
if ctx.lastResponse == nil {
return fmt.Errorf("no metrics response")
}
defer ctx.lastResponse.Body.Close()
if ctx.lastResponse.StatusCode != http.StatusOK {
return fmt.Errorf("expected 200 at metrics endpoint, got %d", ctx.lastResponse.StatusCode)
}
if ct := ctx.lastResponse.Header.Get("Content-Type"); !strings.Contains(ct, "application/json") {
return fmt.Errorf("unexpected content-type for metrics: %s", ct)
}
return nil
}
func (ctx *ReverseProxyBDDTestContext) andMetricsDataShouldBeProperlyFormatted() error {
var data map[string]interface{}
if err := json.NewDecoder(ctx.lastResponse.Body).Decode(&data); err != nil {
return fmt.Errorf("invalid metrics json: %w", err)
}
// basic shape assertion
if _, ok := data["uptime_seconds"]; !ok {
return fmt.Errorf("metrics missing uptime_seconds")
}
return nil
}
// Debug Endpoints Scenarios
func (ctx *ReverseProxyBDDTestContext) iHaveAReverseProxyWithDebugEndpointsEnabled() error {
// Alias for the alternate phrasing in the feature file
return ctx.iHaveADebugEndpointsEnabledReverseProxy()
}
func (ctx *ReverseProxyBDDTestContext) iHaveADebugEndpointsEnabledReverseProxy() error {
ctx.resetContext()
// Create new application
app, err := modular.NewApplication(modular.WithLogger(&testLogger{}))
if err != nil {
return fmt.Errorf("failed to create application: %w", err)
}
ctx.app = app
backend := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
w.Write([]byte("ok"))
}))
ctx.testServers = append(ctx.testServers, backend)
ctx.config = &ReverseProxyConfig{
DefaultBackend: "b1",
BackendServices: map[string]string{"b1": backend.URL},
Routes: map[string]string{"/api/*": "b1"},
BackendConfigs: map[string]BackendServiceConfig{
"b1": {URL: backend.URL},
},
DebugEndpoints: DebugEndpointsConfig{Enabled: true, BasePath: "/debug"},
HealthCheck: HealthCheckConfig{
Enabled: false,
Interval: 30 * time.Second,
},
CircuitBreakerConfig: CircuitBreakerConfig{
Enabled: false,
FailureThreshold: 5,
OpenTimeout: 30 * time.Second,
},
}
return ctx.setupApplicationWithConfig()
}
func (ctx *ReverseProxyBDDTestContext) iHaveADebugEndpointsAndFeatureFlagsEnabledReverseProxy() error {
ctx.resetContext()
// Create new application
app, err := modular.NewApplication(modular.WithLogger(&testLogger{}))
if err != nil {
return fmt.Errorf("failed to create application: %w", err)
}
ctx.app = app
backend := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
w.Write([]byte("ok"))
}))
ctx.testServers = append(ctx.testServers, backend)
ctx.config = &ReverseProxyConfig{
DefaultBackend: "b1",
BackendServices: map[string]string{"b1": backend.URL},
Routes: map[string]string{"/api/*": "b1"},
BackendConfigs: map[string]BackendServiceConfig{
"b1": {URL: backend.URL},
},
DebugEndpoints: DebugEndpointsConfig{Enabled: true, BasePath: "/debug"},
FeatureFlags: FeatureFlagsConfig{
Enabled: true,
Flags: map[string]bool{
"test-flag": true,
},
},
HealthCheck: HealthCheckConfig{
Enabled: false,
Interval: 30 * time.Second,
},
CircuitBreakerConfig: CircuitBreakerConfig{
Enabled: false,
FailureThreshold: 5,
OpenTimeout: 30 * time.Second,
},
}
return ctx.setupApplicationWithConfig()
}
func (ctx *ReverseProxyBDDTestContext) iHaveADebugEndpointsAndCircuitBreakersEnabledReverseProxy() error {
ctx.resetContext()
// Create new application
app, err := modular.NewApplication(modular.WithLogger(&testLogger{}))
if err != nil {
return fmt.Errorf("failed to create application: %w", err)
}
ctx.app = app
backend := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
w.Write([]byte("ok"))
}))
ctx.testServers = append(ctx.testServers, backend)
ctx.config = &ReverseProxyConfig{
DefaultBackend: "b1",
BackendServices: map[string]string{"b1": backend.URL},
Routes: map[string]string{"/api/*": "b1"},
BackendConfigs: map[string]BackendServiceConfig{
"b1": {URL: backend.URL},
},
DebugEndpoints: DebugEndpointsConfig{Enabled: true, BasePath: "/debug"},
HealthCheck: HealthCheckConfig{
Enabled: false,
Interval: 30 * time.Second,
},
CircuitBreakerConfig: CircuitBreakerConfig{
Enabled: true,
FailureThreshold: 3,
OpenTimeout: 30 * time.Second,
},
}
return ctx.setupApplicationWithConfig()
}
func (ctx *ReverseProxyBDDTestContext) iHaveADebugEndpointsAndHealthChecksEnabledReverseProxy() error {
ctx.resetContext()
// Create new application
app, err := modular.NewApplication(modular.WithLogger(&testLogger{}))
if err != nil {
return fmt.Errorf("failed to create application: %w", err)
}
ctx.app = app
backend := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
w.Write([]byte("ok"))
}))
ctx.testServers = append(ctx.testServers, backend)
ctx.config = &ReverseProxyConfig{
DefaultBackend: "b1",
BackendServices: map[string]string{"b1": backend.URL},
Routes: map[string]string{"/api/*": "b1"},
BackendConfigs: map[string]BackendServiceConfig{
"b1": {URL: backend.URL},
},
DebugEndpoints: DebugEndpointsConfig{Enabled: true, BasePath: "/debug"},
HealthCheck: HealthCheckConfig{
Enabled: true,
Interval: 30 * time.Second,
},
CircuitBreakerConfig: CircuitBreakerConfig{
Enabled: false,
FailureThreshold: 5,
OpenTimeout: 30 * time.Second,
},
}
return ctx.setupApplicationWithConfig()
}
func (ctx *ReverseProxyBDDTestContext) whenDebugEndpointsAreAccessed() error {
// Access a few debug endpoints
paths := []string{"/debug/info", "/debug/backends"}
for _, p := range paths {
resp, err := ctx.makeRequestThroughModule("GET", p, nil)
if err != nil {
return err
}
io.Copy(io.Discard, resp.Body)
resp.Body.Close()
}
return nil
}
func (ctx *ReverseProxyBDDTestContext) thenConfigurationInformationShouldBeExposed() error {
resp, err := ctx.makeRequestThroughModule("GET", "/debug/info", nil)
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return fmt.Errorf("debug info status %d", resp.StatusCode)
}
var info map[string]interface{}
if err := json.NewDecoder(resp.Body).Decode(&info); err != nil {
return fmt.Errorf("invalid debug info json: %w", err)
}
if _, ok := info["backendServices"]; !ok {
return fmt.Errorf("debug info missing backendServices")
}
return nil
}
func (ctx *ReverseProxyBDDTestContext) andDebugDataShouldBeProperlyFormatted() error {
resp, err := ctx.makeRequestThroughModule("GET", "/debug/backends", nil)
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return fmt.Errorf("debug backends status %d", resp.StatusCode)
}
var data map[string]interface{}
if err := json.NewDecoder(resp.Body).Decode(&data); err != nil {
return fmt.Errorf("invalid debug backends json: %w", err)
}
if _, ok := data["backendServices"]; !ok {
return fmt.Errorf("debug backends missing backendServices")
}
return nil
}
// Specific debug endpoint scenarios
func (ctx *ReverseProxyBDDTestContext) theDebugInfoEndpointIsAccessed() error {
resp, err := ctx.makeRequestThroughModule("GET", "/debug/info", nil)
if err != nil {
return err
}
ctx.lastResponse = resp
return nil
}
func (ctx *ReverseProxyBDDTestContext) generalProxyInformationShouldBeReturned() error {
if ctx.lastResponse == nil {
return fmt.Errorf("no debug info response")
}
defer ctx.lastResponse.Body.Close()
if ctx.lastResponse.StatusCode != http.StatusOK {
return fmt.Errorf("expected 200 for debug info, got %d", ctx.lastResponse.StatusCode)
}
var info map[string]interface{}
if err := json.NewDecoder(ctx.lastResponse.Body).Decode(&info); err != nil {
return fmt.Errorf("invalid debug info json: %w", err)
}
// Check for general proxy information
if _, ok := info["module_name"]; !ok {
return fmt.Errorf("debug info missing module_name field")
}
return nil
}
func (ctx *ReverseProxyBDDTestContext) configurationDetailsShouldBeIncluded() error {
// Configuration details should be included in the debug info response
// This is validated in the previous step's JSON parsing
return nil
}
func (ctx *ReverseProxyBDDTestContext) theDebugBackendsEndpointIsAccessed() error {
resp, err := ctx.makeRequestThroughModule("GET", "/debug/backends", nil)
if err != nil {
return err
}
// Store the parsed data for later assertions
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return fmt.Errorf("expected 200 for debug backends, got %d", resp.StatusCode)
}
var data map[string]interface{}
if err := json.NewDecoder(resp.Body).Decode(&data); err != nil {
return fmt.Errorf("invalid debug backends json: %w", err)
}
// Cache the parsed data for use in subsequent steps
ctx.debugBackendsData = data
return nil
}
func (ctx *ReverseProxyBDDTestContext) backendConfigurationShouldBeReturned() error {
if ctx.debugBackendsData == nil {
return fmt.Errorf("no debug backends data available")
}
if _, ok := ctx.debugBackendsData["backendServices"]; !ok {
return fmt.Errorf("debug backends missing backendServices field")
}
return nil
}
func (ctx *ReverseProxyBDDTestContext) backendHealthStatusShouldBeIncluded() error {
if ctx.debugBackendsData == nil {
return fmt.Errorf("no debug backends data available")
}
// Health status should be included if health checks are enabled
// For now, just verify the response structure is reasonable
if len(ctx.debugBackendsData) == 0 {
return fmt.Errorf("debug backends data should not be empty")
}
return nil
}
func (ctx *ReverseProxyBDDTestContext) theDebugFlagsEndpointIsAccessed() error {
resp, err := ctx.makeRequestThroughModule("GET", "/debug/flags", nil)
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return fmt.Errorf("expected 200 for debug flags, got %d", resp.StatusCode)
}
var data map[string]interface{}
if err := json.NewDecoder(resp.Body).Decode(&data); err != nil {
return fmt.Errorf("invalid debug flags json: %w", err)
}
ctx.debugFlagsData = data
return nil
}
func (ctx *ReverseProxyBDDTestContext) currentFeatureFlagStatesShouldBeReturned() error {
if ctx.debugFlagsData == nil {
return fmt.Errorf("no debug flags data available")
}
// Check if feature flag information is present
if _, ok := ctx.debugFlagsData["feature_flags"]; !ok {
return fmt.Errorf("debug flags missing feature_flags field")
}
return nil
}
func (ctx *ReverseProxyBDDTestContext) tenantSpecificFlagsShouldBeIncluded() error {
if ctx.debugFlagsData == nil {
return fmt.Errorf("no debug flags data available")
}
// Tenant-specific flags should be included if configured
// For now, just verify we have valid flag data
if len(ctx.debugFlagsData) == 0 {
return fmt.Errorf("debug flags data should not be empty")
}
return nil
}
func (ctx *ReverseProxyBDDTestContext) theDebugCircuitBreakersEndpointIsAccessed() error {
resp, err := ctx.makeRequestThroughModule("GET", "/debug/circuit-breakers", nil)
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return fmt.Errorf("expected 200 for debug circuit breakers, got %d", resp.StatusCode)
}
var data map[string]interface{}
if err := json.NewDecoder(resp.Body).Decode(&data); err != nil {
return fmt.Errorf("invalid debug circuit breakers json: %w", err)
}
// Verify circuit breaker data structure
if _, ok := data["circuit_breakers"]; !ok {
return fmt.Errorf("debug circuit breakers missing circuit_breakers field")
}
return nil
}
func (ctx *ReverseProxyBDDTestContext) circuitBreakerStatesShouldBeReturned() error {
// Circuit breaker states should be included in the debug response
// This is validated in the previous step
return nil
}
func (ctx *ReverseProxyBDDTestContext) circuitBreakerMetricsShouldBeIncluded() error {
// Circuit breaker metrics should be included in the debug response
// This is part of the general circuit breaker debug information
return nil
}
func (ctx *ReverseProxyBDDTestContext) theDebugHealthChecksEndpointIsAccessed() error {
resp, err := ctx.makeRequestThroughModule("GET", "/debug/health-checks", nil)
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return fmt.Errorf("expected 200 for debug health checks, got %d", resp.StatusCode)
}
var data map[string]interface{}
if err := json.NewDecoder(resp.Body).Decode(&data); err != nil {
return fmt.Errorf("invalid debug health checks json: %w", err)
}
// Verify health check data structure
if _, ok := data["health_checks"]; !ok {
return fmt.Errorf("debug health checks missing health_checks field")
}
return nil
}
func (ctx *ReverseProxyBDDTestContext) healthCheckStatusShouldBeReturned() error {
// Health check status should be included in the debug response
// This is validated in the previous step
return nil
}
func (ctx *ReverseProxyBDDTestContext) healthCheckHistoryShouldBeIncluded() error {
// Health check history should be included in the debug response
// This is part of the general health check debug information
return nil
}