omegon-extension 0.25.2

Omegon extension SDK — safe, versioned interface for third-party extensions
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

//! package.install@1 HostAction types.

use serde::{Deserialize, Serialize};
use serde_json::Value;

pub const PACKAGE_INSTALL_V1: &str = "package.install@1";

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct PackageInstallParams {
    pub package: String,
    pub source: PackageInstallSource,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub digest: Option<String>,
    #[serde(default)]
    pub dry_run: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub activation: Option<PackageActivation>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reuse_key: Option<String>,
}

impl PackageInstallParams {
    pub fn dry_run_registry(package: impl Into<String>) -> Self {
        Self {
            package: package.into(),
            source: PackageInstallSource::Registry,
            version: None,
            digest: None,
            dry_run: true,
            activation: None,
            reuse_key: None,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum PackageInstallSource {
    Registry,
    LocalPath,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum PackageActivation {
    None,
    Enable,
    Restart,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct PackageInstallResult {
    pub install_id: String,
    pub package: String,
    pub source: PackageInstallSource,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,
    pub dry_run: bool,
    pub status: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub plan: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub effects: Vec<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub handle: Option<Value>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub warnings: Vec<String>,
}

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

    #[test]
    fn package_install_params_round_trip() {
        let params = PackageInstallParams {
            package: "omegon-nex-rs".to_string(),
            source: PackageInstallSource::Registry,
            version: Some("0.1.0".to_string()),
            digest: Some("sha256:abc".to_string()),
            dry_run: true,
            activation: Some(PackageActivation::Enable),
            reuse_key: Some("nex".to_string()),
        };

        let json = serde_json::to_value(&params).unwrap();
        assert_eq!(json["package"], "omegon-nex-rs");
        assert_eq!(json["source"], "registry");
        assert_eq!(json["dry_run"], true);
        assert_eq!(json["activation"], "enable");
        let parsed: PackageInstallParams = serde_json::from_value(json).unwrap();
        assert_eq!(parsed, params);
    }

    #[test]
    fn package_install_result_round_trip() {
        let result = PackageInstallResult {
            install_id: "install_123".to_string(),
            package: "omegon-nex-rs".to_string(),
            source: PackageInstallSource::Registry,
            version: Some("0.1.0".to_string()),
            dry_run: true,
            status: "planned".to_string(),
            plan: vec!["download package".to_string(), "verify digest".to_string()],
            effects: vec!["omegon/extensions/omegon-nex-rs".to_string()],
            handle: Some(serde_json::json!({"registry": "omegon"})),
            warnings: vec!["manual approval required".to_string()],
        };

        let json = serde_json::to_value(&result).unwrap();
        let parsed: PackageInstallResult = serde_json::from_value(json).unwrap();
        assert_eq!(parsed, result);
    }
}