Merge pull request #19600 from github/redsun82/rust-new-macro-expansion-integration-test

redsun82 · web-flow · commit 7d1a38f42a51 · 2025-05-28T17:19:06.000+02:00
Rust: add more macro expansion tests
diff --git a/rust/ql/integration-tests/.gitignore b/rust/ql/integration-tests/.gitignore
@@ -1 +1,2 @@
 target/
+Cargo.lock
diff --git a/rust/ql/integration-tests/macro-expansion/Cargo.lock b/rust/ql/integration-tests/macro-expansion/Cargo.lock
diff --git a/rust/ql/integration-tests/macro-expansion/Cargo.toml b/rust/ql/integration-tests/macro-expansion/Cargo.toml
@@ -1,11 +1,3 @@
 [workspace]
-members = ["macros"]
+members = [ "attributes", "calls", "proc_macros"]
 resolver = "2"
-
-[package]
-name = "macro_expansion"
-version = "0.1.0"
-edition = "2024"
-
-[dependencies]
-macros = { path = "macros" }
diff --git a/rust/ql/integration-tests/macro-expansion/attributes/Cargo.toml b/rust/ql/integration-tests/macro-expansion/attributes/Cargo.toml
@@ -0,0 +1,7 @@
+[package]
+name = "attributes"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+proc_macros = { path = "../proc_macros" }
diff --git a/rust/ql/integration-tests/macro-expansion/attributes/src/lib.rs b/rust/ql/integration-tests/macro-expansion/attributes/src/lib.rs
@@ -1,8 +1,8 @@
-use macros::repeat;
+use proc_macros::repeat;
 
 #[repeat(3)]
 fn foo() {
-    println!("Hello, world!");
+    _ = concat!("Hello ", "world!");
 
     #[repeat(2)]
     fn inner() {}
diff --git a/rust/ql/integration-tests/macro-expansion/calls/Cargo.toml b/rust/ql/integration-tests/macro-expansion/calls/Cargo.toml
@@ -0,0 +1,6 @@
+[package]
+name = "calls"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
diff --git a/rust/ql/integration-tests/macro-expansion/calls/src/included.rs b/rust/ql/integration-tests/macro-expansion/calls/src/included.rs
@@ -0,0 +1,3 @@
+fn included() {
+    _ = concat!("Hello", " ", "world!");  // this doesn't expand (in included.rs) since 0.0.274
+}
diff --git a/rust/ql/integration-tests/macro-expansion/calls/src/lib.rs b/rust/ql/integration-tests/macro-expansion/calls/src/lib.rs
@@ -0,0 +1,30 @@
+struct S;
+
+macro_rules! def_x {
+    () => {
+        fn x() {}
+    };
+}
+
+impl S {
+    def_x!();  // this doesn't expand since 0.0.274
+}
+
+macro_rules! my_macro {
+    ($head:expr, $($tail:tt)*) => { format!($head, $($tail)*) };
+}
+
+
+fn test() {
+    _ = concat!("x", "y");
+
+    _ = my_macro!(
+        concat!("<", "{}", ">"),  // this doesn't expand since 0.0.274
+        "hi",
+    );
+}
+
+include!("included.rs");
+
+#[doc = include_str!("some.txt")]  // this doesn't expand since 0.0.274
+fn documented() {}
diff --git a/rust/ql/integration-tests/macro-expansion/calls/src/some.txt b/rust/ql/integration-tests/macro-expansion/calls/src/some.txt
@@ -0,0 +1 @@
+Hey!
diff --git a/rust/ql/integration-tests/macro-expansion/diagnostics.expected b/rust/ql/integration-tests/macro-expansion/diagnostics.expected
@@ -38,7 +38,7 @@
         "pretty": "__REDACTED__"
       }
     },
-    "numberOfFiles": 2,
+    "numberOfFiles": 4,
     "numberOfManifests": 1
   },
   "severity": "note",
diff --git a/rust/ql/integration-tests/macro-expansion/proc_macros/Cargo.toml b/rust/ql/integration-tests/macro-expansion/proc_macros/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "macros"
+name = "proc_macros"
 version = "0.1.0"
 edition = "2024"
 
diff --git a/rust/ql/integration-tests/macro-expansion/proc_macros/src/lib.rs b/rust/ql/integration-tests/macro-expansion/proc_macros/src/lib.rs
diff --git a/rust/ql/integration-tests/macro-expansion/source_archive.expected b/rust/ql/integration-tests/macro-expansion/source_archive.expected
@@ -1,2 +1,4 @@
-macros/src/lib.rs
-src/lib.rs
+attributes/src/lib.rs
+calls/src/included.rs
+calls/src/lib.rs
+proc_macros/src/lib.rs
diff --git a/rust/ql/integration-tests/macro-expansion/summary.expected b/rust/ql/integration-tests/macro-expansion/summary.expected
diff --git a/rust/ql/integration-tests/macro-expansion/summary.qlref b/rust/ql/integration-tests/macro-expansion/summary.qlref
diff --git a/rust/ql/integration-tests/macro-expansion/test.expected b/rust/ql/integration-tests/macro-expansion/test.expected
@@ -1,17 +1,34 @@
-| src/lib.rs:3:1:9:1 | fn foo | 0 | src/lib.rs:4:1:8:16 | fn foo_0 |
-| src/lib.rs:3:1:9:1 | fn foo | 1 | src/lib.rs:4:1:8:16 | fn foo_1 |
-| src/lib.rs:3:1:9:1 | fn foo | 2 | src/lib.rs:4:1:8:16 | fn foo_2 |
-| src/lib.rs:7:5:8:16 | fn inner | 0 | src/lib.rs:8:5:8:16 | fn inner_0 |
-| src/lib.rs:7:5:8:16 | fn inner | 0 | src/lib.rs:8:5:8:16 | fn inner_0 |
-| src/lib.rs:7:5:8:16 | fn inner | 0 | src/lib.rs:8:5:8:16 | fn inner_0 |
-| src/lib.rs:7:5:8:16 | fn inner | 1 | src/lib.rs:8:5:8:16 | fn inner_1 |
-| src/lib.rs:7:5:8:16 | fn inner | 1 | src/lib.rs:8:5:8:16 | fn inner_1 |
-| src/lib.rs:7:5:8:16 | fn inner | 1 | src/lib.rs:8:5:8:16 | fn inner_1 |
-| src/lib.rs:11:1:13:11 | fn bar | 0 | src/lib.rs:12:1:13:10 | fn bar_0 |
-| src/lib.rs:11:1:13:11 | fn bar | 1 | src/lib.rs:12:1:13:10 | fn bar_1 |
-| src/lib.rs:12:1:13:10 | fn bar_0 | 0 | src/lib.rs:13:1:13:10 | fn bar_0_0 |
-| src/lib.rs:12:1:13:10 | fn bar_0 | 1 | src/lib.rs:13:1:13:10 | fn bar_0_1 |
-| src/lib.rs:12:1:13:10 | fn bar_0 | 2 | src/lib.rs:13:1:13:10 | fn bar_0_2 |
-| src/lib.rs:12:1:13:10 | fn bar_1 | 0 | src/lib.rs:13:1:13:10 | fn bar_1_0 |
-| src/lib.rs:12:1:13:10 | fn bar_1 | 1 | src/lib.rs:13:1:13:10 | fn bar_1_1 |
-| src/lib.rs:12:1:13:10 | fn bar_1 | 2 | src/lib.rs:13:1:13:10 | fn bar_1_2 |
+attribute_macros
+| attributes/src/lib.rs:3:1:9:1 | fn foo | 0 | attributes/src/lib.rs:4:1:8:16 | fn foo_0 |
+| attributes/src/lib.rs:3:1:9:1 | fn foo | 1 | attributes/src/lib.rs:4:1:8:16 | fn foo_1 |
+| attributes/src/lib.rs:3:1:9:1 | fn foo | 2 | attributes/src/lib.rs:4:1:8:16 | fn foo_2 |
+| attributes/src/lib.rs:7:5:8:16 | fn inner | 0 | attributes/src/lib.rs:8:5:8:16 | fn inner_0 |
+| attributes/src/lib.rs:7:5:8:16 | fn inner | 0 | attributes/src/lib.rs:8:5:8:16 | fn inner_0 |
+| attributes/src/lib.rs:7:5:8:16 | fn inner | 0 | attributes/src/lib.rs:8:5:8:16 | fn inner_0 |
+| attributes/src/lib.rs:7:5:8:16 | fn inner | 1 | attributes/src/lib.rs:8:5:8:16 | fn inner_1 |
+| attributes/src/lib.rs:7:5:8:16 | fn inner | 1 | attributes/src/lib.rs:8:5:8:16 | fn inner_1 |
+| attributes/src/lib.rs:7:5:8:16 | fn inner | 1 | attributes/src/lib.rs:8:5:8:16 | fn inner_1 |
+| attributes/src/lib.rs:11:1:13:11 | fn bar | 0 | attributes/src/lib.rs:12:1:13:10 | fn bar_0 |
+| attributes/src/lib.rs:11:1:13:11 | fn bar | 1 | attributes/src/lib.rs:12:1:13:10 | fn bar_1 |
+| attributes/src/lib.rs:12:1:13:10 | fn bar_0 | 0 | attributes/src/lib.rs:13:1:13:10 | fn bar_0_0 |
+| attributes/src/lib.rs:12:1:13:10 | fn bar_0 | 1 | attributes/src/lib.rs:13:1:13:10 | fn bar_0_1 |
+| attributes/src/lib.rs:12:1:13:10 | fn bar_0 | 2 | attributes/src/lib.rs:13:1:13:10 | fn bar_0_2 |
+| attributes/src/lib.rs:12:1:13:10 | fn bar_1 | 0 | attributes/src/lib.rs:13:1:13:10 | fn bar_1_0 |
+| attributes/src/lib.rs:12:1:13:10 | fn bar_1 | 1 | attributes/src/lib.rs:13:1:13:10 | fn bar_1_1 |
+| attributes/src/lib.rs:12:1:13:10 | fn bar_1 | 2 | attributes/src/lib.rs:13:1:13:10 | fn bar_1_2 |
+macro_calls
+| attributes/src/lib.rs:5:9:5:34 | concat!... | attributes/src/lib.rs:5:17:5:34 | "Hello world!" |
+| attributes/src/lib.rs:5:9:5:34 | concat!... | attributes/src/lib.rs:5:17:5:34 | "Hello world!" |
+| attributes/src/lib.rs:5:9:5:34 | concat!... | attributes/src/lib.rs:5:17:5:34 | "Hello world!" |
+| calls/src/included.rs:2:9:2:39 | concat!... | calls/src/included.rs:2:17:2:38 | "Hello world!" |
+| calls/src/lib.rs:10:5:10:13 | def_x!... | calls/src/lib.rs:10:5:10:13 | MacroItems |
+| calls/src/lib.rs:19:9:19:25 | concat!... | calls/src/lib.rs:19:17:19:24 | "xy" |
+| calls/src/lib.rs:21:9:24:5 | my_macro!... | calls/src/lib.rs:22:9:23:13 | MacroExpr |
+| calls/src/lib.rs:22:9:22:31 | concat!... | calls/src/lib.rs:22:17:22:30 | "<{}>" |
+| calls/src/lib.rs:22:9:23:13 | ...::format_args!... | calls/src/lib.rs:22:9:23:13 | FormatArgsExpr |
+| calls/src/lib.rs:22:9:23:13 | format!... | calls/src/lib.rs:22:9:23:13 | ...::must_use(...) |
+| calls/src/lib.rs:27:1:27:24 | concat!... | calls/src/lib.rs:27:1:27:24 | "Hello world!" |
+| calls/src/lib.rs:27:1:27:24 | include!... | calls/src/lib.rs:27:1:27:24 | MacroItems |
+| calls/src/lib.rs:29:9:29:32 | include_str!... | calls/src/lib.rs:29:22:29:31 | "" |
+unexpanded_macro_calls
+| attributes/src/lib.rs:5:9:5:35 | concat!... |
diff --git a/rust/ql/integration-tests/macro-expansion/test.ql b/rust/ql/integration-tests/macro-expansion/test.ql
@@ -1,5 +1,15 @@
 import rust
 
-from Item i, MacroItems items, int index, Item expanded
-where i.fromSource() and i.getAttributeMacroExpansion() = items and items.getItem(index) = expanded
-select i, index, expanded
+query predicate attribute_macros(Item i, int index, Item expanded) {
+  i.fromSource() and expanded = i.getAttributeMacroExpansion().getItem(index)
+}
+
+query predicate macro_calls(MacroCall c, AstNode expansion) {
+  c.fromSource() and
+  not c.getLocation().getFile().getAbsolutePath().matches("%proc_macros%") and
+  expansion = c.getMacroCallExpansion()
+}
+
+query predicate unexpanded_macro_calls(MacroCall c) {
+  c.fromSource() and not c.hasMacroCallExpansion()
+}
diff --git a/rust/ql/test/extractor-tests/generated/MacroCall/some.txt b/rust/ql/test/extractor-tests/generated/MacroCall/some.txt
@@ -0,0 +1 @@
+Hello!

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+fn included() {`
	`2`	`+ _ = concat!("Hello", " ", "world!"); // this doesn't expand (in included.rs) since 0.0.274`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@`
`38`	`38`	`"pretty": "__REDACTED__"`
`39`	`39`	`}`
`40`	`40`	`},`
`41`		`- "numberOfFiles": 2,`
	`41`	`+ "numberOfFiles": 4,`
`42`	`42`	`"numberOfManifests": 1`
`43`	`43`	`},`
`44`	`44`	`"severity": "note",`