caelix 0.0.8

Public Caelix framework crate.
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

#![cfg(all(feature = "actix", feature = "validator"))]

use actix_web::{App, test as actix_test, web};
use caelix::{ModuleMetadata, Response, Result, controller, injectable};
use serde::Deserialize;
use serde_json::{Value, json};
use validator::Validate;

#[derive(Debug, Deserialize, Validate)]
struct CreateUserBody {
    #[validate(required)]
    name: Option<String>,
}

#[derive(Debug, Deserialize, Validate)]
struct SearchUsersQuery {
    #[validate(required)]
    q: Option<String>,
}

#[derive(Debug, Deserialize, Validate)]
struct UserPath {
    #[validate(range(min = 1))]
    id: i64,
}

#[injectable]
struct ValidationController;

#[controller("/validation")]
impl ValidationController {
    #[post("/body")]
    async fn create_body(
        &self,
        #[body]
        #[validate]
        _body: CreateUserBody,
    ) -> Result<Response<Value>> {
        Ok(Response::Body(json!({"ok": true})))
    }

    #[get("/query")]
    async fn search_query(
        &self,
        #[query]
        #[validate]
        _query: SearchUsersQuery,
    ) -> Result<Response<Value>> {
        Ok(Response::Body(json!({"ok": true})))
    }

    #[get("/path/{id}")]
    async fn find_by_path(
        &self,
        #[param]
        #[validate]
        _path: UserPath,
    ) -> Result<Response<Value>> {
        Ok(Response::Body(json!({"ok": true})))
    }
}

struct ValidationModule;

impl caelix::Module for ValidationModule {
    fn register() -> ModuleMetadata {
        ModuleMetadata::new().controller::<ValidationController>()
    }
}

#[actix_web::test]
async fn validate_body_empty_object_returns_field_errors() {
    let container = std::sync::Arc::new(caelix::build_container::<ValidationModule>().await);
    let app = actix_test::init_service(
        App::new()
            .app_data(web::Data::new(container))
            .configure(|cfg| caelix::register_module_controllers::<ValidationModule>(cfg)),
    )
    .await;

    let response = actix_test::call_service(
        &app,
        actix_test::TestRequest::post()
            .uri("/validation/body")
            .insert_header(("content-type", "application/json"))
            .set_payload("{}")
            .to_request(),
    )
    .await;

    assert_eq!(response.status(), actix_web::http::StatusCode::BAD_REQUEST);
    let body: Value = actix_test::read_body_json(response).await;
    assert_eq!(
        body,
        json!({
            "status": 400,
            "error": "Bad Request",
            "message": "Validation failed",
            "errors": {
                "name": ["is required"]
            }
        })
    );
}

#[actix_web::test]
async fn validate_query_empty_query_returns_field_errors() {
    let container = std::sync::Arc::new(caelix::build_container::<ValidationModule>().await);
    let app = actix_test::init_service(
        App::new()
            .app_data(web::Data::new(container))
            .configure(|cfg| caelix::register_module_controllers::<ValidationModule>(cfg)),
    )
    .await;

    let response = actix_test::call_service(
        &app,
        actix_test::TestRequest::get()
            .uri("/validation/query")
            .to_request(),
    )
    .await;

    assert_eq!(response.status(), actix_web::http::StatusCode::BAD_REQUEST);
    let body: Value = actix_test::read_body_json(response).await;
    assert_eq!(
        body,
        json!({
            "status": 400,
            "error": "Bad Request",
            "message": "Validation failed",
            "errors": {
                "q": ["is required"]
            }
        })
    );
}

#[actix_web::test]
async fn validate_path_runs_after_path_deserialization() {
    let container = std::sync::Arc::new(caelix::build_container::<ValidationModule>().await);
    let app = actix_test::init_service(
        App::new()
            .app_data(web::Data::new(container))
            .configure(|cfg| caelix::register_module_controllers::<ValidationModule>(cfg)),
    )
    .await;

    let response = actix_test::call_service(
        &app,
        actix_test::TestRequest::get()
            .uri("/validation/path/0")
            .to_request(),
    )
    .await;

    assert_eq!(response.status(), actix_web::http::StatusCode::BAD_REQUEST);
    let body: Value = actix_test::read_body_json(response).await;
    assert_eq!(
        body,
        json!({
            "status": 400,
            "error": "Bad Request",
            "message": "Validation failed",
            "errors": {
                "id": ["is invalid (range)"]
            }
        })
    );
}