repolens 2.0.0

A CLI tool to audit and prepare repositories for open source or enterprise standards
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

//! Rule category constants and validation

use colored::Colorize;

/// Valid category names for --only and --skip options
pub const VALID_CATEGORIES: &[&str] = &[
    "secrets",
    "files",
    "docs",
    "security",
    "workflows",
    "quality",
    "dependencies",
    "licenses",
    "docker",
    "git",
    "custom",
];

/// Check if a category name is valid
pub fn is_valid_category(name: &str) -> bool {
    VALID_CATEGORIES.contains(&name)
}

/// Filter a list of categories, returning only valid ones and printing warnings for invalid ones
pub fn filter_valid_categories(categories: Vec<String>) -> Vec<String> {
    let mut valid = Vec::new();
    for category in categories {
        if is_valid_category(&category) {
            valid.push(category);
        } else {
            eprintln!(
                "{} Unknown category '{}' ignored. Valid categories: {}",
                "Warning:".yellow(),
                category.cyan(),
                VALID_CATEGORIES.join(", ").dimmed()
            );
        }
    }
    valid
}

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

    #[test]
    fn test_valid_categories_list() {
        assert_eq!(VALID_CATEGORIES.len(), 11);
        assert!(VALID_CATEGORIES.contains(&"secrets"));
        assert!(VALID_CATEGORIES.contains(&"files"));
        assert!(VALID_CATEGORIES.contains(&"docs"));
        assert!(VALID_CATEGORIES.contains(&"security"));
        assert!(VALID_CATEGORIES.contains(&"workflows"));
        assert!(VALID_CATEGORIES.contains(&"quality"));
        assert!(VALID_CATEGORIES.contains(&"dependencies"));
        assert!(VALID_CATEGORIES.contains(&"licenses"));
        assert!(VALID_CATEGORIES.contains(&"docker"));
        assert!(VALID_CATEGORIES.contains(&"git"));
        assert!(VALID_CATEGORIES.contains(&"custom"));
    }

    #[test]
    fn test_is_valid_category_returns_true_for_valid() {
        assert!(is_valid_category("secrets"));
        assert!(is_valid_category("files"));
        assert!(is_valid_category("docs"));
        assert!(is_valid_category("security"));
        assert!(is_valid_category("workflows"));
        assert!(is_valid_category("quality"));
        assert!(is_valid_category("dependencies"));
        assert!(is_valid_category("licenses"));
        assert!(is_valid_category("docker"));
        assert!(is_valid_category("git"));
        assert!(is_valid_category("custom"));
    }

    #[test]
    fn test_is_valid_category_returns_false_for_invalid() {
        assert!(!is_valid_category("invalid"));
        assert!(!is_valid_category("unknown"));
        assert!(!is_valid_category(""));
        assert!(!is_valid_category("SECRETS")); // case-sensitive
        assert!(!is_valid_category("Files"));
    }

    #[test]
    fn test_filter_valid_categories_keeps_valid() {
        let input = vec![
            "secrets".to_string(),
            "files".to_string(),
            "docs".to_string(),
        ];
        let result = filter_valid_categories(input);
        assert_eq!(result.len(), 3);
        assert!(result.contains(&"secrets".to_string()));
        assert!(result.contains(&"files".to_string()));
        assert!(result.contains(&"docs".to_string()));
    }

    #[test]
    fn test_filter_valid_categories_removes_invalid() {
        let input = vec![
            "secrets".to_string(),
            "invalid".to_string(),
            "docs".to_string(),
        ];
        let result = filter_valid_categories(input);
        assert_eq!(result.len(), 2);
        assert!(result.contains(&"secrets".to_string()));
        assert!(result.contains(&"docs".to_string()));
        assert!(!result.contains(&"invalid".to_string()));
    }

    #[test]
    fn test_filter_valid_categories_empty_input() {
        let input: Vec<String> = vec![];
        let result = filter_valid_categories(input);
        assert!(result.is_empty());
    }

    #[test]
    fn test_filter_valid_categories_all_invalid() {
        let input = vec!["invalid".to_string(), "unknown".to_string()];
        let result = filter_valid_categories(input);
        assert!(result.is_empty());
    }
}