Merge pull request Calsign#41 from Calsign/calsignlabs/revup/main/test-only-modules

Handle discovery of test-only modules correctly

Author: Calsign

gazelle_rust_parser/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "gazelle_rust_parser"
 version = "0.1.0"
-edition = "2021"
+edition = "2024"
 license = "Apache-2.0"
 description = "Parse and extract imports from rust sources, used by the gazelle_rust build file generator"
 homepage = "https://github.com/Calsign/gazelle_rust/tree/main/gazelle_rust_parser"

gazelle_rust_parser/src/lib.rs

@@ -17,6 +17,7 @@ pub struct RustImports {
     pub imports: Vec<String>,
     pub test_imports: Vec<String>,
     pub extern_mods: Vec<String>,
+    pub test_extern_mods: Vec<String>,
     pub compile_data: Vec<String>,
 }
 
@@ -75,6 +76,7 @@ pub fn parse_imports_from_str(
         imports: filter_imports(root_scope.imports),
         test_imports: filter_imports(root_scope.test_imports),
         extern_mods: visitor.extern_mods.into_iter().collect(),
+        test_extern_mods: visitor.test_extern_mods.into_iter().collect(),
         compile_data: visitor.compile_data.into_iter().collect(),
     })
 }
@@ -205,6 +207,8 @@ struct AstVisitor<'ast> {
     hints: Hints,
     /// bare mods defined in external files
     extern_mods: HashSet<String>,
+    /// bare mods defined in external files that are declared behind `#[cfg(test)]`
+    test_extern_mods: HashSet<String>,
     /// mods that are disallowed from being added to the current scope; this is currently only used
     /// for a hack, see below
     mod_denylist: HashSet<Ident<'ast>>,
@@ -229,6 +233,7 @@ impl AstVisitor<'_> {
             scope_mods: HashSet::default(),
             hints: Hints::default(),
             extern_mods: HashSet::new(),
+            test_extern_mods: HashSet::new(),
             mod_denylist: HashSet::new(),
             enabled_features: enabled_features.iter().cloned().collect(),
             compile_data: HashSet::new(),
@@ -562,6 +567,7 @@ impl<'ast> AstVisitor<'ast> {
             self.mod_denylist.insert(id_copy);
         }
         self.extern_mods = other.extern_mods;
+        self.test_extern_mods = other.test_extern_mods;
         self.compile_data = other.compile_data;
         self.enabled_features = other.enabled_features;
         self.hints.has_main = other.hints.has_main;
@@ -725,8 +731,14 @@ impl<'ast> Visit<'ast> for AstVisitor<'ast> {
         }
 
         if self.is_root_scope() && node.content.is_none() {
+            let extern_mod = node.ident.unraw().to_string();
+
             // this mod is defined in a different file
-            self.extern_mods.insert(node.ident.unraw().to_string());
+            if is_test_only {
+                self.test_extern_mods.insert(extern_mod);
+            } else {
+                self.extern_mods.insert(extern_mod);
+            }
         }
 
         self.add_mod(&node.ident);

gazelle_rust_parser/test_data/test_only.rs

@@ -13,6 +13,9 @@ fn foobar_test(arg: f::X) {
     use a;
 }
 
+#[cfg(test)]
+mod test_extern_mod;
+
 #[cfg(test)]
 mod tests {
     use c;

gazelle_rust_parser/tests/parse_test.rs

@@ -8,6 +8,7 @@ struct TestCase {
     expected_imports: Vec<&'static str>,
     expected_test_imports: Vec<&'static str>,
     expected_extern_mods: Vec<&'static str>,
+    expected_test_extern_mods: Vec<&'static str>,
     expected_compile_data: Vec<&'static str>,
 }
 
@@ -46,6 +47,7 @@ lazy_static::lazy_static! {
             ],
             expected_test_imports: vec![],
             expected_extern_mods: vec!["extern_mod"],
+            expected_test_extern_mods: vec![],
             expected_compile_data: vec![
                 "file1.txt",
                 "file2.txt",
@@ -66,6 +68,7 @@ lazy_static::lazy_static! {
                 "f",
             ],
             expected_extern_mods: vec![],
+            expected_test_extern_mods: vec!["test_extern_mod"],
             expected_compile_data: vec![],
         },
         TestCase {
@@ -74,6 +77,7 @@ lazy_static::lazy_static! {
             expected_imports: vec!["ee"],
             expected_test_imports: vec![],
             expected_extern_mods: vec![],
+            expected_test_extern_mods: vec![],
             expected_compile_data: vec![],
         },
         TestCase {
@@ -90,6 +94,7 @@ lazy_static::lazy_static! {
             expected_extern_mods: vec![
                 "extern_mod_2",
             ],
+            expected_test_extern_mods: vec![],
             expected_compile_data: vec![],
         },
         TestCase {
@@ -105,6 +110,7 @@ lazy_static::lazy_static! {
             ],
             expected_test_imports: vec![],
             expected_extern_mods: vec![],
+            expected_test_extern_mods: vec![],
             expected_compile_data: vec![
                 "file1.txt",
                 "file2.txt",
@@ -134,6 +140,7 @@ lazy_static::lazy_static! {
                 "async_std_timeout_dep",
             ],
             expected_extern_mods: vec![],
+            expected_test_extern_mods: vec![],
             expected_compile_data: vec![],
         },
         TestCase {
@@ -142,6 +149,7 @@ lazy_static::lazy_static! {
             expected_imports: vec!["gazelle"],
             expected_test_imports: vec![],
             expected_extern_mods: vec![],
+            expected_test_extern_mods: vec![],
             expected_compile_data: vec![],
         },
     ];
@@ -224,6 +232,15 @@ fn parse_test() -> Result<(), Box<dyn Error>> {
                 .collect::<Vec<_>>(),
             "extern_modes",
         );
+        assert_eq_vecs(
+            &rust_imports.test_extern_mods,
+            &test_case
+                .expected_test_extern_mods
+                .iter()
+                .map(|s| s.to_string())
+                .collect::<Vec<_>>(),
+            "test_extern_mods",
+        );
         assert_eq_vecs(
             &rust_imports.compile_data,
             &test_case

generation_tests/cargo/test_only_modules/BUILD.in

@@ -0,0 +1 @@
+# gazelle:rust_mode generate_from_cargo

generation_tests/cargo/test_only_modules/BUILD.out

@@ -0,0 +1 @@
+# gazelle:rust_mode generate_from_cargo

generation_tests/cargo/test_only_modules/Cargo.toml

@@ -0,0 +1,6 @@
+[workspace]
+
+members = [
+    "helper",
+    "subject",
+]

generation_tests/cargo/test_only_modules/README.md

@@ -0,0 +1,3 @@
+
+Test that a module declared #[cfg(test)] contributes its imports to the crate test target
+rather than to the library.

generation_tests/cargo/test_only_modules/WORKSPACE

@@ -0,0 +1,9 @@
+load("@rules_rust//rust:defs.bzl", "rust_library")
+
+rust_library(
+    name = "helper",
+    srcs = ["src/lib.rs"],
+    compile_data = ["Cargo.toml"],
+    edition = "2021",
+    visibility = ["//visibility:public"],
+)