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
//! A real HTTP server for tests, on a real port.
//!
//! It binds an `axum::Router` to a random localhost port and serves
//! it on a background task. Reach for it when
//! [`crate::test_client::TestClient`] is not enough, for example
//! with a headless browser, WebSocket upgrades, or code that reads
//! the request scheme or host.
//!
//! ```ignore
//! use rustango::test_server::LiveServer;
//!
//! #[tokio::test]
//! async fn home_returns_200_over_real_http() {
//! let server = LiveServer::spawn(make_app()).await;
//! let body = reqwest::get(server.url("/")).await.unwrap().text().await.unwrap();
//! assert!(body.contains("Hello"));
//! server.shutdown().await;
//! }
//! ```
//!
//! ## Lifetime
//!
//! The handle owns the listener and the background task. Drop it,
//! or call `shutdown`, to stop the server. Each server binds
//! `127.0.0.1:0`, so parallel tests never share a port.
use std::net::SocketAddr;
use axum::Router;
use tokio::net::TcpListener;
use tokio::sync::oneshot;
use tokio::task::JoinHandle;
/// An HTTP server on a random localhost port.
///
/// Keep the value alive; dropping it stops the server. In tests
/// call [`Self::shutdown`] instead, so the server finishes before
/// the test returns.
pub struct LiveServer {
addr: SocketAddr,
shutdown: Option<oneshot::Sender<()>>,
join: Option<JoinHandle<()>>,
}
impl LiveServer {
/// Bind `router` to a random `127.0.0.1` port and serve it in
/// the background. It returns once the listener accepts
/// connections, so the first request cannot race startup.
///
/// # Panics
/// If the TCP bind fails. Panicking here names the real cause,
/// instead of leaving later requests to fail with "connection
/// refused".
pub async fn spawn(router: Router) -> Self {
let listener = TcpListener::bind("127.0.0.1:0")
.await
.expect("LiveServer: bind 127.0.0.1:0");
let addr = listener
.local_addr()
.expect("LiveServer: listener.local_addr()");
let (tx, rx) = oneshot::channel::<()>();
let join = tokio::spawn(async move {
// With ConnectInfo, as a real server runs: IP filters and
// per-IP limits read it (#1958).
axum::serve(
listener,
router.into_make_service_with_connect_info::<SocketAddr>(),
)
.with_graceful_shutdown(async move {
// Exit on the signal, or when the sender drops.
let _ = rx.await;
})
.await
.ok();
});
Self {
addr,
shutdown: Some(tx),
join: Some(join),
}
}
/// The bound address, `127.0.0.1:<random port>`.
#[must_use]
pub fn addr(&self) -> SocketAddr {
self.addr
}
/// Base URL, such as `http://127.0.0.1:54321`. No trailing
/// slash; use [`Self::url`] to add a path.
#[must_use]
pub fn base_url(&self) -> String {
format!("http://{}", self.addr)
}
/// Absolute URL for `path`. A leading slash is optional.
///
/// ```ignore
/// server.url("/users/1") // "http://127.0.0.1:54321/users/1"
/// server.url("users/1") // "http://127.0.0.1:54321/users/1"
/// ```
#[must_use]
pub fn url(&self, path: &str) -> String {
let path = path.strip_prefix('/').unwrap_or(path);
format!("http://{}/{}", self.addr, path)
}
/// Stop the server and wait for the background task to finish.
pub async fn shutdown(mut self) {
if let Some(tx) = self.shutdown.take() {
let _ = tx.send(());
}
if let Some(join) = self.join.take() {
let _ = join.await;
}
}
}
impl Drop for LiveServer {
fn drop(&mut self) {
// Signal the task even if the test forgot to call
// `shutdown`. Drop is sync, so we cannot await the task and
// it may outlive this handle for a moment.
if let Some(tx) = self.shutdown.take() {
let _ = tx.send(());
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use axum::routing::get;
use axum::Router;
fn echo_app() -> Router {
Router::new()
.route("/", get(|| async { "hello world" }))
.route(
"/status",
get(|| async { (axum::http::StatusCode::CREATED, "made") }),
)
}
#[tokio::test]
async fn spawn_returns_addr_on_loopback() {
let server = LiveServer::spawn(echo_app()).await;
let addr = server.addr();
assert!(addr.ip().is_loopback(), "addr: {addr}");
assert!(addr.port() > 0);
server.shutdown().await;
}
#[tokio::test]
async fn base_url_shape() {
let server = LiveServer::spawn(echo_app()).await;
let url = server.base_url();
assert!(url.starts_with("http://127.0.0.1:"), "url: {url}");
assert!(!url.ends_with('/'));
server.shutdown().await;
}
#[tokio::test]
async fn url_handles_with_and_without_leading_slash() {
let server = LiveServer::spawn(echo_app()).await;
let a = server.url("/foo");
let b = server.url("foo");
assert_eq!(a, b, "leading slash should be normalised");
assert!(a.ends_with("/foo"));
server.shutdown().await;
}
/// Talks HTTP/1.1 over a raw `TcpStream`, so the test does not
/// need an HTTP client crate.
#[tokio::test]
async fn serves_get_root_over_real_tcp() {
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::net::TcpStream;
let server = LiveServer::spawn(echo_app()).await;
let mut stream = TcpStream::connect(server.addr()).await.unwrap();
stream
.write_all(b"GET / HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n")
.await
.unwrap();
let mut buf = Vec::new();
stream.read_to_end(&mut buf).await.unwrap();
let raw = String::from_utf8_lossy(&buf);
assert!(raw.contains("HTTP/1.1 200"), "status line: {raw}");
assert!(raw.contains("hello world"), "body: {raw}");
server.shutdown().await;
}
/// Handlers and IP layers see the real peer, not a missing extension.
#[tokio::test]
async fn handlers_see_the_peer_address() {
use axum::extract::ConnectInfo;
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::net::TcpStream;
let app = Router::new().route(
"/ip",
get(|ConnectInfo(addr): ConnectInfo<SocketAddr>| async move { addr.ip().to_string() }),
);
let server = LiveServer::spawn(app).await;
let mut stream = TcpStream::connect(server.addr()).await.unwrap();
stream
.write_all(b"GET /ip HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n")
.await
.unwrap();
let mut buf = Vec::new();
stream.read_to_end(&mut buf).await.unwrap();
let raw = String::from_utf8_lossy(&buf);
assert!(raw.contains("HTTP/1.1 200"), "status line: {raw}");
assert!(raw.ends_with("127.0.0.1"), "body: {raw}");
server.shutdown().await;
}
/// `127.0.0.1:0` asks the OS for a fresh port each time, so
/// parallel tests do not collide.
#[tokio::test]
async fn parallel_servers_get_distinct_ports() {
let a = LiveServer::spawn(echo_app()).await;
let b = LiveServer::spawn(echo_app()).await;
assert_ne!(a.addr().port(), b.addr().port());
a.shutdown().await;
b.shutdown().await;
}
}