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
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
294
295
296
297
298
299

use crate::adapters::analyzers::srp::*;

#[test]
fn test_returns_self_yes() {
    let ret: syn::ReturnType = syn::parse_quote!(-> Self);
    assert!(returns_self(&ret));
}

#[test]
fn test_returns_self_result_self() {
    let ret: syn::ReturnType = syn::parse_quote!(-> Result<Self, String>);
    assert!(returns_self(&ret));
}

#[test]
fn test_returns_self_option_self() {
    let ret: syn::ReturnType = syn::parse_quote!(-> Option<Self>);
    assert!(returns_self(&ret));
}

#[test]
fn test_returns_self_no() {
    let ret: syn::ReturnType = syn::parse_quote!(-> i32);
    assert!(!returns_self(&ret));
}

#[test]
fn test_returns_self_result_non_self() {
    let ret: syn::ReturnType = syn::parse_quote!(-> Result<String, Error>);
    assert!(!returns_self(&ret));
}

#[test]
fn test_returns_self_default_return() {
    let ret = syn::ReturnType::Default;
    assert!(!returns_self(&ret));
}

#[test]
fn test_is_self_expr_true() {
    let expr: syn::Expr = syn::parse_quote!(self);
    assert!(is_self_expr(&expr));
}

#[test]
fn test_is_self_expr_false_other_path() {
    let expr: syn::Expr = syn::parse_quote!(other);
    assert!(!is_self_expr(&expr));
}

#[test]
fn test_is_self_expr_false_literal() {
    let expr: syn::Expr = syn::parse_quote!(42);
    assert!(!is_self_expr(&expr));
}

fn parse_file(code: &str) -> syn::File {
    syn::parse_file(code).expect("Failed to parse test code")
}

/// Test helper: collect structs via visit_all_files (same as analyze_srp uses).
fn collect_structs(parsed: &[(String, String, syn::File)]) -> Vec<StructInfo> {
    let mut result = Vec::new();
    let mut collector = StructCollector {
        file: String::new(),
        structs: &mut result,
    };
    crate::adapters::shared::file_visitor::visit_all_files(parsed, &mut collector);
    result
}

/// Test helper: collect methods via visit_all_files (same as analyze_srp uses).
fn collect_methods(parsed: &[(String, String, syn::File)]) -> Vec<MethodFieldData> {
    let mut result = Vec::new();
    let mut bridges = Vec::new();
    let mut collector = ImplMethodCollector {
        file: String::new(),
        methods: &mut result,
        bridges: &mut bridges,
    };
    crate::adapters::shared::file_visitor::visit_all_files(parsed, &mut collector);
    result
}

/// Run the full `analyze_srp` path over a single in-memory source and return
/// just its struct warnings — the shared arrange for the source-level
/// struct-SRP tests, so each test body is only its own source + oracle.
fn struct_warnings_for(path: &str, code: &str) -> Vec<SrpWarning> {
    let parsed = vec![(path.to_string(), code.to_string(), parse_file(code))];
    analyze_srp(
        &parsed,
        &SrpConfig::default(),
        &std::collections::HashMap::new(),
        300,
    )
    .struct_warnings
}

#[test]
fn test_struct_collector_named_fields() {
    let code = "struct Foo { x: i32, y: String }";
    let syntax = parse_file(code);
    let parsed = vec![("test.rs".to_string(), code.to_string(), syntax)];
    let result = collect_structs(&parsed);
    assert_eq!(result.len(), 1);
    assert_eq!(result[0].name, "Foo");
    assert_eq!(result[0].fields, vec!["x", "y"]);
}

#[test]
fn test_struct_collector_tuple_struct_skipped() {
    let code = "struct Point(i32, i32);";
    let syntax = parse_file(code);
    let parsed = vec![("test.rs".to_string(), code.to_string(), syntax)];
    let result = collect_structs(&parsed);
    assert!(result.is_empty(), "Tuple structs should be skipped");
}

#[test]
fn test_struct_collector_unit_struct_skipped() {
    let code = "struct Marker;";
    let syntax = parse_file(code);
    let parsed = vec![("test.rs".to_string(), code.to_string(), syntax)];
    let result = collect_structs(&parsed);
    assert!(result.is_empty(), "Unit structs should be skipped");
}

#[test]
fn test_impl_method_collector_instance_methods_and_constructors() {
    let code = r#"
        struct Foo { x: i32, y: i32 }
        impl Foo {
            fn new(x: i32, y: i32) -> Self { Self { x, y } }
            fn get_x(&self) -> i32 { self.x }
            fn set_y(&mut self, y: i32) { self.y = y; }
            fn helper() -> i32 { 42 }
        }
    "#;
    let syntax = parse_file(code);
    let parsed = vec![("test.rs".to_string(), code.to_string(), syntax)];
    let result = collect_methods(&parsed);
    // Instance methods (get_x, set_y) + constructor (new) — helper is static (no self, no -> Self)
    assert_eq!(result.len(), 3);
    let names: Vec<&str> = result.iter().map(|m| m.method_name.as_str()).collect();
    assert!(names.contains(&"get_x"));
    assert!(names.contains(&"set_y"));
    assert!(names.contains(&"new"));
    // Verify constructor flag
    let new_method = result.iter().find(|m| m.method_name == "new").unwrap();
    assert!(new_method.is_constructor);
    let get_x_method = result.iter().find(|m| m.method_name == "get_x").unwrap();
    assert!(!get_x_method.is_constructor);
}

#[test]
fn test_impl_method_collector_skips_trait_impls() {
    let code = r#"
        struct Foo { x: i32 }
        impl Foo {
            fn get_x(&self) -> i32 { self.x }
        }
        impl std::fmt::Display for Foo {
            fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
                write!(f, "{}", self.x)
            }
        }
    "#;
    let syntax = parse_file(code);
    let parsed = vec![("test.rs".to_string(), code.to_string(), syntax)];
    let result = collect_methods(&parsed);
    // Only inherent methods, not trait impls
    assert_eq!(result.len(), 1);
    assert_eq!(result[0].method_name, "get_x");
}

#[test]
fn test_method_body_visitor_field_accesses() {
    let code = r#"
        struct Foo { x: i32, y: i32, z: i32 }
        impl Foo {
            fn sum(&self) -> i32 { self.x + self.y }
        }
    "#;
    let syntax = parse_file(code);
    let parsed = vec![("test.rs".to_string(), code.to_string(), syntax)];
    let result = collect_methods(&parsed);
    assert_eq!(result.len(), 1);
    assert!(result[0].field_accesses.contains("x"));
    assert!(result[0].field_accesses.contains("y"));
    assert!(!result[0].field_accesses.contains("z"));
}

#[test]
fn test_method_body_visitor_call_targets() {
    let code = r#"
        struct Foo { data: Vec<i32> }
        impl Foo {
            fn process(&self) -> usize { helper(self.data.len()) }
        }
        fn helper(n: usize) -> usize { n }
    "#;
    let syntax = parse_file(code);
    let parsed = vec![("test.rs".to_string(), code.to_string(), syntax)];
    let result = collect_methods(&parsed);
    assert_eq!(result.len(), 1);
    assert!(result[0].call_targets.contains("helper"));
}

#[test]
fn test_analyze_srp_empty() {
    let parsed: Vec<(String, String, syn::File)> = vec![];
    let config = SrpConfig::default();
    let call_graph = std::collections::HashMap::new();
    let analysis = analyze_srp(&parsed, &config, &call_graph, 300);
    assert!(analysis.struct_warnings.is_empty());
    assert!(analysis.module_warnings.is_empty());
}

#[test]
fn test_analyze_srp_cohesive_struct() {
    let code = r#"
        struct Counter { count: usize }
        impl Counter {
            fn increment(&mut self) { self.count += 1; }
            fn get(&self) -> usize { self.count }
            fn reset(&mut self) { self.count = 0; }
        }
    "#;
    // Fully cohesive struct → no warning
    assert!(
        struct_warnings_for("test.rs", code).is_empty(),
        "Cohesive struct should not trigger SRP warning"
    );
}

#[test]
fn test_analyze_srp_multiple_files() {
    let code1 = "struct A { x: i32 }\nimpl A { fn get_x(&self) -> i32 { self.x } }";
    let code2 = "struct B { y: i32 }\nimpl B { fn get_y(&self) -> i32 { self.y } }";
    let syntax1 = parse_file(code1);
    let syntax2 = parse_file(code2);
    let parsed = vec![
        ("a.rs".to_string(), code1.to_string(), syntax1),
        ("b.rs".to_string(), code2.to_string(), syntax2),
    ];
    let config = SrpConfig::default();
    let call_graph = std::collections::HashMap::new();
    let analysis = analyze_srp(&parsed, &config, &call_graph, 300);
    // Both structs are simple → no warnings
    assert!(analysis.struct_warnings.is_empty());
}

#[test]
fn test_analyze_srp_returns_empty_param_warnings() {
    // param_warnings are now populated by the pipeline, not analyze_srp
    let parsed: Vec<(String, String, syn::File)> = vec![];
    let config = SrpConfig::default();
    let call_graph = std::collections::HashMap::new();
    let analysis = analyze_srp(&parsed, &config, &call_graph, 300);
    assert!(analysis.param_warnings.is_empty());
}

#[test]
fn test_analyze_srp_god_struct_fires_in_test_file() {
    // SRP-001 (god-struct cohesion) deliberately applies to TEST code too: a
    // god-fixture wiring up auth + db + caching + routing in one struct is a
    // real smell, and the "independent #[test] fns are the file's purpose"
    // rationale that makes the MODULE cluster-check production-only does NOT
    // excuse it. Only `analyze_module_srp` skips test files; the struct-level
    // check is intentionally NOT gated on cfg_test_files (production thresholds,
    // no separate `[tests]` knob — `// qual:allow(srp)` covers rare fixtures).
    // The `#![cfg(test)]` inner attr marks this a whole test file, so this pins
    // the struct warning still fires there.
    let code = r#"
        #![cfg(test)]
        struct GodFixture {
            db: u8, cache: u8, logger: u8, metrics: u8, config: u8, state: u8,
            buffer: u8, queue: u8, pool: u8, handler: u8, router: u8, auth: u8,
        }
        impl GodFixture {
            fn read_db(&self) { query(self.db); }
            fn write_db(&mut self) { commit(self.db); }
            fn read_cache(&self) { get_key(self.cache); }
            fn write_cache(&mut self) { set_key(self.cache); }
            fn log_info(&self) { format_log(self.logger); }
            fn log_error(&self) { format_log(self.logger); inc(self.metrics); }
            fn route(&self) { dispatch(self.router, self.handler); }
            fn authenticate(&self) { verify(self.auth, self.config); }
            fn flush(&mut self) { drain(self.buffer, self.queue); }
            fn manage_pool(&mut self) { alloc(self.pool, self.state); }
        }
    "#;
    assert!(
        struct_warnings_for("tests/fixtures.rs", code)
            .iter()
            .any(|w| w.struct_name == "GodFixture"),
        "struct SRP-001 must fire on a god-struct even in a test file"
    );
}