zorath-env 0.3.9

Fast CLI for .env validation against JSON/YAML schemas. 14 types, secret detection, watch mode, remote schemas, 7 export formats, CI templates, health diagnostics, code scanning, auto-fix. Language-agnostic single binary.
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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
use std::collections::{BTreeMap, BTreeSet};

use crate::envfile;
use crate::errors::CliError;
use crate::schema::{self, LoadOptions};
use crate::suggestions::find_closest_match;
use serde::Serialize;

/// JSON output structure for diff command
#[derive(Serialize)]
struct DiffOutput {
    file_a: String,
    file_b: String,
    only_in_a: Vec<KeyValue>,
    only_in_b: Vec<KeyValue>,
    different_values: Vec<ValueDiff>,
    #[serde(skip_serializing_if = "Option::is_none")]
    schema_compliance: Option<SchemaCompliance>,
    identical: bool,
}

#[derive(Serialize)]
struct KeyValue {
    key: String,
    value: String,
}

#[derive(Serialize)]
struct ValueDiff {
    key: String,
    value_a: String,
    value_b: String,
}

#[derive(Serialize)]
struct SchemaCompliance {
    schema_path: String,
    file_a: FileCompliance,
    file_b: FileCompliance,
}

#[derive(Serialize)]
struct FileCompliance {
    missing_required: Vec<String>,
    unknown_keys: Vec<String>,
}

#[doc(hidden)]
pub fn run(
    env_a: &str,
    env_b: &str,
    schema_path: Option<&str>,
    format: &str,
    no_cache: bool,
    verify_hash: Option<&str>,
    ca_cert: Option<&str>,
) -> Result<(), CliError> {
    // Parse both env files
    let map_a = envfile::parse_env_file(env_a).map_err(|e| CliError::Input(format!("Error reading {}: {}", env_a, e)))?;
    let map_b = envfile::parse_env_file(env_b).map_err(|e| CliError::Input(format!("Error reading {}: {}", env_b, e)))?;

    // Convert to BTreeMap for sorted output
    let map_a: BTreeMap<String, String> = map_a.into_iter().collect();
    let map_b: BTreeMap<String, String> = map_b.into_iter().collect();

    let keys_a: BTreeSet<&String> = map_a.keys().collect();
    let keys_b: BTreeSet<&String> = map_b.keys().collect();

    // Find differences
    let only_in_a: Vec<&String> = keys_a.difference(&keys_b).copied().collect();
    let only_in_b: Vec<&String> = keys_b.difference(&keys_a).copied().collect();
    let in_both: Vec<&String> = keys_a.intersection(&keys_b).copied().collect();

    // Find values that differ
    let mut different_values: Vec<(&String, &String, &String)> = Vec::new();
    for key in &in_both {
        let val_a = map_a.get(*key).unwrap();
        let val_b = map_b.get(*key).unwrap();
        if val_a != val_b {
            different_values.push((key, val_a, val_b));
        }
    }

    // Handle JSON output format
    if format == "json" {
        return output_json(env_a, env_b, &map_a, &map_b, &only_in_a, &only_in_b, &different_values, schema_path, no_cache, verify_hash, ca_cert)
            .map_err(CliError::Input);
    }

    if format != "text" {
        return Err(CliError::Input(format!("unknown format '{}'. Use 'text' or 'json'", format)));
    }

    // Print header
    println!("Comparing {} vs {}\n", env_a, env_b);

    let mut has_diff = false;

    // Variables only in A
    if !only_in_a.is_empty() {
        has_diff = true;
        println!("Only in {}:", env_a);
        for key in &only_in_a {
            let val = map_a.get(*key).unwrap();
            println!("  + {}={}", key, truncate_value(val, 50));
        }
        println!();
    }

    // Variables only in B
    if !only_in_b.is_empty() {
        has_diff = true;
        println!("Only in {}:", env_b);
        for key in &only_in_b {
            let val = map_b.get(*key).unwrap();
            println!("  + {}={}", key, truncate_value(val, 50));
        }
        println!();
    }

    // Check for potential typos between only_in_a and only_in_b
    if !only_in_a.is_empty() && !only_in_b.is_empty() {
        let mut typo_suggestions: Vec<(String, String)> = Vec::new();

        // For each key in A, check if there's a similar key in B
        let keys_b_strings: Vec<String> = only_in_b.iter().map(|k| (*k).clone()).collect();
        for key_a in &only_in_a {
            if let Some((match_key, distance)) =
                find_closest_match(key_a, keys_b_strings.iter().map(|s| s.as_str()), 3)
            {
                // Only suggest if the distance is small relative to key length
                if distance <= key_a.len() / 3 + 1 {
                    typo_suggestions.push(((*key_a).clone(), match_key.to_string()));
                }
            }
        }

        if !typo_suggestions.is_empty() {
            println!("Possible typos:");
            for (key_a, key_b) in &typo_suggestions {
                println!("  {} (in {}) <-> {} (in {})", key_a, env_a, key_b, env_b);
            }
            println!();
        }
    }

    // Variables with different values
    if !different_values.is_empty() {
        has_diff = true;
        println!("Different values:");
        for (key, val_a, val_b) in &different_values {
            println!("  {}:", key);
            println!("    {} -> {}", truncate_value(val_a, 40), truncate_value(val_b, 40));
        }
        println!();
    }

    // Schema compliance check if schema provided
    if let Some(schema_path) = schema_path {
        let options = LoadOptions {
            no_cache,
            verify_hash: verify_hash.map(|s| s.to_string()),
            ca_cert: ca_cert.map(|s| s.to_string()),
            rate_limit_seconds: None,
        };
        match schema::load_schema_with_options(schema_path, &options) {
            Ok(schema) => {
                println!("Schema compliance ({}):", schema_path);

                // Check A against schema
                let missing_a = check_missing_required(&map_a, &schema);
                let unknown_a = check_unknown_keys(&map_a, &schema);

                // Check B against schema
                let missing_b = check_missing_required(&map_b, &schema);
                let unknown_b = check_unknown_keys(&map_b, &schema);

                // Report A
                print!("  {}: ", env_a);
                if missing_a.is_empty() && unknown_a.is_empty() {
                    println!("OK");
                } else {
                    let mut issues = Vec::new();
                    if !missing_a.is_empty() {
                        issues.push(format!("{} missing required", missing_a.len()));
                    }
                    if !unknown_a.is_empty() {
                        issues.push(format!("{} unknown", unknown_a.len()));
                    }
                    println!("{}", issues.join(", "));
                }

                // Report B
                print!("  {}: ", env_b);
                if missing_b.is_empty() && unknown_b.is_empty() {
                    println!("OK");
                } else {
                    let mut issues = Vec::new();
                    if !missing_b.is_empty() {
                        issues.push(format!("{} missing required", missing_b.len()));
                    }
                    if !unknown_b.is_empty() {
                        issues.push(format!("{} unknown", unknown_b.len()));
                    }
                    println!("{}", issues.join(", "));
                }
                println!();
            }
            Err(e) => {
                eprintln!("Warning: Could not load schema: {}", e);
            }
        }
    }

    if !has_diff {
        println!("Files are identical.");
    }

    Ok(())
}

/// Truncate a value for display, masking potential secrets
fn truncate_value(value: &str, max_len: usize) -> String {
    // Replace newlines for display
    let display = value.replace('\n', "\\n").replace('\r', "\\r");

    if display.len() <= max_len {
        display
    } else {
        format!("{}...", &display[..max_len])
    }
}

/// Check for missing required variables
fn check_missing_required(
    env_map: &BTreeMap<String, String>,
    schema: &schema::Schema,
) -> Vec<String> {
    let mut missing = Vec::new();
    for (key, spec) in schema.iter() {
        if spec.required && spec.default.is_none() && !env_map.contains_key(key) {
            missing.push(key.clone());
        }
    }
    missing
}

/// Check for unknown keys not in schema
fn check_unknown_keys(
    env_map: &BTreeMap<String, String>,
    schema: &schema::Schema,
) -> Vec<String> {
    let mut unknown = Vec::new();
    for key in env_map.keys() {
        if !schema.contains_key(key) {
            unknown.push(key.clone());
        }
    }
    unknown
}

/// Output diff results as JSON
#[allow(clippy::too_many_arguments)]
fn output_json(
    env_a: &str,
    env_b: &str,
    map_a: &BTreeMap<String, String>,
    map_b: &BTreeMap<String, String>,
    only_in_a: &[&String],
    only_in_b: &[&String],
    different_values: &[(&String, &String, &String)],
    schema_path: Option<&str>,
    no_cache: bool,
    verify_hash: Option<&str>,
    ca_cert: Option<&str>,
) -> Result<(), String> {
    let has_diff = !only_in_a.is_empty() || !only_in_b.is_empty() || !different_values.is_empty();

    // Build schema compliance if schema provided
    let schema_compliance = if let Some(schema_path) = schema_path {
        let options = LoadOptions {
            no_cache,
            verify_hash: verify_hash.map(|s| s.to_string()),
            ca_cert: ca_cert.map(|s| s.to_string()),
            rate_limit_seconds: None,
        };
        match schema::load_schema_with_options(schema_path, &options) {
            Ok(schema) => {
                Some(SchemaCompliance {
                    schema_path: schema_path.to_string(),
                    file_a: FileCompliance {
                        missing_required: check_missing_required(map_a, &schema),
                        unknown_keys: check_unknown_keys(map_a, &schema),
                    },
                    file_b: FileCompliance {
                        missing_required: check_missing_required(map_b, &schema),
                        unknown_keys: check_unknown_keys(map_b, &schema),
                    },
                })
            }
            Err(_) => None,
        }
    } else {
        None
    };

    let output = DiffOutput {
        file_a: env_a.to_string(),
        file_b: env_b.to_string(),
        only_in_a: only_in_a.iter().map(|k| KeyValue {
            key: (*k).clone(),
            value: map_a.get(*k).unwrap().clone(),
        }).collect(),
        only_in_b: only_in_b.iter().map(|k| KeyValue {
            key: (*k).clone(),
            value: map_b.get(*k).unwrap().clone(),
        }).collect(),
        different_values: different_values.iter().map(|(k, va, vb)| ValueDiff {
            key: (*k).clone(),
            value_a: (*va).clone(),
            value_b: (*vb).clone(),
        }).collect(),
        schema_compliance,
        identical: !has_diff,
    };

    let json = serde_json::to_string_pretty(&output).map_err(|e| e.to_string())?;
    println!("{}", json);
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::fs;
    use tempfile::TempDir;

    fn create_temp_env(dir: &TempDir, name: &str, content: &str) -> String {
        let path = dir.path().join(name);
        fs::write(&path, content).unwrap();
        path.to_string_lossy().to_string()
    }

    #[test]
    fn test_truncate_value_short() {
        assert_eq!(truncate_value("short", 10), "short");
    }

    #[test]
    fn test_truncate_value_long() {
        assert_eq!(truncate_value("this is a very long value", 10), "this is a ...");
    }

    #[test]
    fn test_truncate_value_newlines() {
        assert_eq!(truncate_value("line1\nline2", 20), "line1\\nline2");
    }

    #[test]
    fn test_diff_identical_files() {
        let dir = TempDir::new().unwrap();
        let env_a = create_temp_env(&dir, "a.env", "FOO=bar\nBAZ=qux");
        let env_b = create_temp_env(&dir, "b.env", "FOO=bar\nBAZ=qux");

        let result = run(&env_a, &env_b, None, "text", false, None, None);
        assert!(result.is_ok());
    }

    #[test]
    fn test_diff_different_files() {
        let dir = TempDir::new().unwrap();
        let env_a = create_temp_env(&dir, "a.env", "FOO=bar\nONLY_A=value");
        let env_b = create_temp_env(&dir, "b.env", "FOO=different\nONLY_B=value");

        let result = run(&env_a, &env_b, None, "text", false, None, None);
        assert!(result.is_ok());
    }

    #[test]
    fn test_diff_with_schema() {
        let dir = TempDir::new().unwrap();
        let env_a = create_temp_env(&dir, "a.env", "FOO=bar");
        let env_b = create_temp_env(&dir, "b.env", "FOO=bar\nBAZ=qux");
        let schema = create_temp_env(&dir, "schema.json", r#"{"FOO": {"type": "string", "required": true}}"#);

        let result = run(&env_a, &env_b, Some(&schema), "text", false, None, None);
        assert!(result.is_ok());
    }

    #[test]
    fn test_diff_missing_file() {
        let result = run("nonexistent_a.env", "nonexistent_b.env", None, "text", false, None, None);
        assert!(result.is_err());
    }

    #[test]
    fn test_diff_json_format() {
        let dir = TempDir::new().unwrap();
        let env_a = create_temp_env(&dir, "a.env", "FOO=bar\nONLY_A=value");
        let env_b = create_temp_env(&dir, "b.env", "FOO=different\nONLY_B=value");

        let result = run(&env_a, &env_b, None, "json", false, None, None);
        assert!(result.is_ok());
    }

    #[test]
    fn test_diff_json_with_schema() {
        let dir = TempDir::new().unwrap();
        let env_a = create_temp_env(&dir, "a.env", "FOO=bar");
        let env_b = create_temp_env(&dir, "b.env", "FOO=bar\nBAZ=qux");
        let schema = create_temp_env(&dir, "schema.json", r#"{"FOO": {"type": "string", "required": true}}"#);

        let result = run(&env_a, &env_b, Some(&schema), "json", false, None, None);
        assert!(result.is_ok());
    }

    #[test]
    fn test_diff_invalid_format() {
        let dir = TempDir::new().unwrap();
        let env_a = create_temp_env(&dir, "a.env", "FOO=bar");
        let env_b = create_temp_env(&dir, "b.env", "FOO=bar");

        let result = run(&env_a, &env_b, None, "xml", false, None, None);
        assert!(result.is_err());
        assert!(result.unwrap_err().to_string().contains("unknown format"));
    }

    #[test]
    fn test_diff_empty_files() {
        let dir = TempDir::new().unwrap();
        let env_a = create_temp_env(&dir, "a.env", "");
        let env_b = create_temp_env(&dir, "b.env", "");

        let result = run(&env_a, &env_b, None, "text", false, None, None);
        assert!(result.is_ok());
    }

    #[test]
    fn test_diff_one_empty_one_populated() {
        let dir = TempDir::new().unwrap();
        let env_a = create_temp_env(&dir, "a.env", "");
        let env_b = create_temp_env(&dir, "b.env", "FOO=bar\nBAZ=qux");

        let result = run(&env_a, &env_b, None, "text", false, None, None);
        assert!(result.is_ok());
    }

    #[test]
    fn test_diff_multiline_values() {
        let dir = TempDir::new().unwrap();
        let env_a = create_temp_env(&dir, "a.env", "FOO=\"line1\nline2\"");
        let env_b = create_temp_env(&dir, "b.env", "FOO=\"line1\nline2\nline3\"");

        let result = run(&env_a, &env_b, None, "text", false, None, None);
        assert!(result.is_ok());
    }

    #[test]
    fn test_truncate_value_exact_limit() {
        // Value exactly at limit should not be truncated
        let value = "0123456789";
        assert_eq!(truncate_value(value, 10), value);
    }

    #[test]
    fn test_truncate_value_one_over_limit() {
        // Value one char over limit should be truncated
        let value = "01234567890";
        let result = truncate_value(value, 10);
        assert!(result.ends_with("..."));
    }

    #[test]
    fn test_truncate_value_empty() {
        assert_eq!(truncate_value("", 10), "");
    }

    #[test]
    fn test_diff_with_comments_and_blank_lines() {
        let dir = TempDir::new().unwrap();
        let env_a = create_temp_env(&dir, "a.env", "# Comment\nFOO=bar\n\n# Another comment\nBAZ=qux");
        let env_b = create_temp_env(&dir, "b.env", "FOO=bar\nBAZ=qux");

        let result = run(&env_a, &env_b, None, "text", false, None, None);
        assert!(result.is_ok());
    }

    // ====== Typo Detection Tests ======

    #[test]
    fn test_diff_with_typo_detection() {
        let dir = TempDir::new().unwrap();
        // API_KEY vs APY_KEY - typo (1 edit distance)
        let env_a = create_temp_env(&dir, "a.env", "API_KEY=secret123");
        let env_b = create_temp_env(&dir, "b.env", "APY_KEY=secret123");

        // Run should succeed and internally detect the typo
        let result = run(&env_a, &env_b, None, "text", false, None, None);
        assert!(result.is_ok());
    }

    #[test]
    fn test_diff_no_typos_completely_different() {
        let dir = TempDir::new().unwrap();
        // Completely different keys - no typo suggestion
        let env_a = create_temp_env(&dir, "a.env", "FOO=bar");
        let env_b = create_temp_env(&dir, "b.env", "COMPLETELY_DIFFERENT=value");

        let result = run(&env_a, &env_b, None, "text", false, None, None);
        assert!(result.is_ok());
    }

    #[test]
    fn test_diff_multiple_similar_keys() {
        let dir = TempDir::new().unwrap();
        // Multiple similar keys
        let env_a = create_temp_env(&dir, "a.env", "DATABASE_URL=db1\nDATABASE_HOST=host1");
        let env_b = create_temp_env(&dir, "b.env", "DATABSE_URL=db2\nDATABSE_HOST=host2");

        let result = run(&env_a, &env_b, None, "text", false, None, None);
        assert!(result.is_ok());
    }

    // ====== Schema Compliance Helper Tests ======

    #[test]
    fn test_check_missing_required() {
        use crate::schema::{Schema, VarSpec, VarType};

        let mut schema = Schema::new();
        let spec = VarSpec {
            var_type: VarType::String,
            required: true,
            ..Default::default()
        };
        schema.insert("REQUIRED_VAR".to_string(), spec);

        let mut env_map: std::collections::BTreeMap<String, String> = std::collections::BTreeMap::new();
        env_map.insert("OTHER_VAR".to_string(), "value".to_string());

        let missing = check_missing_required(&env_map, &schema);
        assert_eq!(missing.len(), 1);
        assert!(missing.contains(&"REQUIRED_VAR".to_string()));
    }

    #[test]
    fn test_check_unknown_keys() {
        use crate::schema::{Schema, VarSpec, VarType};

        let mut schema = Schema::new();
        let spec = VarSpec {
            var_type: VarType::String,
            ..Default::default()
        };
        schema.insert("KNOWN_VAR".to_string(), spec);

        let mut env_map: std::collections::BTreeMap<String, String> = std::collections::BTreeMap::new();
        env_map.insert("KNOWN_VAR".to_string(), "value".to_string());
        env_map.insert("UNKNOWN_VAR".to_string(), "value".to_string());

        let unknown = check_unknown_keys(&env_map, &schema);
        assert_eq!(unknown.len(), 1);
        assert!(unknown.contains(&"UNKNOWN_VAR".to_string()));
    }

    #[test]
    fn test_diff_schema_both_files_compliant() {
        let dir = TempDir::new().unwrap();
        let env_a = create_temp_env(&dir, "a.env", "PORT=3000\nDEBUG=true");
        let env_b = create_temp_env(&dir, "b.env", "PORT=8080\nDEBUG=false");
        let schema = create_temp_env(&dir, "schema.json", r#"{
            "PORT": {"type": "int", "required": true},
            "DEBUG": {"type": "bool", "required": true}
        }"#);

        let result = run(&env_a, &env_b, Some(&schema), "text", false, None, None);
        assert!(result.is_ok());
    }

    #[test]
    fn test_diff_json_output_structure() {
        let dir = TempDir::new().unwrap();
        let env_a = create_temp_env(&dir, "a.env", "FOO=bar\nONLY_A=value");
        let env_b = create_temp_env(&dir, "b.env", "FOO=different\nONLY_B=value");

        let result = run(&env_a, &env_b, None, "json", false, None, None);
        assert!(result.is_ok());
    }
}