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
use http::{HeaderMap, HeaderValue, Method, header, header::HeaderName};
use crate::{Endpoint, IntoEndpoint, test::TestRequestBuilder};
macro_rules! impl_methods {
($($(#[$docs:meta])* ($name:ident, $method:ident)),*) => {
$(
$(#[$docs])*
pub fn $name(&self, uri: impl Into<String>) -> TestRequestBuilder<'_, E> {
TestRequestBuilder::new(self, Method::$method, uri.into())
}
)*
};
}
/// A client for testing.
pub struct TestClient<E> {
pub(crate) ep: E,
pub(crate) default_headers: HeaderMap,
}
impl<E: Endpoint> TestClient<E> {
/// Create a new client for the specified endpoint.
pub fn new<T>(ep: T) -> TestClient<T::Endpoint>
where
T: IntoEndpoint<Endpoint = E>,
{
TestClient {
ep: ep.into_endpoint(),
default_headers: Default::default(),
}
}
/// Sets the default header for each requests.
///
/// # Examples
///
/// ```
/// use poem::{Route, handler, http::HeaderMap, test::TestClient};
///
/// #[handler]
/// fn index(headers: &HeaderMap) -> String {
/// headers
/// .get("X-Custom-Header")
/// .and_then(|value| value.to_str().ok())
/// .unwrap_or_default()
/// .to_string()
/// }
///
/// let app = Route::new().at("/", index);
/// let cli = TestClient::new(app).default_header("X-Custom-Header", "test");
///
/// # tokio::runtime::Runtime::new().unwrap().block_on(async {
/// let resp = cli.get("/").send().await;
/// resp.assert_status_is_ok();
/// resp.assert_text("test").await;
/// # });
/// ```
#[must_use]
pub fn default_header<K, V>(mut self, key: K, value: V) -> Self
where
K: TryInto<HeaderName>,
V: TryInto<HeaderValue>,
{
let key = key.try_into().map_err(|_| ()).expect("valid header name");
let value = value
.try_into()
.map_err(|_| ())
.expect("valid header value");
self.default_headers.append(key, value);
self
}
/// Upsert on default_headers for the current client.
///
/// # Examples
///
/// ```
/// use poem::{Route, handler, http::HeaderMap, test::TestClient};
///
/// #[handler]
/// fn index(headers: &HeaderMap) -> String {
/// headers
/// .get("X-Custom-Header")
/// .and_then(|value| value.to_str().ok())
/// .unwrap_or_default()
/// .to_string()
/// }
///
/// let app = Route::new().at("/", index);
/// let mut cli = TestClient::new(app).default_header("X-Custom-Header", "test");
///
/// # tokio::runtime::Runtime::new().unwrap().block_on(async {
/// let resp = cli.get("/").send().await;
/// resp.assert_status_is_ok();
/// resp.assert_text("test").await;
/// # });
///
/// cli.upsert_default_header("X-Custom-Header", "updated");
///
/// # tokio::runtime::Runtime::new().unwrap().block_on(async {
/// let resp = cli.get("/").send().await;
/// resp.assert_status_is_ok();
/// resp.assert_text("updated").await;
/// # });
/// ```
pub fn upsert_default_header<K, V>(&mut self, key: K, value: V)
where
K: TryInto<HeaderName>,
V: TryInto<HeaderValue>,
{
let key = key.try_into().map_err(|_| ()).expect("valid header name");
let value = value
.try_into()
.map_err(|_| ())
.expect("valid header value");
self.default_headers.insert(key, value);
}
/// Sets the default content type for each requests.
#[must_use]
pub fn default_content_type(self, content_type: impl AsRef<str>) -> Self {
self.default_header(header::CONTENT_TYPE, content_type.as_ref())
}
/// Create a [`TestRequestBuilder`].
pub fn request(&self, method: Method, uri: impl Into<String>) -> TestRequestBuilder<'_, E> {
TestRequestBuilder::new(self, method, uri.into())
}
impl_methods!(
/// Create a [`TestRequestBuilder`] with `GET` method.
(get, GET),
/// Create a [`TestRequestBuilder`] with `POST` method.
(post, POST),
/// Create a [`TestRequestBuilder`] with `PUT` method.
(put, PUT),
/// Create a [`TestRequestBuilder`] with `DELETE` method.
(delete, DELETE),
/// Create a [`TestRequestBuilder`] with `HEAD` method.
(head, HEAD),
/// Create a [`TestRequestBuilder`] with `OPTIONS` method.
(options, OPTIONS),
/// Create a [`TestRequestBuilder`] with `CONNECT` method.
(connect, CONNECT),
/// Create a [`TestRequestBuilder`] with `PATCH` method.
(patch, PATCH),
/// Create a [`TestRequestBuilder`] with `TRACE` method.
(trace, TRACE)
);
}