greentic-flow 0.4.63

Generic YGTC flow schema/loader/IR for self-describing component nodes.
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

use greentic_interfaces_host::component_v0_6::exports::greentic::component::node::{
    ComponentDescriptor, SchemaSource, SetupOutput,
};

pub fn has_setup(descriptor: &ComponentDescriptor) -> bool {
    descriptor.setup.is_some()
}

pub fn qa_spec_ref(descriptor: &ComponentDescriptor) -> Option<&SchemaSource> {
    descriptor.setup.as_ref().map(|setup| &setup.qa_spec)
}

pub fn answers_schema_ref(descriptor: &ComponentDescriptor) -> Option<&SchemaSource> {
    descriptor.setup.as_ref().map(|setup| &setup.answers_schema)
}

pub fn setup_outputs(descriptor: &ComponentDescriptor) -> Option<&[SetupOutput]> {
    descriptor
        .setup
        .as_ref()
        .map(|setup| setup.outputs.as_slice())
}

#[cfg(test)]
mod tests {
    use super::*;
    use greentic_interfaces_host::component_v0_6::exports::greentic::component::node::{
        IoSchema, Op, SchemaRef, SetupContract,
    };

    fn sample_descriptor() -> ComponentDescriptor {
        ComponentDescriptor {
            name: "demo".to_string(),
            version: "0.1.0".to_string(),
            summary: Some("demo component".to_string()),
            capabilities: vec!["host:config".to_string()],
            ops: vec![Op {
                name: "setup.apply_answers".to_string(),
                summary: None,
                input: IoSchema {
                    schema: SchemaSource::InlineCbor(vec![0xa0]),
                    content_type: "application/cbor".to_string(),
                    schema_version: None,
                },
                output: IoSchema {
                    schema: SchemaSource::InlineCbor(vec![0xa0]),
                    content_type: "application/cbor".to_string(),
                    schema_version: None,
                },
                examples: Vec::new(),
            }],
            schemas: vec![SchemaRef {
                id: "schema-1".to_string(),
                content_type: "application/cbor".to_string(),
                blake3_hash: "deadbeef".to_string(),
                version: "1".to_string(),
                bytes: None,
                uri: None,
            }],
            setup: Some(SetupContract {
                qa_spec: SchemaSource::InlineCbor(vec![0xa1, 0x01]),
                answers_schema: SchemaSource::InlineCbor(vec![0xa1, 0x02]),
                examples: Vec::new(),
                outputs: vec![SetupOutput::ConfigOnly],
            }),
        }
    }

    #[test]
    fn extracts_setup_refs() {
        let descriptor = sample_descriptor();
        assert!(has_setup(&descriptor));
        assert!(matches!(
            qa_spec_ref(&descriptor),
            Some(SchemaSource::InlineCbor(bytes)) if bytes == &vec![0xa1, 0x01]
        ));
        assert!(matches!(
            answers_schema_ref(&descriptor),
            Some(SchemaSource::InlineCbor(bytes)) if bytes == &vec![0xa1, 0x02]
        ));
        assert!(matches!(
            setup_outputs(&descriptor),
            Some(outputs) if outputs.len() == 1
        ));
    }
}