phoxal 0.8.0

Phoxal — production-oriented autonomous robot framework (engine, model, typed bus, contracts).
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

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
pub struct ScenarioSpec {
    pub name: String,
    pub world: WebotsWorld,
    pub test: String,
    pub timeout_secs: u64,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub category: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub tier: Option<u8>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub fixture_bundle: Option<String>,
}

#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
#[serde(transparent)]
pub struct WebotsWorld {
    name: String,
}

impl WebotsWorld {
    pub fn named(name: impl Into<String>) -> Self {
        Self { name: name.into() }
    }

    pub fn as_str(&self) -> &str {
        &self.name
    }
}

impl ScenarioSpec {
    pub fn new(name: impl Into<String>) -> Self {
        let name = name.into();
        Self {
            test: name.clone(),
            name,
            world: WebotsWorld::named("headless"),
            timeout_secs: 30,
            category: None,
            tier: None,
            fixture_bundle: None,
        }
    }

    pub fn world(mut self, world: WebotsWorld) -> Self {
        self.world = world;
        self
    }

    pub fn test(mut self, test: impl Into<String>) -> Self {
        self.test = test.into();
        self
    }

    pub fn timeout_secs(mut self, timeout_secs: u64) -> Self {
        self.timeout_secs = timeout_secs;
        self
    }

    pub fn category(mut self, category: impl Into<String>) -> Self {
        self.category = Some(category.into());
        self
    }

    pub fn tier(mut self, tier: u8) -> Self {
        self.tier = Some(tier);
        self
    }

    pub fn fixture_bundle(mut self, fixture_bundle: impl Into<String>) -> Self {
        self.fixture_bundle = Some(fixture_bundle.into());
        self
    }
}

#[cfg(test)]
mod tests {
    use super::{ScenarioSpec, WebotsWorld};

    #[test]
    fn scenario_spec_builds_robot_acceptance_shape() {
        let spec = ScenarioSpec::new("drive-forward")
            .world(WebotsWorld::named("ArenaWorld"))
            .test("drive_forward")
            .timeout_secs(30)
            .category("directed-drive")
            .tier(1);

        assert_eq!(spec.name, "drive-forward");
        assert_eq!(spec.world.as_str(), "ArenaWorld");
        assert_eq!(spec.test, "drive_forward");
        assert_eq!(spec.timeout_secs, 30);
        assert_eq!(spec.category.as_deref(), Some("directed-drive"));
        assert_eq!(spec.tier, Some(1));
        assert_eq!(spec.fixture_bundle, None);
    }

    #[test]
    fn webots_world_serializes_as_name() {
        let json = serde_json::to_string(&WebotsWorld::named("SimpleWorld")).unwrap();

        assert_eq!(json, "\"SimpleWorld\"");
    }
}