earl 0.5.2

AI-safe CLI for AI agents
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176

use std::collections::BTreeMap;
use std::path::PathBuf;

use rkyv::{Archive, Deserialize as RkyvDeserialize, Serialize as RkyvSerialize};
use serde::{Deserialize, Serialize};

use super::schema::{CommandMode, CommandTemplate, ProviderEnvironments};
use earl_core::with::AsPath;

#[derive(Debug, Clone, Serialize, Deserialize, Archive, RkyvSerialize, RkyvDeserialize)]
pub struct TemplateCatalog {
    pub entries: BTreeMap<String, TemplateCatalogEntry>,
}

impl TemplateCatalog {
    pub fn empty() -> Self {
        Self {
            entries: BTreeMap::new(),
        }
    }

    pub fn get(&self, key: &str) -> Option<&TemplateCatalogEntry> {
        self.entries.get(key)
    }

    pub fn upsert(&mut self, key: String, entry: TemplateCatalogEntry) {
        self.entries.insert(key, entry);
    }

    pub fn values(&self) -> impl Iterator<Item = &TemplateCatalogEntry> {
        self.entries.values()
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, Archive, RkyvSerialize, RkyvDeserialize)]
pub struct TemplateCatalogEntry {
    pub key: String,
    pub provider: String,
    pub command: String,
    pub title: String,
    pub summary: String,
    pub description: String,
    pub categories: Vec<String>,
    pub mode: CommandMode,
    pub source: TemplateSource,
    pub template: CommandTemplate,
    pub provider_environments: Option<ProviderEnvironments>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Archive, RkyvSerialize, RkyvDeserialize)]
pub struct TemplateSource {
    #[rkyv(with = AsPath)]
    pub path: PathBuf,
    pub scope: TemplateScope,
}

#[derive(
    Debug,
    Clone,
    Copy,
    Serialize,
    Deserialize,
    PartialEq,
    Eq,
    Archive,
    RkyvSerialize,
    RkyvDeserialize,
)]
pub enum TemplateScope {
    Local,
    Global,
}

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

    #[cfg(feature = "bash")]
    fn catalog_with_provider_environments() -> TemplateCatalog {
        use earl_core::schema::{CommandMode, ResultTemplate};
        use earl_protocol_bash::{BashOperationTemplate, BashScriptTemplate};

        use super::super::schema::{Annotations, CommandTemplate, OperationTemplate};

        let mut prod_vars = BTreeMap::new();
        prod_vars.insert(
            "base_url".to_string(),
            "https://api.example.com".to_string(),
        );
        let mut envs = BTreeMap::new();
        envs.insert("production".to_string(), prod_vars);

        let pe = ProviderEnvironments {
            default: Some("production".to_string()),
            secrets: vec![],
            environments: envs,
        };

        let op = OperationTemplate::Bash(BashOperationTemplate {
            bash: BashScriptTemplate {
                script: "echo hi".into(),
                env: None,
                cwd: None,
                sandbox: None,
            },
            transport: None,
            stream: false,
        });

        let cmd = CommandTemplate {
            title: "T".into(),
            summary: "S".into(),
            description: "D".into(),
            categories: vec![],
            annotations: Annotations::default(),
            params: vec![],
            operation: op,
            result: ResultTemplate {
                output: "{{ result }}".into(),
                ..Default::default()
            },
            environment_overrides: BTreeMap::new(),
        };

        let entry = TemplateCatalogEntry {
            key: "myservice.ping".to_string(),
            provider: "myservice".to_string(),
            command: "ping".to_string(),
            title: "Ping".to_string(),
            summary: "Ping the service".to_string(),
            description: "Ping.".to_string(),
            categories: vec![],
            mode: CommandMode::Read,
            source: TemplateSource {
                path: PathBuf::from("myservice.hcl"),
                scope: TemplateScope::Local,
            },
            template: cmd,
            provider_environments: Some(pe),
        };

        let mut catalog = TemplateCatalog::empty();
        catalog.upsert("myservice.ping".to_string(), entry);
        catalog
    }

    #[test]
    #[cfg(feature = "bash")]
    fn catalog_preserves_provider_environment_default() {
        let catalog = catalog_with_provider_environments();
        let envs = catalog
            .get("myservice.ping")
            .unwrap()
            .provider_environments
            .as_ref()
            .unwrap();
        assert_eq!(envs.default.as_deref(), Some("production"));
    }

    #[test]
    #[cfg(feature = "bash")]
    fn catalog_preserves_provider_environment_variables() {
        let catalog = catalog_with_provider_environments();
        let envs = catalog
            .get("myservice.ping")
            .unwrap()
            .provider_environments
            .as_ref()
            .unwrap();
        assert_eq!(
            envs.environments["production"]["base_url"],
            "https://api.example.com"
        );
    }
}