zacor 0.1.0

Package manager and dispatcher for zr — install, manage, and run modular CLI packages
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
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
use crate::error::*;
use crate::paths;
use crate::receipt::Receipt;
use std::collections::BTreeMap;
use std::fs;
use std::io::Write as _;
use std::path::Path;

/// A configured registry source.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct RegistryConfig {
    pub name: String,
    pub url: String,
}

/// Global config file structure (config.toml).
#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
pub struct GlobalConfig {
    #[serde(default)]
    pub zr: BTreeMap<String, String>,
    #[serde(default)]
    pub packages: BTreeMap<String, BTreeMap<String, String>>,
    #[serde(default)]
    pub registries: Vec<RegistryConfig>,
}

/// Read config.toml. Returns default if file doesn't exist.
pub fn read_global(home: &Path) -> Result<GlobalConfig> {
    let path = paths::config_path(home);
    if !path.exists() {
        return Ok(GlobalConfig::default());
    }
    let contents = fs::read_to_string(&path).context("failed to read config.toml")?;
    parse_global_config(&contents)
}

/// Read project-level config.toml from `.zr/config.toml`.
/// Returns default if the file doesn't exist.
pub fn read_project(project_root: &Path) -> Result<GlobalConfig> {
    let path = paths::project_config_path(project_root);
    if !path.exists() {
        return Ok(GlobalConfig::default());
    }
    let contents = fs::read_to_string(&path).context("failed to read project config.toml")?;
    parse_global_config(&contents)
}

/// Atomically write config.toml.
pub fn write_global(home: &Path, config: &GlobalConfig) -> Result<()> {
    let path = paths::config_path(home);
    let dir = path
        .parent()
        .ok_or_else(|| anyhow!("config path has no parent directory"))?;
    fs::create_dir_all(dir).context("failed to create config directory")?;
    let output = toml::to_string_pretty(config).context("failed to serialize config.toml")?;
    let mut tmp =
        tempfile::NamedTempFile::new_in(dir).context("failed to create temp file for config")?;
    tmp.write_all(output.as_bytes())
        .context("failed to write config temp file")?;
    tmp.as_file()
        .sync_all()
        .context("failed to sync config to disk")?;
    tmp.persist(&path)
        .context("failed to persist config file")?;
    Ok(())
}

fn parse_global_config(contents: &str) -> Result<GlobalConfig> {
    toml::from_str(contents).context("failed to parse config.toml")
}

/// Resolve a config value for a package using layered resolution.
/// Priority: flags > env > project per-pkg > project [zr] > receipt config > global per-pkg > global [zr] > package defaults
pub fn resolve(
    key: &str,
    package_name: &str,
    flags: &BTreeMap<String, String>,
    receipt: &Receipt,
    global_config: &GlobalConfig,
    package_config: &BTreeMap<String, serde_yml::Value>,
    project_config: Option<&GlobalConfig>,
) -> Option<String> {
    // 1. Flags (parsed CLI args)
    if let Some(v) = flags.get(key) {
        return Some(v.clone());
    }

    // 2. Environment variables (declaration-gated)
    if package_config.contains_key(key) {
        let env_var = config_env_var_name(package_name, key);
        if let Ok(v) = std::env::var(&env_var) {
            return Some(v);
        }
    }

    // 3. Project per-package config
    if let Some(proj) = project_config {
        if let Some(section) = proj.packages.get(package_name)
            && let Some(v) = section.get(key)
        {
            return Some(v.clone());
        }

        // 4. Project [zr] global config
        if let Some(v) = proj.zr.get(key) {
            return Some(v.clone());
        }
    }

    // 5. Receipt config
    if let Some(v) = receipt.config.get(key) {
        return Some(v.clone());
    }

    // 6. Global config.toml per-package
    if let Some(section) = global_config.packages.get(package_name)
        && let Some(v) = section.get(key)
    {
        return Some(v.clone());
    }

    // 7. Global config.toml [zr]
    if let Some(v) = global_config.zr.get(key) {
        return Some(v.clone());
    }

    // 8. Package defaults
    if let Some(v) = package_config.get(key) {
        return Some(yaml_value_to_string(v));
    }

    None
}

/// Build the `ZR_<PACKAGE>__<KEY>` environment variable name.
/// Hyphens → single underscores, everything uppercase.
pub fn config_env_var_name(package_name: &str, key: &str) -> String {
    let package_part = package_name.replace('-', "_").to_uppercase();
    let key_part = key.replace('-', "_").to_uppercase();
    format!("ZR_{}__{}", package_part, key_part)
}

/// Convert a serde_yml::Value to a string for config resolution.
pub fn yaml_value_to_string(v: &serde_yml::Value) -> String {
    match v {
        serde_yml::Value::Bool(b) => if *b { "true" } else { "false" }.to_string(),
        serde_yml::Value::Number(n) => n.to_string(),
        serde_yml::Value::String(s) => s.clone(),
        _ => format!("{:?}", v),
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::package_definition;
    use crate::receipt::SourceRecord;
    use crate::test_util;

    fn make_package_config() -> BTreeMap<String, serde_yml::Value> {
        let yaml = r#"
name: my-pkg
version: "1.0.0"
binary: my-pkg
config:
  model: base
  language: auto
commands:
  default:
    description: Transcribe
"#;
        package_definition::parse(yaml).unwrap().config
    }

    fn make_receipt() -> Receipt {
        Receipt::new(
            "1.0.0".to_string(),
            SourceRecord::Local {
                path: "/tmp/test".to_string(),
            },
        )
    }

    #[test]
    fn test_config_layering_default() {
        let pkg_config = make_package_config();
        let receipt = make_receipt();
        let global = GlobalConfig::default();
        let flags = BTreeMap::new();

        let val = resolve("model", "my-pkg", &flags, &receipt, &global, &pkg_config, None);
        assert_eq!(val, Some("base".to_string()));
    }

    #[test]
    fn test_config_layering_receipt_overrides_default() {
        let pkg_config = make_package_config();
        let mut receipt = make_receipt();
        receipt.set_config("model".to_string(), "large".to_string());
        let global = GlobalConfig::default();
        let flags = BTreeMap::new();

        let val = resolve("model", "my-pkg", &flags, &receipt, &global, &pkg_config, None);
        assert_eq!(val, Some("large".to_string()));
    }

    #[test]
    fn test_config_layering_flag_overrides_all() {
        let pkg_config = make_package_config();
        let mut receipt = make_receipt();
        receipt.set_config("model".to_string(), "large".to_string());
        let global = GlobalConfig::default();
        let mut flags = BTreeMap::new();
        flags.insert("model".to_string(), "tiny".to_string());

        let val = resolve("model", "my-pkg", &flags, &receipt, &global, &pkg_config, None);
        assert_eq!(val, Some("tiny".to_string()));
    }

    #[test]
    fn test_config_layering_global_config() {
        let pkg_config = make_package_config();
        let receipt = make_receipt();
        let mut global = GlobalConfig::default();
        let mut section = BTreeMap::new();
        section.insert("model".to_string(), "medium".to_string());
        global.packages.insert("my-pkg".to_string(), section);
        let flags = BTreeMap::new();

        let val = resolve("model", "my-pkg", &flags, &receipt, &global, &pkg_config, None);
        assert_eq!(val, Some("medium".to_string()));
    }

    #[test]
    fn test_env_var_naming() {
        assert_eq!(config_env_var_name("my-tool", "output-dir"), "ZR_MY_TOOL__OUTPUT_DIR");
        assert_eq!(config_env_var_name("my-pkg", "model"), "ZR_MY_PKG__MODEL");
    }

    #[test]
    fn test_env_var_declaration_gated() {
        let pkg_config = make_package_config();
        let receipt = make_receipt();
        let global = GlobalConfig::default();
        let flags = BTreeMap::new();

        // Set env var for undeclared key — should not be resolved
        unsafe { std::env::set_var("ZR_MY_PKG__UNDECLARED", "test"); }
        let val = resolve("undeclared", "my-pkg", &flags, &receipt, &global, &pkg_config, None);
        assert!(val.is_none());
        unsafe { std::env::remove_var("ZR_MY_PKG__UNDECLARED"); }
    }

    #[test]
    fn test_config_unset() {
        let mut receipt = make_receipt();
        receipt.set_config("model".to_string(), "large".to_string());
        receipt.unset_config("model");
        assert!(!receipt.config.contains_key("model"));
    }

    #[test]
    fn test_missing_config_file() {
        let home = test_util::temp_home("config");
        let config = read_global(home.path()).unwrap();
        assert!(config.zr.is_empty());
        assert!(config.packages.is_empty());
    }

    #[test]
    fn test_config_key_validation() {
        assert!(crate::platform::validate_config_key("model").is_ok());
        assert!(crate::platform::validate_config_key("output-format").is_ok());
        assert!(crate::platform::validate_config_key("output_format").is_err());
        assert!(crate::platform::validate_config_key("Model").is_err());
    }

    #[test]
    fn test_global_config_read_write() {
        let home = test_util::temp_home("config");
        let mut config = GlobalConfig::default();
        config.zr.insert("verbose".to_string(), "true".to_string());
        let mut pkg_section = BTreeMap::new();
        pkg_section.insert("model".to_string(), "large".to_string());
        config.packages.insert("my-pkg".to_string(), pkg_section);

        write_global(home.path(), &config).unwrap();
        let loaded = read_global(home.path()).unwrap();
        assert_eq!(loaded.zr.get("verbose").unwrap(), "true");
        assert_eq!(
            loaded.packages.get("my-pkg").unwrap().get("model").unwrap(),
            "large"
        );
    }

    #[test]
    fn test_project_config_overrides_global() {
        let pkg_config = make_package_config();
        let receipt = make_receipt();
        let mut global = GlobalConfig::default();
        let mut section = BTreeMap::new();
        section.insert("model".to_string(), "sha512".to_string());
        global.packages.insert("my-pkg".to_string(), section);
        let flags = BTreeMap::new();

        let mut project = GlobalConfig::default();
        let mut proj_section = BTreeMap::new();
        proj_section.insert("model".to_string(), "md5".to_string());
        project.packages.insert("my-pkg".to_string(), proj_section);

        let val = resolve("model", "my-pkg", &flags, &receipt, &global, &pkg_config, Some(&project));
        assert_eq!(val, Some("md5".to_string()));
    }

    #[test]
    fn test_project_config_overrides_receipt() {
        let pkg_config = make_package_config();
        let mut receipt = make_receipt();
        receipt.set_config("model".to_string(), "sha256".to_string());
        let global = GlobalConfig::default();
        let flags = BTreeMap::new();

        let mut project = GlobalConfig::default();
        let mut proj_section = BTreeMap::new();
        proj_section.insert("model".to_string(), "md5".to_string());
        project.packages.insert("my-pkg".to_string(), proj_section);

        let val = resolve("model", "my-pkg", &flags, &receipt, &global, &pkg_config, Some(&project));
        assert_eq!(val, Some("md5".to_string()));
    }

    #[test]
    fn test_flags_override_project_config() {
        let pkg_config = make_package_config();
        let receipt = make_receipt();
        let global = GlobalConfig::default();
        let mut flags = BTreeMap::new();
        flags.insert("model".to_string(), "sha512".to_string());

        let mut project = GlobalConfig::default();
        let mut proj_section = BTreeMap::new();
        proj_section.insert("model".to_string(), "md5".to_string());
        project.packages.insert("my-pkg".to_string(), proj_section);

        let val = resolve("model", "my-pkg", &flags, &receipt, &global, &pkg_config, Some(&project));
        assert_eq!(val, Some("sha512".to_string()));
    }

    #[test]
    fn test_absent_project_config_skips_layer() {
        let pkg_config = make_package_config();
        let mut receipt = make_receipt();
        receipt.set_config("model".to_string(), "large".to_string());
        let global = GlobalConfig::default();
        let flags = BTreeMap::new();

        let val = resolve("model", "my-pkg", &flags, &receipt, &global, &pkg_config, None);
        assert_eq!(val, Some("large".to_string()));
    }

    #[test]
    fn test_registries_read_write() {
        let home = test_util::temp_home("config");
        let mut config = GlobalConfig::default();
        config.registries.push(RegistryConfig {
            name: "default".to_string(),
            url: "https://github.com/zacor-packages/registry".to_string(),
        });
        config.registries.push(RegistryConfig {
            name: "company".to_string(),
            url: "https://github.com/my-org/zr-packages".to_string(),
        });

        write_global(home.path(), &config).unwrap();
        let loaded = read_global(home.path()).unwrap();
        assert_eq!(loaded.registries.len(), 2);
        assert_eq!(loaded.registries[0].name, "default");
        assert_eq!(loaded.registries[0].url, "https://github.com/zacor-packages/registry");
        assert_eq!(loaded.registries[1].name, "company");
    }

    #[test]
    fn test_config_without_registries_parses() {
        let home = test_util::temp_home("config");
        let mut config = GlobalConfig::default();
        config.zr.insert("verbose".to_string(), "true".to_string());
        write_global(home.path(), &config).unwrap();

        let loaded = read_global(home.path()).unwrap();
        assert!(loaded.registries.is_empty());
        assert_eq!(loaded.zr.get("verbose").unwrap(), "true");
    }

    #[test]
    fn test_mixed_config_with_registries() {
        let home = test_util::temp_home("config");
        let mut config = GlobalConfig::default();
        config.zr.insert("verbose".to_string(), "true".to_string());
        let mut pkg_section = BTreeMap::new();
        pkg_section.insert("model".to_string(), "large".to_string());
        config.packages.insert("my-pkg".to_string(), pkg_section);
        config.registries.push(RegistryConfig {
            name: "default".to_string(),
            url: "https://example.com/registry".to_string(),
        });

        write_global(home.path(), &config).unwrap();
        let loaded = read_global(home.path()).unwrap();
        assert_eq!(loaded.zr.get("verbose").unwrap(), "true");
        assert_eq!(loaded.packages.get("my-pkg").unwrap().get("model").unwrap(), "large");
        assert_eq!(loaded.registries.len(), 1);
        assert_eq!(loaded.registries[0].name, "default");
    }
}