boardwalk 0.2.0

Hypermedia server framework with reverse-tunnel federation
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

//! Hubless device registration via Boardwalk::register_factory.

use std::collections::HashMap;
use std::net::SocketAddr;

use boardwalk::{Boardwalk, Device, DeviceConfig, DeviceError, TransitionInput};
use futures::future::BoxFuture;
use serde_json::Value as Json;

#[derive(Default)]
struct Led {
    name: Option<String>,
    on: bool,
}

impl Device for Led {
    fn config(&self, cfg: &mut DeviceConfig) {
        cfg.type_("led")
            .state(self.state())
            .when("off", &["turn-on"])
            .when("on", &["turn-off"]);
        if let Some(n) = &self.name {
            cfg.name(n.clone());
        }
    }
    fn state(&self) -> &str {
        if self.on { "on" } else { "off" }
    }
    fn transition<'a>(
        &'a mut self,
        name: &'a str,
        _input: TransitionInput,
    ) -> BoxFuture<'a, Result<(), DeviceError>> {
        Box::pin(async move {
            match name {
                "turn-on" => {
                    self.on = true;
                    Ok(())
                }
                "turn-off" => {
                    self.on = false;
                    Ok(())
                }
                _ => Err(DeviceError::Invalid("?".into())),
            }
        })
    }
}

async fn serve(boardwalk: Boardwalk) -> SocketAddr {
    let built = boardwalk.build().unwrap();
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = listener.local_addr().unwrap();
    tokio::spawn(async move {
        axum::serve(listener, built.router).await.unwrap();
    });
    addr
}

#[tokio::test]
async fn register_factory_creates_device_at_runtime() {
    let boardwalk =
        Boardwalk::new()
            .name("hub")
            .register_factory("led", |args: HashMap<String, String>| {
                let _ = args;
                Ok(Box::new(Led::default()) as Box<dyn Device>)
            });
    let addr = serve(boardwalk).await;

    // Before any POST, no devices.
    let server: Json = reqwest::get(format!("http://{addr}/servers/hub"))
        .await
        .unwrap()
        .json()
        .await
        .unwrap();
    assert!(
        server
            .get("entities")
            .and_then(|e| e.as_array())
            .map(|a| a.is_empty())
            .unwrap_or(true)
    );

    // POST a registration.
    let client = reqwest::Client::new();
    let resp = client
        .post(format!("http://{addr}/servers/hub/devices"))
        .header("content-type", "application/x-www-form-urlencoded")
        .body("type=led&name=KitchenLED")
        .send()
        .await
        .unwrap();
    assert_eq!(resp.status(), 201);
    let dev: Json = resp.json().await.unwrap();
    assert_eq!(dev["properties"]["type"], "led");
    assert_eq!(dev["properties"]["name"], "KitchenLED");
    assert_eq!(dev["properties"]["state"], "off");

    // The device now appears in the server listing.
    let server: Json = reqwest::get(format!("http://{addr}/servers/hub"))
        .await
        .unwrap()
        .json()
        .await
        .unwrap();
    let entities = server["entities"].as_array().unwrap();
    assert_eq!(entities.len(), 1);
    assert_eq!(entities[0]["properties"]["name"], "KitchenLED");
}

#[tokio::test]
async fn missing_type_returns_400() {
    let boardwalk = Boardwalk::new()
        .name("hub")
        .register_factory("led", |_| Ok(Box::new(Led::default()) as Box<dyn Device>));
    let addr = serve(boardwalk).await;
    let client = reqwest::Client::new();
    let resp = client
        .post(format!("http://{addr}/servers/hub/devices"))
        .header("content-type", "application/x-www-form-urlencoded")
        .body("name=Foo")
        .send()
        .await
        .unwrap();
    assert_eq!(resp.status(), 400);
}

#[tokio::test]
async fn unknown_type_returns_400() {
    let boardwalk = Boardwalk::new()
        .name("hub")
        .register_factory("led", |_| Ok(Box::new(Led::default()) as Box<dyn Device>));
    let addr = serve(boardwalk).await;
    let client = reqwest::Client::new();
    let resp = client
        .post(format!("http://{addr}/servers/hub/devices"))
        .header("content-type", "application/x-www-form-urlencoded")
        .body("type=motion")
        .send()
        .await
        .unwrap();
    assert_eq!(resp.status(), 400);
}

#[tokio::test]
async fn no_factories_returns_501() {
    let addr = serve(Boardwalk::new().name("hub")).await;
    let client = reqwest::Client::new();
    let resp = client
        .post(format!("http://{addr}/servers/hub/devices"))
        .header("content-type", "application/x-www-form-urlencoded")
        .body("type=led")
        .send()
        .await
        .unwrap();
    assert_eq!(resp.status(), 501);
}