debtmap 0.16.6

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

use debtmap::extraction::UnifiedFileExtractor;
use std::path::Path;

#[test]
fn test_python_extraction_basic() {
    let source = r#"
def add(a, b):
    return a + b

class Math:
    def multiply(self, a, b):
        return a * b
"#;
    let path = Path::new("test.py");
    let data = UnifiedFileExtractor::extract(path, source).expect("Failed to extract");

    assert_eq!(data.total_lines, 7);
    assert_eq!(data.functions.len(), 2);

    let add_func = data.functions.iter().find(|f| f.name == "add").unwrap();
    assert_eq!(add_func.parameter_names, vec!["a", "b"]);
    assert_eq!(add_func.cyclomatic, 1);

    let multiply_func = data
        .functions
        .iter()
        .find(|f| f.name == "multiply")
        .unwrap();
    assert_eq!(multiply_func.qualified_name, "Math.multiply");
    assert_eq!(multiply_func.parameter_names, vec!["self", "a", "b"]);
}

#[test]
fn test_python_complexity() {
    let source = r#"
def complex(x):
    if x > 0:
        if x > 10:
            return 1
        else:
            return 2
    elif x < 0:
        for i in range(10):
            print(i)
    return 0
"#;
    let path = Path::new("complex.py");
    let data = UnifiedFileExtractor::extract(path, source).expect("Failed to extract");

    let func = &data.functions[0];
    assert!(func.cyclomatic >= 5); // 1 (base) + if + if + elif + for = 5
    assert!(func.nesting >= 2);
}

#[test]
fn test_python_imports() {
    let source = r#"
import os
import sys as system
from collections import HashMap, deque
from math import *
"#;
    let path = Path::new("imports.py");
    let data = UnifiedFileExtractor::extract(path, source).expect("Failed to extract");

    let paths: Vec<_> = data.imports.iter().map(|i| &i.path).collect();
    assert!(paths.contains(&&"os".to_string()));
    assert!(paths.contains(&&"sys".to_string()));
    assert!(paths.contains(&&"collections.HashMap".to_string()));
    assert!(paths.contains(&&"collections.deque".to_string()));
    assert!(paths.contains(&&"math.*".to_string()));

    let sys_import = data.imports.iter().find(|i| i.path == "sys").unwrap();
    assert_eq!(sys_import.alias, Some("system".to_string()));
}

#[test]
fn test_python_io_detection() {
    let source = r#"
def io_func():
    print("hello")
    with open("test.txt", "r") as f:
        content = f.read()
    import socket
    s = socket.socket()
"#;
    let path = Path::new("io.py");
    let data = UnifiedFileExtractor::extract(path, source).expect("Failed to extract");

    let func = &data.functions[0];
    assert!(func
        .io_operations
        .iter()
        .any(|op| op.io_type == debtmap::extraction::IoType::Console));
    assert!(func
        .io_operations
        .iter()
        .any(|op| op.io_type == debtmap::extraction::IoType::File));
}

#[test]
fn test_python_test_lines() {
    let source = r#"
def regular_func():
    return 42

def test_func():
    assert regular_func() == 42
"#;
    let path = Path::new("test_lines.py");
    let data = UnifiedFileExtractor::extract(path, source).expect("Failed to extract");

    // test_func is 2 lines
    assert!(data.test_lines >= 2);
    assert!(data.production_lines() >= 2);
}

#[test]
fn test_python_extraction_handles_typed_default_parameters() {
    let source = r#"
def configure(
    host: str = "localhost",
    port: int = 5432,
    *args,
    **kwargs,
):
    return host, port, args, kwargs
"#;
    let path = Path::new("typed_default_params.py");
    let data = UnifiedFileExtractor::extract(path, source).expect("Failed to extract");

    let func = data
        .functions
        .iter()
        .find(|f| f.name == "configure")
        .expect("configure function should be extracted");

    assert_eq!(func.parameter_names, vec!["host", "port", "args", "kwargs"]);
}

#[test]
fn test_python_extraction_handles_decorated_methods() {
    let source = r#"
def authenticated(method):
    return method

class CharacterHandler:
    @authenticated
    def get(self, character_id):
        return character_id

    @authenticated
    async def post(self):
        return None
"#;
    let path = Path::new("decorated_methods.py");
    let data = UnifiedFileExtractor::extract(path, source).expect("Failed to extract");

    let get_func = data
        .functions
        .iter()
        .find(|f| f.qualified_name == "CharacterHandler.get")
        .expect("decorated get method should be extracted");
    let post_func = data
        .functions
        .iter()
        .find(|f| f.qualified_name == "CharacterHandler.post")
        .expect("decorated async post method should be extracted");

    assert_eq!(get_func.parameter_names, vec!["self", "character_id"]);
    assert!(post_func.is_async);
}