xecute 0.1.3

Nest-style modules and dependency injection for Axum
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
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

//! Exercise receiver-based routes, automatic validation, and OpenAPI contracts.

use axum::{
    body::{Body, to_bytes},
    http::Request,
};
use garde::Validate;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use std::sync::Arc;
use tower::ServiceExt;
use xecute::prelude::*;

#[derive(Deserialize, Validate, JsonSchema)]
struct Payload {
    #[garde(length(chars, min = 3))]
    name: String,
}

#[derive(Serialize, JsonSchema)]
struct Reply {
    name: String,
}

#[controller("/v1/test")]
#[derive(Injectable)]
struct TestController {}

#[routes]
impl TestController {
    #[post("/create")]
    #[api(summary = "Create", tag = "Tests", operation_id = "createTest")]
    #[body(json = Payload)]
    #[resp(200, "Created", json = Reply)]
    #[resp(422, "Invalid payload")]
    async fn create(&self, #[body] request: Payload) -> Result<Json<Reply>, HttpError> {
        Ok(Json(Reply { name: request.name }))
    }

    #[get("/search")]
    #[resp(200, "Query result", json = Reply)]
    async fn search(&self, #[query] request: Payload) -> Json<Reply> {
        Json(Reply { name: request.name })
    }
}

#[tokio::test]
async fn receiver_handlers_validate_before_running() {
    let controller = xecute::Container::builder()
        .injectable::<TestController>()
        .build()
        .unwrap()
        .resolve()
        .unwrap();
    let app = TestController::router(controller);
    for (payload, expected) in [
        (r#"{"name":"ab"}"#, 422),
        (r#"{"name":"Valid"}"#, 200),
        ("invalid", 400),
    ] {
        let request = Request::builder()
            .method("POST")
            .uri("/v1/test/create")
            .header("content-type", "application/json")
            .body(Body::from(payload))
            .unwrap();
        let response = app.clone().oneshot(request).await.unwrap();
        assert_eq!(response.status().as_u16(), expected);
        if expected == 200 {
            assert_eq!(
                serde_json::from_slice::<serde_json::Value>(
                    &to_bytes(response.into_body(), 4096).await.unwrap()
                )
                .unwrap()["name"],
                "Valid"
            );
        }
    }
    for (path, expected) in [
        ("/v1/test/search?name=ab", 422),
        ("/v1/test/search?name=Valid", 200),
    ] {
        assert_eq!(
            app.clone()
                .oneshot(Request::builder().uri(path).body(Body::empty()).unwrap())
                .await
                .unwrap()
                .status()
                .as_u16(),
            expected
        );
    }
}

#[test]
fn openapi_includes_routes_payloads_and_response_contracts() {
    let spec = xecute::openapi_document("Test", "1", TestController::api_operations()).unwrap();
    assert_eq!(spec["openapi"], "3.1.0");
    let create = &spec["paths"]["/v1/test/create"]["post"];
    assert_eq!(create["operationId"], "createTest");
    assert_eq!(
        create["requestBody"]["content"]["application/json"]["schema"]["properties"]["name"]["type"],
        "string"
    );
    assert!(
        create["responses"]["200"]["content"]["application/json"]["schema"]["properties"]["name"]
            .is_object()
    );
    assert!(
        xecute::openapi_document(
            "Test",
            "1",
            TestController::api_operations()
                .into_iter()
                .chain(TestController::api_operations())
                .collect()
        )
        .is_err()
    );
}

#[derive(Injectable)]
struct LegacyController {}

#[xecute::controller("/legacy")]
impl LegacyController {
    #[get("")]
    async fn list() -> Json<Vec<String>> {
        Json(Vec::new())
    }
}

#[tokio::test]
async fn original_impl_controller_syntax_remains_supported() {
    let app = LegacyController::router(Arc::new(LegacyController {}));
    assert_eq!(
        app.oneshot(
            Request::builder()
                .uri("/legacy")
                .body(Body::empty())
                .unwrap()
        )
        .await
        .unwrap()
        .status(),
        HttpStatus::OK
    );
}