sprawl-guard 0.1.0

Repository sprawl checker CLI.
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

use std::path::Path;

use assert_fs::TempDir;
use indoc::indoc;

use super::common::*;

mod when_explaining_rust_cfg_test_preprocessing {
    use super::*;

    #[test]
    fn it_reports_the_status_and_excluded_item_count() {
        let root = TempDir::new().unwrap();
        write_config(
            &root,
            indoc! {r#"
                [languages.rust]
                enabled = true
            "#},
        );
        write_file(
            &root,
            "src/lib.rs",
            indoc! {r#"
                fn production() {}

                #[cfg(test)]
                fn fixture() {}
            "#},
        );

        let output = sprawl_guard(&root)
            .arg("explain")
            .arg(Path::new("src/lib.rs"))
            .output()
            .unwrap();

        assert_exit_code(&output, exit_codes::SUCCESS);
        assert_eq!(
            stdout(&output),
            indoc! {"
                src/lib.rs: production source (Rust); file LOC limit: 400; directory leaf-file limit: 8; rust cfg(test): parsed; excluded top-level items: 1
            "}
        );
        assert_eq!(stderr(&output), "");
    }
}

mod when_explaining_matching_overrides {
    use super::*;

    #[test]
    fn it_reports_the_final_limits_and_override_stack() {
        let root = TempDir::new().unwrap();
        write_config(
            &root,
            indoc! {r#"
                [limits]
                max_lines_per_file = { code_non_test = 1 }
                max_leaf_files_per_directory = { production = 1 }

                [languages.rust]
                enabled = true

                [[overrides]]
                paths = ["src/**"]
                max_lines_per_file = { code_non_test = 2 }
                max_leaf_files_per_directory = { production = 3 }
                reason = "package exception"

                [[overrides]]
                paths = ["src/legacy/**"]
                max_lines_per_file = { code_non_test = 4 }
                reason = "legacy exception"
            "#},
        );
        write_file(&root, "src/legacy/lib.rs", "fn production() {}\n");

        let output = sprawl_guard(&root)
            .arg("explain")
            .arg(Path::new("src/legacy/lib.rs"))
            .output()
            .unwrap();

        assert_exit_code(&output, exit_codes::SUCCESS);
        assert_eq!(
            stdout(&output),
            indoc! {"
                src/legacy/lib.rs: production source (Rust); file LOC limit: 4; directory leaf-file limit: 3; matched file overrides: #1 paths=[src/**], #2 paths=[src/legacy/**]; matched directory overrides: #1 paths=[src/**], #2 paths=[src/legacy/**]; rust cfg(test): skipped by prefilter; excluded top-level items: 0
            "}
        );
        assert_eq!(stderr(&output), "");
    }

    #[test]
    fn it_reports_directory_only_override_matches() {
        let root = TempDir::new().unwrap();
        write_config(
            &root,
            indoc! {r#"
                [limits]
                max_leaf_files_per_directory = { production = 1 }

                [languages.rust]
                enabled = true

                [[overrides]]
                paths = ["src"]
                max_leaf_files_per_directory = { production = 3 }
                reason = "small module hub"
            "#},
        );
        write_file(&root, "src/lib.rs", "fn production() {}\n");

        let output = sprawl_guard(&root)
            .arg("explain")
            .arg(Path::new("src/lib.rs"))
            .output()
            .unwrap();

        assert_exit_code(&output, exit_codes::SUCCESS);
        assert_eq!(
            stdout(&output),
            indoc! {"
                src/lib.rs: production source (Rust); file LOC limit: 400; directory leaf-file limit: 3; matched directory overrides: #1 paths=[src]; rust cfg(test): skipped by prefilter; excluded top-level items: 0
            "}
        );
        assert_eq!(stderr(&output), "");
    }
}