context-footprint 0.1.0

A static analysis tool for measuring architectural context exposure in codebases.
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

use super::TestDetector;

/// Python test code detector
///
/// Conventions:
/// - test_*.py files
/// - *_test.py files
/// - tests/ directories
/// - test_* functions
/// - Test* classes
pub struct PythonTestDetector;

impl TestDetector for PythonTestDetector {
    fn is_test_code(&self, symbol: &str, file_path: &str) -> bool {
        // Check file path patterns
        if file_path.contains("/tests/")
            || file_path.contains("/test/")
            || file_path.starts_with("tests/")
            || file_path.starts_with("test/")
        {
            return true;
        }

        // Check file name patterns
        if file_path
            .split('/')
            .next_back()
            .is_some_and(|filename| filename.starts_with("test_") || filename.ends_with("_test.py"))
        {
            return true;
        }

        // Check symbol patterns
        // Python test functions: test_*
        if symbol.contains("/test_") || symbol.contains("#test_") {
            return true;
        }

        // Python test classes: Test*
        if symbol.contains("/Test") {
            // More precise: check if it's a class definition
            if symbol.contains("#") {
                // This is a method, check if class name starts with Test
                if symbol.split('#').next().is_some_and(|class_part| {
                    class_part
                        .split('/')
                        .next_back()
                        .is_some_and(|class_name| class_name.starts_with("Test"))
                }) {
                    return true;
                }
            } else if symbol
                .split('/')
                .next_back()
                .is_some_and(|s| s.starts_with("Test"))
            {
                return true;
            }
        }

        false
    }

    fn language(&self) -> &str {
        "python"
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_detects_test_directory() {
        let detector = PythonTestDetector;
        assert!(detector.is_test_code("", "tests/test_api.py"));
        assert!(detector.is_test_code("", "myproject/tests/test_utils.py"));
        assert!(!detector.is_test_code("", "src/utils.py"));
    }

    #[test]
    fn test_detects_test_file_prefix() {
        let detector = PythonTestDetector;
        assert!(detector.is_test_code("", "test_api.py"));
        assert!(detector.is_test_code("", "src/test_utils.py"));
        assert!(!detector.is_test_code("", "src/api.py"));
    }

    #[test]
    fn test_detects_test_file_suffix() {
        let detector = PythonTestDetector;
        assert!(detector.is_test_code("", "api_test.py"));
        assert!(detector.is_test_code("", "src/utils_test.py"));
        assert!(!detector.is_test_code("", "src/api.py"));
    }

    #[test]
    fn test_detects_test_function() {
        let detector = PythonTestDetector;
        assert!(detector.is_test_code(
            "scip-python python myapp ... `module`/test_my_function().",
            "src/module.py"
        ));
        assert!(!detector.is_test_code(
            "scip-python python myapp ... `module`/my_function().",
            "src/module.py"
        ));
    }

    #[test]
    fn test_detects_test_class() {
        let detector = PythonTestDetector;
        assert!(detector.is_test_code(
            "scip-python python myapp ... `module`/TestMyClass#",
            "src/module.py"
        ));
        assert!(detector.is_test_code(
            "scip-python python myapp ... `module`/TestMyClass#test_method().",
            "src/module.py"
        ));
        assert!(!detector.is_test_code(
            "scip-python python myapp ... `module`/MyClass#",
            "src/module.py"
        ));
    }
}