debtmap 0.16.4

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
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

use debtmap::testing::analyze_testing_patterns;
use std::path::PathBuf;

#[test]
fn test_detects_test_without_assertions() {
    let source = r#"
        #[test]
        fn test_without_assertions() {
            let user = User::new("test");
            let result = user.validate();
            // Missing assertion!
        }
        
        #[test]
        fn test_with_assertions() {
            let user = User::new("test");
            let result = user.validate();
            assert!(result.is_ok());
        }
    "#;

    let file = syn::parse_str::<syn::File>(source).unwrap();
    let path = PathBuf::from("test.rs");
    let patterns = analyze_testing_patterns(&file, &path);

    // Debug: print all patterns
    for pattern in &patterns {
        eprintln!("Pattern: {}", pattern.message);
    }

    // Should only detect test_without_assertions
    let no_assertion_patterns: Vec<_> = patterns
        .iter()
        .filter(|p| p.message.contains("no assertions"))
        .collect();
    assert_eq!(
        no_assertion_patterns.len(),
        1,
        "Expected 1 no-assertion pattern, found {}",
        no_assertion_patterns.len()
    );
    assert!(matches!(
        &no_assertion_patterns[0].debt_type,
        debtmap::core::DebtType::TestQuality { .. }
    ));
}

#[test]
fn test_detects_overly_complex_test() {
    let source = r#"
        #[test]
        fn overly_complex_test() {
            let mut mock1 = MockService::new();
            let mut mock2 = MockDatabase::new();
            let mut mock3 = MockCache::new();
            let mut mock4 = MockApi::new();
            let mut mock5 = MockLogger::new();
            let mut mock6 = MockNotifier::new();
            
            mock1.expect_call().times(1).returning(|| Ok(()));
            mock2.expect_query().with(eq("test")).returning(|| Ok(vec![]));
            mock3.expect_get().returning(|| None);
            mock4.expect_fetch().returning(|| Ok(Response::new()));
            mock5.expect_log().returning(|| ());
            mock6.expect_notify().returning(|| Ok(()));
            
            for i in 0..10 {
                if i % 2 == 0 {
                    let result = service.process(i);
                    if let Some(data) = result {
                        assert_eq!(data.len(), i);
                    } else {
                        panic!("Unexpected None");
                    }
                }
            }
        }
    "#;

    let file = syn::parse_str::<syn::File>(source).unwrap();
    let path = PathBuf::from("test.rs");
    let patterns = analyze_testing_patterns(&file, &path);

    let complex_pattern = patterns
        .iter()
        .find(|p| matches!(p.debt_type, debtmap::core::DebtType::TestComplexity { .. }));

    assert!(complex_pattern.is_some());
    assert!(complex_pattern.unwrap().message.contains("overly complex"));
}

#[test]
fn test_detects_flaky_timing_test() {
    let source = r#"
        #[test]
        fn flaky_timing_test() {
            let start = std::time::Instant::now();
            std::thread::sleep(std::time::Duration::from_millis(100));
            let duration = start.elapsed();
            assert!(duration >= std::time::Duration::from_millis(90));
        }
    "#;

    let file = syn::parse_str::<syn::File>(source).unwrap();
    let path = PathBuf::from("test.rs");
    let patterns = analyze_testing_patterns(&file, &path);

    let timing_pattern = patterns
        .iter()
        .find(|p| p.message.contains("flaky pattern"));

    assert!(timing_pattern.is_some());
    assert!(timing_pattern.unwrap().message.contains("TimingDependency"));
}

#[test]
fn test_detects_random_value_usage() {
    let source = r#"
        #[test]
        fn test_with_random() {
            use rand::Rng;
            let mut rng = rand::thread_rng();
            let random_value = rng.gen_range(0..100);
            let result = calculate_something(random_value);
            assert!(result > 0);
        }
    "#;

    let file = syn::parse_str::<syn::File>(source).unwrap();
    let path = PathBuf::from("test.rs");
    let patterns = analyze_testing_patterns(&file, &path);

    let random_pattern = patterns.iter().find(|p| p.message.contains("RandomValues"));

    assert!(random_pattern.is_some());
}

#[test]
fn test_detects_external_service_call() {
    let source = r#"
        #[test]
        fn test_with_external_api() {
            let client = reqwest::Client::new();
            let response = client.get("https://api.example.com/data")
                .send()
                .unwrap();
            assert_eq!(response.status(), 200);
        }
    "#;

    let file = syn::parse_str::<syn::File>(source).unwrap();
    let path = PathBuf::from("test.rs");
    let patterns = analyze_testing_patterns(&file, &path);

    let external_pattern = patterns
        .iter()
        .find(|p| p.message.contains("ExternalDependency"));

    assert!(external_pattern.is_some());
}

#[test]
fn test_detects_filesystem_dependency() {
    let source = r#"
        #[test]
        fn test_with_filesystem() {
            let content = std::fs::read_to_string("test.txt").unwrap();
            assert!(!content.is_empty());
        }
    "#;

    let file = syn::parse_str::<syn::File>(source).unwrap();
    let path = PathBuf::from("test.rs");
    let patterns = analyze_testing_patterns(&file, &path);

    let fs_pattern = patterns
        .iter()
        .find(|p| p.message.contains("FilesystemDependency"));

    assert!(fs_pattern.is_some());
}

#[test]
fn test_detects_test_functions_by_attribute() {
    let source = r#"
        #[test]
        fn proper_test_function() {
            assert!(true);
        }
        
        #[tokio::test]
        async fn async_test_function() {
            assert!(true);
        }
        
        fn not_a_test_function() {
            // This should not be analyzed
        }
    "#;

    let file = syn::parse_str::<syn::File>(source).unwrap();
    let path = PathBuf::from("test.rs");
    let patterns = analyze_testing_patterns(&file, &path);

    // Both tests have assertions so should not report issues
    let no_assertion_patterns: Vec<_> = patterns
        .iter()
        .filter(|p| p.message.contains("no assertions"))
        .collect();
    assert_eq!(no_assertion_patterns.len(), 0);
}

#[test]
fn test_detects_test_functions_by_name() {
    let source = r#"
        fn test_something() {
            let x = 5;
            // Missing assertion
        }
        
        fn something_test() {
            let y = 10;
            // Missing assertion
        }
    "#;

    let file = syn::parse_str::<syn::File>(source).unwrap();
    let path = PathBuf::from("test.rs");
    let patterns = analyze_testing_patterns(&file, &path);

    assert_eq!(patterns.len(), 2);
    assert!(patterns.iter().all(|p| p.message.contains("no assertions")));
}

#[test]
fn test_expect_and_unwrap_count_as_assertions() {
    let source = r#"
        #[test]
        fn test_with_expect() {
            let result = some_function();
            result.expect("Should succeed");
        }
        
        #[test]
        fn test_with_unwrap() {
            let result = some_function();
            result.unwrap();
        }
    "#;

    let file = syn::parse_str::<syn::File>(source).unwrap();
    let path = PathBuf::from("test.rs");
    let patterns = analyze_testing_patterns(&file, &path);

    // expect and unwrap should count as assertions
    assert_eq!(patterns.len(), 0);
}

#[test]
fn test_detects_multiple_anti_patterns_in_single_test() {
    let source = r#"
        #[test]
        fn problematic_test() {
            // Complex setup with many mocks
            let mut mock1 = Mock::new();
            let mut mock2 = Mock::new();
            let mut mock3 = Mock::new();
            let mut mock4 = Mock::new();
            let mut mock5 = Mock::new();
            let mut mock6 = Mock::new();
            
            // Flaky timing dependency
            std::thread::sleep(std::time::Duration::from_millis(100));
            
            // Random value
            let random = rand::random::<u32>();
            
            // External service
            let client = reqwest::Client::new();
            
            // No assertions at all
        }
    "#;

    let file = syn::parse_str::<syn::File>(source).unwrap();
    let path = PathBuf::from("test.rs");
    let patterns = analyze_testing_patterns(&file, &path);

    // Should detect multiple issues
    assert!(patterns.len() >= 3);

    // Should have no assertions issue
    assert!(patterns.iter().any(|p| p.message.contains("no assertions")));

    // Should have flakiness issues
    assert!(patterns.iter().any(|p| p.message.contains("flaky pattern")));
}