debtmap 0.21.1

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

use std::path::{Path, PathBuf};

use super::*;
use crate::analyzers::solidity::debt::natspec::{
    detect_natspec_debt, detect_natspec_debt_with_signatures,
};
use crate::analyzers::solidity::debt::security_patterns::{
    detect_contract_patterns, detect_contract_patterns_with_counts,
};
use crate::analyzers::solidity::debt::{detect_debt, detect_debt_with_extraction};
use crate::analyzers::solidity::extraction::extract_solidity;
use crate::analyzers::solidity::metrics::to_function_metrics;
use crate::analyzers::solidity::parser::parse_source;
use crate::analyzers::solidity::visitor::legacy_oracle::{
    count_advisory_callables, legacy_analyze_ast,
};

const FIXTURES: [(&str, &str); 5] = [
    (
        "SimpleToken.sol",
        include_str!("../../../tests/fixtures/solidity/simple/SimpleToken.sol"),
    ),
    (
        "ComplexVault.sol",
        include_str!("../../../tests/fixtures/solidity/complex/ComplexVault.sol"),
    ),
    (
        "InsecureBank.sol",
        include_str!("../../../tests/fixtures/solidity/security/InsecureBank.sol"),
    ),
    (
        "IERC20.sol",
        include_str!("../../../tests/fixtures/solidity/interfaces/IERC20.sol"),
    ),
    (
        "Token.t.sol",
        include_str!("../../../tests/fixtures/solidity/foundry/Token.t.sol"),
    ),
];

fn assert_analysis_equivalent(
    mut extracted: SolidityAnalysis,
    legacy: SolidityAnalysis,
    fixture: &str,
) {
    for (current, previous) in extracted.functions.iter_mut().zip(&legacy.functions) {
        normalize_entropy(current, previous);
    }
    assert_eq!(extracted, legacy, "analysis changed for {fixture}");
}

fn normalize_entropy(current: &mut SolidityFunction, previous: &SolidityFunction) {
    let (Some(current), Some(previous)) = (
        current.entropy_analysis.as_mut(),
        previous.entropy_analysis.as_ref(),
    ) else {
        return;
    };
    assert!((current.entropy_score - previous.entropy_score).abs() < 1e-12);
    assert!((current.pattern_repetition - previous.pattern_repetition).abs() < 1e-12);
    assert!((current.branch_similarity - previous.branch_similarity).abs() < 1e-12);
    assert!((current.dampening_factor - previous.dampening_factor).abs() < 1e-12);
    current.entropy_score = previous.entropy_score;
    current.pattern_repetition = previous.pattern_repetition;
    current.branch_similarity = previous.branch_similarity;
    current.dampening_factor = previous.dampening_factor;
}

#[test]
fn extracted_analysis_matches_legacy_visitor_for_solidity_fixtures() {
    let config = SolidityLanguageConfig::default();
    for (name, source) in FIXTURES {
        let ast = parse_source(source, Path::new(name)).unwrap();
        let extraction = extract_solidity(&ast);
        let legacy = legacy_analyze_ast(&ast, &config);
        let extracted = analyze_extracted(&ast, &config, &extraction);
        assert_analysis_equivalent(extracted, legacy, name);
    }
}

#[test]
fn extracted_debt_inputs_match_legacy_detectors() {
    let config = SolidityLanguageConfig::default();
    for (name, source) in FIXTURES {
        assert_debt_inputs_equivalent(name, source, &config);
    }
}

fn assert_debt_inputs_equivalent(name: &str, source: &str, config: &SolidityLanguageConfig) {
    let path = PathBuf::from(name);
    let ast = parse_source(source, &path).unwrap();
    let extraction = extract_solidity(&ast);
    let analysis = analyze_extracted(&ast, config, &extraction);
    let metrics = analysis
        .functions
        .iter()
        .map(to_function_metrics)
        .collect::<Vec<_>>();
    assert_eq!(
        detect_natspec_debt(&path, &ast, &metrics),
        detect_natspec_debt_with_signatures(
            &path,
            &ast.source,
            &metrics,
            &extraction.function_signatures,
        ),
        "NatSpec debt changed for {name}"
    );
    assert_contract_inputs(name, &ast, &extraction, config);
    let skip_debt = analysis.is_test_file;
    assert_eq!(
        detect_debt(&path, 10, &metrics, &ast, skip_debt, config),
        detect_debt_with_extraction(&path, 10, &metrics, &ast, &extraction, skip_debt, config,),
        "debt ordering changed for {name}"
    );
}

fn assert_contract_inputs(
    name: &str,
    ast: &SolidityAst,
    extraction: &SolidityExtraction<'_>,
    config: &SolidityLanguageConfig,
) {
    for contract in &extraction.contracts {
        let legacy = detect_contract_patterns(
            contract.node,
            &ast.source,
            count_advisory_callables(contract.node),
            config,
        );
        let extracted = detect_contract_patterns_with_counts(
            &ast.source,
            contract.advisory_function_count,
            contract.info.state_variable_count,
            config,
        );
        assert_eq!(legacy, extracted, "contract debt inputs changed for {name}");
    }
}