rustqual 1.2.5

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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
//! Workspace-level tests for method-call tracing through receivers,
//! locally-bound bindings, parameter-bound generics, async fn bodies,
//! generic-fn path calls, and inline attribute-decorated impl blocks.
//!
//! Each test builds a multi-file workspace via `build_workspace`,
//! produces the full call graph through `build_graph_only`, and
//! asserts the expected `crate::…::Type::method` (or free-fn) edge.
//! Coverage targets the inference paths that turn a syntactic call
//! site into a canonical edge: `self.helper()` chains, locally-bound
//! `let x = open()?; x.method()`, parameter-typed receivers, and
//! `path::call()` inside generic / `match` / async bodies.

use super::support::{
    build_graph_only, build_workspace, callees_of, empty_cfg_test, graph_contains_edge, three_layer,
};
use std::collections::HashSet;

// ─────────────────────────────────────────────────────────────────────
// Self-receiver chains: `self.helper()` reaches an associated fn on
// a different type two hops away.
// ─────────────────────────────────────────────────────────────────────

#[test]
fn self_method_chain_traces_through_helper_to_associated_fn_on_other_type() {
    // Shape:
    //   impl Server {
    //       fn ensure_session(&self) -> Session { Session::open("/p") }
    //   }
    //   impl Server {
    //       pub fn search(&self) { self.ensure_session(); }
    //   }
    //
    // Asserts both edges exist:
    //   Server::search → Server::ensure_session
    //   Server::ensure_session → Session::open
    let ws = build_workspace(&[
        (
            "src/application/session.rs",
            r#"
            pub struct Session;
            pub struct MyErr;
            impl Session {
                pub fn open(_p: &str) -> Result<Self, MyErr> { todo!() }
            }
            "#,
        ),
        (
            "src/mcp/server.rs",
            r#"
            use crate::application::session::{Session, MyErr};

            pub struct Server;

            impl Server {
                pub(crate) fn ensure_session(&self) -> Result<Session, MyErr> {
                    Session::open("/p")
                }
            }

            impl Server {
                pub fn search(&self) -> Result<(), MyErr> {
                    self.ensure_session()?;
                    Ok(())
                }
            }
            "#,
        ),
    ]);
    let graph = build_graph_only(&ws, &three_layer(), &empty_cfg_test(), &HashSet::new());

    let search = "crate::mcp::server::Server::search";
    let ensure = "crate::mcp::server::Server::ensure_session";
    let open = "crate::application::session::Session::open";

    let edge1 = graph_contains_edge(&graph, search, ensure);
    let edge2 = graph_contains_edge(&graph, ensure, open);

    assert!(
        edge1 && edge2,
        "self-method chain `search → ensure_session → Session::open` broken.\n\
         search → ensure_session: {edge1}\n\
         ensure_session → Session::open: {edge2}\n\
         search callees: {:?}\n\
         ensure_session callees: {:?}",
        callees_of(&graph, search),
        callees_of(&graph, ensure),
    );
}

#[test]
fn async_self_method_chain_traces_through_helper_to_associated_fn() {
    // Same chain as the sync variant, but `pub async fn search` —
    // async fn lowering must not break the edge.
    let ws = build_workspace(&[
        (
            "src/application/session.rs",
            r#"
            pub struct Session;
            pub struct MyErr;
            impl Session {
                pub fn open(_p: &str) -> Result<Self, MyErr> { todo!() }
            }
            "#,
        ),
        (
            "src/mcp/server.rs",
            r#"
            use crate::application::session::{Session, MyErr};

            pub struct Server;

            impl Server {
                pub(crate) fn ensure_session(&self) -> Result<Session, MyErr> {
                    Session::open("/p")
                }
            }

            impl Server {
                pub async fn search(&self) -> Result<(), MyErr> {
                    self.ensure_session()?;
                    Ok(())
                }
            }
            "#,
        ),
    ]);
    let graph = build_graph_only(&ws, &three_layer(), &empty_cfg_test(), &HashSet::new());

    let search = "crate::mcp::server::Server::search";
    let ensure = "crate::mcp::server::Server::ensure_session";
    let open = "crate::application::session::Session::open";

    let edge1 = graph_contains_edge(&graph, search, ensure);
    let edge2 = graph_contains_edge(&graph, ensure, open);

    assert!(
        edge1 && edge2,
        "async self-method chain broken.\n\
         search → ensure_session: {edge1}\n\
         ensure_session → Session::open: {edge2}\n\
         search callees: {:?}\n\
         ensure_session callees: {:?}",
        callees_of(&graph, search),
        callees_of(&graph, ensure),
    );
}

// ─────────────────────────────────────────────────────────────────────
// Locally-bound and parameter-bound receivers: `let s = open()?; s.m()`
// and `fn h(s: &Session) { s.m() }` must both produce method edges.
// ─────────────────────────────────────────────────────────────────────

#[test]
fn locally_bound_let_receiver_traces_multiple_method_calls() {
    // `let session = open_session_in_cwd()?;` followed by branches
    // calling `session.replace_preview()` and `session.replace_apply()`
    // must produce TWO edges from the enclosing fn.
    let ws = build_workspace(&[
        (
            "src/application/session.rs",
            r#"
            pub struct Session;
            pub struct MyErr;
            impl Session {
                pub fn replace_preview(&self) {}
                pub fn replace_apply(&self) {}
            }
            "#,
        ),
        (
            "src/cli/helpers.rs",
            r#"
            use crate::application::session::{Session, MyErr};
            pub fn open_session_in_cwd() -> Result<Session, MyErr> { todo!() }
            "#,
        ),
        (
            "src/cli/handlers.rs",
            r#"
            use crate::cli::helpers::open_session_in_cwd;
            use crate::application::session::MyErr;

            pub fn cmd_replace(preview: bool) -> Result<(), MyErr> {
                let session = open_session_in_cwd()?;
                if preview {
                    session.replace_preview();
                } else {
                    session.replace_apply();
                }
                Ok(())
            }
            "#,
        ),
    ]);
    let graph = build_graph_only(&ws, &three_layer(), &empty_cfg_test(), &HashSet::new());

    let cmd = "crate::cli::handlers::cmd_replace";
    let preview = "crate::application::session::Session::replace_preview";
    let apply = "crate::application::session::Session::replace_apply";

    let has_preview = graph_contains_edge(&graph, cmd, preview);
    let has_apply = graph_contains_edge(&graph, cmd, apply);

    assert!(
        has_preview && has_apply,
        "locally-bound `session.X()` calls not traced.\n\
         cmd_replace → replace_preview: {has_preview}\n\
         cmd_replace → replace_apply:   {has_apply}\n\
         cmd_replace callees: {:?}",
        callees_of(&graph, cmd),
    );
}

#[test]
fn parameter_bound_receiver_traces_multiple_method_calls() {
    // `pub fn handle_replace(session: &Session, preview: bool)` —
    // calls inside both `if` branches must produce edges.
    let ws = build_workspace(&[
        (
            "src/application/session.rs",
            r#"
            pub struct Session;
            impl Session {
                pub fn replace_preview(&self) {}
                pub fn replace_apply(&self) {}
            }
            "#,
        ),
        (
            "src/mcp/handlers.rs",
            r#"
            use crate::application::session::Session;

            pub fn handle_replace(session: &Session, preview: bool) {
                if preview {
                    session.replace_preview();
                } else {
                    session.replace_apply();
                }
            }
            "#,
        ),
    ]);
    let graph = build_graph_only(&ws, &three_layer(), &empty_cfg_test(), &HashSet::new());

    let h = "crate::mcp::handlers::handle_replace";
    let preview = "crate::application::session::Session::replace_preview";
    let apply = "crate::application::session::Session::replace_apply";

    let has_preview = graph_contains_edge(&graph, h, preview);
    let has_apply = graph_contains_edge(&graph, h, apply);

    assert!(
        has_preview && has_apply,
        "parameter-bound `session.X()` calls not traced.\n\
         handle_replace → replace_preview: {has_preview}\n\
         handle_replace → replace_apply:   {has_apply}\n\
         handle_replace callees: {:?}",
        callees_of(&graph, h),
    );
}

// ─────────────────────────────────────────────────────────────────────
// Generic-fn bodies: a path call `savings::record_file_op(result, p)`
// inside a generic fn body must emit a path-call edge regardless of
// the surrounding generics.
// ─────────────────────────────────────────────────────────────────────

#[test]
fn generic_fn_body_traces_path_call_to_generic_target() {
    let ws = build_workspace(&[
        (
            "src/application/savings.rs",
            r#"
            pub fn record_file_op<T>(_r: &T, _meta: &str) {}
            "#,
        ),
        (
            "src/application/middleware.rs",
            r#"
            use crate::application::savings;

            pub fn record_operation<T>(meta: &str, result: &T) {
                savings::record_file_op(result, meta);
            }
            "#,
        ),
    ]);
    let graph = build_graph_only(&ws, &three_layer(), &empty_cfg_test(), &HashSet::new());

    let outer = "crate::application::middleware::record_operation";
    let inner = "crate::application::savings::record_file_op";

    assert!(
        graph_contains_edge(&graph, outer, inner),
        "direct path-call edge from generic `record_operation` to \
         generic `record_file_op` missing.\n\
         record_operation callees: {:?}",
        callees_of(&graph, outer),
    );
}

#[test]
fn path_call_inside_generic_match_arm_traces_edge() {
    // Outer call lives inside a `match` arm body — must still produce
    // the edge for each arm.
    let ws = build_workspace(&[
        (
            "src/application/savings.rs",
            r#"
            pub fn record_file_op<T>(_r: &T, _meta: &str) {}
            pub fn record_symbol_op<T>(_r: &T, _meta: &str) {}
            "#,
        ),
        (
            "src/application/middleware.rs",
            r#"
            use crate::application::savings;

            pub enum AlternativeCost { SingleFile(String), SymbolFiles(String) }

            pub fn record_operation<T>(meta: &str, result: &T, alt: &AlternativeCost) {
                let _ = match alt {
                    AlternativeCost::SingleFile(p) => {
                        savings::record_file_op(result, p);
                    }
                    AlternativeCost::SymbolFiles(s) => {
                        savings::record_symbol_op(result, s);
                    }
                };
            }
            "#,
        ),
    ]);
    let graph = build_graph_only(&ws, &three_layer(), &empty_cfg_test(), &HashSet::new());

    let outer = "crate::application::middleware::record_operation";
    let inner_file = "crate::application::savings::record_file_op";
    let inner_sym = "crate::application::savings::record_symbol_op";

    let has_file = graph_contains_edge(&graph, outer, inner_file);
    let has_sym = graph_contains_edge(&graph, outer, inner_sym);

    assert!(
        has_file && has_sym,
        "calls inside match-arm bodies not traced.\n\
         record_operation → record_file_op: {has_file}\n\
         record_operation → record_symbol_op: {has_sym}\n\
         record_operation callees: {:?}",
        callees_of(&graph, outer),
    );
}

// ─────────────────────────────────────────────────────────────────────
// Inline impl-block attributes (`#[tool_router]` / `#[tool]`) must not
// hide the inner method bodies from the call graph. syn stores unknown
// attrs verbatim — the walker must descend into the impl regardless.
// ─────────────────────────────────────────────────────────────────────

#[test]
fn unknown_attribute_on_impl_block_does_not_hide_inner_calls() {
    // Method bodies inside an impl block decorated with a non-cfg
    // unknown attribute must still contribute edges to the call graph.
    // The attributes here are unknown to syn (no proc-macro expansion
    // happens — syn just records them) so this test verifies the
    // visitor doesn't skip attribute-decorated impl blocks.
    let ws = build_workspace(&[
        (
            "src/application/session.rs",
            r#"
            pub struct Session;
            pub struct MyErr;
            impl Session {
                pub fn open(_p: &str) -> Result<Self, MyErr> { todo!() }
            }
            "#,
        ),
        (
            "src/mcp/server.rs",
            r#"
            use crate::application::session::{Session, MyErr};

            pub struct Server;
            pub struct Parameters<T>(pub T);
            pub struct SearchParams;
            pub struct CallToolResult;
            pub struct McpError;

            #[tool_router]
            impl Server {
                #[tool]
                pub async fn search(
                    &self,
                    _params: Parameters<SearchParams>,
                ) -> Result<CallToolResult, McpError> {
                    let _session = Session::open("/p");
                    todo!()
                }
            }
            "#,
        ),
    ]);
    let graph = build_graph_only(&ws, &three_layer(), &empty_cfg_test(), &HashSet::new());

    let search = "crate::mcp::server::Server::search";
    let open = "crate::application::session::Session::open";

    let edge = graph_contains_edge(&graph, search, open);

    assert!(
        edge,
        "Session::open is invisible from inside the \
         #[tool_router]-decorated impl block.\n\
         search callees: {:?}",
        callees_of(&graph, search),
    );
}