rustqual 1.5.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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293

use super::*;

// ── SDP suppression tests ──────────────────────────────

#[test]
fn test_count_sdp_violations_excludes_suppressed() {
    let analysis = crate::adapters::analyzers::coupling::CouplingAnalysis {
        metrics: vec![],
        cycles: vec![],
        sdp_violations: vec![
            crate::adapters::analyzers::coupling::sdp::SdpViolation {
                from_module: "a".into(),
                to_module: "b".into(),
                from_instability: 0.2,
                to_instability: 0.8,
                suppressed: true,
            },
            crate::adapters::analyzers::coupling::sdp::SdpViolation {
                from_module: "c".into(),
                to_module: "d".into(),
                from_instability: 0.3,
                to_instability: 0.9,
                suppressed: false,
            },
        ],
        graph: crate::adapters::analyzers::coupling::ModuleGraph::default(),
    };
    let config = crate::config::sections::CouplingConfig::default();
    let mut summary = Summary::from_results(&[]);
    count_sdp_violations(Some(&analysis), &config, &mut summary);
    assert_eq!(
        summary.sdp_violations, 1,
        "Only unsuppressed violations counted"
    );
}

#[test]
fn dry_suppression_marks_every_group_kind() {
    // `qual:allow(dry)` on the line before an entry (line 4 → entry line 5)
    // suppresses every DRY finding kind: duplicate, repeated-match, fragment,
    // and boilerplate.
    let sups = dry_suppression_at(4);
    let (mut dup, mut rep, mut frag, mut bp) = dry_group_fixtures();
    mark_dry_suppressions(std::slice::from_mut(&mut dup), &sups);
    mark_dry_suppressions(std::slice::from_mut(&mut rep), &sups);
    mark_dry_suppressions(std::slice::from_mut(&mut frag), &sups);
    mark_dry_suppressions(std::slice::from_mut(&mut bp), &sups);
    assert!(
        dup.suppressed,
        "duplicate group suppressed by qual:allow(dry)"
    );
    assert!(rep.suppressed, "repeated-match group suppressed");
    assert!(frag.suppressed, "fragment group suppressed");
    assert!(bp.suppressed, "boilerplate find suppressed");
}

#[test]
fn dry_targeted_suppression_is_per_kind() {
    use crate::domain::SuppressionTarget;
    let targeted = |target: &str| -> std::collections::HashMap<String, Vec<Suppression>> {
        [(
            "test.rs".to_string(),
            vec![Suppression {
                line: 4,
                dimensions: vec![crate::findings::Dimension::Dry],
                reason: Some("r".to_string()),
                target: Some(SuppressionTarget::Boolean {
                    name: target.to_string(),
                }),
            }],
        )]
        .into()
    };
    // allow(dry, duplicate) silences ONLY the duplicate group.
    let (mut dup, mut rep, mut frag, mut bp) = dry_group_fixtures();
    let dup_only = targeted("duplicate");
    mark_dry_suppressions(std::slice::from_mut(&mut dup), &dup_only);
    mark_dry_suppressions(std::slice::from_mut(&mut rep), &dup_only);
    mark_dry_suppressions(std::slice::from_mut(&mut frag), &dup_only);
    mark_dry_suppressions(std::slice::from_mut(&mut bp), &dup_only);
    assert!(
        dup.suppressed,
        "duplicate silenced by allow(dry, duplicate)"
    );
    assert!(!rep.suppressed, "repeated-match must NOT be silenced");
    assert!(!frag.suppressed, "fragment must NOT be silenced");
    assert!(!bp.suppressed, "boilerplate must NOT be silenced");

    // A different target (fragment) leaves the duplicate group active.
    let (mut dup2, _, mut frag2, _) = dry_group_fixtures();
    let frag_only = targeted("fragment");
    mark_dry_suppressions(std::slice::from_mut(&mut dup2), &frag_only);
    mark_dry_suppressions(std::slice::from_mut(&mut frag2), &frag_only);
    assert!(
        !dup2.suppressed,
        "duplicate NOT silenced by fragment target"
    );
    assert!(
        frag2.suppressed,
        "fragment silenced by allow(dry, fragment)"
    );
}

#[test]
fn test_duplicate_without_suppression_not_marked() {
    use crate::adapters::analyzers::dry::functions::{
        DuplicateEntry, DuplicateGroup, DuplicateKind,
    };

    let mut groups = vec![DuplicateGroup {
        entries: vec![
            DuplicateEntry {
                name: "foo".to_string(),
                qualified_name: "foo".to_string(),
                file: "test.rs".to_string(),
                line: 5,
            },
            DuplicateEntry {
                name: "bar".to_string(),
                qualified_name: "bar".to_string(),
                file: "test.rs".to_string(),
                line: 15,
            },
        ],
        kind: DuplicateKind::Exact,
        suppressed: false,
    }];

    let suppression_lines: std::collections::HashMap<String, Vec<Suppression>> =
        std::collections::HashMap::new();

    mark_dry_suppressions(&mut groups, &suppression_lines);
    assert!(
        !groups[0].suppressed,
        "Group without suppression should not be marked"
    );
}

#[test]
fn test_inverse_annotation_suppresses_duplicate() {
    use crate::adapters::analyzers::dry::functions::{
        DuplicateEntry, DuplicateGroup, DuplicateKind,
    };

    let mut groups = vec![DuplicateGroup {
        entries: vec![
            DuplicateEntry {
                name: "as_str".to_string(),
                qualified_name: "Foo::as_str".to_string(),
                file: "test.rs".to_string(),
                line: 5,
            },
            DuplicateEntry {
                name: "parse".to_string(),
                qualified_name: "Foo::parse".to_string(),
                file: "test.rs".to_string(),
                line: 15,
            },
        ],
        kind: DuplicateKind::NearDuplicate { similarity: 0.91 },
        suppressed: false,
    }];

    // qual:inverse(parse) on line 4 (one before as_str at line 5)
    let inverse_lines: std::collections::HashMap<String, Vec<(usize, String)>> =
        [("test.rs".to_string(), vec![(4, "parse".to_string())])].into();

    mark_inverse_suppressions(&mut groups, &inverse_lines);
    assert!(
        groups[0].suppressed,
        "Inverse-annotated pair should be suppressed"
    );
}

#[test]
fn dry_suppression_must_cover_the_dry_dimension() {
    // A marker in the line window but covering a *different* dimension must not
    // suppress a DRY group. Pins the `is_within_window && covers(dry)` filter
    // against `&&`→`||` (which would suppress on window alone).
    use crate::adapters::analyzers::dry::functions::{
        DuplicateEntry, DuplicateGroup, DuplicateKind,
    };
    let mut groups = vec![DuplicateGroup {
        entries: vec![DuplicateEntry {
            name: "foo".into(),
            qualified_name: "foo".into(),
            file: "test.rs".into(),
            line: 5,
        }],
        kind: DuplicateKind::Exact,
        suppressed: false,
    }];
    // Marker on line 4 (in window of entry line 5) but covering Complexity.
    let sups: std::collections::HashMap<String, Vec<Suppression>> = [(
        "test.rs".to_string(),
        vec![Suppression {
            line: 4,
            dimensions: vec![crate::findings::Dimension::Complexity],
            reason: None,
            target: None,
        }],
    )]
    .into();
    mark_dry_suppressions(&mut groups, &sups);
    assert!(
        !groups[0].suppressed,
        "an in-window marker for another dimension must not suppress DRY"
    );
}

/// Build a single near-duplicate group `[as_str@as_line, parse@15]` and mark it
/// against a `qual:inverse(parse)` annotation at `inv_line`.
fn inverse_suppressed(inv_line: usize, as_line: usize) -> bool {
    use crate::adapters::analyzers::dry::functions::{
        DuplicateEntry, DuplicateGroup, DuplicateKind,
    };
    let mut groups = vec![DuplicateGroup {
        entries: vec![
            DuplicateEntry {
                name: "as_str".into(),
                qualified_name: "Foo::as_str".into(),
                file: "test.rs".into(),
                line: as_line,
            },
            DuplicateEntry {
                name: "parse".into(),
                qualified_name: "Foo::parse".into(),
                file: "test.rs".into(),
                line: 15,
            },
        ],
        kind: DuplicateKind::NearDuplicate { similarity: 0.91 },
        suppressed: false,
    }];
    let inverse_lines: std::collections::HashMap<String, Vec<(usize, String)>> =
        [("test.rs".to_string(), vec![(inv_line, "parse".to_string())])].into();
    mark_inverse_suppressions(&mut groups, &inverse_lines);
    groups[0].suppressed
}

#[test]
fn inverse_suppression_window_boundaries() {
    // The inverse window is `line <= entry.line && entry.line - line <= WINDOW`
    // (WINDOW = 3). Annotation at line 1:
    //  - entry at line 4 → diff exactly 3 → suppressed (pins `<=`→`>` and the
    //    `entry.line - line` subtraction against `-`→`/`: 4/1=4 > 3).
    //  - entry at line 10 → diff 9 → not suppressed (pins `&&`→`||`, which would
    //    suppress on the `line <= entry.line` half alone).
    assert!(
        inverse_suppressed(1, 4),
        "inverse pair at the window edge (diff 3) is suppressed"
    );
    assert!(
        !inverse_suppressed(1, 10),
        "inverse pair outside the window (diff 9) is not suppressed"
    );
}

#[test]
fn test_inverse_annotation_must_target_group_member() {
    use crate::adapters::analyzers::dry::functions::{
        DuplicateEntry, DuplicateGroup, DuplicateKind,
    };

    let mut groups = vec![DuplicateGroup {
        entries: vec![
            DuplicateEntry {
                name: "foo".to_string(),
                qualified_name: "foo".to_string(),
                file: "test.rs".to_string(),
                line: 5,
            },
            DuplicateEntry {
                name: "bar".to_string(),
                qualified_name: "bar".to_string(),
                file: "test.rs".to_string(),
                line: 15,
            },
        ],
        kind: DuplicateKind::Exact,
        suppressed: false,
    }];

    // qual:inverse(baz) targets a function not in the group
    let inverse_lines: std::collections::HashMap<String, Vec<(usize, String)>> =
        [("test.rs".to_string(), vec![(4, "baz".to_string())])].into();

    mark_inverse_suppressions(&mut groups, &inverse_lines);
    assert!(
        !groups[0].suppressed,
        "Inverse targeting non-member should not suppress"
    );
}