satay-codegen 0.15.0

Generate Rust client code from OpenAPI 3.1 documents
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

use std::fs;

use crate::ast::*;
use crate::common::*;

const PROPERTY_IDENTIFIERS: &str =
    include_str!("../../../../tests/fixtures/property-identifiers.yaml");

#[test]
fn property_identifiers_render_with_rust_casing_and_wire_renames() {
    let files = satay_codegen::generate(PROPERTY_IDENTIFIERS)
        .expect("generate property identifier fixture");
    let types_rs = parse_rust(find_file(&files, "types.rs"));
    let bus_stop = find_struct(&types_rs, "BusStop");

    assert_eq!(
        field_names(bus_stop),
        [
            "bus_stop_code",
            "road_name",
            "desc",
            "lat",
            "long",
            "request_id",
            "r#type",
        ]
    );
    for (rust_name, wire_name) in [
        ("desc", "Description"),
        ("lat", "Latitude"),
        ("long", "Longitude"),
        ("request_id", "RequestIdentifier"),
        ("r#type", "WireKeyword"),
    ] {
        assert_attr_contains(
            &field(bus_stop, rust_name).attrs,
            "cfg_attr",
            &format!(r#"rename = "{wire_name}""#),
        );
    }

    assert_field(bus_stop, "bus_stop_code", "u32");
    assert_field(bus_stop, "road_name", "String");
    assert_field(bus_stop, "desc", "String");
    assert_field(bus_stop, "lat", "f64");
    assert_field(bus_stop, "long", "f64");
    assert_field(bus_stop, "request_id", "String");
    assert_field(bus_stop, "r#type", "String");
}

#[test]
fn bus_stop_identifier_overrides_round_trip_with_original_wire_keys() {
    let files = satay_codegen::generate(PROPERTY_IDENTIFIERS)
        .expect("generate property identifier fixture");
    let temp = tempfile::tempdir().expect("create temp crate");
    let crate_dir = temp.path();
    let generated_dir = crate_dir.join("src/generated");
    let runtime_path = runtime_path_toml();
    write_manifest(crate_dir, &runtime_path, false, false);
    write_generated_files(&generated_dir, &files);

    let lib_contents = r##"pub mod generated;

#[cfg(test)]
mod tests {
    use super::generated::BusStop;

    #[test]
    fn public_identifiers_are_independent_of_wire_names() {
        let bus_stop: BusStop = serde_json::from_str(
            r#"{
                "BusStopCode": "83139",
                "RoadName": "Bencoolen St",
                "Description": "Bef Bencoolen Stn Exit B",
                "Latitude": 1.299604,
                "Longitude": 103.850604,
                "RequestIdentifier": "request-7",
                "WireKeyword": "keyword"
            }"#,
        )
        .unwrap();

        assert_eq!(bus_stop.bus_stop_code, 83139);
        assert_eq!(bus_stop.road_name, "Bencoolen St");
        assert_eq!(bus_stop.desc, "Bef Bencoolen Stn Exit B");
        assert_eq!(bus_stop.lat, 1.299604);
        assert_eq!(bus_stop.long, 103.850604);
        assert_eq!(bus_stop.request_id, "request-7");
        assert_eq!(bus_stop.r#type, "keyword");

        let encoded = serde_json::to_value(bus_stop).unwrap();
        assert_eq!(encoded["Description"], "Bef Bencoolen Stn Exit B");
        assert_eq!(encoded["Latitude"], 1.299604);
        assert_eq!(encoded["Longitude"], 103.850604);
        assert_eq!(encoded["RequestIdentifier"], "request-7");
        assert_eq!(encoded["WireKeyword"], "keyword");
        assert!(encoded.get("desc").is_none());
        assert!(encoded.get("request_id").is_none());
    }
}
"##;
    fs::write(crate_dir.join("src/lib.rs"), lib_contents).expect("write lib");

    run_temp_cargo(
        crate_dir,
        "test",
        &[],
        "property identifier generated crate tests",
    );
}