greentic-secrets-core 0.5.0

Core runtime and backend orchestration for Greentic secrets.
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

use crate::SecretSpec;
use serde_json::{Map, Value, json};
use std::collections::BTreeMap;

/// Convert an iterator of secret specs into a JSON Schema value.
///
/// The resulting schema describes an object where each spec becomes a string
/// property. Specs are emitted in lexicographic order to keep the schema stable
/// for downstream tooling and snapshots.
pub fn specs_to_json_schema<'a>(specs: impl Iterator<Item = &'a SecretSpec>) -> Value {
    let mut ordered: BTreeMap<&'a str, &'a SecretSpec> = BTreeMap::new();
    for spec in specs {
        ordered.insert(spec.name, spec);
    }

    let mut properties = Map::new();
    for spec in ordered.values() {
        properties.insert(
            spec.name.to_string(),
            json!({
                "type": "string",
                "description": spec.description.unwrap_or(""),
            }),
        );
    }

    json!({
        "type": "object",
        "properties": properties,
    })
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{SecretDescribable, SecretSpec};

    struct DemoA;
    struct DemoB;

    impl SecretDescribable for DemoA {
        fn secret_specs() -> &'static [SecretSpec] {
            &[
                SecretSpec {
                    name: "ALPHA",
                    description: Some("alpha description"),
                },
                SecretSpec {
                    name: "OMEGA",
                    description: None,
                },
            ]
        }
    }

    impl SecretDescribable for DemoB {
        fn secret_specs() -> &'static [SecretSpec] {
            &[SecretSpec {
                name: "BETA",
                description: Some("beta description"),
            }]
        }
    }

    #[test]
    fn schema_properties_are_stably_ordered() {
        let schema = specs_to_json_schema(
            DemoA::secret_specs()
                .iter()
                .chain(DemoB::secret_specs().iter()),
        );

        let object = schema.as_object().expect("schema object");
        assert_eq!(object.get("type").and_then(Value::as_str), Some("object"));

        let properties = object
            .get("properties")
            .and_then(Value::as_object)
            .expect("properties map");

        let ordered_keys: Vec<_> = properties.keys().cloned().collect();
        assert_eq!(ordered_keys, vec!["ALPHA", "BETA", "OMEGA"]);

        let alpha = properties
            .get("ALPHA")
            .and_then(Value::as_object)
            .expect("alpha schema");
        assert_eq!(alpha.get("type").and_then(Value::as_str), Some("string"));
        assert_eq!(
            alpha.get("description").and_then(Value::as_str),
            Some("alpha description")
        );
    }
}