rocket 0.5.1

Web framework with a focus on usability, security, extensibility, and speed.
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

#[macro_use] extern crate rocket;

#[get("/")]
fn inspect_ip(ip: Option<std::net::IpAddr>) -> String {
    ip.map(|ip| ip.to_string()).unwrap_or("<none>".into())
}

mod tests {
    use rocket::{Rocket, Build, Route};
    use rocket::local::blocking::Client;
    use rocket::figment::Figment;
    use rocket::http::Header;

    fn routes() -> Vec<Route> {
        routes![super::inspect_ip]
    }

    fn rocket_with_custom_ip_header(header: Option<&'static str>) -> Rocket<Build> {
        let mut config = rocket::Config::debug_default();
        config.ip_header = header.map(|h| h.into());
        rocket::custom(config).mount("/", routes())
    }

    #[test]
    fn check_real_ip_header_works() {
        let client = Client::debug(rocket_with_custom_ip_header(Some("IP"))).unwrap();
        let response = client.get("/")
            .header(Header::new("X-Real-IP", "1.2.3.4"))
            .header(Header::new("IP", "8.8.8.8"))
            .dispatch();

        assert_eq!(response.into_string(), Some("8.8.8.8".into()));

        let response = client.get("/")
            .header(Header::new("IP", "1.1.1.1"))
            .dispatch();

        assert_eq!(response.into_string(), Some("1.1.1.1".into()));

        let response = client.get("/").dispatch();
        assert_eq!(response.into_string(), Some("<none>".into()));
    }

    #[test]
    fn check_real_ip_header_works_again() {
        let client = Client::debug(rocket_with_custom_ip_header(Some("x-forward-ip"))).unwrap();
        let response = client.get("/")
            .header(Header::new("X-Forward-IP", "1.2.3.4"))
            .dispatch();

        assert_eq!(response.into_string(), Some("1.2.3.4".into()));

        let config = Figment::from(rocket::Config::debug_default())
            .merge(("ip_header", "x-forward-ip"));

        let client = Client::debug(rocket::custom(config).mount("/", routes())).unwrap();
        let response = client.get("/")
            .header(Header::new("X-Forward-IP", "1.2.3.4"))
            .dispatch();

        assert_eq!(response.into_string(), Some("1.2.3.4".into()));
    }

    #[test]
    fn check_default_real_ip_header_works() {
        let client = Client::debug_with(routes()).unwrap();
        let response = client.get("/")
            .header(Header::new("X-Real-IP", "1.2.3.4"))
            .dispatch();

        assert_eq!(response.into_string(), Some("1.2.3.4".into()));
    }

    #[test]
    fn check_no_ip_header_works() {
        let client = Client::debug(rocket_with_custom_ip_header(None)).unwrap();
        let response = client.get("/")
            .header(Header::new("X-Real-IP", "1.2.3.4"))
            .dispatch();

        assert_eq!(response.into_string(), Some("<none>".into()));

        let config = Figment::from(rocket::Config::debug_default())
            .merge(("ip_header", false));

        let client = Client::debug(rocket::custom(config).mount("/", routes())).unwrap();
        let response = client.get("/")
            .header(Header::new("X-Real-IP", "1.2.3.4"))
            .dispatch();

        assert_eq!(response.into_string(), Some("<none>".into()));

        let config = Figment::from(rocket::Config::debug_default());
        let client = Client::debug(rocket::custom(config).mount("/", routes())).unwrap();
        let response = client.get("/")
            .header(Header::new("X-Real-IP", "1.2.3.4"))
            .dispatch();

        assert_eq!(response.into_string(), Some("1.2.3.4".into()));
    }
}