timebomb-cli 0.7.0

Scan source code for deadline-tagged fuses and fail when they detonate
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
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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
//! Integration tests for config loading and merging.
//!
//! These tests exercise the full config loading pipeline including reading from
//! actual `.timebomb.toml` files on disk and merging with CLI overrides.

use std::io::Write;
use std::path::Path;

use timebomb::config::{load_config, CliOverrides, Config};

// ─── Helpers ──────────────────────────────────────────────────────────────────

/// Write a `.timebomb.toml` into a temp directory and return the dir.
fn write_config(content: &str) -> tempfile::TempDir {
    let dir = tempfile::tempdir().unwrap();
    let config_path = dir.path().join(".timebomb.toml");
    let mut f = std::fs::File::create(&config_path).unwrap();
    write!(f, "{}", content).unwrap();
    dir
}

fn no_overrides() -> CliOverrides {
    CliOverrides::default()
}

// ─── Default config ───────────────────────────────────────────────────────────

#[test]
fn test_default_config_tags() {
    let cfg = Config::default();
    let triggers = &cfg.triggers;
    assert!(triggers.contains(&"TODO".to_string()));
    assert!(triggers.contains(&"FIXME".to_string()));
    assert!(triggers.contains(&"HACK".to_string()));
    assert!(triggers.contains(&"TEMP".to_string()));
    assert!(triggers.contains(&"REMOVEME".to_string()));
    assert!(triggers.contains(&"DEBT".to_string()));
    assert!(triggers.contains(&"STOPSHIP".to_string()));
    assert!(triggers.contains(&"WORKAROUND".to_string()));
    assert!(triggers.contains(&"DEPRECATED".to_string()));
    assert!(triggers.contains(&"BUG".to_string()));
    assert_eq!(triggers.len(), 10);
}

#[test]
fn test_default_config_fuse_days_is_zero() {
    let cfg = Config::default();
    assert_eq!(cfg.fuse_days, 0);
}

#[test]
fn test_default_config_fail_on_ticking_is_false() {
    let cfg = Config::default();
    assert!(!cfg.fail_on_ticking);
}

#[test]
fn test_default_config_extensions_non_empty() {
    let cfg = Config::default();
    assert!(!cfg.extensions.is_empty());
}

#[test]
fn test_default_config_extensions_contain_common_types() {
    let cfg = Config::default();
    let exts = &cfg.extensions;
    for expected in &[
        "rs", "go", "ts", "js", "py", "rb", "java", "sql", "yaml", "yml",
    ] {
        assert!(
            exts.contains(&expected.to_string()),
            "expected extension '{}' to be in default list",
            expected
        );
    }
}

#[test]
fn test_default_config_excludes_contain_git() {
    let cfg = Config::default();
    assert!(
        cfg.exclude_patterns.iter().any(|p| p.contains(".git")),
        "default excludes should contain .git/**"
    );
}

#[test]
fn test_default_config_excludes_contain_node_modules() {
    let cfg = Config::default();
    assert!(
        cfg.exclude_patterns
            .iter()
            .any(|p| p.contains("node_modules")),
        "default excludes should contain node_modules/**"
    );
}

#[test]
fn test_default_config_excludes_contain_vendor() {
    let cfg = Config::default();
    assert!(
        cfg.exclude_patterns.iter().any(|p| p.contains("vendor")),
        "default excludes should contain vendor/**"
    );
}

// ─── load_config: no config file present ─────────────────────────────────────

#[test]
fn test_load_config_no_file_uses_defaults() {
    let dir = tempfile::tempdir().unwrap();
    let cfg = load_config(dir.path(), &no_overrides()).unwrap();
    assert_eq!(cfg.triggers, Config::default().triggers);
    assert_eq!(cfg.fuse_days, 0);
    assert!(!cfg.fail_on_ticking);
}

#[test]
fn test_load_config_no_file_no_overrides_default_extensions() {
    let dir = tempfile::tempdir().unwrap();
    let cfg = load_config(dir.path(), &no_overrides()).unwrap();
    assert!(cfg.extensions.contains(&"rs".to_string()));
    assert!(cfg.extensions.contains(&"py".to_string()));
}

// ─── load_config: config file present ────────────────────────────────────────

#[test]
fn test_load_config_reads_triggers_from_file() {
    let dir = write_config(r#"triggers = ["TODO", "FIXME"]"#);
    let cfg = load_config(dir.path(), &no_overrides()).unwrap();
    assert_eq!(cfg.triggers, vec!["TODO", "FIXME"]);
}

#[test]
fn test_load_config_reads_fuse_days() {
    let dir = write_config("fuse_days = 21\n");
    let cfg = load_config(dir.path(), &no_overrides()).unwrap();
    assert_eq!(cfg.fuse_days, 21);
}

#[test]
fn test_load_config_reads_exclude_patterns() {
    let dir = write_config(r#"exclude = ["build/**", "dist/**"]"#);
    let cfg = load_config(dir.path(), &no_overrides()).unwrap();
    assert!(cfg.exclude_patterns.contains(&"build/**".to_string()));
    assert!(cfg.exclude_patterns.contains(&"dist/**".to_string()));
}

#[test]
fn test_load_config_reads_extensions() {
    let dir = write_config(r#"extensions = ["rs", "toml"]"#);
    let cfg = load_config(dir.path(), &no_overrides()).unwrap();
    assert_eq!(cfg.extensions, vec!["rs", "toml"]);
}

#[test]
fn test_load_config_partial_file_fills_rest_from_defaults() {
    // Only fuse_days specified; triggers, exclude, extensions should come from defaults
    let dir = write_config("fuse_days = 7\n");
    let cfg = load_config(dir.path(), &no_overrides()).unwrap();
    assert_eq!(cfg.fuse_days, 7);
    // Triggers should fall back to defaults
    assert!(cfg.triggers.contains(&"TODO".to_string()));
    assert!(cfg.triggers.contains(&"FIXME".to_string()));
    // Extensions should fall back to defaults
    assert!(cfg.extensions.contains(&"rs".to_string()));
}

#[test]
fn test_load_config_empty_file_uses_defaults() {
    let dir = write_config("");
    let cfg = load_config(dir.path(), &no_overrides()).unwrap();
    assert_eq!(cfg.triggers, Config::default().triggers);
    assert_eq!(cfg.fuse_days, 0);
}

#[test]
fn test_load_config_full_file() {
    let toml = r#"
triggers = ["TODO", "FIXME", "HACK"]
fuse_days = 14
exclude = ["vendor/**", "node_modules/**", ".git/**"]
extensions = ["rs", "go", "py"]
"#;
    let dir = write_config(toml);
    let cfg = load_config(dir.path(), &no_overrides()).unwrap();

    assert_eq!(cfg.triggers, vec!["TODO", "FIXME", "HACK"]);
    assert_eq!(cfg.fuse_days, 14);
    assert!(cfg.exclude_patterns.contains(&"vendor/**".to_string()));
    assert_eq!(cfg.extensions, vec!["rs", "go", "py"]);
}

// ─── load_config: invalid config file ────────────────────────────────────────

#[test]
fn test_load_config_invalid_toml_returns_error() {
    let dir = write_config("this is not valid toml ][[[");
    let result = load_config(dir.path(), &no_overrides());
    assert!(result.is_err(), "invalid TOML should return an error");
}

#[test]
fn test_load_config_unknown_field_returns_error() {
    // We use deny_unknown_fields in ConfigFile
    let dir = write_config("unknown_key = true\n");
    let result = load_config(dir.path(), &no_overrides());
    assert!(
        result.is_err(),
        "unknown field in config should return an error due to deny_unknown_fields"
    );
}

#[test]
fn test_load_config_wrong_type_returns_error() {
    // fuse_days should be an integer, not a string
    let dir = write_config(r#"fuse_days = "fourteen""#);
    let result = load_config(dir.path(), &no_overrides());
    assert!(result.is_err(), "wrong type for fuse_days should error");
}

// ─── CLI overrides ────────────────────────────────────────────────────────────

#[test]
fn test_cli_override_fuse_overrides_file() {
    let dir = write_config("fuse_days = 7\n");
    let overrides = CliOverrides::new(Some("30d".to_string()), false);
    let cfg = load_config(dir.path(), &overrides).unwrap();
    assert_eq!(cfg.fuse_days, 30, "CLI --fuse should override config file");
}

#[test]
fn test_cli_override_fuse_overrides_default() {
    let dir = tempfile::tempdir().unwrap();
    let overrides = CliOverrides::new(Some("14d".to_string()), false);
    let cfg = load_config(dir.path(), &overrides).unwrap();
    assert_eq!(cfg.fuse_days, 14);
}

#[test]
fn test_cli_override_fail_on_ticking_sets_flag() {
    let dir = tempfile::tempdir().unwrap();
    let overrides = CliOverrides::new(None, true);
    let cfg = load_config(dir.path(), &overrides).unwrap();
    assert!(cfg.fail_on_ticking);
}

#[test]
fn test_cli_override_fail_on_ticking_false_by_default() {
    let dir = tempfile::tempdir().unwrap();
    let cfg = load_config(dir.path(), &no_overrides()).unwrap();
    assert!(!cfg.fail_on_ticking);
}

#[test]
fn test_cli_override_invalid_duration_returns_error() {
    let dir = tempfile::tempdir().unwrap();
    let overrides = CliOverrides::new(Some("notvalid".to_string()), false);
    let result = load_config(dir.path(), &overrides);
    assert!(
        result.is_err(),
        "invalid duration string should return error"
    );
}

#[test]
fn test_cli_override_duration_without_d_suffix_returns_error() {
    let dir = tempfile::tempdir().unwrap();
    let overrides = CliOverrides::new(Some("30".to_string()), false);
    let result = load_config(dir.path(), &overrides);
    assert!(
        result.is_err(),
        "duration without 'd' suffix should return error"
    );
}

#[test]
fn test_cli_override_zero_days_is_valid() {
    let dir = tempfile::tempdir().unwrap();
    let overrides = CliOverrides::new(Some("0d".to_string()), false);
    let cfg = load_config(dir.path(), &overrides).unwrap();
    assert_eq!(cfg.fuse_days, 0);
}

#[test]
fn test_cli_override_large_days_is_valid() {
    let dir = tempfile::tempdir().unwrap();
    let overrides = CliOverrides::new(Some("365d".to_string()), false);
    let cfg = load_config(dir.path(), &overrides).unwrap();
    assert_eq!(cfg.fuse_days, 365);
}

// ─── GlobSet / extension helpers ─────────────────────────────────────────────

#[test]
fn test_build_exclude_globset_succeeds_with_defaults() {
    let cfg = Config::default();
    let result = cfg.build_exclude_globset();
    assert!(
        result.is_ok(),
        "building default exclude globset should succeed"
    );
}

#[test]
fn test_build_exclude_globset_invalid_pattern_returns_error() {
    let cfg = Config {
        exclude_patterns: vec!["[invalid".to_string()],
        ..Config::default()
    };
    let result = cfg.build_exclude_globset();
    assert!(result.is_err(), "invalid glob pattern should return error");
}

#[test]
fn test_is_excluded_git_dir() {
    let cfg = Config::default();
    let gs = cfg.build_exclude_globset().unwrap();
    assert!(cfg.is_excluded(Path::new(".git/config"), &gs));
    assert!(cfg.is_excluded(Path::new(".git/objects/abc123"), &gs));
}

#[test]
fn test_is_excluded_node_modules() {
    let cfg = Config::default();
    let gs = cfg.build_exclude_globset().unwrap();
    assert!(cfg.is_excluded(Path::new("node_modules/react/index.js"), &gs));
}

#[test]
fn test_is_excluded_vendor() {
    let cfg = Config::default();
    let gs = cfg.build_exclude_globset().unwrap();
    assert!(cfg.is_excluded(Path::new("vendor/github.com/some/pkg/file.go"), &gs));
}

#[test]
fn test_is_excluded_min_js() {
    let cfg = Config::default();
    let gs = cfg.build_exclude_globset().unwrap();
    assert!(cfg.is_excluded(Path::new("bundle.min.js"), &gs));
}

#[test]
fn test_is_not_excluded_src_file() {
    let cfg = Config::default();
    let gs = cfg.build_exclude_globset().unwrap();
    assert!(!cfg.is_excluded(Path::new("src/main.rs"), &gs));
    assert!(!cfg.is_excluded(Path::new("src/lib/util.go"), &gs));
}

#[test]
fn test_is_not_excluded_root_file() {
    let cfg = Config::default();
    let gs = cfg.build_exclude_globset().unwrap();
    assert!(!cfg.is_excluded(Path::new("main.rs"), &gs));
    assert!(!cfg.is_excluded(Path::new("README.md"), &gs));
}

#[test]
fn test_extension_allowed_rs() {
    let cfg = Config::default();
    assert!(cfg.extension_allowed(Path::new("src/main.rs")));
}

#[test]
fn test_extension_allowed_go() {
    let cfg = Config::default();
    assert!(cfg.extension_allowed(Path::new("pkg/server.go")));
}

#[test]
fn test_extension_allowed_py() {
    let cfg = Config::default();
    assert!(cfg.extension_allowed(Path::new("scripts/deploy.py")));
}

#[test]
fn test_extension_allowed_sql() {
    let cfg = Config::default();
    assert!(cfg.extension_allowed(Path::new("db/schema.sql")));
}

#[test]
fn test_extension_allowed_yaml() {
    let cfg = Config::default();
    assert!(cfg.extension_allowed(Path::new(".github/workflows/ci.yml")));
    assert!(cfg.extension_allowed(Path::new("config/app.yaml")));
}

#[test]
fn test_extension_not_allowed_xyz() {
    let cfg = Config::default();
    assert!(!cfg.extension_allowed(Path::new("data.xyz")));
}

#[test]
fn test_extension_not_allowed_no_extension() {
    let cfg = Config::default();
    assert!(!cfg.extension_allowed(Path::new("Makefile")));
    assert!(!cfg.extension_allowed(Path::new("Dockerfile")));
}

#[test]
fn test_extension_allowed_case_insensitive() {
    let cfg = Config::default();
    // .RS should match "rs" in the list
    assert!(cfg.extension_allowed(Path::new("MAIN.RS")));
}

#[test]
fn test_extension_allowed_empty_list_allows_all() {
    let cfg = Config {
        extensions: vec![],
        ..Config::default()
    };
    assert!(cfg.extension_allowed(Path::new("anything.xyz")));
    assert!(cfg.extension_allowed(Path::new("Makefile")));
    assert!(cfg.extension_allowed(Path::new("binary.exe")));
}

// ─── fuse_regex_pattern ────────────────────────────────────────────────────────

#[test]
fn test_fuse_regex_pattern_contains_all_default_triggers() {
    let cfg = Config::default();
    let pattern = cfg.fuse_regex_pattern();
    for tag in &["TODO", "FIXME", "HACK", "TEMP", "REMOVEME"] {
        assert!(
            pattern.contains(tag),
            "pattern should contain trigger '{}'",
            tag
        );
    }
}

#[test]
fn test_fuse_regex_pattern_custom_triggers() {
    let cfg = Config {
        triggers: vec!["MYTAGONE".to_string(), "MYTAGTWO".to_string()],
        ..Config::default()
    };
    let pattern = cfg.fuse_regex_pattern();
    assert!(pattern.contains("MYTAGONE"));
    assert!(pattern.contains("MYTAGTWO"));
    assert!(
        !pattern.contains("TODO"),
        "TODO should not be in custom-only pattern"
    );
}

#[test]
fn test_fuse_regex_pattern_is_valid_regex() {
    let cfg = Config::default();
    let pattern = cfg.fuse_regex_pattern();
    let result = regex::Regex::new(&pattern);
    assert!(
        result.is_ok(),
        "fuse_regex_pattern must produce a valid regex: {:?}",
        result.err()
    );
}

#[test]
fn test_fuse_regex_pattern_matches_basic_annotation() {
    let cfg = Config::default();
    let pattern = cfg.fuse_regex_pattern();
    let re = regex::Regex::new(&pattern).unwrap();
    assert!(re.is_match("// TODO[2020-01-01]: some message"));
    assert!(re.is_match("# FIXME[2099-12-31]: future task"));
    assert!(re.is_match("-- HACK[2018-06-01]: sql comment"));
}

#[test]
fn test_fuse_regex_pattern_does_not_match_plain_todo() {
    let cfg = Config::default();
    let pattern = cfg.fuse_regex_pattern();
    let re = regex::Regex::new(&pattern).unwrap();
    assert!(!re.is_match("// TODO: no date"));
    assert!(!re.is_match("// FIXME: no date bracket"));
    assert!(!re.is_match("// TODO [2020-01-01]: space before bracket"));
}

#[test]
fn test_fuse_regex_pattern_matches_with_owner() {
    let cfg = Config::default();
    let pattern = cfg.fuse_regex_pattern();
    let re = regex::Regex::new(&pattern).unwrap();
    assert!(re.is_match("// TODO[2020-01-01][alice]: owned annotation"));
    assert!(re.is_match("# FIXME[2099-01-01][bob]: another owned"));
}

// ─── CliOverrides construction ────────────────────────────────────────────────

#[test]
fn test_cli_overrides_default() {
    let overrides = CliOverrides::default();
    assert!(overrides.fuse.is_none());
    assert!(!overrides.fail_on_ticking);
}

#[test]
fn test_cli_overrides_new_with_values() {
    let overrides = CliOverrides::new(Some("30d".to_string()), true);
    assert_eq!(overrides.fuse, Some("30d".to_string()));
    assert!(overrides.fail_on_ticking);
}

#[test]
fn test_cli_overrides_new_without_fuse() {
    let overrides = CliOverrides::new(None, false);
    assert!(overrides.fuse.is_none());
    assert!(!overrides.fail_on_ticking);
}

// ─── Config interaction with scanner ─────────────────────────────────────────

#[test]
fn test_config_from_file_integrates_with_scanner() {
    use std::io::Write as _;
    use timebomb::scanner::scan;

    // Write a config that only scans .rs files and has a 14-day fuse window
    let dir = tempfile::tempdir().unwrap();
    let config_path = dir.path().join(".timebomb.toml");
    {
        let mut f = std::fs::File::create(&config_path).unwrap();
        writeln!(f, r#"extensions = ["rs"]"#).unwrap();
        writeln!(f, "fuse_days = 14").unwrap();
    }

    // Create a .rs file with fuses
    let src_path = dir.path().join("main.rs");
    {
        let mut f = std::fs::File::create(&src_path).unwrap();
        writeln!(f, "// TODO[2020-01-01]: expired").unwrap();
        writeln!(f, "// FIXME[2099-01-01]: future").unwrap();
    }

    // Create a .py file with fuses — should be ignored per config
    let py_path = dir.path().join("script.py");
    {
        let mut f = std::fs::File::create(&py_path).unwrap();
        writeln!(f, "# TODO[2020-01-01]: python should be ignored").unwrap();
    }

    let cfg = load_config(dir.path(), &no_overrides()).unwrap();
    let today = chrono::NaiveDate::parse_from_str("2025-06-01", "%Y-%m-%d").unwrap();
    let result = scan(dir.path(), &cfg, today).unwrap();

    // Only main.rs should be scanned
    assert_eq!(
        result.swept_files, 1,
        "only .rs file should be scanned per config extensions"
    );
    assert_eq!(result.fuses.len(), 2);
    assert!(result.has_detonated());
}

#[test]
fn test_config_exclude_pattern_integrates_with_scanner() {
    use std::io::Write as _;
    use timebomb::scanner::scan;

    let dir = tempfile::tempdir().unwrap();
    let config_path = dir.path().join(".timebomb.toml");
    {
        let mut f = std::fs::File::create(&config_path).unwrap();
        // Exclude everything under "generated/"
        writeln!(f, r#"exclude = ["generated/**"]"#).unwrap();
    }

    // File that should be scanned
    let src_path = dir.path().join("main.rs");
    {
        let mut f = std::fs::File::create(&src_path).unwrap();
        writeln!(f, "// TODO[2020-01-01]: should be found").unwrap();
    }

    // File in excluded directory
    std::fs::create_dir(dir.path().join("generated")).unwrap();
    let gen_path = dir.path().join("generated").join("auto.rs");
    {
        let mut f = std::fs::File::create(&gen_path).unwrap();
        writeln!(f, "// TODO[2020-01-01]: should be excluded").unwrap();
    }

    let cfg = load_config(dir.path(), &no_overrides()).unwrap();
    let today = chrono::NaiveDate::parse_from_str("2025-06-01", "%Y-%m-%d").unwrap();
    let result = scan(dir.path(), &cfg, today).unwrap();

    assert_eq!(
        result.swept_files, 1,
        "generated/ directory should be excluded"
    );
    // The one fuse found should be from main.rs
    assert_eq!(result.fuses.len(), 1);
    assert_eq!(result.fuses[0].file, std::path::Path::new("main.rs"));
}