greentic-deploy-spec 0.1.27258078137

Greentic deployment object-model schemas (Environment, Revision, TrafficSplit, BundleDeployment, Credentials, PackConfig, RuntimeConfig)
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

//! Schema versioning primitives.
//!
//! Each top-level spec type carries a `schema` field holding a [`SchemaVersion`]
//! discriminator (e.g. `greentic.environment.v1`). The constants below name the
//! canonical schema string for every type in this crate; consumers should match
//! against `SchemaVersion::ENVIRONMENT_V1` rather than the raw string.
//!
//! [`SemVer`] wraps [`semver::Version`] for places where finer-grained version
//! tracking is wanted (revision pack lists, descriptors, etc.).

use serde::{Deserialize, Serialize};
use std::fmt;

/// Top-level schema discriminator string (e.g. `greentic.environment.v1`).
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(transparent)]
pub struct SchemaVersion(pub String);

impl SchemaVersion {
    pub const ENVIRONMENT_V1: &'static str = "greentic.environment.v1";
    pub const ENVIRONMENT_RUNTIME_V1: &'static str = "greentic.environment-runtime.v1";
    pub const REVISION_V1: &'static str = "greentic.revision.v1";
    pub const TRAFFIC_SPLIT_V1: &'static str = "greentic.traffic-split.v1";
    pub const BUNDLE_DEPLOYMENT_V1: &'static str = "greentic.bundle-deployment.v1";
    pub const REVENUE_POLICY_V1: &'static str = "greentic.revenue-policy.v1";
    pub const CREDENTIALS_V1: &'static str = "greentic.credentials.v1";
    pub const PACK_CONFIG_V1: &'static str = "greentic.pack-config.v1";
    pub const RUNTIME_CONFIG_V1: &'static str = "greentic.runtime-config.v1";
    pub const PACK_LIST_LOCK_V1: &'static str = "greentic.pack-list-lock.v1";
    pub const AUDIT_EVENT_V1: &'static str = "greentic.audit.event.v1";
    pub const BACKUP_MANIFEST_V1: &'static str = "greentic.backup-manifest.v1";
    pub const MESSAGING_ENDPOINT_V1: &'static str = "greentic.messaging-endpoint.v1";

    pub fn new(s: impl Into<String>) -> Self {
        Self(s.into())
    }

    pub fn as_str(&self) -> &str {
        &self.0
    }
}

impl fmt::Display for SchemaVersion {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(&self.0)
    }
}

impl From<&str> for SchemaVersion {
    fn from(s: &str) -> Self {
        Self(s.to_string())
    }
}

/// Semantic version wrapper (re-export with serde glue).
#[derive(Clone, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
#[serde(transparent)]
pub struct SemVer(pub semver::Version);

impl SemVer {
    pub fn new(major: u64, minor: u64, patch: u64) -> Self {
        Self(semver::Version::new(major, minor, patch))
    }
}

impl fmt::Display for SemVer {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl std::str::FromStr for SemVer {
    type Err = semver::Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Ok(Self(s.parse()?))
    }
}