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
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
use std::net::SocketAddr;
use crate::{
api::{output, server::MockServer},
common::util::Join,
};
/// Provides a reference to a mock configuration stored on a [MockServer](struct.MockServer.html).
/// This structure is used for interacting with, monitoring, and managing a specific mock's lifecycle,
/// such as observing call counts or removing the mock from the server.
///
/// This reference allows you to control and verify the behavior of the server in response to
/// incoming HTTP requests that match the mock criteria.
///
/// # Example
/// Demonstrates how to create and manipulate a mock on the server. This includes monitoring its usage
/// and effectively managing its lifecycle by removing it when necessary.
///
/// ```rust
/// use httpmock::prelude::*;
/// use reqwest::blocking::get;
///
/// // Arrange
/// let server = MockServer::start();
///
/// // Create and configure a mock
/// let mut mock = server.mock(|when, then| {
/// when.path("/test");
/// then.status(202);
/// });
///
/// // Act by sending a request and verifying the mock's hit count
/// let response1 = get(&server.url("/test")).unwrap();
/// assert_eq!(mock.hits(), 1); // Verify the mock was triggered
///
/// // Remove the mock and test the server's response to the same path again
/// mock.delete();
/// let response2 = get(&server.url("/test")).unwrap();
///
/// // Assert
/// assert_eq!(response1.status(), 202);
/// assert_eq!(response2.status(), 404); // Expect a 404 status after the mock is deleted
/// ```
pub struct Mock<'a> {
id: usize,
pub(crate) server: &'a MockServer,
}
impl<'a> Mock<'a> {
/// Creates a reference to an existing mock on `server`.
///
/// This is useful when a mock's ID was retained after its original [`Mock`] handle was dropped.
///
/// # Example
///
/// ```rust
/// use httpmock::{Mock, MockServer};
///
/// let server = MockServer::start();
/// let original = server.mock(|when, then| {
/// when.path("/test");
/// then.status(202);
/// });
/// let mock_id = original.id();
/// drop(original);
///
/// let recreated = Mock::new(mock_id, &server);
/// recreated.assert_calls(0);
/// ```
pub fn new(id: usize, server: &'a MockServer) -> Self {
Self { id, server }
}
/// Returns the identifier assigned to this mock by its server.
///
/// The identifier can be retained and later passed to [`Mock::new`] to recreate a handle to
/// the same server-side mock.
pub fn id(&self) -> usize {
self.id
}
/// Verifies that the mock server received exactly one HTTP request matching all specified
/// request conditions for this mock. This method is useful for confirming that a particular
/// operation interacts with the server as expected in test scenarios.
///
/// **Attention**: To assert receipt of multiple requests, use [Mock::assert_hits](struct.Mock.html#method.assert_hits)
/// or [Mock::hits](struct.Mock.html#method.hits) methods instead.
///
/// # Example
/// Demonstrates creating a mock to match a specific request path, sending a request to that path,
/// and then verifying that exactly one such request was received.
///
/// ```rust
/// use httpmock::prelude::*;
/// use reqwest::blocking::get;
///
/// // Arrange: Start a mock server and set up a mock
/// let server = MockServer::start();
/// let mut mock = server.mock(|when, then| {
/// when.path("/hits");
/// then.status(200);
/// });
///
/// // Act: Send a request to the specified path
/// get(&server.url("/hits")).unwrap();
///
/// // Assert: Check that the server received exactly one request that matched the mock
/// mock.assert();
/// ```
///
/// # Panics
/// This method will panic if the mock server did not receive exactly one matching request or if
/// there are issues with the mock server's availability.
pub fn assert(&self) {
self.assert_async().join()
}
/// Asynchronously verifies that the mock server received exactly one HTTP request matching all
/// specified request conditions for this mock. This method is suited for asynchronous testing environments
/// where operations against the mock server occur non-blockingly.
///
/// **Attention**: To assert the receipt of multiple requests asynchronously, consider using
/// [Mock::assert_hits_async](struct.Mock.html#method.assert_hits_async) or
/// [Mock::hits_async](struct.Mock.html#method.hits_async).
///
/// # Example
/// Demonstrates setting up an asynchronous mock, sending a request, and verifying that exactly
/// one such request was received.
///
/// ```rust
/// use httpmock::prelude::*;
/// use reqwest::get;
///
/// let rt = tokio::runtime::Runtime::new().unwrap();
/// rt.block_on(async {
/// // Arrange: Start a mock server asynchronously and set up a mock
/// let server = MockServer::start_async().await;
/// let mut mock = server.mock_async(|when, then| {
/// when.path("/hits");
/// then.status(200);
/// }).await;
///
/// // Act: Send a request to the specified path asynchronously
/// get(&server.url("/hits")).await.unwrap();
///
/// // Assert: Check that the server received exactly one request that matched the mock
/// mock.assert_async().await;
/// });
/// ```
///
/// # Panics
/// This method will panic if the mock server did not receive exactly one matching request or if
/// there are issues with the mock server's availability.
pub async fn assert_async(&self) {
self.assert_calls_async(1).await
}
/// Verifies that the mock server received the specified number of HTTP requests matching all
/// the request conditions defined for this mock.
///
/// This method is useful for confirming that a series of operations interact with the server as expected
/// within test scenarios, especially when specific interaction counts are significant.
///
/// **Attention**: Use [Mock::assert](struct.Mock.html#method.assert) for the common case of asserting exactly one hit.
///
/// # Example
/// Demonstrates creating a mock, sending multiple requests, and verifying the number of received requests
/// matches expectations.
///
/// ```rust
/// use httpmock::prelude::*;
/// use reqwest::blocking::get;
///
/// // Arrange: Start a mock server and configure a mock
/// let server = MockServer::start();
/// let mut mock = server.mock(|when, then| {
/// when.path("/hits");
/// then.status(200);
/// });
///
/// // Act: Send multiple requests to the configured path
/// get(&server.url("/hits")).unwrap();
/// get(&server.url("/hits")).unwrap();
///
/// // Assert: Check that the server received exactly two requests that matched the mock
/// mock.assert_hits(2);
/// ```
///
/// # Panics
/// This method will panic if the actual number of hits differs from the specified `hits`, or if
/// there are issues with the mock server's availability.
#[deprecated(since = "0.8.0", note = "please use `assert_calls` instead")]
pub fn assert_hits(&self, hits: usize) {
self.assert_calls(hits)
}
/// Verifies that the mock server received the specified number of HTTP requests matching all
/// the request conditions defined for this mock.
///
/// This method is useful for confirming that a series of operations interact with the server as expected
/// within test scenarios, especially when specific interaction counts are significant.
///
/// **Attention**: Use [Mock::assert](struct.Mock.html#method.assert) for the common case of asserting exactly one hit.
///
/// # Example
/// Demonstrates creating a mock, sending multiple requests, and verifying the number of received requests
/// matches expectations.
///
/// ```rust
/// use httpmock::prelude::*;
/// use reqwest::blocking::get;
///
/// // Arrange: Start a mock server and configure a mock
/// let server = MockServer::start();
/// let mut mock = server.mock(|when, then| {
/// when.path("/hits");
/// then.status(200);
/// });
///
/// // Act: Send multiple requests to the configured path
/// get(&server.url("/hits")).unwrap();
/// get(&server.url("/hits")).unwrap();
///
/// // Assert: Check that the server received exactly two requests that matched the mock
/// mock.assert_calls(2);
/// ```
///
/// # Panics
/// This method will panic if the actual number of hits differs from the specified `hits`, or if
/// there are issues with the mock server's availability.
pub fn assert_calls(&self, count: usize) {
self.assert_calls_async(count).join()
}
/// Asynchronously verifies that the mock server received the specified number of HTTP requests
/// matching all defined request conditions for this mock.
///
/// This method supports asynchronous testing environments, enabling non-blocking verification
/// of multiple interactions with the mock server. It's particularly useful when exact counts
/// of interactions are critical for test assertions.
///
/// **Attention**: For asserting exactly one request asynchronously, use
/// [Mock::assert_async](struct.Mock.html#method.assert_async) for simpler syntax.
///
/// # Example
/// Demonstrates setting up an asynchronous mock, sending multiple requests, and verifying the
/// number of requests received matches expectations.
///
/// ```rust
/// use httpmock::prelude::*;
/// use reqwest::get;
///
/// let rt = tokio::runtime::Runtime::new().unwrap();
/// rt.block_on(async {
/// // Arrange: Start a mock server asynchronously and set up a mock
/// let server = MockServer::start_async().await;
/// let mut mock = server.mock_async(|when, then| {
/// when.path("/hits");
/// then.status(200);
/// }).await;
///
/// // Act: Send multiple asynchronous requests to the configured path
/// get(&server.url("/hits")).await.unwrap();
/// get(&server.url("/hits")).await.unwrap();
///
/// // Assert: Check that the server received exactly two requests that matched the mock
/// mock.assert_hits_async(2).await;
/// });
/// ```
///
/// # Panics
/// This method will panic if the actual number of hits differs from the specified `hits`, or if
/// there are issues with the mock server's availability.
#[deprecated(since = "0.8.0", note = "please use `assert_calls_async` instead")]
pub async fn assert_hits_async(&self, hits: usize) {
self.assert_calls_async(hits).await
}
/// Asynchronously verifies that the mock server received the specified number of HTTP requests
/// matching all defined request conditions for this mock.
///
/// This method supports asynchronous testing environments, enabling non-blocking verification
/// of multiple interactions with the mock server. It's particularly useful when exact counts
/// of interactions are critical for test assertions.
///
/// **Attention**: For asserting exactly one request asynchronously, use
/// [Mock::assert_async](struct.Mock.html#method.assert_async) for simpler syntax.
///
/// # Example
/// Demonstrates setting up an asynchronous mock, sending multiple requests, and verifying the
/// number of requests received matches expectations.
///
/// ```rust
/// use httpmock::prelude::*;
/// use reqwest::get;
///
/// let rt = tokio::runtime::Runtime::new().unwrap();
/// rt.block_on(async {
/// // Arrange: Start a mock server asynchronously and set up a mock
/// let server = MockServer::start_async().await;
/// let mut mock = server.mock_async(|when, then| {
/// when.path("/hits");
/// then.status(200);
/// }).await;
///
/// // Act: Send multiple asynchronous requests to the configured path
/// get(&server.url("/hits")).await.unwrap();
/// get(&server.url("/hits")).await.unwrap();
///
/// // Assert: Check that the server received exactly two requests that matched the mock
/// mock.assert_calls_async(2).await;
/// });
/// ```
///
/// # Panics
/// This method will panic if the actual number of hits differs from the specified `hits`, or if
/// there are issues with the mock server's availability.
pub async fn assert_calls_async(&self, hits: usize) {
let active_mock = self
.server
.server_adapter
.as_ref()
.unwrap()
.fetch_mock(self.id)
.await
.expect("cannot deserialize mock server response");
if active_mock.call_counter == hits {
return;
}
if active_mock.call_counter > hits {
assert_eq!(
active_mock.call_counter, hits,
"The number of matching requests was higher than expected (expected {} but was {})",
hits, active_mock.call_counter
)
}
// Once exhausted, mocks ignore matching requests.
if let Some(limit) = active_mock.up_to_n_times
&& active_mock.is_exhausted()
{
assert_eq!(
active_mock.call_counter, hits,
"The number of matching requests was lower than expected (expected {} but was {}). The mock stopped \
matching after reaching its up_to_n_times limit of {}",
hits, active_mock.call_counter, limit
)
}
let closest_match = self
.server
.server_adapter
.as_ref()
.unwrap()
.verify(&active_mock.definition.request)
.await
.expect("Cannot contact mock server");
output::fail_with(active_mock.call_counter, hits, closest_match)
}
/// Returns the number of times the specified mock has been triggered on the mock server.
///
/// This method is useful for verifying that a mock has been invoked the expected number of times,
/// allowing for precise control and assertion of interactions within test scenarios.
///
/// # Example
/// Demonstrates setting up a mock, sending a request, and then verifying that the mock
/// was triggered exactly once.
///
/// ```rust
/// use httpmock::prelude::*;
/// use reqwest::blocking::get;
///
/// // Arrange: Start a mock server and create a mock
/// let server = MockServer::start();
/// let mut mock = server.mock(|when, then| {
/// when.path("/hits");
/// then.status(200);
/// });
///
/// // Act: Send a request to the mock path
/// get(&server.url("/hits")).unwrap();
///
/// // Assert: Verify the mock was called once
/// assert_eq!(1, mock.hits());
/// ```
///
/// # Panics
/// This method will panic if there are issues accessing the mock server or retrieving the hit count.
#[deprecated(since = "0.8.0", note = "please use `calls` instead")]
pub fn hits(&self) -> usize {
self.calls()
}
/// Returns the number of times the specified mock has been triggered on the mock server.
///
/// This method is useful for verifying that a mock has been invoked the expected number of times,
/// allowing for precise control and assertion of interactions within test scenarios.
///
/// # Example
/// Demonstrates setting up a mock, sending a request, and then verifying that the mock
/// was triggered exactly once.
///
/// ```rust
/// use httpmock::prelude::*;
/// use reqwest::blocking::get;
///
/// // Arrange: Start a mock server and create a mock
/// let server = MockServer::start();
/// let mut mock = server.mock(|when, then| {
/// when.path("/hits");
/// then.status(200);
/// });
///
/// // Act: Send a request to the mock path
/// get(&server.url("/hits")).unwrap();
///
/// // Assert: Verify the mock was called once
/// assert_eq!(1, mock.calls());
/// ```
///
/// # Panics
/// This method will panic if there are issues accessing the mock server or retrieving the hit count.
pub fn calls(&self) -> usize {
self.calls_async().join()
}
/// Asynchronously returns the number of times the specified mock has been triggered on the mock server.
///
/// This method is particularly useful in asynchronous test setups where non-blocking verifications
/// are needed to confirm that a mock has been invoked the expected number of times. It ensures test
/// assertions align with asynchronous operations.
///
/// # Example
/// Demonstrates setting up an asynchronous mock, sending a request, and then verifying the number
/// of times the mock was triggered.
///
/// ```rust
/// use httpmock::prelude::*;
/// use reqwest::get;
///
/// let rt = tokio::runtime::Runtime::new().unwrap();
/// rt.block_on(async {
/// // Arrange: Start an asynchronous mock server and create a mock
/// let server = MockServer::start_async().await;
/// let mut mock = server
/// .mock_async(|when, then| {
/// when.path("/hits");
/// then.status(200);
/// })
/// .await;
///
/// // Act: Send an asynchronous request to the mock path
/// get(&server.url("/hits")).await.unwrap();
///
/// // Assert: Verify the mock was called once
/// assert_eq!(1, mock.hits_async().await);
/// });
/// ```
///
/// # Panics
/// This method will panic if there are issues accessing the mock server or retrieving the hit count asynchronously.
#[deprecated(since = "0.8.0", note = "please use `calls_async` instead")]
pub async fn hits_async(&self) -> usize {
self.calls_async().await
}
/// Asynchronously returns the number of times the specified mock has been triggered on the mock server.
///
/// This method is particularly useful in asynchronous test setups where non-blocking verifications
/// are needed to confirm that a mock has been invoked the expected number of times. It ensures test
/// assertions align with asynchronous operations.
///
/// # Example
/// Demonstrates setting up an asynchronous mock, sending a request, and then verifying the number
/// of times the mock was triggered.
///
/// ```rust
/// use httpmock::prelude::*;
/// use reqwest::get;
///
/// let rt = tokio::runtime::Runtime::new().unwrap();
/// rt.block_on(async {
/// // Arrange: Start an asynchronous mock server and create a mock
/// let server = MockServer::start_async().await;
/// let mut mock = server
/// .mock_async(|when, then| {
/// when.path("/hits");
/// then.status(200);
/// })
/// .await;
///
/// // Act: Send an asynchronous request to the mock path
/// get(&server.url("/hits")).await.unwrap();
///
/// // Assert: Verify the mock was called once
/// assert_eq!(1, mock.calls_async().await);
/// });
/// ```
///
/// # Panics
/// This method will panic if there are issues accessing the mock server or retrieving the hit count asynchronously.
pub async fn calls_async(&self) -> usize {
let response = self
.server
.server_adapter
.as_ref()
.unwrap()
.fetch_mock(self.id)
.await
.expect("cannot deserialize mock server response");
response.call_counter
}
/// Removes the specified mock from the mock server. This operation is useful for testing scenarios
/// where the mock should no longer intercept requests, effectively simulating an environment
/// where certain endpoints may go offline or change behavior dynamically during testing.
///
/// # Example
/// Demonstrates creating a mock, verifying its behavior with a request, then deleting the mock and
/// verifying that subsequent requests are not intercepted.
///
/// ```rust
/// use httpmock::prelude::*;
/// use reqwest::blocking::get;
///
/// // Arrange: Start a mock server and set up a mock
/// let server = MockServer::start();
/// let mut mock = server.mock(|when, then| {
/// when.path("/test");
/// then.status(202);
/// });
///
/// // Act: Send a request to the mock and verify its behavior
/// let response1 = get(&server.url("/test")).unwrap();
/// assert_eq!(mock.hits(), 1); // Verify the mock was called once
///
/// // Delete the mock from the server
/// mock.delete();
///
/// // Send another request and verify the response now that the mock is deleted
/// let response2 = get(&server.url("/test")).unwrap();
///
/// // Assert: The first response should be 202 as the mock was active, the second should be 404
/// assert_eq!(response1.status(), 202);
/// assert_eq!(response2.status(), 404);
/// ```
///
/// This method ensures that the mock is completely removed, and any subsequent requests to the
/// same path will not be intercepted by this mock, typically resulting in a 404 Not Found response
/// unless another active mock matches the request.
pub fn delete(&mut self) {
self.delete_async().join();
}
/// Asynchronously deletes this mock from the mock server. This method is the asynchronous equivalent of
/// [Mock::delete](struct.Mock.html#method.delete) and is suited for use in asynchronous testing environments
/// where non-blocking operations are preferred.
///
/// # Example
/// Demonstrates creating an asynchronous mock, sending a request to verify its behavior, then deleting
/// the mock and verifying that subsequent requests are not intercepted.
///
/// ```rust
/// use httpmock::prelude::*;
/// use reqwest::get;
///
/// let rt = tokio::runtime::Runtime::new().unwrap();
/// rt.block_on(async {
/// // Arrange: Start an asynchronous mock server and create a mock
/// let server = MockServer::start_async().await;
/// let mut mock = server
/// .mock_async(|when, then| {
/// when.path("/test");
/// then.status(202);
/// })
/// .await;
///
/// // Act: Send a request to the mock path and verify the mock's hit count
/// let response1 = get(&server.url("/test")).await.unwrap();
/// assert_eq!(mock.hits_async().await, 1); // Verify the mock was called once
///
/// // Delete the mock asynchronously from the server
/// mock.delete_async().await;
///
/// // Send another request and check the response now that the mock is deleted
/// let response2 = get(&server.url("/test")).await.unwrap();
///
/// // Assert: The first response should be 202 as the mock was active, the second should be 404
/// assert_eq!(response1.status(), 202);
/// assert_eq!(response2.status(), 404);
/// });
/// ```
///
/// This method ensures that the mock is completely removed asynchronously, and any subsequent requests to the
/// same path will not be intercepted by this mock, typically resulting in a 404 Not Found response
/// unless another active mock matches the request.
pub async fn delete_async(&self) {
self.server
.server_adapter
.as_ref()
.unwrap()
.delete_mock(self.id)
.await
.expect("could not delete mock from server");
}
/// Limits this mock to serving up to `n` calls in total, counting calls it has already served.
///
/// Once the limit is reached, the mock stops matching and later requests fall through to
/// mocks created after it. Serving fewer than `n` calls does not fail the test, and
/// [Mock::calls](struct.Mock.html#method.calls) and
/// [Mock::assert_calls](struct.Mock.html#method.assert_calls) still work.
///
/// The limit is set in a separate request after the mock was created. If the code under test
/// may already be sending requests, use
/// [Then::up_to_n_times](struct.Then.html#method.up_to_n_times) instead.
///
/// # Example
/// Demonstrates limiting a mock to one call, after which a second mock takes over.
///
/// ```rust
/// use httpmock::prelude::*;
/// use reqwest::blocking::get;
///
/// // Arrange: Start a mock server and set up two mocks for the same path
/// let server = MockServer::start();
/// let first = server.mock(|when, then| {
/// when.path("/test");
/// then.status(202);
/// });
/// let second = server.mock(|when, then| {
/// when.path("/test");
/// then.status(302);
/// });
///
/// // Limit the first mock to a single call
/// first.up_to_n_times(1);
///
/// // Act: The first request is served by the first mock, the second one by the second mock
/// let response1 = get(&server.url("/test")).unwrap();
/// let response2 = get(&server.url("/test")).unwrap();
///
/// // Assert
/// assert_eq!(response1.status(), 202);
/// assert_eq!(response2.status(), 302);
/// first.assert_calls(1);
/// second.assert_calls(1);
/// ```
///
/// # Panics
/// This method will panic if `n` is zero, if the mock no longer exists on the server, if the
/// mock server is a remote server that predates this method, or if there are issues with the
/// mock server's availability.
pub fn up_to_n_times(&self, n: usize) {
self.up_to_n_times_async(n).join();
}
/// Asynchronously limits this mock to serving up to `n` calls in total. This method is the
/// asynchronous equivalent of [Mock::up_to_n_times](struct.Mock.html#method.up_to_n_times).
///
/// # Example
/// Demonstrates limiting a mock to one call, after which a second mock takes over.
///
/// ```rust
/// use httpmock::prelude::*;
/// use reqwest::get;
///
/// let rt = tokio::runtime::Runtime::new().unwrap();
/// rt.block_on(async {
/// // Arrange: Start an asynchronous mock server and set up two mocks for the same path
/// let server = MockServer::start_async().await;
/// let first = server
/// .mock_async(|when, then| {
/// when.path("/test");
/// then.status(202);
/// })
/// .await;
/// let second = server
/// .mock_async(|when, then| {
/// when.path("/test");
/// then.status(302);
/// })
/// .await;
///
/// // Limit the first mock to a single call
/// first.up_to_n_times_async(1).await;
///
/// // Act: The first request is served by the first mock, the second one by the second mock
/// let response1 = get(&server.url("/test")).await.unwrap();
/// let response2 = get(&server.url("/test")).await.unwrap();
///
/// // Assert
/// assert_eq!(response1.status(), 202);
/// assert_eq!(response2.status(), 302);
/// first.assert_calls_async(1).await;
/// second.assert_calls_async(1).await;
/// });
/// ```
///
/// # Panics
/// This method will panic if `n` is zero, if the mock no longer exists on the server, if the
/// mock server is a remote server that predates this method, or if there are issues with the
/// mock server's availability.
pub async fn up_to_n_times_async(&self, n: usize) {
self.server
.server_adapter
.as_ref()
.unwrap()
.set_up_to_n_times(self.id, n)
.await
.expect("could not set the up_to_n_times limit on mock");
}
/// Returns the network address of the mock server where the associated mock object is stored.
///
/// This method provides access to the IP address and port number of the mock server, useful for
/// connecting to it in tests or displaying its address in debugging output.
///
/// # Example
/// Demonstrates how to retrieve and print the address of a mock server after it has been started.
///
/// ```rust
/// use httpmock::prelude::*;
/// use std::net::SocketAddr;
///
/// // Arrange: Start a mock server
/// let server = MockServer::start();
///
/// // Print the address of the server
/// let address: &SocketAddr = server.address();
/// println!("{}", address);
/// // Output will be something like "127.0.0.1:12345", where 12345 is the port the server is running on.
/// ```
pub fn server_address(&self) -> &SocketAddr {
self.server.server_adapter.as_ref().unwrap().address()
}
}
/// A set of mocks created from a recording.
#[cfg(feature = "record")]
pub struct MockSet<'a> {
pub ids: Vec<usize>,
pub(crate) server: &'a MockServer,
}
#[cfg(feature = "record")]
impl<'a> MockSet<'a> {
pub fn delete(&mut self) {
self.delete_async().join();
}
pub async fn delete_async(&self) {
for id in &self.ids {
self.server
.server_adapter
.as_ref()
.unwrap()
.delete_mock(*id)
.await
.expect("could not delete mock from server");
}
}
}