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
//! Builder for creating [`crate::mock::Mock`] services and testing them with a
//! [`tower_async_layer::Layer`].

use std::convert::Infallible;

use tower_async_layer::Layer;
use tower_async_service::Service;

pub mod marker {
    //! Marker types for builder state,
    //! used to prevent invalid state transitions.

    /// Marker type to indicates an unspecified Type.
    #[derive(Debug, Default)]
    pub struct None;

    /// Marker type to indicates a defined Type.
    #[derive(Debug, Default)]
    pub struct Defined;

    /// Marker type to indicates a successful response (used for the test type).
    #[derive(Debug, Default)]
    pub struct Ok<T>(pub T);

    /// Marker type to indicates an error (used for the test type).
    #[derive(Debug, Default)]
    pub struct Err<T>(pub T);
}

/// Defines the test data structure used by the builder,
/// to store internally the registeresd tests.
#[derive(Debug)]
pub struct Test<In, Out> {
    output: Out,
    expected_input: Option<In>,
}

/// Builder for creating [`crate::mock::Mock`] services and testing them with a
/// [`tower_async_layer::Layer`].
///
/// This generic builder is designed to make it easy to test your own
/// [`tower_async_layer::Layer`] in a type-safe and guided manner. It achieves
/// this by using the "Builder" pattern and a secure state flow guided by the Rust
/// type system.
///
/// # Flow
///
/// ```none
///                               define another cycle
///                               ┌───────┐
///                               │       │
///                               │       │
/// ┌───────────────┐     ┌───────▼───────┴───────┐              ┌─────────────────────────┐
/// │Define         │     │Define <Response>      │              │Execute and await the    │
/// │<Input> Request├─────►or <Error> to send from├──────────────►test using the previously│
/// └───────────────┘     │within the Mock Service│              │defined flow and using   │
///                       │to your Layer.         │   ┌──────────►the passed in Layer to   │
///                       └──────▲─────┬──────────┘   │          │generate the service used│
///                              │     │              │          │for testing.             │
///                    define    │     │              │          └─────────────┬───────────┘
///                    another   │     │              │                        │
///                    cycle     │     │              │                        │
///                        ┌─────┴─────▼──────────────┴─┐        ┌─────────────▼─────────────┐
///                        │Define the expected         │        │Optionally expect the final│
///                        │<Request> received by       │        │Output or Error (Result).  │
///                        │the Mock Service (Optional).│        │                           │
///                        └────────────────────────────┘        └───────────────────────────┘
/// ```
///
/// # Examples
///
/// ```
/// use tower_async_test::Builder;
/// use tower_async_layer::Identity;
///
/// #[tokio::main]
/// async fn main() {
///     Builder::new("ping")
///         .send_response("pong")
///         .expect_request("ping")
///         .test(Identity::new())
///         .await
///         .expect_response("pong");
/// }
/// ```
#[derive(Debug)]
pub struct Builder<R, T, RequestState> {
    request: R,
    tests: T,
    _request_state: RequestState,
}

//////////////////////////
/// Virgin Builder
//////////////////////////

impl<R> Builder<R, marker::None, marker::None> {
    /// Creates a new builder with the given request.
    pub fn new(request: R) -> Self {
        Self {
            request,
            tests: marker::None,
            _request_state: marker::None,
        }
    }

    /// Register the sending of a (successful) response.
    pub fn send_response<Response>(
        self,
        response: Response,
    ) -> Builder<R, Vec<Test<R, marker::Ok<Response>>>, marker::None> {
        Builder {
            request: self.request,
            tests: vec![Test {
                output: marker::Ok(response),
                expected_input: None,
            }],
            _request_state: marker::None,
        }
    }

    /// Register the sending of an error.
    pub fn send_error<Error>(
        self,
        error: Error,
    ) -> Builder<R, Vec<Test<R, marker::Err<Error>>>, marker::None> {
        Builder {
            request: self.request,
            tests: vec![Test {
                output: marker::Err(error),
                expected_input: None,
            }],
            _request_state: marker::None,
        }
    }
}

//////////////////////////
/// Ok-only test builder
//////////////////////////

impl<R, Response, RequestState> Builder<R, Vec<Test<R, marker::Ok<Response>>>, RequestState> {
    /// Register the sending of an additional (successful) response.
    pub fn send_response(
        mut self,
        response: Response,
    ) -> Builder<R, Vec<Test<R, marker::Ok<Response>>>, marker::None> {
        self.tests.push(Test {
            output: marker::Ok(response),
            expected_input: None,
        });
        Builder {
            request: self.request,
            tests: self.tests,
            _request_state: marker::None,
        }
    }

    /// Register the sending of an additional error.
    #[allow(clippy::type_complexity)]
    pub fn send_error<Error>(
        self,
        error: Error,
    ) -> Builder<R, Vec<Test<R, Result<Response, Error>>>, marker::None> {
        let mut tests: Vec<_> = self
            .tests
            .into_iter()
            .map(|test| Test {
                output: Ok(test.output.0),
                expected_input: test.expected_input,
            })
            .collect();
        tests.push(Test {
            output: Err(error),
            expected_input: None,
        });
        Builder {
            request: self.request,
            tests,
            _request_state: marker::None,
        }
    }
}

impl<R, Response, RequestState> Builder<R, Vec<Test<R, marker::Ok<Response>>>, RequestState>
where
    R: Send + Sync + std::fmt::Debug + PartialEq,
    Response: Send + Sync,
{
    /// Test the given [`tower_async_layer::Layer`] with the previously registered tests.
    ///
    /// # Panics
    ///
    /// Panics if there are less requests returned then there
    /// are responses+errors registered.
    pub async fn test<L>(
        self,
        layer: L,
    ) -> ResponseTester<
        <<L as Layer<crate::mock::Mock<R, Response, Infallible>>>::Service as Service<R>>::Response,
        <<L as Layer<crate::mock::Mock<R, Response, Infallible>>>::Service as Service<R>>::Error,
    >
    where
        L: Layer<crate::mock::Mock<R, Response, Infallible>>,
        L::Service: Service<R>,
    {
        let tests = self
            .tests
            .into_iter()
            .map(|test| Test {
                output: Ok(test.output.0),
                expected_input: test.expected_input,
            })
            .collect();
        test_layer(layer, self.request, tests).await
    }
}

impl<R, Response> Builder<R, Vec<Test<R, marker::Ok<Response>>>, marker::None> {
    /// Register the expectation of a request,
    /// for the same cycle as the previously added successful response.
    pub fn expect_request(
        mut self,
        request: R,
    ) -> Builder<R, Vec<Test<R, marker::Ok<Response>>>, marker::Defined> {
        self.tests.last_mut().unwrap().expected_input = Some(request);
        Builder {
            request: self.request,
            tests: self.tests,
            _request_state: marker::Defined,
        }
    }
}

//////////////////////////
/// Error-only test builder
//////////////////////////

impl<R, Error, RequestState> Builder<R, Vec<Test<R, marker::Err<Error>>>, RequestState> {
    /// Register the sending of an additional (successful) response.
    ///
    #[allow(clippy::type_complexity)]
    pub fn send_response<Response>(
        self,
        response: Response,
    ) -> Builder<R, Vec<Test<R, Result<Response, Error>>>, marker::None> {
        let mut tests: Vec<_> = self
            .tests
            .into_iter()
            .map(|test| Test {
                output: Err(test.output.0),
                expected_input: test.expected_input,
            })
            .collect();
        tests.push(Test {
            output: Ok(response),
            expected_input: None,
        });
        Builder {
            request: self.request,
            tests,
            _request_state: marker::None,
        }
    }

    /// Register the sending of an additional error.
    pub fn send_error(
        mut self,
        error: Error,
    ) -> Builder<R, Vec<Test<R, marker::Err<Error>>>, marker::None> {
        self.tests.push(Test {
            output: marker::Err(error),
            expected_input: None,
        });
        Builder {
            request: self.request,
            tests: self.tests,
            _request_state: marker::None,
        }
    }
}

impl<R, Error, RequestState> Builder<R, Vec<Test<R, marker::Err<Error>>>, RequestState>
where
    R: Send + Sync + std::fmt::Debug + PartialEq,
    Error: Send + Sync,
{
    /// Test the given layer with the previously registered tests.
    ///
    /// # Panics
    ///
    /// Panics if there are less requests returned then there
    /// are responses+errors registered.
    pub async fn test<L>(
        self,
        layer: L,
    ) -> ResponseTester<
        <<L as Layer<crate::mock::Mock<R, (), Error>>>::Service as Service<R>>::Response,
        <<L as Layer<crate::mock::Mock<R, (), Error>>>::Service as Service<R>>::Error,
    >
    where
        L: Layer<crate::mock::Mock<R, (), Error>>,
        L::Service: Service<R>,
    {
        let tests = self
            .tests
            .into_iter()
            .map(|test| Test {
                output: Err(test.output.0),
                expected_input: test.expected_input,
            })
            .collect();
        test_layer(layer, self.request, tests).await
    }
}

impl<R, Error> Builder<R, Vec<Test<R, marker::Err<Error>>>, marker::None> {
    /// Register the expectation of a request,
    /// for the same cycle as the previously added error.
    pub fn expect_request(
        mut self,
        request: R,
    ) -> Builder<R, Vec<Test<R, marker::Err<Error>>>, marker::Defined> {
        self.tests.last_mut().unwrap().expected_input = Some(request);
        Builder {
            request: self.request,
            tests: self.tests,
            _request_state: marker::Defined,
        }
    }
}

//////////////////////////
/// Full Result (Ok+Err mix) test builder
//////////////////////////

impl<R, Response, Error, RequestState>
    Builder<R, Vec<Test<R, Result<Response, Error>>>, RequestState>
{
    /// Register the sending of an additional (successful) response.
    #[allow(clippy::type_complexity)]
    pub fn send_response(
        mut self,
        response: Response,
    ) -> Builder<R, Vec<Test<R, Result<Response, Error>>>, marker::None> {
        self.tests.push(Test {
            output: Ok(response),
            expected_input: None,
        });
        Builder {
            request: self.request,
            tests: self.tests,
            _request_state: marker::None,
        }
    }

    /// Register the sending of an additional error.
    #[allow(clippy::type_complexity)]
    pub fn send_error(
        mut self,
        error: Error,
    ) -> Builder<R, Vec<Test<R, Result<Response, Error>>>, marker::None> {
        self.tests.push(Test {
            output: Err(error),
            expected_input: None,
        });
        Builder {
            request: self.request,
            tests: self.tests,
            _request_state: marker::None,
        }
    }
}

impl<R, Response, Error, RequestState>
    Builder<R, Vec<Test<R, Result<Response, Error>>>, RequestState>
where
    R: Send + Sync + std::fmt::Debug + PartialEq,
    Response: Send + Sync,
    Error: Send + Sync,
{
    /// Test the given layer with the previously registered tests.
    ///
    /// # Panics
    ///
    /// Panics if there are less requests returned then there
    /// are responses+errors registered.
    pub async fn test<L>(
        self,
        layer: L,
    ) -> ResponseTester<
        <<L as Layer<crate::mock::Mock<R, Response, Error>>>::Service as Service<R>>::Response,
        <<L as Layer<crate::mock::Mock<R, Response, Error>>>::Service as Service<R>>::Error,
    >
    where
        L: Layer<crate::mock::Mock<R, Response, Error>>,
        L::Service: Service<R>,
    {
        test_layer(layer, self.request, self.tests).await
    }
}

#[allow(clippy::type_complexity)]
impl<R, Response, Error> Builder<R, Vec<Test<R, Result<Response, Error>>>, marker::None> {
    /// Register the expectation of a request,
    /// for the same cycle as the previously added result.
    pub fn expect_request(
        mut self,
        request: R,
    ) -> Builder<R, Vec<Test<R, Result<Response, Error>>>, marker::Defined> {
        self.tests.last_mut().unwrap().expected_input = Some(request);
        Builder {
            request: self.request,
            tests: self.tests,
            _request_state: marker::Defined,
        }
    }
}

//////////////////////////
/// Shared Inner Functions
//////////////////////////

async fn test_layer<L, Request, Response, Error>(
    layer: L,
    request: Request,
    tests: Vec<Test<Request, Result<Response, Error>>>,
) -> ResponseTester<<<L as Layer<crate::mock::Mock<Request, Response, Error>>>::Service as Service<Request>>::Response, <<L as Layer<crate::mock::Mock<Request, Response, Error>>>::Service as Service<Request>>::Error>
where
    L: Layer<crate::mock::Mock<Request, Response, Error>>,
    L::Service: Service<Request>,
    Request: Send + Sync + std::fmt::Debug + PartialEq,
    Response: Send + Sync,
    Error: Send + Sync,
{
    let (service, handle) = crate::mock::spawn();

    let layer = layer;
    let mut service = layer.layer(service);

    let (input_results, expected_inputs): (Vec<_>, Vec<_>) = tests
        .into_iter()
        .map(|test| (test.output, test.expected_input))
        .unzip();

    {
        let mut handle = handle.lock().await;
        for result in input_results {
            handle.push_result(result);
        }
    }

    let response = service.call(request).await;

    {
        let mut handle = handle.lock().await;
        for expected_input in expected_inputs {
            let request = handle.pop_request();
            if let Some(expected_request) = expected_input {
                assert_eq!(request, expected_request);
            }
        }
    }

    ResponseTester::new(response)
}

//////////////////////////
/// ResponseTester
//////////////////////////

/// Helper type for testing the response of a layer's service.
#[derive(Debug)]
pub struct ResponseTester<Response, Error> {
    result: Result<Response, Error>,
}

/// Helper type for testing the response of a layer's service.
impl<Response, Error> ResponseTester<Response, Error> {
    /// Creates a new `ResponseTester` with the given result.
    pub(crate) fn new(result: Result<Response, Error>) -> Self {
        Self { result }
    }
}

impl<Response, Error> ResponseTester<Response, Error>
where
    Response: PartialEq + std::fmt::Debug,
    Error: std::fmt::Debug,
{
    /// Asserts that the response is equal to the given expected response.
    ///
    /// # Panics
    ///
    /// Panics if the response is an error or if the response is not equal to the given expected
    /// response.
    pub fn expect_response(self, expected: Response) {
        match self.result {
            Ok(response) => assert_eq!(response, expected),
            Err(err) => panic!("expected response, got error: {:?}", err),
        }
    }
}

impl<Response, Error> ResponseTester<Response, Error>
where
    Response: std::fmt::Debug,
    Error: PartialEq + std::fmt::Debug,
{
    /// Asserts that the response is equal to the given expected error.
    ///
    /// # Panics
    ///
    /// Panics if the response is not an error or if the error is not equal to the given expected
    /// error.
    pub fn expect_error(self, expected: Error) {
        match self.result {
            Ok(response) => panic!("expected error, got response: {:?}", response),
            Err(err) => assert_eq!(err, expected),
        }
    }
}