homeboy 0.63.0

CLI for multi-component deployment and development workflow automation
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

//! Check files against discovered or explicit conventions.
//!
//! Takes conventions and produces check results that can be converted
//! into actionable findings.

use super::conventions::{Convention, Outlier};

/// Result of checking a set of conventions.
#[derive(Debug, Clone, serde::Serialize)]
pub struct CheckResult {
    /// The convention that was checked.
    pub convention_name: String,
    /// Whether the convention is healthy (no outliers).
    pub status: CheckStatus,
    /// Number of conforming files.
    pub conforming_count: usize,
    /// Total files in the group.
    pub total_count: usize,
    /// Outliers found.
    pub outliers: Vec<Outlier>,
}

#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum CheckStatus {
    /// All files conform.
    Clean,
    /// Some files deviate.
    Drift,
    /// Less than half conform — convention may be wrong or split.
    Fragmented,
}

/// Run checks on all discovered conventions.
pub fn check_conventions(conventions: &[Convention]) -> Vec<CheckResult> {
    conventions
        .iter()
        .map(|conv| {
            let status = if conv.outliers.is_empty() {
                CheckStatus::Clean
            } else if conv.confidence >= 0.5 {
                CheckStatus::Drift
            } else {
                CheckStatus::Fragmented
            };

            CheckResult {
                convention_name: conv.name.clone(),
                status,
                conforming_count: conv.conforming.len(),
                total_count: conv.total_files,
                outliers: conv.outliers.clone(),
            }
        })
        .collect()
}

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

#[cfg(test)]
mod tests {
    use super::*;
    use crate::code_audit::conventions::{Deviation, DeviationKind};

    #[test]
    fn clean_convention_produces_clean_status() {
        let conv = Convention {
            name: "Test".to_string(),
            glob: "*.rs".to_string(),
            expected_methods: vec!["run".to_string()],
            expected_registrations: vec![],
            expected_interfaces: vec![],
            expected_namespace: None,
            expected_imports: vec![],
            conforming: vec!["a.rs".to_string(), "b.rs".to_string()],
            outliers: vec![],
            total_files: 2,
            confidence: 1.0,
        };

        let results = check_conventions(&[conv]);
        assert_eq!(results[0].status, CheckStatus::Clean);
    }

    #[test]
    fn outliers_produce_drift_status() {
        let conv = Convention {
            name: "Test".to_string(),
            glob: "*.rs".to_string(),
            expected_methods: vec!["run".to_string()],
            expected_registrations: vec![],
            expected_interfaces: vec![],
            expected_namespace: None,
            expected_imports: vec![],
            conforming: vec!["a.rs".to_string(), "b.rs".to_string()],
            outliers: vec![Outlier {
                file: "c.rs".to_string(),
                deviations: vec![Deviation {
                    kind: DeviationKind::MissingMethod,
                    description: "Missing method: run".to_string(),
                    suggestion: "Add run()".to_string(),
                }],
            }],
            total_files: 3,
            confidence: 0.67,
        };

        let results = check_conventions(&[conv]);
        assert_eq!(results[0].status, CheckStatus::Drift);
        assert_eq!(results[0].outliers.len(), 1);
    }

    #[test]
    fn low_confidence_produces_fragmented_status() {
        let conv = Convention {
            name: "Test".to_string(),
            glob: "*.rs".to_string(),
            expected_methods: vec!["run".to_string()],
            expected_registrations: vec![],
            expected_interfaces: vec![],
            expected_namespace: None,
            expected_imports: vec![],
            conforming: vec!["a.rs".to_string()],
            outliers: vec![
                Outlier {
                    file: "b.rs".to_string(),
                    deviations: vec![Deviation {
                        kind: DeviationKind::MissingMethod,
                        description: "Missing".to_string(),
                        suggestion: "Fix".to_string(),
                    }],
                },
                Outlier {
                    file: "c.rs".to_string(),
                    deviations: vec![Deviation {
                        kind: DeviationKind::MissingMethod,
                        description: "Missing".to_string(),
                        suggestion: "Fix".to_string(),
                    }],
                },
            ],
            total_files: 3,
            confidence: 0.33,
        };

        let results = check_conventions(&[conv]);
        assert_eq!(results[0].status, CheckStatus::Fragmented);
    }
}