kxio 3.2.0

Provides injectable Filesystem and Network resources to make code more testable
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
use http::StatusCode;
//
use kxio::net::{Error, MockNet, Net};

use assert2::let_assert;

#[tokio::test]
async fn test_get_url() {
    //given
    let mock_net = kxio::net::mock();

    let url = "https://www.example.com";
    let url_alpha = format!("{url}/alpha");
    let url_beta = format!("{url}/beta");

    mock_net
        .on()
        .get(&url_alpha)
        .respond(StatusCode::OK)
        .body("Get OK alpha")
        .expect("mock alpha");
    mock_net
        .on()
        .get(&url_beta)
        .respond(StatusCode::OK)
        .body("Get OK beta")
        .expect("mock beta");
    mock_net
        .on()
        .get(url)
        .respond(StatusCode::OK)
        .body("Get OK")
        .expect("mock");
    let net = Net::from(mock_net);

    //when
    let response_alpha = net.get(url_alpha).send().await.expect("response alpha");
    let response_beta = net.get(url_beta).send().await.expect("response beta");
    let response = net.get(url).send().await.expect("response");

    //then
    assert_eq!(response_alpha.status(), http::StatusCode::OK);
    assert_eq!(
        response_alpha.bytes().await.expect("response body alpha"),
        "Get OK alpha"
    );
    assert_eq!(response_beta.status(), http::StatusCode::OK);
    assert_eq!(
        response_beta.bytes().await.expect("response body beta"),
        "Get OK beta"
    );
    assert_eq!(response.status(), http::StatusCode::OK);
    assert_eq!(response.bytes().await.expect("response body"), "Get OK");
}

#[tokio::test]
async fn test_post_url() {
    //given
    let net = kxio::net::mock();
    let client = net.client();

    let url = "https://www.example.com";

    net.on()
        .post(url)
        .respond(StatusCode::OK)
        .body("post OK")
        .expect("mock");

    //when
    let response = Net::from(net)
        .send(client.post(url))
        .await
        .expect("reponse");

    //then
    assert_eq!(response.status(), http::StatusCode::OK);
    assert_eq!(response.bytes().await.expect("response body"), "post OK");
}

#[tokio::test]
async fn test_put_url() {
    //given
    let net = kxio::net::mock();
    let client = net.client();

    let url = "https://www.example.com";

    net.on()
        .put(url)
        .respond(StatusCode::OK)
        .body("put OK")
        .expect("mock");

    //when
    let response = Net::from(net).send(client.put(url)).await.expect("reponse");

    //then
    assert_eq!(response.status(), http::StatusCode::OK);
    assert_eq!(response.bytes().await.expect("response body"), "put OK");
}

#[tokio::test]
async fn test_delete_url() {
    //given
    let net = kxio::net::mock();
    let client = net.client();

    let url = "https://www.example.com";

    net.on()
        .delete(url)
        .respond(StatusCode::OK)
        .body("delete OK")
        .expect("mock");

    //when
    let response = Net::from(net)
        .send(client.delete(url))
        .await
        .expect("reponse");

    //then
    assert_eq!(response.status(), http::StatusCode::OK);
    assert_eq!(response.bytes().await.expect("response body"), "delete OK");
}

#[tokio::test]
async fn test_head_url() {
    //given
    let net = kxio::net::mock();
    let client = net.client();

    let url = "https://www.example.com";

    net.on()
        .head(url)
        .respond(StatusCode::OK)
        .body("head OK")
        .expect("mock");

    //when
    let response = Net::from(net)
        .send(client.head(url))
        .await
        .expect("reponse");

    //then
    assert_eq!(response.status(), http::StatusCode::OK);
    assert_eq!(response.bytes().await.expect("response body"), "head OK");
}

#[tokio::test]
async fn test_patch_url() {
    //given
    let net = kxio::net::mock();
    let client = net.client();

    let url = "https://www.example.com";

    net.on()
        .patch(url)
        .respond(StatusCode::OK)
        .body("patch OK")
        .expect("mock");

    //when
    let response = Net::from(net)
        .send(client.patch(url))
        .await
        .expect("reponse");

    //then
    assert_eq!(response.status(), http::StatusCode::OK);
    assert_eq!(response.bytes().await.expect("response body"), "patch OK");
}

// #[tokio::test]
// async fn test_get_auth_url() {
//     //given
//     let net = kxio::net::mock();
//
//     let url = "https://user:pass@www.example.com";
//
//     net.on()
//         .get(url)
//         .respond(StatusCode::OK)
//         .body("post OK")
//         .expect("mock");
//
//     //when
//     let response = Net::from(net).get(url).send().await.expect("reponse");
//
//     //then
//     assert_eq!(response.status(), http::StatusCode::OK);
//     assert_eq!(response.bytes().await.expect("response body"), "post OK");
// }

#[tokio::test]
async fn test_get_wrong_url() {
    //given
    let net = kxio::net::mock();
    let client = net.client();

    let url = "https://www.example.com";

    net.on()
        .get(url)
        .respond(StatusCode::OK)
        .body("Get OK")
        .expect("mock");

    let net = Net::from(net);

    //when
    let_assert!(
        Err(Error::UnexpectedMockRequest { request }) =
            net.send(client.get("https://some.other.url/")).await
    );

    //then
    assert_eq!(request.url().to_string(), "https://some.other.url/");

    // remove pending unmatched request - we never meant to match against it
    let mock_net = MockNet::try_from(net).await.expect("recover net");
    mock_net.reset();
}

#[tokio::test]
async fn test_post_by_method() {
    //given
    let net = kxio::net::mock();
    let client = net.client();

    // NOTE: No URL specified - so should match any URL
    net.on().respond(StatusCode::OK).body("").expect("mock");

    //when
    let response = Net::from(net)
        .send(client.post("https://some.other.url"))
        .await
        .expect("response");

    //then
    assert_eq!(response.status(), http::StatusCode::OK);
    assert_eq!(response.bytes().await.expect("response body"), "");
}

#[tokio::test]
async fn test_post_by_body() {
    //given
    let net = kxio::net::mock();
    let client = net.client();

    // No URL - so any POST with a matching body
    net.on()
        .body("match on body")
        .respond(StatusCode::OK)
        .body("response body")
        .expect("mock");

    //when
    let response = Net::from(net)
        .send(client.post("https://some.other.url").body("match on body"))
        .await
        .expect("response");

    //then
    assert_eq!(response.status(), http::StatusCode::OK);
    assert_eq!(
        response.bytes().await.expect("response body"),
        "response body"
    );
}

#[tokio::test]
async fn test_post_by_header() {
    //given
    let net = kxio::net::mock();
    let client = net.client();

    net.on()
        .header("test", "match")
        .respond(StatusCode::OK)
        .body("response body")
        .expect("mock");

    //when
    let response = Net::from(net)
        .send(
            client
                .post("https://some.other.url")
                .body("any body")
                .header("test", "match"),
        )
        .await
        .expect("response");

    //then
    assert_eq!(response.status(), http::StatusCode::OK);
    assert_eq!(
        response.bytes().await.expect("response body"),
        "response body"
    );
}

#[tokio::test]
async fn test_post_by_header_wrong_value() {
    //given
    let mock_net = kxio::net::mock();
    let client = mock_net.client();

    mock_net
        .on()
        .header("test", "match")
        .respond(StatusCode::OK)
        .body("response body")
        .expect("mock");
    let net = Net::from(mock_net);

    //when
    let response = net
        .send(
            client
                .post("https://some.other.url")
                .body("any body")
                .header("test", "no match"),
        )
        .await;

    //then
    let_assert!(Err(kxio::net::Error::UnexpectedMockRequest { request: _ }) = response);

    MockNet::try_from(net).await.expect("recover mock").reset();
}

#[tokio::test]
#[should_panic(expected = "1 expected requests were not made")]
async fn test_unused_post_as_net() {
    //given
    let mock_net = kxio::net::mock();

    let url = "https://www.example.com";

    mock_net
        .on()
        .post(url)
        .respond(StatusCode::OK)
        .body("Post OK")
        .expect("mock");

    let net = Net::from(mock_net);

    //when
    // don't send the planned request
    // let _response = net.send(client.post(url)).await.expect("send");

    //then
    net.assert_no_unused_plans();
}

#[tokio::test]
#[should_panic(expected = "1 expected requests were not made")]
async fn test_unused_post_as_mocknet() {
    //given
    let mock_net = kxio::net::mock();

    let url = "https://www.example.com";

    mock_net
        .on()
        .post(url)
        .respond(StatusCode::OK)
        .body("Post OK")
        .expect("mock");

    //when
    // don't send the planned request
    // let _response = mock_net.send(client.post(url)).await.expect("send");

    //then
    mock_net.assert_no_unused_plans();
}

#[tokio::test]
async fn test_get_url_with_fragment() {
    //given
    let net = kxio::net::mock();
    let client = net.client();

    let url = "https://www.example.com#test";

    net.on()
        .get(url)
        .respond(StatusCode::OK)
        .body("post OK")
        .expect("mock");

    //when
    let response = Net::from(net).send(client.get(url)).await.expect("reponse");

    //then
    assert_eq!(response.status(), http::StatusCode::OK);
    assert_eq!(response.bytes().await.expect("response body"), "post OK");
}

#[tokio::test]
async fn test_get_with_query_parameters() {
    //given
    let mock_net = kxio::net::mock();
    let url = "https://www.example.com/path";

    mock_net
        .on()
        .get(url)
        .query("key-1", "value-1")
        .respond(StatusCode::OK)
        .body("with query parameters 1/1")
        .expect("mock");
    mock_net
        .on()
        .get(url)
        .query("key-1", "value-2")
        .respond(StatusCode::OK)
        .body("with query parameters 1/2")
        .expect("mock");
    mock_net
        .on()
        .get(url)
        .query("key-2", "value-2")
        .respond(StatusCode::OK)
        .body("with query parameters 2/2")
        .expect("mock");
    mock_net
        .on()
        .get(url)
        .respond(StatusCode::OK)
        .body("sans query parameters")
        .expect("mock");
    let net = Net::from(mock_net);

    //when
    // The order of 12 nad 11 should be in that order to ensure we test the discrimination of the
    // query value when the keys are the same
    let response_with_12 = net
        .get(url)
        .query("key-1", "value-2")
        .send()
        .await
        .expect("response with qp 1/2");
    let response_with_11 = net
        .get(url)
        .query("key-1", "value-1")
        .send()
        .await
        .expect("response with qp 1/1");
    let response_with_22 = net
        .get(url)
        .query("key-2", "value-2")
        .send()
        .await
        .expect("response with qp 2/2");
    let response_sans_qp = net.get(url).send().await.expect("response sans qp");

    //then
    assert_eq!(
        response_with_11.bytes().await.expect("with qp 1/1 body"),
        "with query parameters 1/1"
    );
    assert_eq!(
        response_with_12.bytes().await.expect("with qp 1/2 body"),
        "with query parameters 1/2"
    );
    assert_eq!(
        response_with_22.bytes().await.expect("with qp 2/2 body"),
        "with query parameters 2/2"
    );
    assert_eq!(
        response_sans_qp.bytes().await.expect("sans qp body"),
        "sans query parameters"
    );
}

#[tokio::test]
async fn test_get_with_duplicate_query_keys() {
    //given
    let mock_net = kxio::net::mock();
    let url = "https://www.example.com/path";

    mock_net
        .on()
        .get(url)
        .query("key", "value-1")
        .query("key", "value-2")
        .respond(StatusCode::OK)
        .body("key:value-1,value-2")
        .expect("mock");
    mock_net
        .on()
        .get(url)
        .query("key", "value-3")
        .query("key", "value-4")
        .respond(StatusCode::OK)
        .body("key:value-3,value-4")
        .expect("mock");
    let net = Net::from(mock_net);

    //when
    let response_a = net
        .get(url)
        .query("key", "value-2")
        .query("key", "value-1")
        .send()
        .await
        .expect("response a");
    let response_b = net
        .get(url)
        .query("key", "value-3")
        .query("key", "value-4")
        .send()
        .await
        .expect("response b");

    //then
    assert_eq!(
        response_a.bytes().await.expect("response a bytes"),
        "key:value-1,value-2"
    );
    assert_eq!(
        response_b.bytes().await.expect("response b bytes"),
        "key:value-3,value-4"
    );
}

#[tokio::test]
async fn test_get_with_basic_auth() {
    //given
    let mock_net = kxio::net::mock();
    let url = "https://www.example.com/path";

    mock_net
        .on()
        .get(url)
        .basic_auth("bob", Some("secret"))
        .respond(StatusCode::OK)
        .mock()
        .expect("mock");
    mock_net
        .on()
        .get(url)
        .basic_auth("bob", None::<String>)
        .respond(StatusCode::FORBIDDEN)
        .mock()
        .expect("mock");
    let net = Net::from(mock_net);

    //when
    let invalid = net.get(url).basic_auth("bob", None::<String>).send().await;
    let valid = net
        .get(url)
        .basic_auth("bob", Some("secret"))
        .send()
        .await
        .expect("valid response");

    //then
    let_assert!(Err(Error::ResponseError { response }) = invalid);
    assert_eq!(response.status(), StatusCode::FORBIDDEN);
    assert_eq!(valid.status(), StatusCode::OK);
}

#[tokio::test]
async fn test_get_with_bearer_auth() {
    //given
    let mock_net = kxio::net::mock();
    let url = "https://www.example.com/path";

    mock_net
        .on()
        .get(url)
        .bearer_auth("token")
        .respond(StatusCode::OK)
        .mock()
        .expect("mock");
    mock_net
        .on()
        .get(url)
        .bearer_auth("invalid")
        .respond(StatusCode::FORBIDDEN)
        .mock()
        .expect("mock");
    let net = Net::from(mock_net);

    //when
    let invalid = net.get(url).bearer_auth("invalid").send().await;
    let valid = net
        .get(url)
        .bearer_auth("token")
        .send()
        .await
        .expect("valid response");

    //then
    let_assert!(Err(Error::ResponseError { response }) = invalid);
    assert_eq!(response.status(), StatusCode::FORBIDDEN);
    assert_eq!(valid.status(), StatusCode::OK);
}

#[tokio::test]
async fn test_get_with_user_agent() {
    //given
    let mock_net = kxio::net::mock();
    let url = "https://www.example.com/path";

    mock_net
        .on()
        .get(url)
        .user_agent("007")
        .respond(StatusCode::OK)
        .mock()
        .expect("mock");
    mock_net
        .on()
        .get(url)
        .user_agent("orange")
        .respond(StatusCode::FORBIDDEN)
        .mock()
        .expect("mock");
    let net = Net::from(mock_net);

    //when
    let invalid = net.get(url).user_agent("orange").send().await;
    let valid = net
        .get(url)
        .user_agent("007")
        .send()
        .await
        .expect("valid response");

    //then
    let_assert!(Err(Error::ResponseError { response }) = invalid);
    assert_eq!(response.status(), StatusCode::FORBIDDEN);
    assert_eq!(valid.status(), StatusCode::OK);
}