phoxal-model 0.45.2

Phoxal canonical robot model and robot.json wire schema.
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188

use phoxal_model::{Robot, component::CapabilityRef};

const GOLDEN: &[u8] = include_bytes!("golden/rgbd-imu-diff-drive.robot.json");

#[test]
fn golden_robot_round_trips_deterministically() {
    let robot = Robot::decode(GOLDEN).expect("golden robot must decode");
    assert_eq!(robot.encode().expect("robot must encode"), GOLDEN);
    assert_eq!(robot.robot_id(), "rgbd-imu-diff-drive");
    assert_eq!(robot.components().len(), 7);
}

#[test]
fn component_link_targets_resolve_against_the_canonical_component_structure() {
    let robot = Robot::decode(GOLDEN).expect("golden robot must decode");
    let reference = CapabilityRef::new("front_camera", "imu");
    assert_eq!(
        robot.link_target_frame(&reference).unwrap(),
        "front_camera__imu_link"
    );
}

#[test]
fn decode_rejects_unknown_fields_at_every_level() {
    let mut value: serde_json::Value = serde_json::from_slice(GOLDEN).unwrap();
    value["robot"]["motion"]["limits"]["unknown"] = serde_json::json!(true);
    let error = Robot::decode(&serde_json::to_vec(&value).unwrap()).unwrap_err();
    assert!(error.to_string().contains("unknown field"));

    let mut value: serde_json::Value = serde_json::from_slice(GOLDEN).unwrap();
    value["robot"]["structure"]["joints"][0]["unknown"] = serde_json::json!(true);
    let error = Robot::decode(&serde_json::to_vec(&value).unwrap()).unwrap_err();
    assert!(error.to_string().contains("unknown field"));

    let mut value: serde_json::Value = serde_json::from_slice(GOLDEN).unwrap();
    value["robot"]["component_types"]["drive_motor"]["structure"]["links"][1]["visuals"][0]["geometry"]
        ["unknown"] = serde_json::json!(true);
    let error = Robot::decode(&serde_json::to_vec(&value).unwrap()).unwrap_err();
    assert!(error.to_string().contains("unknown field"));
}

#[test]
fn decode_rejects_duplicate_object_fields() {
    let duplicate = br#"{"schema":"phoxal/robot/v0","schema":"phoxal/robot/v0","robot":{}}"#;
    assert!(
        Robot::decode(duplicate)
            .unwrap_err()
            .to_string()
            .contains("duplicate JSON object field")
    );
}

#[test]
fn decode_rejects_invalid_references_and_values() {
    let mut value: serde_json::Value = serde_json::from_slice(GOLDEN).unwrap();
    value["robot"]["component_instances"]["imu"]["component_type"] = serde_json::json!("missing");
    assert!(
        Robot::decode(&serde_json::to_vec(&value).unwrap())
            .unwrap_err()
            .to_string()
            .contains("unknown component type")
    );

    let mut value: serde_json::Value = serde_json::from_slice(GOLDEN).unwrap();
    value["robot"]["motion"]["limits"]["max_linear_speed_mps"] = serde_json::json!(-1.0);
    assert!(
        Robot::decode(&serde_json::to_vec(&value).unwrap())
            .unwrap_err()
            .to_string()
            .contains("max_linear_speed_mps")
    );

    let mut value: serde_json::Value = serde_json::from_slice(GOLDEN).unwrap();
    value["robot"]["structure"]["joints"][1]["parent"] =
        serde_json::json!("front_right_wheel_mount");
    value["robot"]["structure"]["joints"][2]["parent"] =
        serde_json::json!("front_left_wheel_mount");
    assert!(
        Robot::decode(&serde_json::to_vec(&value).unwrap())
            .unwrap_err()
            .to_string()
            .contains("joint cycle")
    );

    let mut value: serde_json::Value = serde_json::from_slice(GOLDEN).unwrap();
    value["robot"]["component_instances"]["front_left_drive"]["direction_signs"]["motor"] =
        serde_json::json!(2);
    assert!(
        Robot::decode(&serde_json::to_vec(&value).unwrap())
            .unwrap_err()
            .to_string()
            .contains("direction sign")
    );

    let mut value: serde_json::Value = serde_json::from_slice(GOLDEN).unwrap();
    let instance = value["robot"]["component_instances"]
        .as_object_mut()
        .unwrap()
        .remove("front_left_drive")
        .unwrap();
    value["robot"]["component_instances"]["front__left_drive"] = instance;
    value["robot"]["component_instances"]["front__left_drive"]["id"] =
        serde_json::json!("front__left_drive");
    assert!(
        Robot::decode(&serde_json::to_vec(&value).unwrap())
            .unwrap_err()
            .to_string()
            .contains("reserved separator")
    );

    let mut value: serde_json::Value = serde_json::from_slice(GOLDEN).unwrap();
    value["robot"]["structure"]["links"][0]["inertial"]["mass_kg"] = serde_json::json!(-1.0);
    assert!(
        Robot::decode(&serde_json::to_vec(&value).unwrap())
            .unwrap_err()
            .to_string()
            .contains("mass")
    );

    let mut value: serde_json::Value = serde_json::from_slice(GOLDEN).unwrap();
    value["robot"]["component_types"]["drive_motor"]["capabilities"]["motor"]["target"]["id"] =
        serde_json::json!("missing_joint");
    assert!(
        Robot::decode(&serde_json::to_vec(&value).unwrap())
            .unwrap_err()
            .to_string()
            .contains("references unknown joint 'missing_joint'")
    );

    let mut value: serde_json::Value = serde_json::from_slice(GOLDEN).unwrap();
    let inertia = &mut value["robot"]["structure"]["links"][0]["inertial"]["inertia"];
    inertia["ixx"] = serde_json::json!(1.0);
    inertia["iyy"] = serde_json::json!(1.0);
    inertia["izz"] = serde_json::json!(1.0);
    inertia["ixy"] = serde_json::json!(1.0);
    inertia["ixz"] = serde_json::json!(2.0);
    inertia["iyz"] = serde_json::json!(2.0);
    assert!(
        Robot::decode(&serde_json::to_vec(&value).unwrap())
            .unwrap_err()
            .to_string()
            .contains("positive semidefinite")
    );

    let mut value: serde_json::Value = serde_json::from_slice(GOLDEN).unwrap();
    value["robot"]["structure"]["joints"][0]["name"] = serde_json::json!("reserved__joint");
    assert!(
        Robot::decode(&serde_json::to_vec(&value).unwrap())
            .unwrap_err()
            .to_string()
            .contains("reserved separator")
    );

    let mut value: serde_json::Value = serde_json::from_slice(GOLDEN).unwrap();
    value["robot"]["component_types"]["drive_motor"]["structure"]["joints"][0]["kind"] =
        serde_json::json!("floating");
    assert!(
        Robot::decode(&serde_json::to_vec(&value).unwrap())
            .unwrap_err()
            .to_string()
            .contains("unsupported runtime kind")
    );
}

#[test]
fn unsupported_schema_is_reported_before_payload_parsing() {
    let mut value: serde_json::Value = serde_json::from_slice(GOLDEN).unwrap();
    value["schema"] = serde_json::json!("phoxal/robot/v1");
    value["robot"] = serde_json::json!({"future": true});
    assert_eq!(
        Robot::decode(&serde_json::to_vec(&value).unwrap())
            .unwrap_err()
            .to_string(),
        "unsupported robot schema 'phoxal/robot/v1'"
    );
}

#[test]
fn missing_schema_has_a_dedicated_error() {
    let mut value: serde_json::Value = serde_json::from_slice(GOLDEN).unwrap();
    value.as_object_mut().unwrap().remove("schema");
    assert_eq!(
        Robot::decode(&serde_json::to_vec(&value).unwrap())
            .unwrap_err()
            .to_string(),
        "canonical robot is missing string field 'schema'"
    );
}