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
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
use assert_fs::TempDir;
use assert_fs::prelude::*;
use sprawl_guard_lib::config::supported_language_ids;
use std::process::Output;

use super::common::*;

fn assert_init_writes_config(root: &TempDir, expected: toml::Table) -> Output {
    let output = sprawl_guard(root).arg("init").output().unwrap();
    let config = read_config_toml(root);

    assert_exit_code(&output, exit_codes::SUCCESS);
    assert_eq!(config, toml_value(expected));
    assert_eq!(stderr(&output), "");
    output
}

mod when_supported_languages_are_detected {
    use super::*;

    #[test]
    fn it_writes_a_minimal_config_for_only_detected_languages() {
        let root = TempDir::new().unwrap();
        write_file(&root, "src/lib.rs", "fn main() {}\n");

        let output = assert_init_writes_config(
            &root,
            toml::toml! {
                [languages.rust]
                enabled = true
            },
        );
        assert!(stdout(&output).contains("Wrote "));
    }

    #[test]
    fn it_detects_typescript_only_repositories() {
        let root = TempDir::new().unwrap();
        write_file(&root, "src/index.ts", "export const value = 1;\n");

        assert_init_writes_config(
            &root,
            toml::toml! {
                [languages.typescript]
                enabled = true
            },
        );
    }

    #[test]
    fn it_detects_mixed_repositories() {
        let root = TempDir::new().unwrap();
        write_file(&root, "src/lib.rs", "pub fn value() -> u8 { 1 }\n");
        write_file(&root, "src/index.ts", "export const value = 1;\n");

        assert_init_writes_config(
            &root,
            toml::toml! {
                [languages.rust]
                enabled = true

                [languages.typescript]
                enabled = true
            },
        );
    }

    #[test]
    fn it_uses_ignore_rules_when_detecting_languages() {
        let root = TempDir::new().unwrap();
        write_file(&root, ".gitignore", "ignored/**\n");
        write_file(&root, "ignored/index.ts", "export const ignored = true;\n");
        write_file(&root, "src/lib.rs", "pub fn value() -> u8 { 1 }\n");

        assert_init_writes_config(
            &root,
            toml::toml! {
                [languages.rust]
                enabled = true
            },
        );
    }
}

mod when_config_path_is_explicit {
    use super::*;

    #[test]
    fn it_writes_relative_paths_under_the_root() {
        let root = TempDir::new().unwrap();
        write_file(&root, "src/lib.rs", "fn main() {}\n");

        let output = sprawl_guard(&root)
            .args(["--config", "custom-sprawl.toml", "init"])
            .output()
            .unwrap();

        assert_exit_code(&output, exit_codes::SUCCESS);
        assert!(!root.child("sprawl-guard.toml").path().exists());
        assert_toml_contains(
            &parse_toml(&std::fs::read_to_string(root.child("custom-sprawl.toml")).unwrap()),
            toml::toml! {
                [languages.rust]
                enabled = true
            },
        );
        assert_eq!(stderr(&output), "");
    }

    #[test]
    fn it_writes_the_explicit_target_when_only_the_default_config_exists() {
        let root = TempDir::new().unwrap();
        write_config(&root, "[languages.rust]\nenabled = true\n");
        write_file(&root, "src/lib.rs", "fn main() {}\n");

        let output = sprawl_guard(&root)
            .args(["--config", "alternate.toml", "init"])
            .output()
            .unwrap();

        assert_exit_code(&output, exit_codes::SUCCESS);
        assert!(root.child("alternate.toml").path().exists());
        assert_eq!(stderr(&output), "");
    }

    #[test]
    fn it_refuses_to_overwrite_the_explicit_target() {
        let root = TempDir::new().unwrap();
        write_file(
            &root,
            "alternate.toml",
            "[languages.rust]\nenabled = false\n",
        );
        write_file(&root, "src/lib.rs", "fn main() {}\n");

        let output = sprawl_guard(&root)
            .args(["--config", "alternate.toml", "init"])
            .output()
            .unwrap();

        assert_exit_code(&output, exit_codes::OPERATIONAL_ERROR);
        assert_eq!(
            std::fs::read_to_string(root.child("alternate.toml").path()).unwrap(),
            "[languages.rust]\nenabled = false\n"
        );
        assert!(stderr(&output).contains("config file already exists:"));
    }
}

mod when_languages_are_explicit {
    use super::*;

    #[test]
    fn it_writes_those_languages_without_matching_files() {
        let root = TempDir::new().unwrap();

        let output = sprawl_guard(&root)
            .args(["init", "--languages", "rust,typescript"])
            .output()
            .unwrap();
        let config = read_config_toml(&root);

        assert_exit_code(&output, exit_codes::SUCCESS);
        assert_eq!(
            config,
            toml_value(toml::toml! {
                [languages.rust]
                enabled = true

                [languages.typescript]
                enabled = true
            })
        );
        assert_eq!(stderr(&output), "");
    }

    #[test]
    fn it_normalizes_aliases_to_canonical_lowercase_keys() {
        let root = TempDir::new().unwrap();

        let output = sprawl_guard(&root)
            .args(["init", "--languages", "TypeScript", "--dry-run"])
            .output()
            .unwrap();

        assert_exit_code(&output, exit_codes::SUCCESS);
        let config = toml_from_stdout_config(&output);

        assert_eq!(
            config,
            toml_value(toml::toml! {
                [languages.typescript]
                enabled = true
            })
        );
        assert_eq!(stderr(&output), "");
    }
}

mod when_all_languages_are_requested {
    use super::*;

    #[test]
    fn it_writes_every_supported_language_section() {
        let root = TempDir::new().unwrap();

        let output = sprawl_guard(&root)
            .args(["init", "--all-languages"])
            .output()
            .unwrap();
        let config = read_config_toml(&root);
        let language_table = config["languages"].as_table().unwrap();

        assert_exit_code(&output, exit_codes::SUCCESS);
        assert_eq!(language_table.len(), supported_language_ids().len());
        for language in supported_language_ids() {
            let key = language.to_string().to_ascii_lowercase();
            assert_eq!(language_table[&key]["enabled"].as_bool(), Some(true));
        }
        assert_toml_contains(
            &config,
            toml::toml! {
                [languages.rust]
                enabled = true

                [languages.typescript]
                enabled = true

                [languages."c++"]
                enabled = true
            },
        );
        assert_eq!(stderr(&output), "");
    }
}

mod when_dry_run_is_used {
    use super::*;

    #[test]
    fn it_prints_the_config_without_writing_it() {
        let root = TempDir::new().unwrap();

        let output = sprawl_guard(&root)
            .args(["init", "--languages", "rust", "--dry-run"])
            .output()
            .unwrap();
        let config_path = root.child("sprawl-guard.toml");

        assert_exit_code(&output, exit_codes::SUCCESS);
        assert!(!config_path.path().exists());
        assert!(stdout(&output).contains("Would write "));
        let config = toml_from_stdout_config(&output);
        assert_eq!(
            config,
            toml_value(toml::toml! {
                [languages.rust]
                enabled = true
            })
        );
        assert_eq!(stderr(&output), "");
    }

    #[test]
    fn it_reports_that_a_real_write_would_refuse_an_existing_config() {
        let root = TempDir::new().unwrap();
        write_config(&root, "[languages.rust]\nenabled = true\n");

        let output = sprawl_guard(&root)
            .args(["init", "--languages", "rust", "--dry-run"])
            .output()
            .unwrap();

        assert_exit_code(&output, exit_codes::SUCCESS);
        assert!(stdout(&output).contains("A real write would be refused"));
        assert_eq!(stderr(&output), "");
    }
}

mod when_config_already_exists {
    use super::*;

    #[test]
    fn it_refuses_to_overwrite_the_file() {
        let root = TempDir::new().unwrap();
        write_config(&root, "[languages.rust]\nenabled = true\n");

        let output = sprawl_guard(&root)
            .args(["init", "--languages", "rust"])
            .output()
            .unwrap();

        assert_exit_code(&output, exit_codes::OPERATIONAL_ERROR);
        assert!(stderr(&output).contains("config file already exists:"));
    }

    #[test]
    fn it_refuses_hidden_alias_config_before_language_detection() {
        let root = TempDir::new().unwrap();
        write_alias_config(&root, "[languages.rust]\nenabled = true\n");

        let output = sprawl_guard(&root).arg("init").output().unwrap();
        let stderr = stderr(&output);

        assert_exit_code(&output, exit_codes::OPERATIONAL_ERROR);
        assert!(stderr.contains("config file already exists:"));
        assert!(stderr.contains(".sprawlrc.toml"));
        assert!(!stderr.contains("no supported source files found"));
    }
}

mod when_no_languages_are_selected_or_detected {
    use super::*;

    #[test]
    fn it_exits_without_writing_config() {
        let root = TempDir::new().unwrap();

        let output = sprawl_guard(&root).arg("init").output().unwrap();

        assert_exit_code(&output, exit_codes::OPERATIONAL_ERROR);
        assert!(!root.child("sprawl-guard.toml").path().exists());
        assert!(stderr(&output).contains("no supported source files found"));
    }
}

mod when_advisory_scan_fails {
    use super::*;

    #[test]
    fn it_does_not_write_the_config() {
        let root = TempDir::new().unwrap();
        write_oversized_rust_source(&root, "src/huge.rs");

        let output = sprawl_guard(&root)
            .args(["init", "--languages", "rust"])
            .output()
            .unwrap();

        assert_exit_code(&output, exit_codes::OPERATIONAL_ERROR);
        assert!(!root.child("sprawl-guard.toml").path().exists());
        assert!(stderr(&output).contains("failed to run init advisory scan before writing"));
        assert!(stderr(&output).contains("is too large to count"));
    }
}

mod when_generated_vendor_like_paths_are_included {
    use super::*;

    #[test]
    fn it_prints_an_advisory_without_mutating_config_excludes() {
        let root = TempDir::new().unwrap();
        for index in 0..100 {
            write_file(
                &root,
                &format!("dist/file-{index}.js"),
                "export const x = 1;\n",
            );
        }

        let output = sprawl_guard(&root).arg("init").output().unwrap();
        let config = read_config_toml(&root);

        assert_exit_code(&output, exit_codes::SUCCESS);
        assert!(stdout(&output).contains("Large generated/vendor-like directories"));
        assert!(stdout(&output).contains("dist/"));
        assert!(stdout(&output).contains("100 files javascript"));
        assert_eq!(
            config,
            toml_value(toml::toml! {
                [languages.javascript]
                enabled = true
            })
        );
        assert_eq!(stderr(&output), "");
    }
}

mod when_advisory_scan_finds_current_violations {
    use super::*;

    #[test]
    fn it_reports_violation_counts_by_group() {
        let root = TempDir::new().unwrap();
        write_rust_source_with_function_count(&root, "src/huge.rs", 401);
        write_rust_source_with_function_count(&root, "src/huge.test.rs", 801);
        for index in 0..9 {
            write_file(
                &root,
                &format!("src/leaf-{index}.rs"),
                &format!("fn leaf_{index}() {{}}\n"),
            );
        }

        let output = sprawl_guard(&root).arg("init").output().unwrap();
        let stdout = stdout(&output);

        assert_exit_code(&output, exit_codes::SUCCESS);
        assert!(stdout.contains("Current tree has violations under the new policy:"));
        assert!(stdout.contains("production file LOC violations: 1"));
        assert!(stdout.contains("test file LOC violations: 1"));
        assert!(stdout.contains("production directory fan-out violations: 1"));
        assert!(stdout.contains("test directory fan-out violations: not enforced (unlimited)"));
        assert_eq!(stderr(&output), "");
    }

    #[test]
    fn it_uses_rust_cfg_test_preprocessing() {
        let root = TempDir::new().unwrap();
        let cfg_test_lines = (0..600)
            .map(|index| format!("    fn test_{index}() {{}}\n"))
            .collect::<String>();
        write_file(
            &root,
            "src/lib.rs",
            &format!("pub fn production() {{}}\n#[cfg(test)]\nmod tests {{\n{cfg_test_lines}}}\n"),
        );

        let output = sprawl_guard(&root).arg("init").output().unwrap();
        let stdout = stdout(&output);

        assert_exit_code(&output, exit_codes::SUCCESS);
        assert!(stdout.contains("Current tree has no violations under the new policy."));
        assert_eq!(stderr(&output), "");
    }
}