tldr-core 0.1.6

Core analysis engine for TLDR code analysis tool
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
//! Integration tests for Quality and Security modules (Phase 8)

use std::path::PathBuf;

use tldr_core::quality::maintainability::maintainability_index;
use tldr_core::quality::smells::{detect_smells, SmellType, ThresholdPreset};
use tldr_core::security::secrets::{scan_secrets, Severity};
use tldr_core::security::vuln::{scan_vulnerabilities, VulnType};

fn fixtures_dir() -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .parent()
        .unwrap()
        .parent()
        .unwrap()
        .join("tests/fixtures")
}

// =============================================================================
// smells tests
// =============================================================================

mod smells_tests {
    use super::*;

    #[test]
    fn smells_detects_god_class() {
        let project = fixtures_dir().join("quality/god_class.py");
        if !project.exists() {
            eprintln!("Skipping test - fixture not found: {:?}", project);
            return;
        }

        let result = detect_smells(
            &project,
            ThresholdPreset::Default,
            Some(SmellType::GodClass),
            false,
        );
        assert!(result.is_ok(), "Should succeed: {:?}", result);

        let report = result.unwrap();
        assert!(
            report
                .smells
                .iter()
                .any(|s| matches!(s.smell_type, SmellType::GodClass)),
            "Should detect god class smell"
        );
    }

    #[test]
    fn smells_detects_long_parameter_list() {
        let project = fixtures_dir().join("quality/long_params.py");
        if !project.exists() {
            eprintln!("Skipping test - fixture not found: {:?}", project);
            return;
        }

        let result = detect_smells(
            &project,
            ThresholdPreset::Default,
            Some(SmellType::LongParameterList),
            false,
        );
        assert!(result.is_ok(), "Should succeed: {:?}", result);

        let report = result.unwrap();
        assert!(
            report
                .smells
                .iter()
                .any(|s| matches!(s.smell_type, SmellType::LongParameterList)),
            "Should detect long parameter list smell"
        );
    }

    #[test]
    fn smells_provides_suggestions_when_requested() {
        let project = fixtures_dir().join("quality/god_class.py");
        if !project.exists() {
            return;
        }

        let result = detect_smells(&project, ThresholdPreset::Default, None, true);
        assert!(result.is_ok());

        let report = result.unwrap();
        for smell in &report.smells {
            assert!(
                smell.suggestion.is_some(),
                "Should have suggestion when suggest=true"
            );
        }
    }

    #[test]
    fn smells_strict_finds_more_than_relaxed() {
        let project = fixtures_dir().join("quality");
        if !project.exists() {
            return;
        }

        let strict = detect_smells(&project, ThresholdPreset::Strict, None, false);
        let relaxed = detect_smells(&project, ThresholdPreset::Relaxed, None, false);

        if let (Ok(strict), Ok(relaxed)) = (strict, relaxed) {
            assert!(
                strict.smells.len() >= relaxed.smells.len(),
                "Strict should find at least as many smells as relaxed"
            );
        }
    }
}

// =============================================================================
// maintainability tests
// =============================================================================

mod maintainability_tests {
    use super::*;

    #[test]
    fn maintainability_calculates_mi_score() {
        let project = fixtures_dir().join("quality/grade_a.py");
        if !project.exists() {
            eprintln!("Skipping test - fixture not found: {:?}", project);
            return;
        }

        let result = maintainability_index(&project, false, None);
        assert!(result.is_ok(), "Should succeed: {:?}", result);

        let report = result.unwrap();
        assert!(!report.files.is_empty(), "Should have analyzed files");

        let file_mi = &report.files[0];
        assert!(
            file_mi.mi >= 0.0 && file_mi.mi <= 100.0,
            "MI should be 0-100"
        );
    }

    #[test]
    fn maintainability_assigns_correct_grade() {
        let project = fixtures_dir().join("quality/grade_a.py");
        if !project.exists() {
            return;
        }

        let result = maintainability_index(&project, false, None);
        assert!(result.is_ok());

        let report = result.unwrap();
        // Simple file should get a good grade (A or B)
        let grade = report.files[0].grade;
        assert!(
            grade == 'A' || grade == 'B',
            "Simple file should get grade A or B, got {}",
            grade
        );
    }

    #[test]
    fn maintainability_includes_halstead_when_requested() {
        let project = fixtures_dir().join("quality/grade_a.py");
        if !project.exists() {
            return;
        }

        let result = maintainability_index(&project, true, None);
        assert!(result.is_ok());

        let report = result.unwrap();
        assert!(
            report.files[0].halstead.is_some(),
            "Should include Halstead metrics when requested"
        );

        let halstead = report.files[0].halstead.as_ref().unwrap();
        assert!(halstead.volume > 0.0, "Halstead volume should be positive");
    }

    #[test]
    fn maintainability_summarizes_directory() {
        let project = fixtures_dir().join("quality");
        if !project.exists() {
            return;
        }

        let result = maintainability_index(&project, false, None);
        assert!(result.is_ok());

        let report = result.unwrap();
        assert!(report.summary.files_analyzed > 0, "Should analyze files");
        assert!(report.summary.average_mi > 0.0, "Should have average MI");
    }
}

// =============================================================================
// secrets tests
// =============================================================================

mod secrets_tests {
    use super::*;

    #[test]
    fn secrets_detects_aws_access_key() {
        let project = fixtures_dir().join("security/aws_key.py");
        if !project.exists() {
            eprintln!("Skipping test - fixture not found: {:?}", project);
            return;
        }

        let result = scan_secrets(&project, 4.5, false, None);
        assert!(result.is_ok(), "Should succeed: {:?}", result);

        let report = result.unwrap();
        assert!(
            report.findings.iter().any(|f| f.pattern.contains("AWS")),
            "Should detect AWS key pattern"
        );
    }

    #[test]
    fn secrets_detects_private_key_header() {
        let project = fixtures_dir().join("security/private_key.py");
        if !project.exists() {
            return;
        }

        let result = scan_secrets(&project, 4.5, false, None);
        assert!(result.is_ok());

        let report = result.unwrap();
        assert!(
            report
                .findings
                .iter()
                .any(|f| f.pattern.contains("Private Key")),
            "Should detect private key pattern"
        );
    }

    #[test]
    fn secrets_masks_sensitive_values() {
        let project = fixtures_dir().join("security/aws_key.py");
        if !project.exists() {
            return;
        }

        let result = scan_secrets(&project, 4.5, false, None);
        assert!(result.is_ok());

        let report = result.unwrap();
        for finding in &report.findings {
            // Masked value should contain asterisks or be short
            assert!(
                finding.masked_value.contains('*') || finding.masked_value.len() < 20,
                "Value should be masked: {}",
                finding.masked_value
            );
        }
    }

    #[test]
    fn secrets_assigns_severity_levels() {
        let project = fixtures_dir().join("security");
        if !project.exists() {
            return;
        }

        let result = scan_secrets(&project, 4.5, true, None);
        assert!(result.is_ok());

        let report = result.unwrap();
        // AWS keys should be Critical
        assert!(
            report
                .findings
                .iter()
                .any(|f| f.severity == Severity::Critical),
            "Should have critical severity findings"
        );
    }

    #[test]
    fn secrets_filters_by_severity() {
        let project = fixtures_dir().join("security");
        if !project.exists() {
            return;
        }

        let result = scan_secrets(&project, 4.5, true, Some(Severity::Critical));
        assert!(result.is_ok());

        let report = result.unwrap();
        assert!(
            report
                .findings
                .iter()
                .all(|f| f.severity >= Severity::Critical),
            "Should only have critical or higher findings"
        );
    }

    #[test]
    fn secrets_reports_file_and_line() {
        let project = fixtures_dir().join("security/aws_key.py");
        if !project.exists() {
            return;
        }

        let result = scan_secrets(&project, 4.5, false, None);
        assert!(result.is_ok());

        let report = result.unwrap();
        for finding in &report.findings {
            assert!(!finding.file.as_os_str().is_empty(), "Should have file");
            assert!(finding.line > 0, "Should have line number");
        }
    }
}

// =============================================================================
// vuln tests
// =============================================================================

mod vuln_tests {
    use super::*;

    #[test]
    fn vuln_detects_sql_injection() {
        let project = fixtures_dir().join("security/sql_injection.py");
        if !project.exists() {
            eprintln!("Skipping test - fixture not found: {:?}", project);
            return;
        }

        let result = scan_vulnerabilities(&project, None, Some(VulnType::SqlInjection));
        assert!(result.is_ok(), "Should succeed: {:?}", result);

        let report = result.unwrap();
        // Should detect the SQL injection from request.args -> cursor.execute
        assert!(
            report
                .findings
                .iter()
                .any(|f| matches!(f.vuln_type, VulnType::SqlInjection)),
            "Should detect SQL injection vulnerability"
        );
    }

    #[test]
    fn vuln_detects_command_injection() {
        let project = fixtures_dir().join("security/command_injection.py");
        if !project.exists() {
            return;
        }

        let result = scan_vulnerabilities(&project, None, Some(VulnType::CommandInjection));
        assert!(result.is_ok());

        let report = result.unwrap();
        assert!(
            report
                .findings
                .iter()
                .any(|f| matches!(f.vuln_type, VulnType::CommandInjection)),
            "Should detect command injection vulnerability"
        );
    }

    #[test]
    fn vuln_identifies_sources_and_sinks() {
        let project = fixtures_dir().join("security/sql_injection.py");
        if !project.exists() {
            return;
        }

        let result = scan_vulnerabilities(&project, None, None);
        assert!(result.is_ok());

        let report = result.unwrap();
        for finding in &report.findings {
            assert!(
                !finding.source.variable.is_empty(),
                "Should have source variable"
            );
            assert!(
                !finding.sink.function.is_empty(),
                "Should have sink function"
            );
        }
    }

    #[test]
    fn vuln_provides_remediation() {
        let project = fixtures_dir().join("security/sql_injection.py");
        if !project.exists() {
            return;
        }

        let result = scan_vulnerabilities(&project, None, None);
        assert!(result.is_ok());

        let report = result.unwrap();
        for finding in &report.findings {
            assert!(
                !finding.remediation.is_empty(),
                "Should have remediation advice"
            );
            assert!(finding.cwe_id.is_some(), "Should have CWE ID");
        }
    }

    #[test]
    fn vuln_scans_directory() {
        let project = fixtures_dir().join("security");
        if !project.exists() {
            return;
        }

        let result = scan_vulnerabilities(&project, None, None);
        assert!(result.is_ok());

        let report = result.unwrap();
        assert!(report.files_scanned > 0, "Should scan multiple files");
    }
}