modo-rs 0.8.0

Rust web framework for small monolithic apps
Documentation 
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

use axum::body::Body;
use http::{Method, Request};
use serde::Serialize;
use tower::ServiceExt;

use super::response::TestResponse;

/// A builder for an in-process HTTP request sent to a [`super::TestApp`].
///
/// Obtain one from the HTTP-method helpers on `TestApp` (e.g. `app.get("/")`)
/// or directly via [`TestRequestBuilder::new`]. Configure headers and a body,
/// then call [`send`](TestRequestBuilder::send) to execute the request and
/// receive a [`TestResponse`].
#[must_use]
pub struct TestRequestBuilder {
    router: axum::Router,
    method: Method,
    uri: String,
    headers: Vec<(String, String)>,
    body: Option<Vec<u8>>,
}

impl TestRequestBuilder {
    /// Create a new builder that will dispatch `method` to `uri` on `router`.
    pub fn new(router: axum::Router, method: Method, uri: &str) -> Self {
        Self {
            router,
            method,
            uri: uri.to_string(),
            headers: Vec::new(),
            body: None,
        }
    }

    /// Append an HTTP header to the request.
    pub fn header(mut self, key: &str, value: &str) -> Self {
        self.headers.push((key.to_string(), value.to_string()));
        self
    }

    /// Serialize `body` as JSON and set `content-type: application/json`.
    ///
    /// Any previously set `content-type` header is replaced.
    ///
    /// # Panics
    ///
    /// Panics if serialization fails.
    pub fn json<T: Serialize>(mut self, body: &T) -> Self {
        let bytes = serde_json::to_vec(body).expect("failed to serialize JSON body");
        self.headers.retain(|(k, _)| k != "content-type");
        self.headers
            .push(("content-type".to_string(), "application/json".to_string()));
        self.body = Some(bytes);
        self
    }

    /// URL-encode `body` as a form and set `content-type: application/x-www-form-urlencoded`.
    ///
    /// Any previously set `content-type` header is replaced.
    ///
    /// # Panics
    ///
    /// Panics if serialization fails.
    pub fn form<T: Serialize>(mut self, body: &T) -> Self {
        let encoded = serde_urlencoded::to_string(body).expect("failed to serialize form body");
        self.headers.retain(|(k, _)| k != "content-type");
        self.headers.push((
            "content-type".to_string(),
            "application/x-www-form-urlencoded".to_string(),
        ));
        self.body = Some(encoded.into_bytes());
        self
    }

    /// Set a raw byte body without modifying any headers.
    pub fn body(mut self, body: impl Into<Vec<u8>>) -> Self {
        self.body = Some(body.into());
        self
    }

    /// Dispatch the request in-process and return the [`TestResponse`].
    ///
    /// # Panics
    ///
    /// Panics if the request cannot be built or the router returns an error.
    pub async fn send(self) -> TestResponse {
        let body = match self.body {
            Some(bytes) => Body::from(bytes),
            None => Body::empty(),
        };

        let mut request = Request::builder().method(self.method).uri(self.uri);
        for (key, value) in &self.headers {
            request = request.header(key.as_str(), value.as_str());
        }
        let request = request.body(body).expect("failed to build request");

        let response = self.router.oneshot(request).await.expect("request failed");

        let status = response.status();
        let headers = response.headers().clone();
        let body = axum::body::to_bytes(response.into_body(), usize::MAX)
            .await
            .expect("failed to read response body");

        TestResponse::new(status, headers, body.to_vec())
    }
}