greentic-component 0.5.1

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
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

use displaydoc::Display;

#[cfg(feature = "abi")]
use crate::abi::AbiError;
use crate::capabilities::CapabilityError;
#[cfg(feature = "describe")]
use crate::describe::DescribeError;
use crate::limits::LimitError;
#[cfg(feature = "loader")]
use crate::loader::LoadError;
use crate::manifest::ManifestError;
use crate::schema::SchemaIntrospectionError;
use crate::signing::SigningError;

#[derive(Debug, Display, thiserror::Error)]
pub enum ComponentError {
    /// manifest failure: {0}
    Manifest(#[from] ManifestError),
    /// schema introspection failure: {0}
    SchemaIntrospection(#[from] SchemaIntrospectionError),
    /// ABI failure: {0}
    #[cfg(feature = "abi")]
    Abi(#[from] AbiError),
    /// describe failure: {0}
    #[cfg(feature = "describe")]
    Describe(#[from] DescribeError),
    /// load failure: {0}
    #[cfg(feature = "loader")]
    Load(#[from] LoadError),
    /// capability failure: {0}
    Capability(#[from] CapabilityError),
    /// limit failure: {0}
    Limits(#[from] LimitError),
    /// signing failure: {0}
    Signing(#[from] SigningError),
    /// io failure: {0}
    Io(#[from] std::io::Error),
    /// doctor failure: {0}
    Doctor(String),
    /// operation schema empty: {component}/{operation} {direction} ({suggestion})
    SchemaQualityEmpty {
        component: String,
        operation: String,
        direction: &'static str,
        suggestion: String,
    },
}

impl ComponentError {
    pub fn code(&self) -> &'static str {
        match self {
            ComponentError::Manifest(_) => "manifest-invalid",
            ComponentError::SchemaIntrospection(_) => "schema-introspection",
            #[cfg(feature = "abi")]
            ComponentError::Abi(err) => match err {
                crate::abi::AbiError::WorldMismatch { .. } => "world-mismatch",
                crate::abi::AbiError::MissingWasiTarget => "wasi-target-missing",
                _ => "abi-error",
            },
            #[cfg(feature = "describe")]
            ComponentError::Describe(err) => match err {
                crate::describe::DescribeError::NotFound(_) => "describe-missing",
                crate::describe::DescribeError::Json { .. } => "describe-invalid",
                crate::describe::DescribeError::Io { .. } => "describe-io",
                crate::describe::DescribeError::Metadata(_) => "describe-metadata",
            },
            #[cfg(feature = "loader")]
            ComponentError::Load(_) => "component-load",
            ComponentError::Capability(_) => "capability-error",
            ComponentError::Limits(_) => "limits-error",
            ComponentError::Signing(_) => "hash-mismatch",
            ComponentError::Io(_) => "io-error",
            ComponentError::Doctor(_) => "doctor-failure",
            ComponentError::SchemaQualityEmpty { .. } => "E_OP_SCHEMA_EMPTY",
        }
    }
}

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

    #[test]
    fn code_maps_key_error_variants_to_stable_strings() {
        assert_eq!(
            ComponentError::Doctor("oops".into()).code(),
            "doctor-failure"
        );
        assert_eq!(
            ComponentError::SchemaQualityEmpty {
                component: "demo".into(),
                operation: "run".into(),
                direction: "input",
                suggestion: "add fields".into(),
            }
            .code(),
            "E_OP_SCHEMA_EMPTY"
        );
        assert_eq!(
            ComponentError::Capability(CapabilityError::invalid("host.http", "denied")).code(),
            "capability-error"
        );
        assert_eq!(
            ComponentError::Signing(SigningError::HashMismatch {
                expected: "a".into(),
                found: "b".into(),
            })
            .code(),
            "hash-mismatch"
        );
    }

    #[test]
    fn code_distinguishes_abi_and_describe_subclasses() {
        #[cfg(feature = "abi")]
        {
            assert_eq!(
                ComponentError::Abi(AbiError::MissingWasiTarget).code(),
                "wasi-target-missing"
            );
        }
        #[cfg(feature = "describe")]
        {
            assert_eq!(
                ComponentError::Describe(DescribeError::NotFound("describe".into())).code(),
                "describe-missing"
            );
        }
        #[cfg(feature = "loader")]
        {
            assert_eq!(
                ComponentError::Load(LoadError::NotFound("demo".into())).code(),
                "component-load"
            );
        }
    }
}