rustqual 1.2.5

//! Workspace-level tests for module-path resolution as the call graph
//! canonicalises call sites and `use` imports.
//!
//! Each test sets up a multi-file (or inline-mod) workspace, builds
//! the call graph, and asserts whether a given import or call site
//! resolves to the expected canonical path. Coverage:
//!
//! - Sibling-submodule `use foo::X` taking precedence over a
//!   crate-root `foo` with the same leaf name (Rust 2018+ resolution).
//! - Inline `mod foo { mod bar; use bar::X; }` blocks contributing
//!   module-path entries equal to filesystem-derived siblings.
//! - Orphan files (no `mod` declaration backing them) NOT acting as
//!   sibling submodules — Rust ignores them, so we must too.
//! - Private `mod X;` declarations inside a file whose ancestor chain
//!   is hidden by a non-root private `mod` still acting as real
//!   children for code inside the parent file.
//! - `pub use` re-exports forwarding the call site to the real fn
//!   definition rather than dropping the edge at the re-export path.
//! - Concrete UFCS (`ConcreteType::new(...)`) where the type is
//!   named-imported from a sibling submodule — common
//!   middleware-/builder-pattern shape.

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

#[test]
fn concrete_ufcs_via_sibling_submodule_import_traces_edge() {
    // `dispatcher<T>` body calls `ConcreteOutput::new(body)` where
    // `ConcreteOutput` is imported via `use response::ConcreteOutput`
    // (relative sibling-submodule). The edge must resolve to the
    // sibling's inherent `new` even though the call lives in a
    // generic-fn body.
    let ws = build_workspace(&[
        (
            "src/application/mod.rs",
            r#"
            pub mod response;

            use serde::Serialize;
            use response::ConcreteOutput;

            pub fn dispatcher<T: Serialize>(value: &T) -> ConcreteOutput {
                let body = serde_json::to_string(value).unwrap_or_default();
                ConcreteOutput::new(body)
            }
            "#,
        ),
        (
            "src/application/response.rs",
            r#"
            pub struct ConcreteOutput { pub body: String }
            impl ConcreteOutput {
                pub fn new(body: String) -> Self { Self { body } }
            }
            "#,
        ),
        (
            "src/cli/mod.rs",
            r#"
            use crate::application::dispatcher;

            pub fn cmd_run() -> String {
                let out = dispatcher(&42u32);
                out.body
            }
            "#,
        ),
    ]);
    let graph = build_graph_only(&ws, &three_layer(), &empty_cfg_test(), &HashSet::new());

    let dispatcher = "crate::application::dispatcher";
    let new_target = "crate::application::response::ConcreteOutput::new";
    assert!(
        graph_contains_edge(&graph, dispatcher, new_target),
        "concrete UFCS `ConcreteOutput::new(body)` inside generic \
         `dispatcher<T>` body must emit edge to `{new_target}` when \
         `ConcreteOutput` is named-imported from a sibling submodule. \
         dispatcher callees: {:?}",
        callees_of(&graph, dispatcher),
    );
}

#[test]
fn sibling_submodule_wins_over_crate_root_with_same_leaf_name() {
    // Rust 2018+: `use foo::X` inside `crate::application` resolves
    // to `crate::application::foo::X` (local sibling) even when
    // `crate::foo` also exists. The normaliser must check the sibling
    // branch BEFORE crate-root modules.
    let ws = build_workspace(&[
        (
            "src/response/mod.rs",
            r#"
            pub struct OuterRoot;
            impl OuterRoot {
                pub fn run() {}
            }
            "#,
        ),
        (
            "src/application/response.rs",
            r#"
            pub struct Local;
            impl Local {
                pub fn run() {}
            }
            "#,
        ),
        (
            "src/application/mod.rs",
            r#"
            pub mod response;

            use response::Local;

            pub fn dispatch() {
                Local::run();
            }
            "#,
        ),
        (
            "src/cli/mod.rs",
            r#"
            use crate::application::dispatch;

            pub fn cmd_run() {
                dispatch();
            }
            "#,
        ),
    ]);
    let graph = build_graph_only(&ws, &three_layer(), &empty_cfg_test(), &HashSet::new());
    let dispatch = "crate::application::dispatch";
    let local_target = "crate::application::response::Local::run";
    let crate_root_target = "crate::response::OuterRoot::run";
    assert!(
        graph_contains_edge(&graph, dispatch, local_target),
        "Rust 2018+: `use response::Local` in `application/mod.rs` must \
         resolve to local sibling `crate::application::response::Local`, \
         not crate-root `crate::response`. dispatch callees: {:?}",
        callees_of(&graph, dispatch),
    );
    assert!(
        !graph_contains_edge(&graph, dispatch, crate_root_target),
        "must NOT route to crate-root `{crate_root_target}` — that's \
         the wrong target. dispatch callees: {:?}",
        callees_of(&graph, dispatch),
    );
}

#[test]
fn inline_mod_sibling_import_traces_edge() {
    // `mod outer { mod inner { ... } use inner::X; }` — inline `mod`
    // blocks must contribute the same module-path entries as
    // filesystem-derived modules so `use inner::Local` resolves to
    // `crate::application::outer::inner::Local`.
    let ws = build_workspace(&[
        (
            "src/application/mod.rs",
            r#"
            pub mod outer {
                pub mod inner {
                    pub struct Local;
                    impl Local {
                        pub fn run() {}
                    }
                }

                use inner::Local;

                pub fn dispatch() {
                    Local::run();
                }
            }
            "#,
        ),
        (
            "src/cli/mod.rs",
            r#"
            use crate::application::outer::dispatch;

            pub fn cmd_run() {
                dispatch();
            }
            "#,
        ),
    ]);
    let graph = build_graph_only(&ws, &three_layer(), &empty_cfg_test(), &HashSet::new());
    let dispatch = "crate::application::outer::dispatch";
    let target = "crate::application::outer::inner::Local::run";
    assert!(
        graph_contains_edge(&graph, dispatch, target),
        "inline-mod sibling import `use inner::Local` from `mod outer` \
         must trace to `{target}`. dispatch callees: {:?}",
        callees_of(&graph, dispatch),
    );
}

#[test]
fn orphan_file_does_not_act_as_sibling_submodule() {
    // `application/orphan.rs` exists on disk but `application/mod.rs`
    // never declares `mod orphan;` — Rust treats it as dead code.
    // The sibling-submodule discriminator must filter by reachability
    // through `mod` declarations, otherwise `use orphan::X` from a
    // sibling fabricates a false edge to `crate::application::orphan::X`.
    let ws = build_workspace(&[
        (
            "src/application/mod.rs",
            r#"
            use orphan::Local;

            pub fn dispatch() {
                Local::run();
            }
            "#,
        ),
        (
            "src/application/orphan.rs",
            r#"
            pub struct Local;
            impl Local {
                pub fn run() {}
            }
            "#,
        ),
        (
            "src/cli/mod.rs",
            r#"
            use crate::application::dispatch;

            pub fn cmd_run() {
                dispatch();
            }
            "#,
        ),
    ]);
    let graph = build_graph_only(&ws, &three_layer(), &empty_cfg_test(), &HashSet::new());
    let dispatch = "crate::application::dispatch";
    let phantom_target = "crate::application::orphan::Local::run";
    assert!(
        !graph_contains_edge(&graph, dispatch, phantom_target),
        "orphan file `application/orphan.rs` (no `mod orphan;` decl in \
         application/mod.rs) must NOT be treated as a real sibling \
         submodule — `use orphan::Local` is an external/unresolved \
         import, not a workspace canonical. dispatch callees: {:?}",
        callees_of(&graph, dispatch),
    );
}

#[test]
fn private_mod_sibling_import_resolves_even_when_ancestor_chain_is_hidden() {
    // `src/lib.rs` declares `pub mod application;`. Inside that,
    // `application/mod.rs` declares a private `mod hidden;` — that
    // marks `application/hidden.rs` as not externally reachable per
    // the file-root visibility chain. But from inside `hidden.rs`,
    // `use response::Local;` must still normalise to
    // `crate::application::hidden::response::Local`: `mod response;`
    // is declared in `hidden.rs` itself, so it's a real child module
    // for code inside the parent file, regardless of how the chain
    // is filtered for external visibility.
    let ws = build_workspace(&[
        (
            "src/lib.rs",
            r#"
            pub mod application;
            "#,
        ),
        (
            "src/application/mod.rs",
            r#"
            mod hidden;
            "#,
        ),
        (
            "src/application/hidden.rs",
            r#"
            mod response;

            use response::Local;

            pub fn dispatch() {
                Local::run();
            }
            "#,
        ),
        (
            "src/application/hidden/response.rs",
            r#"
            pub struct Local;
            impl Local {
                pub fn run() {}
            }
            "#,
        ),
    ]);
    let graph = build_graph_only(&ws, &three_layer(), &empty_cfg_test(), &HashSet::new());
    let dispatch = "crate::application::hidden::dispatch";
    let target = "crate::application::hidden::response::Local::run";
    assert!(
        graph_contains_edge(&graph, dispatch, target),
        "private `mod response;` declared INSIDE a file whose ancestor \
         chain is hidden by a non-root private `mod hidden;` is still a \
         real child module for code inside `hidden.rs`. \
         `use response::Local` must normalise to `{target}` regardless \
         of public-visibility filtering. dispatch callees: {:?}",
        callees_of(&graph, dispatch),
    );
}

#[test]
fn pub_use_reexport_call_resolves_to_real_definition() {
    // Caller imports `middleware::record_operation` — re-exported via
    // `pub use savings_recorder::record_operation;`. The canonicaliser
    // must follow the `pub use` to the real definition or the edge
    // is dropped.
    let ws = build_workspace(&[
        (
            "src/application/middleware/mod.rs",
            r#"
            pub mod savings_recorder;
            pub use savings_recorder::record_operation;
            "#,
        ),
        (
            "src/application/middleware/savings_recorder.rs",
            r#"
            pub fn record_operation() {}
            "#,
        ),
        (
            "src/application/session.rs",
            r#"
            use crate::application::middleware;
            pub struct Session;
            impl Session {
                pub fn search(&self) {
                    middleware::record_operation();
                }
            }
            "#,
        ),
    ]);
    let graph = build_graph_only(&ws, &three_layer(), &empty_cfg_test(), &HashSet::new());

    let search = "crate::application::session::Session::search";
    let real_target = "crate::application::middleware::savings_recorder::record_operation";

    assert!(
        graph_contains_edge(&graph, search, real_target),
        "call site `middleware::record_operation()` not resolved through \
         the `pub use` re-export to the real definition `{real_target}`.\n\
         search callees: {:?}",
        callees_of(&graph, search),
    );
}

#[test]
fn fallback_walker_skips_stale_mod_rs_when_file_rs_is_the_winner() {
    // Same stale-leftover scenario as the lib.rs-rooted case, but in
    // the FALLBACK path: a workspace without `src/lib.rs` / `src/main.rs`
    // (test-fixture shape). `build_module_segs_to_path_map` already
    // picks `foo.rs` as the winner for `["foo"]`, but
    // `walk_fallback_roots` iterates the raw `files` slice and treats
    // BOTH `foo.rs` and `foo/mod.rs` as implicit roots — so the stale
    // `foo/mod.rs`'s `mod beta;` declaration still landed in
    // `workspace_module_paths` and `use beta::T;` from `foo.rs` then
    // false-resolved to `crate::foo::beta::T` via the sibling-submodule
    // discriminator.
    //
    // Fix: the fallback walker must consider only the tie-break
    // winner as an implicit root, mirroring the precedence
    // `build_module_segs_to_path_map` already established.
    let ws = build_workspace(&[
        (
            "src/foo.rs",
            r#"
            // Live module file. Does NOT declare `mod beta;`. The
            // legitimate behaviour for `use beta::T;` here is "extern
            // import" — not a workspace edge.
            use beta::T;
            pub fn dispatch() { T::run(); }
            "#,
        ),
        // Stale `mod.rs` from a long-ago refactor. Declares its own
        // `mod beta;`. The walker must NOT trust this file's
        // submodule declarations once `foo.rs` is the winner.
        ("src/foo/mod.rs", "pub mod beta;\n"),
        (
            "src/foo/beta.rs",
            r#"
            pub struct T;
            impl T { pub fn run() {} }
            "#,
        ),
    ]);
    let graph = build_graph_only(&ws, &three_layer(), &empty_cfg_test(), &HashSet::new());
    let dispatch = "crate::foo::dispatch";
    let stale_phantom = "crate::foo::beta::T::run";
    assert!(
        !graph_contains_edge(&graph, dispatch, stale_phantom),
        "in the fallback (no `src/lib.rs` / `src/main.rs`) walker, a \
         stale `src/foo/mod.rs` must NOT register its submodules once \
         `src/foo.rs` is the tie-break winner — otherwise \
         `use beta::T;` inside `foo.rs` false-resolves to \
         `{stale_phantom}`. dispatch callees: {:?}",
        callees_of(&graph, dispatch),
    );
}

#[test]
fn absolute_use_alias_does_not_re_canonicalise_to_workspace() {
    // `use ::ext::A as Local;` is a Rust 2018+ absolute path. The
    // leading colon says: "this is the extern-crate `ext`, not our
    // workspace's `ext`." So `Local::m()` must NOT silently route to
    // `crate::ext::A::m` even when a same-named workspace module
    // exists.
    //
    // The bug: `gather_alias_map` / `gather_alias_map_scoped` only
    // pass `u.tree` into `collect_alias_entries`, dropping
    // `u.leading_colon`. The use-site canonicaliser then treats the
    // alias as relative, and `normalize_after_alias` happily prepends
    // `crate::` once it spots `ext` as a workspace top-level module.
    // Result: a false workspace edge to a symbol that the program
    // never actually addressed.
    let ws = build_workspace(&[
        ("src/lib.rs", "pub mod ext;\npub mod app;\n"),
        (
            "src/ext.rs",
            r#"
            pub struct A;
            impl A { pub fn m() {} }
            "#,
        ),
        (
            "src/app.rs",
            r#"
            // Absolute path — refers to the extern crate `ext`, NOT
            // the workspace's `crate::ext`.
            use ::ext::A as Local;
            pub fn dispatch() { Local::m(); }
            "#,
        ),
    ]);
    let graph = build_graph_only(&ws, &three_layer(), &empty_cfg_test(), &HashSet::new());
    let dispatch = "crate::app::dispatch";
    let workspace_phantom = "crate::ext::A::m";
    assert!(
        !graph_contains_edge(&graph, dispatch, workspace_phantom),
        "`use ::ext::A as Local;` is an extern-rooted import (the \
         leading `::` means extern crate `ext`, not the workspace's \
         `crate::ext`). `Local::m()` must NOT route to \
         `{workspace_phantom}` even when a same-named workspace \
         module exists. dispatch callees: {:?}",
        callees_of(&graph, dispatch),
    );
}

#[test]
fn file_rs_wins_over_dir_mod_rs_when_both_back_the_same_module_path() {
    // Stale-leftover scenario: both `src/foo.rs` and `src/foo/mod.rs`
    // exist in the workspace (e.g. after a refactor that switched
    // legacy `mod.rs` style to single-file style but forgot to delete
    // the old file). `file_to_module_segments` maps both paths to
    // `["foo"]`, so the `segs_to_path` lookup in
    // `collect_workspace_module_paths` saw a collision and silently
    // kept whichever entry happened to land last in iteration order.
    // Whichever AST won determined which submodule declarations got
    // registered — driving non-deterministic graph results and
    // dropped call edges when the "wrong" file's submodules were
    // walked.
    //
    // After the fix, `foo.rs` deterministically wins (matches modern
    // Rust precedence), so `mod alpha;` declared in `foo.rs` always
    // ends up in `workspace_module_paths` and the sibling-submodule
    // discriminator routes `use alpha::Local;` correctly.
    //
    // Test ordering: putting `foo/mod.rs` AFTER `foo.rs` in the input
    // slice reproduces the bug deterministically — the later insert
    // wins the HashMap collision in the buggy code.
    let ws = build_workspace(&[
        ("src/lib.rs", "pub mod foo;\n"),
        (
            "src/foo.rs",
            r#"
            pub mod alpha;
            use alpha::Local;
            pub fn dispatch() { Local::run(); }
            "#,
        ),
        (
            "src/foo/alpha.rs",
            r#"
            pub struct Local;
            impl Local { pub fn run() {} }
            "#,
        ),
        // Stale leftover from a legacy mod.rs layout. Declares a
        // *different* submodule. Must NOT shadow `foo.rs`.
        ("src/foo/mod.rs", "pub mod beta;\n"),
        ("src/foo/beta.rs", "pub fn unused() {}\n"),
    ]);
    let graph = build_graph_only(&ws, &three_layer(), &empty_cfg_test(), &HashSet::new());
    let dispatch = "crate::foo::dispatch";
    let target = "crate::foo::alpha::Local::run";
    assert!(
        graph_contains_edge(&graph, dispatch, target),
        "when both `src/foo.rs` and `src/foo/mod.rs` exist, the analyser \
         must deterministically prefer `foo.rs` (Rust 2018+ convention) \
         and walk its declared submodules. `use alpha::Local;` inside \
         `foo.rs` must resolve to `{target}`. dispatch callees: {:?}",
        callees_of(&graph, dispatch),
    );
}