volga 0.9.7

Easy & Fast Web Framework for Rust
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

#![allow(missing_docs)]
#![cfg(feature = "test")]

use std::{
    io::ErrorKind,
    time::{Duration, Instant},
};

use volga::{App, ShutdownHandle, ok};

fn pick_free_port() -> u16 {
    std::net::TcpListener::bind("127.0.0.1:0")
        .unwrap()
        .local_addr()
        .unwrap()
        .port()
}

/// Returns whether this machine can listen on the IPv6 loopback.
fn has_ipv6_loopback() -> bool {
    std::net::TcpListener::bind("[::1]:0").is_ok()
}

/// A `reqwest::Client` with proxies disabled, so localhost probes are
/// not redirected by HTTP(S)_PROXY env vars set in the test environment.
fn local_client() -> reqwest::Client {
    reqwest::Client::builder()
        .no_proxy()
        .build()
        .expect("failed to build reqwest client")
}

async fn wait_until_listening(client: &reqwest::Client, url: &str) {
    let deadline = Instant::now() + Duration::from_secs(5);
    while Instant::now() < deadline {
        if client.get(url).send().await.is_ok() {
            return;
        }
        tokio::time::sleep(Duration::from_millis(20)).await;
    }
    panic!("server never started listening on {url}");
}

fn build_app(addr: String) -> (App, ShutdownHandle) {
    let (app, handle) = App::with_shutdown();
    let mut app = app.bind(addr).without_greeter();
    app.map_get("/ping", || async { ok!("pong") });
    (app, handle)
}

/// Serves `/ping` on `addr` and probes it at `url`.
async fn assert_serves(addr: String, url: String) {
    let (app, handle) = build_app(addr);
    let task = tokio::spawn(async move { app.run().await });

    let client = local_client();
    wait_until_listening(&client, &url).await;

    let response = client.get(&url).send().await.unwrap();
    assert!(response.status().is_success());
    assert_eq!(response.text().await.unwrap(), "pong");

    handle.shutdown();
    task.await.unwrap().unwrap();
}

#[tokio::test]
async fn it_binds_a_host_name() {
    let port = pick_free_port();

    assert_serves(
        format!("localhost:{port}"),
        format!("http://localhost:{port}/ping"),
    )
    .await;
}

#[tokio::test]
async fn it_binds_an_unbracketed_ipv6_literal() {
    if !has_ipv6_loopback() {
        return;
    }
    let port = pick_free_port();

    assert_serves(format!("::1:{port}"), format!("http://[::1]:{port}/ping")).await;
}

#[tokio::test]
async fn it_binds_a_bracketed_ipv6_literal() {
    if !has_ipv6_loopback() {
        return;
    }
    let port = pick_free_port();

    assert_serves(format!("[::1]:{port}"), format!("http://[::1]:{port}/ping")).await;
}

#[tokio::test]
async fn it_binds_an_ipv4_literal() {
    let port = pick_free_port();

    assert_serves(
        format!("127.0.0.1:{port}"),
        format!("http://127.0.0.1:{port}/ping"),
    )
    .await;
}

/// A bind address that cannot be understood must fail the startup instead of
/// silently listening somewhere else - see https://github.com/RomanEmreis/volga/issues/210
#[tokio::test]
async fn it_does_not_listen_on_a_different_address_when_the_address_is_invalid() {
    for addr in ["invalid_ip", "localhost", "", ":7878", "localhost:70000"] {
        let (app, _handle) = App::with_shutdown();
        let err = app
            .bind(addr)
            .without_greeter()
            .run()
            .await
            .expect_err("an address that cannot be understood must not start a server");

        assert_eq!(err.kind(), ErrorKind::InvalidInput, "address: '{addr}'");
        assert!(
            err.to_string().starts_with("invalid bind address"),
            "address: '{addr}', error: {err}"
        );
    }
}

#[tokio::test]
async fn it_does_not_listen_when_the_host_name_cannot_be_resolved() {
    let (app, _handle) = App::with_shutdown();

    let err = app
        .bind("volga.invalid:7878")
        .without_greeter()
        .run()
        .await
        .expect_err("an unresolvable host name must not start a server");

    // A resolver error carries no OS code and does not name the host, so it is annotated with
    // the address; a platform that reports resolution failures as OS errors keeps its own error.
    assert!(
        err.raw_os_error().is_some() || err.to_string().contains("volga.invalid:7878"),
        "an unresolvable name must be reported as an OS error or with the address: {err}"
    );
}