rustqual 1.6.0

Comprehensive Rust code quality analyzer — seven dimensions: IOSP, Complexity, DRY, SRP, Coupling, Test Quality, Architecture
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

use crate::domain::{target_kind, target_names, Dimension, Suppression, SuppressionTarget};

fn metric(dim: Dimension, name: &str, pin: f64) -> Suppression {
    Suppression {
        line: 1,
        dimensions: vec![dim],
        reason: Some("r".into()),
        target: Some(SuppressionTarget::Metric {
            name: name.into(),
            pin,
        }),
    }
}

#[test]
fn metric_pin_suppresses_at_or_below_and_refires_above() {
    let s = metric(Dimension::Srp, "file_length", 400.0);
    assert!(
        s.suppresses(Dimension::Srp, "file_length", Some(400.0)),
        "at the pin"
    );
    assert!(
        s.suppresses(Dimension::Srp, "file_length", Some(399.0)),
        "below the pin"
    );
    assert!(
        !s.suppresses(Dimension::Srp, "file_length", Some(401.0)),
        "above → re-fires"
    );
}

#[test]
fn metric_pin_never_silences_a_value_less_finding() {
    // The whole point of the redesign: a Metric target queried with no value
    // fails closed (does not suppress). A `map_or(true, …)` regression here
    // would silently over-suppress.
    let s = metric(Dimension::Srp, "file_length", 400.0);
    assert!(!s.suppresses(Dimension::Srp, "file_length", None));
}

#[test]
fn metric_pin_only_matches_its_own_target_and_dimension() {
    let s = metric(Dimension::Srp, "file_length", 400.0);
    assert!(
        !s.suppresses(Dimension::Srp, "max_parameters", Some(1.0)),
        "wrong target"
    );
    assert!(
        !s.suppresses(Dimension::Complexity, "file_length", Some(1.0)),
        "wrong dim"
    );
}

#[test]
fn boolean_target_silences_by_name_regardless_of_value() {
    let s = Suppression {
        line: 1,
        dimensions: vec![Dimension::Srp],
        reason: Some("r".into()),
        target: Some(SuppressionTarget::Boolean {
            name: "god_struct".into(),
        }),
    };
    assert!(s.suppresses(Dimension::Srp, "god_struct", None));
    assert!(s.suppresses(Dimension::Srp, "god_struct", Some(9.0)));
    assert!(
        !s.suppresses(Dimension::Srp, "file_length", Some(1.0)),
        "wrong target"
    );
}

#[test]
fn blanket_suppression_silences_every_finding_of_its_dimension() {
    let s = Suppression {
        line: 1,
        dimensions: vec![Dimension::Dry],
        reason: None,
        target: None,
    };
    assert!(s.suppresses(Dimension::Dry, "duplicate", None));
    assert!(s.suppresses(Dimension::Dry, "anything", Some(5.0)));
    assert!(
        !s.suppresses(Dimension::Srp, "duplicate", None),
        "wrong dim"
    );
}

#[test]
fn target_kind_and_target_names_agree_for_every_dimension() {
    // The two hand-maintained vocabularies must not drift: every name in
    // `target_names(dim)` must resolve via `target_kind(dim, name)`, else a
    // valid-looking target would be rejected by the parser or unmatchable by
    // the orphan detector.
    for dim in [
        Dimension::Iosp,
        Dimension::Complexity,
        Dimension::Dry,
        Dimension::Srp,
        Dimension::Coupling,
        Dimension::TestQuality,
        Dimension::Architecture,
    ] {
        for name in target_names(dim) {
            assert!(
                target_kind(dim, name).is_some(),
                "{dim:?} lists target {name:?} but target_kind doesn't classify it"
            );
        }
        assert!(target_kind(dim, "definitely_not_a_target").is_none());
    }
}

#[test]
fn empty_dimensions_list_covers_everything() {
    let s = Suppression {
        line: 1,
        dimensions: vec![],
        reason: None,
        target: None,
    };
    assert!(s.covers(Dimension::Iosp));
    assert!(s.covers(Dimension::Complexity));
    assert!(s.covers(Dimension::Architecture));
}

#[test]
fn specific_dimensions_only_cover_those_listed() {
    let s = Suppression {
        line: 1,
        dimensions: vec![Dimension::Iosp],
        reason: None,
        target: None,
    };
    assert!(s.covers(Dimension::Iosp));
    assert!(!s.covers(Dimension::Complexity));
    assert!(!s.covers(Dimension::Architecture));
}

#[test]
fn multiple_dimensions_cover_all_listed() {
    let s = Suppression {
        line: 1,
        dimensions: vec![Dimension::Iosp, Dimension::Architecture],
        reason: Some("migration in progress".into()),
        target: None,
    };
    assert!(s.covers(Dimension::Iosp));
    assert!(s.covers(Dimension::Architecture));
    assert!(!s.covers(Dimension::Dry));
}