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
//! Tests for HTTP scenario switching feature
//!
//! This module tests the ability to switch between different response examples
//! using the X-Mockforge-Scenario header or MOCKFORGE_HTTP_SCENARIO environment variable.
use mockforge_openapi::openapi_routes::create_registry_from_json;
use serde_json::json;
#[tokio::test]
async fn test_scenario_selection_via_method() {
// Create a spec with multiple scenarios
let spec_json = json!({
"openapi": "3.0.0",
"info": {
"title": "Scenario Test API",
"version": "1.0.0"
},
"paths": {
"/users/{id}": {
"get": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {"type": "string"}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"examples": {
"happy": {
"summary": "Happy path",
"value": {
"id": "123",
"name": "John Doe",
"status": "active"
}
},
"errors": {
"summary": "Error scenario",
"value": {
"id": "123",
"name": "Suspended User",
"status": "suspended",
"reason": "Terms violation"
}
},
"edge": {
"summary": "Edge case",
"value": {
"id": "123",
"name": "New User",
"status": "pending"
}
}
}
}
}
}
}
}
}
}
});
let registry = create_registry_from_json(spec_json).expect("Failed to create registry");
// Get the route
let route = registry.get_route("/users/{id}", "GET").expect("Route should exist");
// Test default scenario (should use first example, order may vary)
let (status, body) = route.mock_response_with_status_and_scenario(None);
assert_eq!(status, 200);
// Just verify we got one of the valid scenarios
assert!(body.get("status").is_some());
assert!(body.get("name").is_some());
// Test "happy" scenario explicitly
let (status, body) = route.mock_response_with_status_and_scenario(Some("happy"));
assert_eq!(status, 200);
assert_eq!(body["status"], "active");
assert_eq!(body["name"], "John Doe");
// Test "errors" scenario
let (status, body) = route.mock_response_with_status_and_scenario(Some("errors"));
assert_eq!(status, 200);
assert_eq!(body["status"], "suspended");
assert_eq!(body["name"], "Suspended User");
assert_eq!(body["reason"], "Terms violation");
// Test "edge" scenario
let (status, body) = route.mock_response_with_status_and_scenario(Some("edge"));
assert_eq!(status, 200);
assert_eq!(body["status"], "pending");
assert_eq!(body["name"], "New User");
// Test non-existent scenario (should fall back to first example)
let (status, body) = route.mock_response_with_status_and_scenario(Some("nonexistent"));
assert_eq!(status, 200);
// Should fall back to one of the examples (order may vary in HashMap)
assert!(body.get("status").is_some());
}
#[tokio::test]
async fn test_scenario_with_post_endpoint() {
let spec_json = json!({
"openapi": "3.0.0",
"info": {
"title": "Order API",
"version": "1.0.0"
},
"paths": {
"/orders": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"userId": {"type": "string"},
"items": {"type": "array"}
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"examples": {
"happy": {
"value": {
"orderId": "ord_123",
"status": "confirmed",
"total": 99.99
}
},
"errors": {
"value": {
"orderId": "ord_123",
"status": "payment_failed",
"errorCode": "INSUFFICIENT_FUNDS"
}
},
"edge": {
"value": {
"orderId": "ord_123",
"status": "partially_available",
"warning": "Some items unavailable"
}
}
}
}
}
}
}
}
}
}
});
let registry = create_registry_from_json(spec_json).expect("Failed to create registry");
let route = registry.get_route("/orders", "POST").expect("Route should exist");
// Test happy scenario
let (status, body) = route.mock_response_with_status_and_scenario(Some("happy"));
assert_eq!(status, 201);
assert_eq!(body["status"], "confirmed");
assert_eq!(body["total"], 99.99);
// Test errors scenario
let (status, body) = route.mock_response_with_status_and_scenario(Some("errors"));
assert_eq!(status, 201);
assert_eq!(body["status"], "payment_failed");
assert_eq!(body["errorCode"], "INSUFFICIENT_FUNDS");
// Test edge scenario
let (status, body) = route.mock_response_with_status_and_scenario(Some("edge"));
assert_eq!(status, 201);
assert_eq!(body["status"], "partially_available");
assert_eq!(body["warning"], "Some items unavailable");
}
#[tokio::test]
async fn test_scenario_fallback_to_schema() {
// Test that when no examples are defined, schema-based generation still works
let spec_json = json!({
"openapi": "3.0.0",
"info": {
"title": "Schema Only API",
"version": "1.0.0"
},
"paths": {
"/items": {
"get": {
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {"type": "string"},
"name": {"type": "string"}
}
}
}
}
}
}
}
}
}
});
let registry = create_registry_from_json(spec_json).expect("Failed to create registry");
let route = registry.get_route("/items", "GET").expect("Route should exist");
// Should still generate a response from schema
let (status, body) = route.mock_response_with_status_and_scenario(Some("happy"));
assert_eq!(status, 200);
assert!(body.is_object());
assert!(body.get("id").is_some());
assert!(body.get("name").is_some());
}
#[tokio::test]
async fn test_single_example_without_scenarios() {
// Test that single 'example' field (not 'examples') still works
let spec_json = json!({
"openapi": "3.0.0",
"info": {
"title": "Single Example API",
"version": "1.0.0"
},
"paths": {
"/ping": {
"get": {
"responses": {
"200": {
"description": "Pong",
"content": {
"application/json": {
"example": {
"message": "pong",
"timestamp": "2024-01-20T15:00:00Z"
}
}
}
}
}
}
}
}
});
let registry = create_registry_from_json(spec_json).expect("Failed to create registry");
let route = registry.get_route("/ping", "GET").expect("Route should exist");
// Single example should be returned regardless of scenario
let (status, body) = route.mock_response_with_status_and_scenario(None);
assert_eq!(status, 200);
assert_eq!(body["message"], "pong");
// Even with scenario specified, should return the single example
let (status, body) = route.mock_response_with_status_and_scenario(Some("happy"));
assert_eq!(status, 200);
assert_eq!(body["message"], "pong");
}
#[tokio::test]
async fn test_multiple_status_codes_with_scenarios() {
let spec_json = json!({
"openapi": "3.0.0",
"info": {
"title": "Multi-Status API",
"version": "1.0.0"
},
"paths": {
"/resource": {
"get": {
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"examples": {
"happy": {
"value": {"status": "ok", "data": "success"}
},
"errors": {
"value": {"status": "degraded", "data": "partial"}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"example": {
"error": "Resource not found"
}
}
}
}
}
}
}
}
});
let registry = create_registry_from_json(spec_json).expect("Failed to create registry");
let route = registry.get_route("/resource", "GET").expect("Route should exist");
// Should use 200 (first status code) with happy scenario
let (status, body) = route.mock_response_with_status_and_scenario(Some("happy"));
assert_eq!(status, 200);
assert_eq!(body["status"], "ok");
// Should use 200 with errors scenario
let (status, body) = route.mock_response_with_status_and_scenario(Some("errors"));
assert_eq!(status, 200);
assert_eq!(body["status"], "degraded");
}
#[test]
fn test_env_var_scenario_selection() {
// Test that environment variable is respected
// Note: This test modifies environment variables, so it should be run in isolation
std::env::set_var("MOCKFORGE_HTTP_SCENARIO", "errors");
let spec_json = json!({
"openapi": "3.0.0",
"info": {
"title": "Env Test API",
"version": "1.0.0"
},
"paths": {
"/test": {
"get": {
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"examples": {
"happy": {
"value": {"scenario": "happy"}
},
"errors": {
"value": {"scenario": "errors"}
}
}
}
}
}
}
}
}
}
});
let registry = create_registry_from_json(spec_json).expect("Failed to create registry");
let route = registry.get_route("/test", "GET").expect("Route should exist");
// When no scenario is passed to the method, it should use one of the examples
// The environment variable is actually checked in the HTTP handler layer, not in the route method
let (status, body) = route.mock_response_with_status_and_scenario(None);
assert_eq!(status, 200);
// Default behavior without passing scenario - should get one of the scenarios
assert!(body.get("scenario").is_some());
// Clean up
std::env::remove_var("MOCKFORGE_HTTP_SCENARIO");
}