edge_schema/schema/
capability.rs

1use std::collections::HashMap;
2
3use serde::{Deserialize, Serialize};
4
5use super::{
6    locality::CapabilityLocalityV1, CapabilityCpuV1, CapabilityFileSystemV1, CapabilityLoggingV1,
7    CapabilityMemorySwapV1, CapabilityMemoryV1, CapabilityNetworkDnsV1, CapabilityNetworkGatewayV1,
8    CapabilityNetworkV1, CapabilityPersistentMemoryV1, CapabilityWasiV1, CapabilityWebGatewayV1,
9    Merge,
10};
11
12#[derive(Serialize, Deserialize, PartialEq, Eq, Clone, Debug, schemars::JsonSchema)]
13pub enum CapabilityV1 {
14    #[serde(rename = "cpu")]
15    Cpu(CapabilityCpuV1),
16    #[serde(rename = "fs")]
17    FileSystem(CapabilityFileSystemV1),
18    #[serde(rename = "memory_swap")]
19    MemorySwap(CapabilityMemorySwapV1),
20    #[serde(rename = "memory_persistent")]
21    MemoryPersistent(CapabilityPersistentMemoryV1),
22    #[serde(rename = "network")]
23    Network(CapabilityNetworkV1),
24    #[serde(rename = "network_dns")]
25    NetworkDns(CapabilityNetworkDnsV1),
26    #[serde(rename = "network_gateway")]
27    NetworkGateway(CapabilityNetworkGatewayV1),
28}
29
30#[derive(Serialize, Deserialize, Default, PartialEq, Eq, Clone, Debug, schemars::JsonSchema)]
31pub struct CapabilityMapV1 {
32    #[serde(skip_serializing_if = "Option::is_none")]
33    pub wasi: Option<CapabilityWasiV1>,
34    #[serde(skip_serializing_if = "Option::is_none")]
35    pub cpu: Option<CapabilityCpuV1>,
36    #[serde(skip_serializing_if = "Option::is_none")]
37    pub fs: Option<CapabilityFileSystemV1>,
38    #[serde(skip_serializing_if = "Option::is_none")]
39    pub memory: Option<CapabilityMemoryV1>,
40
41    #[serde(skip_serializing_if = "Option::is_none")]
42    pub network: Option<CapabilityNetworkV1>,
43    #[serde(skip_serializing_if = "Option::is_none")]
44    pub network_dns: Option<CapabilityNetworkDnsV1>,
45    #[serde(skip_serializing_if = "Option::is_none")]
46    pub network_gateway: Option<CapabilityNetworkGatewayV1>,
47    #[serde(skip_serializing_if = "Option::is_none")]
48    pub logging: Option<CapabilityLoggingV1>,
49    #[serde(skip_serializing_if = "Option::is_none")]
50    pub locality: Option<CapabilityLocalityV1>,
51    #[serde(skip_serializing_if = "Option::is_none")]
52    pub web_gateway: Option<CapabilityWebGatewayV1>,
53
54    /// Additional unknown capabilities.
55    #[serde(flatten)]
56    pub other: HashMap<String, serde_json::Value>,
57}
58
59impl Merge for CapabilityMapV1 {
60    fn merge_extend(self, other: &Self) -> Self {
61        Self {
62            wasi: self.wasi.merge_extend(&other.wasi),
63            cpu: self.cpu.merge_extend(&other.cpu),
64            fs: self.fs.merge_extend(&other.fs),
65            memory: self.memory.merge_extend(&other.memory),
66            network: self.network.merge_extend(&other.network),
67            network_dns: self.network_dns.merge_extend(&other.network_dns),
68            network_gateway: self.network_gateway.merge_extend(&other.network_gateway),
69            logging: self.logging.merge_extend(&other.logging),
70            locality: self.locality.merge_extend(&other.locality),
71            web_gateway: self.web_gateway.merge_extend(&other.web_gateway),
72            other: self.other,
73        }
74    }
75}
76
77#[cfg(test)]
78mod tests {
79    use std::sync::Arc;
80
81    use crate::schema::{FsVolumeConfig, VolumeMountV1, VolumeSourceShared, VolumeSourceV1};
82
83    use super::*;
84
85    #[test]
86    fn test_deser_validate_fs() {
87        let raw = r#"
88fs:
89  volumes:
90    - name: data
91      source:
92        shared:
93          id: bf522f22-b5ff-42c4-9625-d1d9bf796b44
94      mounts:
95        - mount_path: /data
96"#;
97
98        let data = serde_yaml::from_str::<CapabilityMapV1>(raw).unwrap();
99        assert_eq!(
100            data,
101            CapabilityMapV1 {
102                fs: Some(CapabilityFileSystemV1 {
103                    volumes: vec![FsVolumeConfig {
104                        name: "data".to_string(),
105                        source: VolumeSourceV1::Shared(VolumeSourceShared {
106                            id: uuid::Uuid::parse_str("bf522f22-b5ff-42c4-9625-d1d9bf796b44")
107                                .unwrap(),
108                            size: None,
109                        }),
110                        mounts: vec![VolumeMountV1 {
111                            mount_path: "/data".to_string(),
112                            sub_path: None,
113                            permissions: None,
114                        }],
115                    }],
116                }),
117                ..Default::default()
118            }
119        );
120
121        let gen =
122            schemars::gen::SchemaGenerator::new(schemars::gen::SchemaSettings::draft2019_09());
123
124        let schema = gen.into_root_schema_for::<CapabilityMapV1>();
125        let schema_value = serde_json::to_value(&schema).unwrap();
126
127        let value = serde_json::to_value(&data).unwrap();
128        let schema = Arc::new(jsonschema::JSONSchema::compile(&schema_value).unwrap());
129
130        let res = schema.validate(&value);
131
132        if let Err(errors) = res {
133            for error in errors {
134                println!("Validation error: {}", error);
135            }
136            panic!("Validation failed");
137        }
138    }
139}
edge_schema/schema/capability.rs

edge_schema/schema/
capability.rs
