depguard-domain-core 0.1.0

Core model and policy primitives for depguard domain logic
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

use depguard_types::Severity;
use depguard_yanked::YankedIndex;
use std::collections::BTreeMap;

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Scope {
    Repo,
    Diff,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum FailOn {
    Error,
    Warning,
}

#[derive(Clone, Debug)]
pub struct CheckPolicy {
    pub enabled: bool,
    pub severity: Severity,
    pub allow: Vec<String>,
    /// Check-specific option for deps.path_requires_version.
    pub ignore_publish_false: bool,
}

impl CheckPolicy {
    pub fn enabled(severity: Severity) -> Self {
        Self {
            enabled: true,
            severity,
            allow: Vec::new(),
            ignore_publish_false: false,
        }
    }

    pub fn disabled() -> Self {
        Self {
            enabled: false,
            severity: Severity::Info,
            allow: Vec::new(),
            ignore_publish_false: false,
        }
    }
}

#[derive(Clone, Debug)]
pub struct EffectiveConfig {
    pub profile: String,
    pub scope: Scope,
    pub fail_on: FailOn,
    pub max_findings: usize,
    /// Optional offline yanked-version index used by deps.yanked_versions.
    pub yanked_index: Option<YankedIndex>,
    pub checks: BTreeMap<String, CheckPolicy>,
}

impl EffectiveConfig {
    pub fn check_policy(&self, check_id: &str) -> Option<&CheckPolicy> {
        self.checks.get(check_id).filter(|p| p.enabled)
    }
}

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

    #[test]
    fn check_policy_enabled_and_disabled() {
        let enabled = CheckPolicy::enabled(Severity::Warning);
        assert!(enabled.enabled);
        assert_eq!(enabled.severity, Severity::Warning);
        assert!(!enabled.ignore_publish_false);

        let disabled = CheckPolicy::disabled();
        assert!(!disabled.enabled);
        assert_eq!(disabled.severity, Severity::Info);
    }

    #[test]
    fn effective_config_filters_disabled_checks() {
        let mut checks = BTreeMap::new();
        checks.insert(
            "enabled".to_string(),
            CheckPolicy::enabled(Severity::Warning),
        );
        checks.insert("disabled".to_string(), CheckPolicy::disabled());

        let cfg = EffectiveConfig {
            profile: "test".to_string(),
            scope: Scope::Repo,
            fail_on: FailOn::Error,
            max_findings: 10,
            yanked_index: None,
            checks,
        };

        assert!(cfg.check_policy("enabled").is_some());
        assert!(cfg.check_policy("disabled").is_none());
        assert!(cfg.check_policy("missing").is_none());
    }
}