forjar 1.4.2

Rust-native Infrastructure as Code — bare-metal first, BLAKE3 state, provenance tracing
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
//! Phase 101 — Fleet Insight & Dependency Quality: validate commands (FJ-1070, FJ-1073, FJ-1076).

use crate::core::types;
use std::collections::HashMap;
use std::path::Path;

// ============================================================================
// FJ-1070: Resource dependency fan-out limit
// ============================================================================

/// Default threshold for fan-out (number of direct dependents).
const DEFAULT_FAN_OUT_THRESHOLD: usize = 10;

/// A warning about a resource whose fan-out exceeds the threshold.
struct FanOutWarning {
    resource: String,
    fan_out: usize,
    threshold: usize,
}

/// Count how many other resources depend on each resource (fan-out = dependent count).
fn find_fan_out_warnings(config: &types::ForjarConfig, threshold: usize) -> Vec<FanOutWarning> {
    let mut dependent_counts: HashMap<String, usize> = HashMap::new();
    for resource in config.resources.values() {
        for dep in &resource.depends_on {
            *dependent_counts.entry(dep.clone()).or_insert(0) += 1;
        }
    }
    let mut warnings = Vec::new();
    let mut names: Vec<&String> = config.resources.keys().collect();
    names.sort();
    for name in names {
        let count = dependent_counts.get(name.as_str()).copied().unwrap_or(0);
        if count > threshold {
            warnings.push(FanOutWarning {
                resource: name.clone(),
                fan_out: count,
                threshold,
            });
        }
    }
    warnings
}

/// FJ-1070: Warn if any resource has more than N direct dependents (default 10).
///
/// Parses the config and counts how many other resources list each resource in
/// their `depends_on`. Resources exceeding the threshold are flagged, as high
/// fan-out indicates a coupling bottleneck.
pub(crate) fn cmd_validate_check_resource_dependency_fan_out_limit(
    file: &Path,
    json: bool,
) -> Result<(), String> {
    let txt = std::fs::read_to_string(file).map_err(|e| e.to_string())?;
    let cfg: crate::core::types::ForjarConfig =
        serde_yaml_ng::from_str(&txt).map_err(|e| e.to_string())?;

    let warnings = find_fan_out_warnings(&cfg, DEFAULT_FAN_OUT_THRESHOLD);

    if json {
        let items: Vec<serde_json::Value> = warnings
            .iter()
            .map(|w| {
                serde_json::json!({
                    "resource": w.resource,
                    "fan_out": w.fan_out,
                    "threshold": w.threshold
                })
            })
            .collect();
        println!(
            "{}",
            serde_json::json!({ "fan_out_warnings": items, "count": warnings.len() })
        );
    } else if warnings.is_empty() {
        println!("No dependency fan-out warnings found.");
    } else {
        println!("Dependency fan-out warnings ({}):", warnings.len());
        for w in &warnings {
            println!(
                "  warning: resource '{}' has {} dependents (threshold: {})",
                w.resource, w.fan_out, w.threshold
            );
        }
    }
    Ok(())
}

// ============================================================================
// FJ-1073: Resource tag required keys
// ============================================================================

/// Required tag namespace prefixes that every resource should have.
const REQUIRED_TAG_NAMESPACES: &[&str] = &["env", "team", "tier"];

/// A warning about a resource missing required tag namespaces.
struct TagRequiredKeysWarning {
    resource: String,
    missing_namespaces: Vec<String>,
}

/// Check if a resource's tags contain the expected namespace prefix.
fn has_tag_namespace(tags: &[String], namespace: &str) -> bool {
    let prefix = format!("{namespace}:");
    tags.iter().any(|t| t.starts_with(&prefix))
}

/// Find resources missing required tag namespaces.
fn find_tag_required_keys_warnings(config: &types::ForjarConfig) -> Vec<TagRequiredKeysWarning> {
    let mut warnings = Vec::new();
    let mut names: Vec<&String> = config.resources.keys().collect();
    names.sort();
    for name in names {
        let resource = &config.resources[name];
        let missing: Vec<String> = REQUIRED_TAG_NAMESPACES
            .iter()
            .filter(|ns| !has_tag_namespace(&resource.tags, ns))
            .map(|ns| (*ns).to_string())
            .collect();
        if !missing.is_empty() {
            warnings.push(TagRequiredKeysWarning {
                resource: name.clone(),
                missing_namespaces: missing,
            });
        }
    }
    warnings
}

/// FJ-1073: Warn if resources lack required tag keys (env, team, tier).
///
/// Parses the config and checks each resource's tags for the presence of
/// expected namespace prefixes (`env:`, `team:`, `tier:`). Resources missing
/// any of these namespaces are flagged for governance compliance.
pub(crate) fn cmd_validate_check_resource_tag_required_keys(
    file: &Path,
    json: bool,
) -> Result<(), String> {
    let txt = std::fs::read_to_string(file).map_err(|e| e.to_string())?;
    let cfg: crate::core::types::ForjarConfig =
        serde_yaml_ng::from_str(&txt).map_err(|e| e.to_string())?;

    let warnings = find_tag_required_keys_warnings(&cfg);

    if json {
        let items: Vec<serde_json::Value> = warnings
            .iter()
            .map(|w| {
                serde_json::json!({
                    "resource": w.resource,
                    "missing_namespaces": w.missing_namespaces
                })
            })
            .collect();
        println!(
            "{}",
            serde_json::json!({ "tag_warnings": items, "count": warnings.len() })
        );
    } else if warnings.is_empty() {
        println!("All resources have required tag namespaces.");
    } else {
        println!("Tag required-key warnings ({}):", warnings.len());
        for w in &warnings {
            println!(
                "  warning: resource '{}' missing tag namespaces: {}",
                w.resource,
                w.missing_namespaces.join(", ")
            );
        }
    }
    Ok(())
}

// ============================================================================
// FJ-1076: Resource content drift risk
// ============================================================================

/// Drift risk entry for a resource.
struct DriftRiskEntry {
    resource: String,
    resource_type: String,
    base_risk: usize,
    dependency_count: usize,
    dependent_count: usize,
    total_risk: usize,
}

/// Assign a base drift-risk score by resource type.
fn base_risk_for_type(rt: &types::ResourceType) -> usize {
    match rt {
        types::ResourceType::File => 3,
        types::ResourceType::Service => 4,
        types::ResourceType::Package => 2,
        _ => 1,
    }
}

/// Build a map of resource name to dependent count.
fn build_dependent_counts(config: &types::ForjarConfig) -> HashMap<String, usize> {
    let mut counts: HashMap<String, usize> = HashMap::new();
    for resource in config.resources.values() {
        for dep in &resource.depends_on {
            *counts.entry(dep.clone()).or_insert(0) += 1;
        }
    }
    counts
}

/// Score drift risk for each resource.
fn compute_drift_risk(config: &types::ForjarConfig) -> Vec<DriftRiskEntry> {
    let dependent_counts = build_dependent_counts(config);
    let mut entries = Vec::new();
    let mut names: Vec<&String> = config.resources.keys().collect();
    names.sort();
    for name in names {
        let resource = &config.resources[name];
        let base = base_risk_for_type(&resource.resource_type);
        let dep_count = resource.depends_on.len();
        let depnt_count = dependent_counts.get(name.as_str()).copied().unwrap_or(0);
        let total = base + dep_count + depnt_count;
        entries.push(DriftRiskEntry {
            resource: name.clone(),
            resource_type: resource.resource_type.to_string(),
            base_risk: base,
            dependency_count: dep_count,
            dependent_count: depnt_count,
            total_risk: total,
        });
    }
    entries
}

/// FJ-1076: Score drift risk based on resource type, content volatility, and dependency count.
///
/// Parses the config and assigns a base risk score by resource type
/// (file=3, service=4, package=2, other=1). Adds 1 per dependency
/// (`depends_on` count) and 1 per dependent (how many others depend on it).
/// Reports the total risk score for each resource.
pub(crate) fn cmd_validate_check_resource_content_drift_risk(
    file: &Path,
    json: bool,
) -> Result<(), String> {
    let txt = std::fs::read_to_string(file).map_err(|e| e.to_string())?;
    let cfg: crate::core::types::ForjarConfig =
        serde_yaml_ng::from_str(&txt).map_err(|e| e.to_string())?;

    let entries = compute_drift_risk(&cfg);

    if json {
        let items: Vec<serde_json::Value> = entries
            .iter()
            .map(|e| {
                serde_json::json!({
                    "resource": e.resource,
                    "resource_type": e.resource_type,
                    "base_risk": e.base_risk,
                    "dependency_count": e.dependency_count,
                    "dependent_count": e.dependent_count,
                    "total_risk": e.total_risk
                })
            })
            .collect();
        println!("{}", serde_json::json!({ "drift_risk": items }));
    } else if entries.is_empty() {
        println!("No resources to assess for drift risk.");
    } else {
        println!("Drift risk assessment ({} resources):", entries.len());
        for e in &entries {
            println!(
                "  {} ({}): risk={} (base={}, deps={}, dependents={})",
                e.resource,
                e.resource_type,
                e.total_risk,
                e.base_risk,
                e.dependency_count,
                e.dependent_count
            );
        }
    }
    Ok(())
}

// ============================================================================
// Tests
// ============================================================================

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

    /// Deserialize a minimal resource from YAML, setting only the `type` field.
    fn make_resource(rtype: &str) -> types::Resource {
        let yaml = format!("type: {rtype}");
        serde_yaml_ng::from_str(&yaml).unwrap()
    }

    /// Build a ForjarConfig from a list of `(name, resource)` pairs.
    fn make_config(resources: Vec<(&str, types::Resource)>) -> types::ForjarConfig {
        let mut map = indexmap::IndexMap::new();
        for (name, res) in resources {
            map.insert(name.to_string(), res);
        }
        let yaml = "version: '1.0'\nname: test\nresources: {}";
        let mut cfg: types::ForjarConfig = serde_yaml_ng::from_str(yaml).unwrap();
        cfg.resources = map;
        cfg
    }

    // -- FJ-1070: Fan-out tests --

    #[test]
    fn test_fan_out_empty_config() {
        let config = make_config(vec![]);
        let warnings = find_fan_out_warnings(&config, 10);
        assert!(warnings.is_empty());
    }

    #[test]
    fn test_fan_out_under_threshold() {
        let a = make_resource("package");
        let mut b = make_resource("service");
        b.depends_on = vec!["a".to_string()];
        let config = make_config(vec![("a", a), ("b", b)]);
        let warnings = find_fan_out_warnings(&config, 10);
        assert!(warnings.is_empty());
    }

    #[test]
    fn test_fan_out_over_threshold() {
        let base = make_resource("package");
        let mut resources: Vec<(&str, types::Resource)> = vec![("base", base)];
        let names: Vec<String> = (0..12).map(|i| format!("svc-{i}")).collect();
        for name in &names {
            let mut r = make_resource("service");
            r.depends_on = vec!["base".to_string()];
            resources.push((name.as_str(), r));
        }
        let config = make_config(resources);
        let warnings = find_fan_out_warnings(&config, 10);
        assert_eq!(warnings.len(), 1);
        assert_eq!(warnings[0].resource, "base");
        assert_eq!(warnings[0].fan_out, 12);
    }

    #[test]
    fn test_fan_out_exact_threshold_no_warning() {
        let base = make_resource("package");
        let mut resources: Vec<(&str, types::Resource)> = vec![("base", base)];
        let names: Vec<String> = (0..10).map(|i| format!("svc-{i}")).collect();
        for name in &names {
            let mut r = make_resource("service");
            r.depends_on = vec!["base".to_string()];
            resources.push((name.as_str(), r));
        }
        let config = make_config(resources);
        let warnings = find_fan_out_warnings(&config, 10);
        assert!(warnings.is_empty());
    }

    #[test]
    fn test_fan_out_no_dependencies() {
        let a = make_resource("file");
        let b = make_resource("service");
        let config = make_config(vec![("a", a), ("b", b)]);
        let warnings = find_fan_out_warnings(&config, 10);
        assert!(warnings.is_empty());
    }

    // -- FJ-1073: Tag required keys tests --

    #[test]
    fn test_tag_required_keys_empty_config() {
        let config = make_config(vec![]);
        let warnings = find_tag_required_keys_warnings(&config);
        assert!(warnings.is_empty());
    }

    #[test]
    fn test_tag_required_keys_all_present() {
        let mut r = make_resource("file");
        r.tags = vec![
            "env:prod".to_string(),
            "team:infra".to_string(),
            "tier:web".to_string(),
        ];
        let config = make_config(vec![("app", r)]);
        let warnings = find_tag_required_keys_warnings(&config);
        assert!(warnings.is_empty());
    }

    #[test]
    fn test_tag_required_keys_missing_some() {
        let mut r = make_resource("service");
        r.tags = vec!["env:staging".to_string()];
        let config = make_config(vec![("svc", r)]);
        let warnings = find_tag_required_keys_warnings(&config);
        assert_eq!(warnings.len(), 1);
        assert_eq!(warnings[0].resource, "svc");
        assert_eq!(warnings[0].missing_namespaces, vec!["team", "tier"]);
    }

    #[test]
    fn test_tag_required_keys_missing_all() {
        let r = make_resource("package");
        let config = make_config(vec![("pkg", r)]);
        let warnings = find_tag_required_keys_warnings(&config);
        assert_eq!(warnings.len(), 1);
        assert_eq!(warnings[0].missing_namespaces, vec!["env", "team", "tier"]);
    }

    #[test]
    fn test_tag_required_keys_partial_match_not_counted() {
        let mut r = make_resource("file");
        // "environment" does not start with "env:"
        r.tags = vec!["environment".to_string()];
        let config = make_config(vec![("cfg", r)]);
        let warnings = find_tag_required_keys_warnings(&config);
        assert_eq!(warnings.len(), 1);
        assert!(warnings[0].missing_namespaces.contains(&"env".to_string()));
    }

    // -- FJ-1076: Drift risk tests --

    #[test]
    fn test_drift_risk_empty_config() {
        let config = make_config(vec![]);
        let entries = compute_drift_risk(&config);
        assert!(entries.is_empty());
    }

    #[test]
    fn test_drift_risk_base_scores() {
        let f = make_resource("file");
        let s = make_resource("service");
        let p = make_resource("package");
        let m = make_resource("mount");
        let config = make_config(vec![("f", f), ("m", m), ("p", p), ("s", s)]);
        let entries = compute_drift_risk(&config);
        // Sorted: f, m, p, s
        assert_eq!(entries[0].resource, "f");
        assert_eq!(entries[0].base_risk, 3);
        assert_eq!(entries[0].total_risk, 3);
        assert_eq!(entries[1].resource, "m");
        assert_eq!(entries[1].base_risk, 1);
        assert_eq!(entries[2].resource, "p");
        assert_eq!(entries[2].base_risk, 2);
        assert_eq!(entries[3].resource, "s");
        assert_eq!(entries[3].base_risk, 4);
    }

    #[test]
    fn test_drift_risk_with_dependencies() {
        let a = make_resource("package");
        let mut b = make_resource("service");
        b.depends_on = vec!["a".to_string()];
        let config = make_config(vec![("a", a), ("b", b)]);
        let entries = compute_drift_risk(&config);
        // "a": base=2, deps=0, dependents=1, total=3
        assert_eq!(entries[0].resource, "a");
        assert_eq!(entries[0].total_risk, 3);
        assert_eq!(entries[0].dependent_count, 1);
        // "b": base=4, deps=1, dependents=0, total=5
        assert_eq!(entries[1].resource, "b");
        assert_eq!(entries[1].total_risk, 5);
        assert_eq!(entries[1].dependency_count, 1);
    }

    #[test]
    fn test_drift_risk_high_fan_out_increases_risk() {
        let base = make_resource("file");
        let mut resources: Vec<(&str, types::Resource)> = vec![("base", base)];
        let names: Vec<String> = (0..5).map(|i| format!("dep-{i}")).collect();
        for name in &names {
            let mut r = make_resource("service");
            r.depends_on = vec!["base".to_string()];
            resources.push((name.as_str(), r));
        }
        let config = make_config(resources);
        let entries = compute_drift_risk(&config);
        let base_entry = entries.iter().find(|e| e.resource == "base").unwrap();
        // base: base_risk=3 + 0 deps + 5 dependents = 8
        assert_eq!(base_entry.total_risk, 8);
        assert_eq!(base_entry.dependent_count, 5);
    }
}