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

use super::TestDetector;

/// Java test code detector
///
/// Conventions:
/// - *Test.java files
/// - src/test/ directories
/// - test/ directories
pub struct JavaTestDetector;

impl TestDetector for JavaTestDetector {
    fn is_test_code(&self, _symbol: &str, file_path: &str) -> bool {
        // Check test directories
        if file_path.contains("/src/test/")
            || file_path.contains("/test/")
            || file_path.starts_with("test/")
        {
            return true;
        }

        // Check test file suffix
        if file_path.split('/').next_back().is_some_and(|filename| {
            filename.ends_with("Test.java") || filename.ends_with("Tests.java")
        }) {
            return true;
        }

        false
    }

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

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

    #[test]
    fn test_detects_java_test_directories() {
        let detector = JavaTestDetector;
        assert!(detector.is_test_code("", "src/test/java/com/ExampleTest.java"));
        assert!(detector.is_test_code("", "project/test/MyTest.java"));
        assert!(detector.is_test_code("", "test/MyTest.java"));
        assert!(!detector.is_test_code("", "src/main/java/com/Example.java"));
    }

    #[test]
    fn test_detects_java_test_file_suffix() {
        let detector = JavaTestDetector;
        assert!(detector.is_test_code("", "com/example/ServiceTest.java"));
        assert!(detector.is_test_code("", "com/example/ServiceTests.java"));
        assert!(!detector.is_test_code("", "com/example/Service.java"));
    }

    #[test]
    fn test_language_returns_java() {
        let detector = JavaTestDetector;
        assert_eq!(detector.language(), "java");
    }
}