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

// 📦🦋 charted TestKit: testing library for Axum services with testcontainers support
// Copyright (c) 2024 Noelware, LLC. <team@noelware.org>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

/// Checks whenever if a [`Response`][axum::http::response::Response] is successful
/// or not.
///
/// ## Example
/// ```rust
/// # use axum::http::{response::Response, StatusCode};
/// #
/// let res = Response::builder().status(StatusCode::OK).body(()).expect("response to be avaliable");
/// charted_testkit::assert_successful!(res);
/// ```
#[macro_export]
macro_rules! assert_successful {
    ($res:expr) => {
        assert!(($res).status().is_success());
    };
}

/// Macro to easily assert if a given [response][axum::http::response::Response]'s status code
/// is the same as one you provide.
///
/// ## Example
/// ```rust
/// # use axum::http::{response::Response, StatusCode};
/// #
/// let res = Response::builder().status(StatusCode::OK).body(()).expect("response to be avaliable");
/// charted_testkit::assert_status_code!(res, StatusCode::OK);
/// ```
#[macro_export]
macro_rules! assert_status_code {
    ($res:expr, $status:expr) => {
        assert_eq!($status, ($res).status());
    };
}

/// Macro to consume the full body of a [response][axum::http::response::Response] and returns
/// a [`Bytes`][axum::body::Bytes] container.
///
/// ```rust
/// # use axum::{http::response::Response, http::StatusCode, body::Bytes};
/// #
/// # #[tokio::main]
/// # async fn main() {
/// let res = Response::builder()
///     .status(StatusCode::OK)
///     .body(String::from("Hello, world!"))
///     .expect("response to be constructed");
///
/// assert_eq!(charted_testkit::consume_body!(res), Bytes::from_static(b"Hello, world!"));
/// # }
/// ```
#[macro_export]
macro_rules! consume_body {
    ($res:expr) => {{
        use $crate::__private::BodyExt;

        let collected = ($res).collect().await.expect("failed to consume full body");
        collected.to_bytes()
    }};
}

/// Assertion macro to indicate that a [`Response`][axum::http::response::Response] has the header it needs.
///
/// ## Example
/// ```
/// # use axum::http::{response::Response, StatusCode, header};
/// #
/// let res = Response::builder()
///     .status(StatusCode::OK)
///     .header("Accept", "application/json")
///     .body(())
///     .expect("response to be avaliable");
///
/// charted_testkit::assert_has_header!(res, header::ACCEPT);
/// ```
#[macro_export]
macro_rules! assert_has_header {
    ($res:expr, $header:expr) => {
        assert!($res.headers().get($header).is_some());
    };
}

/// Assertion macro to indicate that a [`Response`][axum::http::response::Response] doesn't have the header it needs.
///
/// ## Example
/// ```
/// # use axum::http::{response::Response, StatusCode, header};
/// #
/// let res = Response::builder().status(StatusCode::OK).body(()).expect("response to be avaliable");
/// charted_testkit::assert_doesnt_have_header!(res, header::ACCEPT);
/// ```
#[macro_export]
macro_rules! assert_doesnt_have_header {
    ($res:expr, $header:expr) => {
        assert!($res.headers().get($header).is_none());
    };
}