debtmap 0.16.5

Code complexity and technical debt analyzer
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

use debtmap::*;
use std::path::PathBuf;

#[test]
fn test_suppression_block_comments() {
    let content = r#"
// debtmap:ignore-start
// TODO: This should be suppressed
// FIXME: This too
// debtmap:ignore-end
// TODO: This should not be suppressed
"#;

    let path = PathBuf::from("test.rs");
    let items = find_todos_and_fixmes_with_suppression(
        content,
        &path,
        Some(&parse_suppression_comments(content, Language::Rust, &path)),
    );

    assert_eq!(items.len(), 1, "Should only find one non-suppressed TODO");
    assert!(items[0].message.contains("This should not be suppressed"));
}

#[test]
fn test_suppression_line_comments() {
    // debtmap:ignore-start -- Test fixture data
    let content = r#"
// TODO: Not suppressed
// TODO: Suppressed // debtmap:ignore
// FIXME: Also not suppressed
"#;
    // debtmap:ignore-end

    let path = PathBuf::from("test.rs");
    let items = find_todos_and_fixmes_with_suppression(
        content,
        &path,
        Some(&parse_suppression_comments(content, Language::Rust, &path)),
    );

    assert_eq!(items.len(), 2, "Should find two non-suppressed items");
    assert!(!items.iter().any(|i| i.message.contains("Suppressed")));
}

#[test]
fn test_suppression_next_line() {
    let content = r#"
// debtmap:ignore-next-line
// TODO: This should be suppressed
// TODO: This should not be suppressed
"#;

    let path = PathBuf::from("test.rs");
    let items = find_todos_and_fixmes_with_suppression(
        content,
        &path,
        Some(&parse_suppression_comments(content, Language::Rust, &path)),
    );

    assert_eq!(items.len(), 1, "Should only find one non-suppressed TODO");
    assert!(items[0].message.contains("This should not be suppressed"));
}

#[test]
fn test_type_specific_suppression() {
    // debtmap:ignore-start -- Test fixture data
    let content = r#"
// debtmap:ignore-start[todo]
// TODO: Suppressed
// FIXME: Not suppressed  
// debtmap:ignore-end
"#;
    // debtmap:ignore-end

    let path = PathBuf::from("test.rs");
    let items = find_todos_and_fixmes_with_suppression(
        content,
        &path,
        Some(&parse_suppression_comments(content, Language::Rust, &path)),
    );

    assert_eq!(items.len(), 1, "Should only find FIXME");
    assert!(matches!(items[0].debt_type, DebtType::Fixme { .. }));
}

#[test]
fn test_suppression_with_reason() {
    let content = r#"
// debtmap:ignore-start -- Test fixture data
// TODO: Test TODO
// FIXME: Test FIXME
// debtmap:ignore-end
"#;

    let path = PathBuf::from("test.rs");
    let suppression = parse_suppression_comments(content, Language::Rust, &path);
    let items = find_todos_and_fixmes_with_suppression(content, &path, Some(&suppression));

    assert_eq!(items.len(), 0, "All items should be suppressed");
    assert_eq!(
        suppression.active_blocks[0].reason,
        Some("Test fixture data".to_string())
    );
}

#[test]
fn test_python_suppression() {
    // debtmap:ignore-start -- Test fixture data
    let content = r#"
# debtmap:ignore-start
# TODO: Python TODO
# FIXME: Python FIXME
# debtmap:ignore-end
# TODO: Not suppressed
"#;
    // debtmap:ignore-end

    let path = PathBuf::from("test.py");
    let items = find_todos_and_fixmes_with_suppression(
        content,
        &path,
        Some(&parse_suppression_comments(
            content,
            Language::Python,
            &path,
        )),
    );

    assert_eq!(items.len(), 1, "Should only find one non-suppressed TODO");
    assert!(items[0].message.contains("Not suppressed"));
}

#[test]
fn test_wildcard_suppression() {
    // debtmap:ignore-start -- Test fixture data
    let content = r#"
// debtmap:ignore[*]
// TODO: Suppressed
// FIXME: Also suppressed
"#;
    // debtmap:ignore-end

    let path = PathBuf::from("test.rs");
    let suppression = parse_suppression_comments(content, Language::Rust, &path);

    assert!(suppression.is_suppressed(2, &DebtType::Todo { reason: None }));
    assert!(suppression.is_suppressed(2, &DebtType::Fixme { reason: None }));
    assert!(suppression.is_suppressed(2, &DebtType::CodeSmell { smell_type: None }));
}