http-endpoint-server-harness 0.1.1

HTTP endpoint server harness for testing mock endpoints
Documentation
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
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
//! Integration tests for http-endpoint-server-harness

use http_endpoint_server_harness::prelude::*;
use std::net::SocketAddr;
use std::time::Duration;

/// Helper to get an available port
fn get_available_port() -> u16 {
    std::net::TcpListener::bind("127.0.0.1:0")
        .unwrap()
        .local_addr()
        .unwrap()
        .port()
}

/// Helper to create an address with an available port
fn get_test_addr() -> SocketAddr {
    SocketAddr::from(([127, 0, 0, 1], get_available_port()))
}

/// Helper to wait for server to be ready with retries
async fn wait_for_server(addr: SocketAddr) {
    let client = reqwest::Client::new();
    for _ in 0..50 {
        if client
            .get(format!("http://{}/", addr))
            .timeout(Duration::from_millis(50))
            .send()
            .await
            .is_ok()
        {
            return;
        }
        tokio::time::sleep(Duration::from_millis(10)).await;
    }
}

#[tokio::test]
async fn test_single_endpoint_get() {
    let addr = get_test_addr();

    // Spawn task to make HTTP requests
    let requests_task = tokio::spawn(async move {
        wait_for_server(addr).await;

        let client = reqwest::Client::new();
        let response = client
            .get(format!("http://{}/api/test", addr))
            .send()
            .await
            .unwrap();

        assert_eq!(response.status(), 200);
        let body: serde_json::Value = response.json().await.unwrap();
        assert_eq!(body["status"], "ok");
    });

    // Execute scenario
    let collected = ScenarioBuilder::new()
        .server(Axum::bind(addr))
        .collector(DefaultCollector::new())
        .endpoint(
            Endpoint::new("/api/test", Method::Get)
                .with_handler(Handler::from_json(&json!({"status": "ok"}))),
        )
        .build()
        .execute()
        .await
        .unwrap();

    requests_task.await.unwrap();

    assert_eq!(collected.len(), 1);
    assert_eq!(collected[0].method, Method::Get);
    assert_eq!(collected[0].path, "/api/test");
}

#[tokio::test]
async fn test_single_endpoint_post() {
    let addr = get_test_addr();

    let requests_task = tokio::spawn(async move {
        wait_for_server(addr).await;

        let client = reqwest::Client::new();
        let response = client
            .post(format!("http://{}/api/data", addr))
            .json(&json!({"name": "test"}))
            .send()
            .await
            .unwrap();

        assert_eq!(response.status(), 200);
        let body: serde_json::Value = response.json().await.unwrap();
        assert_eq!(body["created"], true);
    });

    let collected = ScenarioBuilder::new()
        .server(Axum::bind(addr))
        .collector(DefaultCollector::new())
        .endpoint(
            Endpoint::new("/api/data", Method::Post)
                .with_handler(Handler::from_json(&json!({"created": true}))),
        )
        .build()
        .execute()
        .await
        .unwrap();

    requests_task.await.unwrap();

    assert_eq!(collected.len(), 1);
    assert_eq!(collected[0].method, Method::Post);
    assert!(collected[0].body_as_str().unwrap().contains("test"));
}

#[tokio::test]
async fn test_multiple_handlers_sequential() {
    let addr = get_test_addr();

    let requests_task = tokio::spawn(async move {
        wait_for_server(addr).await;

        let client = reqwest::Client::new();

        // First request should get first handler
        let response1: serde_json::Value = client
            .post(format!("http://{}/api/token", addr))
            .send()
            .await
            .unwrap()
            .json()
            .await
            .unwrap();
        assert_eq!(response1["token"], "first");

        // Second request should get second handler
        let response2: serde_json::Value = client
            .post(format!("http://{}/api/token", addr))
            .send()
            .await
            .unwrap()
            .json()
            .await
            .unwrap();
        assert_eq!(response2["token"], "second");

        // Third request should get third handler
        let response3: serde_json::Value = client
            .post(format!("http://{}/api/token", addr))
            .send()
            .await
            .unwrap()
            .json()
            .await
            .unwrap();
        assert_eq!(response3["token"], "third");
    });

    let collected = ScenarioBuilder::new()
        .server(Axum::bind(addr))
        .collector(DefaultCollector::new())
        .endpoint(
            Endpoint::new("/api/token", Method::Post)
                .with_handler(Handler::from_json(&json!({"token": "first"})))
                .with_handler(Handler::from_json(&json!({"token": "second"})))
                .with_handler(Handler::from_json(&json!({"token": "third"}))),
        )
        .build()
        .execute()
        .await
        .unwrap();

    requests_task.await.unwrap();
    assert_eq!(collected.len(), 3);
}

#[tokio::test]
async fn test_multiple_endpoints() {
    let addr = get_test_addr();

    let requests_task = tokio::spawn(async move {
        wait_for_server(addr).await;

        let client = reqwest::Client::new();

        let users: serde_json::Value = client
            .get(format!("http://{}/api/users", addr))
            .send()
            .await
            .unwrap()
            .json()
            .await
            .unwrap();
        assert_eq!(users[0]["id"], 1);

        let posts: serde_json::Value = client
            .get(format!("http://{}/api/posts", addr))
            .send()
            .await
            .unwrap()
            .json()
            .await
            .unwrap();
        assert_eq!(posts[0]["id"], 100);
    });

    let collected = ScenarioBuilder::new()
        .server(Axum::bind(addr))
        .collector(DefaultCollector::new())
        .endpoint(
            Endpoint::new("/api/users", Method::Get)
                .with_handler(Handler::from_json(&json!([{"id": 1}]))),
        )
        .endpoint(
            Endpoint::new("/api/posts", Method::Get)
                .with_handler(Handler::from_json(&json!([{"id": 100}]))),
        )
        .build()
        .execute()
        .await
        .unwrap();

    requests_task.await.unwrap();
    assert_eq!(collected.len(), 2);
}

#[tokio::test]
async fn test_custom_status_code() {
    let addr = get_test_addr();

    let requests_task = tokio::spawn(async move {
        wait_for_server(addr).await;

        let client = reqwest::Client::new();
        let response = client
            .get(format!("http://{}/api/error", addr))
            .send()
            .await
            .unwrap();

        assert_eq!(response.status(), 404);
    });

    ScenarioBuilder::new()
        .server(Axum::bind(addr))
        .collector(DefaultCollector::new())
        .endpoint(
            Endpoint::new("/api/error", Method::Get)
                .with_handler(Handler::from_json(&json!({"error": "not found"})).with_status(404)),
        )
        .build()
        .execute()
        .await
        .unwrap();

    requests_task.await.unwrap();
}

#[tokio::test]
async fn test_custom_headers() {
    let addr = get_test_addr();

    let requests_task = tokio::spawn(async move {
        wait_for_server(addr).await;

        let client = reqwest::Client::new();
        let response = client
            .get(format!("http://{}/api/headers", addr))
            .send()
            .await
            .unwrap();

        assert_eq!(
            response.headers().get("X-Custom-Header").unwrap(),
            "custom-value"
        );
        assert_eq!(
            response.headers().get("X-Another").unwrap(),
            "another-value"
        );
    });

    ScenarioBuilder::new()
        .server(Axum::bind(addr))
        .collector(DefaultCollector::new())
        .endpoint(
            Endpoint::new("/api/headers", Method::Get).with_handler(
                Handler::from_json(&json!({}))
                    .with_header("X-Custom-Header", "custom-value")
                    .with_header("X-Another", "another-value"),
            ),
        )
        .build()
        .execute()
        .await
        .unwrap();

    requests_task.await.unwrap();
}

#[tokio::test]
async fn test_put_method() {
    let addr = get_test_addr();

    let requests_task = tokio::spawn(async move {
        wait_for_server(addr).await;

        let client = reqwest::Client::new();
        let response = client
            .put(format!("http://{}/api/resource", addr))
            .json(&json!({"name": "updated"}))
            .send()
            .await
            .unwrap();

        assert_eq!(response.status(), 200);
    });

    let collected = ScenarioBuilder::new()
        .server(Axum::bind(addr))
        .collector(DefaultCollector::new())
        .endpoint(
            Endpoint::new("/api/resource", Method::Put)
                .with_handler(Handler::from_json(&json!({"updated": true}))),
        )
        .build()
        .execute()
        .await
        .unwrap();

    requests_task.await.unwrap();
    assert_eq!(collected[0].method, Method::Put);
}

#[tokio::test]
async fn test_delete_method() {
    let addr = get_test_addr();

    let requests_task = tokio::spawn(async move {
        wait_for_server(addr).await;

        let client = reqwest::Client::new();
        let response = client
            .delete(format!("http://{}/api/resource/123", addr))
            .send()
            .await
            .unwrap();

        assert_eq!(response.status(), 204);
    });

    let collected = ScenarioBuilder::new()
        .server(Axum::bind(addr))
        .collector(DefaultCollector::new())
        .endpoint(
            Endpoint::new("/api/resource/{id}", Method::Delete)
                .with_handler(Handler::new(Response::new(204))),
        )
        .build()
        .execute()
        .await
        .unwrap();

    requests_task.await.unwrap();
    assert_eq!(collected[0].method, Method::Delete);
}

#[tokio::test]
async fn test_patch_method() {
    let addr = get_test_addr();

    let requests_task = tokio::spawn(async move {
        wait_for_server(addr).await;

        let client = reqwest::Client::new();
        let response = client
            .patch(format!("http://{}/api/resource", addr))
            .json(&json!({"field": "value"}))
            .send()
            .await
            .unwrap();

        assert_eq!(response.status(), 200);
    });

    let collected = ScenarioBuilder::new()
        .server(Axum::bind(addr))
        .collector(DefaultCollector::new())
        .endpoint(
            Endpoint::new("/api/resource", Method::Patch)
                .with_handler(Handler::from_json(&json!({"patched": true}))),
        )
        .build()
        .execute()
        .await
        .unwrap();

    requests_task.await.unwrap();
    assert_eq!(collected[0].method, Method::Patch);
}

#[tokio::test]
async fn test_collected_request_headers() {
    let addr = get_test_addr();

    let requests_task = tokio::spawn(async move {
        wait_for_server(addr).await;

        let client = reqwest::Client::new();
        client
            .get(format!("http://{}/api/test", addr))
            .header("Authorization", "Bearer token123")
            .header("X-Request-Id", "req-456")
            .send()
            .await
            .unwrap();
    });

    let collected = ScenarioBuilder::new()
        .server(Axum::bind(addr))
        .collector(DefaultCollector::new())
        .endpoint(
            Endpoint::new("/api/test", Method::Get)
                .with_handler(Handler::from_json(&json!({}))),
        )
        .build()
        .execute()
        .await
        .unwrap();

    requests_task.await.unwrap();
    let req = &collected[0];
    assert_eq!(req.headers.get("authorization").unwrap(), "Bearer token123");
    assert_eq!(req.headers.get("x-request-id").unwrap(), "req-456");
}

#[tokio::test]
async fn test_concurrent_requests() {
    let addr = get_test_addr();

    // Create 10 handlers for 10 concurrent requests
    let mut endpoint = Endpoint::new("/api/concurrent", Method::Get);
    for _ in 0..10 {
        endpoint = endpoint.with_handler(Handler::from_json(&json!({"ok": true})));
    }

    let requests_task = tokio::spawn(async move {
        wait_for_server(addr).await;

        let client = reqwest::Client::new();
        let url = format!("http://{}/api/concurrent", addr);

        // Send 10 concurrent requests
        let futures: Vec<_> = (0..10)
            .map(|_| {
                let client = client.clone();
                let url = url.clone();
                async move { client.get(&url).send().await }
            })
            .collect();

        let responses = futures::future::join_all(futures).await;

        for response in responses {
            assert_eq!(response.unwrap().status(), 200);
        }
    });

    let collected = ScenarioBuilder::new()
        .server(Axum::bind(addr))
        .collector(DefaultCollector::new())
        .endpoint(endpoint)
        .build()
        .execute()
        .await
        .unwrap();

    requests_task.await.unwrap();
    assert_eq!(collected.len(), 10);
}

#[tokio::test]
async fn test_dynamic_handler_echo_path() {
    let addr = get_test_addr();

    let requests_task = tokio::spawn(async move {
        wait_for_server(addr).await;

        let client = reqwest::Client::new();
        let response: serde_json::Value = client
            .get(format!("http://{}/api/users/123", addr))
            .send()
            .await
            .unwrap()
            .json()
            .await
            .unwrap();

        assert!(response["path"].as_str().unwrap().contains("/api/"));
    });

    ScenarioBuilder::new()
        .server(Axum::bind(addr))
        .collector(DefaultCollector::new())
        .endpoint(
            Endpoint::new("/api/{*path}", Method::Get).with_handler(Handler::dynamic(|req| {
                Response::new(200).with_json(&json!({
                    "path": req.path
                }))
            })),
        )
        .build()
        .execute()
        .await
        .unwrap();

    requests_task.await.unwrap();
}

#[tokio::test]
async fn test_dynamic_handler_echo_body() {
    let addr = get_test_addr();

    let requests_task = tokio::spawn(async move {
        wait_for_server(addr).await;

        let client = reqwest::Client::new();
        let response: serde_json::Value = client
            .post(format!("http://{}/echo", addr))
            .json(&json!({"message": "hello"}))
            .send()
            .await
            .unwrap()
            .json()
            .await
            .unwrap();

        assert_eq!(response["received"]["message"], "hello");
    });

    ScenarioBuilder::new()
        .server(Axum::bind(addr))
        .collector(DefaultCollector::new())
        .endpoint(
            Endpoint::new("/echo", Method::Post).with_handler(Handler::dynamic(|req| {
                if let Some(body) = req.body_as_str() {
                    if let Ok(json) = serde_json::from_str::<serde_json::Value>(body) {
                        return Response::new(200).with_json(&json!({
                            "received": json
                        }));
                    }
                }
                Response::new(400).with_body("Invalid JSON")
            })),
        )
        .build()
        .execute()
        .await
        .unwrap();

    requests_task.await.unwrap();
}

#[tokio::test]
async fn test_dynamic_handler_based_on_header() {
    let addr = get_test_addr();

    // Use the same dynamic handler twice to allow 2 requests
    let auth_handler = Handler::dynamic(|req| {
        if let Some(auth) = req.headers.get("authorization") {
            if auth.starts_with("Bearer ") {
                return Response::new(200).with_json(&json!({"authenticated": true}));
            }
        }
        Response::new(401).with_json(&json!({"authenticated": false}))
    });

    let requests_task = tokio::spawn(async move {
        wait_for_server(addr).await;

        let client = reqwest::Client::new();

        // Without auth header
        let response1: serde_json::Value = client
            .get(format!("http://{}/auth", addr))
            .send()
            .await
            .unwrap()
            .json()
            .await
            .unwrap();
        assert_eq!(response1["authenticated"], false);

        // With auth header
        let response2: serde_json::Value = client
            .get(format!("http://{}/auth", addr))
            .header("Authorization", "Bearer token123")
            .send()
            .await
            .unwrap()
            .json()
            .await
            .unwrap();
        assert_eq!(response2["authenticated"], true);
    });

    ScenarioBuilder::new()
        .server(Axum::bind(addr))
        .collector(DefaultCollector::new())
        .endpoint(
            Endpoint::new("/auth", Method::Get)
                .with_handler(auth_handler.clone())
                .with_handler(auth_handler),
        )
        .build()
        .execute()
        .await
        .unwrap();

    requests_task.await.unwrap();
}

#[tokio::test]
async fn test_auto_shutdown_after_all_handlers() {
    let addr = get_test_addr();

    let requests_task = tokio::spawn(async move {
        wait_for_server(addr).await;

        let client = reqwest::Client::new();

        // Call first endpoint
        let resp1 = client
            .get(format!("http://{}/api/step1", addr))
            .send()
            .await
            .unwrap();
        assert_eq!(resp1.status(), 200);

        // Call second endpoint
        let resp2 = client
            .get(format!("http://{}/api/step2", addr))
            .send()
            .await
            .unwrap();
        assert_eq!(resp2.status(), 200);
    });

    // The scenario should complete automatically after all handlers are called
    let collected = ScenarioBuilder::new()
        .server(Axum::bind(addr))
        .collector(DefaultCollector::new())
        .endpoint(
            Endpoint::new("/api/step1", Method::Get)
                .with_handler(Handler::from_json(&json!({"step": 1}))),
        )
        .endpoint(
            Endpoint::new("/api/step2", Method::Get)
                .with_handler(Handler::from_json(&json!({"step": 2}))),
        )
        .build()
        .execute()
        .await
        .unwrap();

    requests_task.await.unwrap();
    assert_eq!(collected.len(), 2);
}

#[tokio::test]
async fn test_auto_shutdown_with_sequential_handlers() {
    let addr = get_test_addr();

    let requests_task = tokio::spawn(async move {
        wait_for_server(addr).await;

        let client = reqwest::Client::new();

        // Call 3 times to exhaust all handlers
        for expected in [1, 2, 3] {
            let resp: serde_json::Value = client
                .get(format!("http://{}/api/counter", addr))
                .send()
                .await
                .unwrap()
                .json()
                .await
                .unwrap();
            assert_eq!(resp["count"], expected);
        }
    });

    let collected = ScenarioBuilder::new()
        .server(Axum::bind(addr))
        .collector(DefaultCollector::new())
        .endpoint(
            Endpoint::new("/api/counter", Method::Get)
                .with_handler(Handler::from_json(&json!({"count": 1})))
                .with_handler(Handler::from_json(&json!({"count": 2})))
                .with_handler(Handler::from_json(&json!({"count": 3}))),
        )
        .build()
        .execute()
        .await
        .unwrap();

    requests_task.await.unwrap();
    assert_eq!(collected.len(), 3);
}