greentic-component 0.5.2

High-level component loader and store for Greentic components
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

use serde::{Deserialize, Serialize};

/// Structured info about a compiled component `.wasm` artifact.
///
/// Serialized as JSON when the `info --json` flag is set. The
/// `info_schema_version` field lets downstream consumers detect
/// breaking changes to this shape.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct InfoReport {
    pub info_schema_version: u32,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub component_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    pub artifact_type: String,
    pub size_bytes: u64,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub wit_world: Option<String>,
    pub exports: Vec<String>,
    pub imports: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub capabilities: Option<Capabilities>,
    pub manifest_source: ManifestSource,
}

/// Non-empty capability surfaces extracted from the manifest.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Capabilities {
    pub host: Vec<String>,
    pub wasi: Vec<String>,
}

/// Where the manifest-derived fields on [`InfoReport`] came from.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub enum ManifestSource {
    /// Manifest read from the `greentic.component.manifest.v1` custom section
    /// inside the `.wasm`.
    Embedded,
    /// Manifest read from a `component.manifest.json` sibling next to the `.wasm`.
    Sibling,
    /// No manifest was found; info fields are binary-derived only.
    None,
}

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

    #[test]
    fn json_has_schema_version_one() {
        let r = InfoReport {
            info_schema_version: 1,
            component_id: None,
            name: None,
            version: None,
            description: None,
            artifact_type: "component/wasm".into(),
            size_bytes: 0,
            wit_world: None,
            exports: vec![],
            imports: vec![],
            capabilities: None,
            manifest_source: ManifestSource::None,
        };
        let v: serde_json::Value = serde_json::to_value(&r).unwrap();
        assert_eq!(v["info_schema_version"], 1);
        assert_eq!(v["manifest_source"], "none");
    }

    #[test]
    fn manifest_source_serializes_lowercase() {
        let v = serde_json::to_value(ManifestSource::Embedded).unwrap();
        assert_eq!(v, serde_json::Value::String("embedded".into()));
        let v = serde_json::to_value(ManifestSource::Sibling).unwrap();
        assert_eq!(v, serde_json::Value::String("sibling".into()));
    }
}