Rust: add integration test for cargo options

Paolo Tranquilli · Paolo Tranquilli · commit a13c70bd11e9 · 2024-11-08T16:50:21.000+01:00
diff --git a/rust/ql/integration-tests/options/Cargo.toml b/rust/ql/integration-tests/options/Cargo.toml
@@ -0,0 +1,9 @@
+[workspace]
+[package]
+name = "options"
+version = "0.1.0"
+edition = "2021"
+
+[features]
+foo = []
+bar = []
diff --git a/rust/ql/integration-tests/options/arch_functions.Darwin.expected b/rust/ql/integration-tests/options/arch_functions.Darwin.expected
@@ -0,0 +1 @@
+| src/arch.rs:7:1:8:13 | macos |
diff --git a/rust/ql/integration-tests/options/arch_functions.Linux.expected b/rust/ql/integration-tests/options/arch_functions.Linux.expected
@@ -0,0 +1 @@
+| src/arch.rs:1:1:2:13 | linux |
diff --git a/rust/ql/integration-tests/options/arch_functions.Windows.expected b/rust/ql/integration-tests/options/arch_functions.Windows.expected
@@ -0,0 +1 @@
+| src/arch.rs:4:1:5:15 | windows |
diff --git a/rust/ql/integration-tests/options/arch_functions.ql b/rust/ql/integration-tests/options/arch_functions.ql
@@ -0,0 +1,5 @@
+import rust
+
+from Function f
+where f.getLocation().getFile().getBaseName() = "arch.rs" and f.hasExtendedCanonicalPath()
+select f
diff --git a/rust/ql/integration-tests/options/cfg_functions.expected b/rust/ql/integration-tests/options/cfg_functions.expected
@@ -0,0 +1,2 @@
+| src/cfg.rs:7:1:8:19 | cfg_no_flag |
+| src/cfg.rs:10:1:11:18 | cfg_no_key |
diff --git a/rust/ql/integration-tests/options/cfg_functions.override.expected b/rust/ql/integration-tests/options/cfg_functions.override.expected
@@ -0,0 +1,3 @@
+| src/cfg.rs:1:1:2:16 | cfg_flag |
+| src/cfg.rs:4:1:5:15 | cfg_key |
+| src/cfg.rs:13:1:14:15 | no_test |
diff --git a/rust/ql/integration-tests/options/cfg_functions.ql b/rust/ql/integration-tests/options/cfg_functions.ql
@@ -0,0 +1,5 @@
+import rust
+
+from Function f
+where f.getLocation().getFile().getBaseName() = "cfg.rs" and f.hasExtendedCanonicalPath()
+select f
diff --git a/rust/ql/integration-tests/options/feature_functions.all.expected b/rust/ql/integration-tests/options/feature_functions.all.expected
@@ -0,0 +1,3 @@
+| src/features.rs:1:1:2:11 | foo |
+| src/features.rs:4:1:5:11 | bar |
+| src/features.rs:7:1:7:14 | always |
diff --git a/rust/ql/integration-tests/options/feature_functions.bar.expected b/rust/ql/integration-tests/options/feature_functions.bar.expected
@@ -0,0 +1,2 @@
+| src/features.rs:4:1:5:11 | bar |
+| src/features.rs:7:1:7:14 | always |
diff --git a/rust/ql/integration-tests/options/feature_functions.expected b/rust/ql/integration-tests/options/feature_functions.expected
@@ -0,0 +1 @@
+| src/features.rs:7:1:7:14 | always |
diff --git a/rust/ql/integration-tests/options/feature_functions.foo.expected b/rust/ql/integration-tests/options/feature_functions.foo.expected
@@ -0,0 +1,2 @@
+| src/features.rs:1:1:2:11 | foo |
+| src/features.rs:7:1:7:14 | always |
diff --git a/rust/ql/integration-tests/options/feature_functions.ql b/rust/ql/integration-tests/options/feature_functions.ql
@@ -0,0 +1,5 @@
+import rust
+
+from Function f
+where f.getLocation().getFile().getBaseName() = "features.rs" and f.hasExtendedCanonicalPath()
+select f
diff --git a/rust/ql/integration-tests/options/src/arch.rs b/rust/ql/integration-tests/options/src/arch.rs
@@ -0,0 +1,8 @@
+#[cfg(target_os = "linux")]
+fn linux() {}
+
+#[cfg(target_os = "windows")]
+fn windows() {}
+
+#[cfg(target_os = "macos")]
+fn macos() {}
diff --git a/rust/ql/integration-tests/options/src/cfg.rs b/rust/ql/integration-tests/options/src/cfg.rs
@@ -0,0 +1,14 @@
+#[cfg(cfg_flag)]
+fn cfg_flag() {}
+
+#[cfg(cfg_key = "value")]
+fn cfg_key() {}
+
+#[cfg(not(cfg_flag))]
+fn cfg_no_flag() {}
+
+#[cfg(not(cfg_key = "value"))]
+fn cfg_no_key() {}
+
+#[cfg(not(test))]
+fn no_test() {}
diff --git a/rust/ql/integration-tests/options/src/features.rs b/rust/ql/integration-tests/options/src/features.rs
@@ -0,0 +1,7 @@
+#[cfg(feature = "foo")]
+fn foo() {}
+
+#[cfg(feature = "bar")]
+fn bar() {}
+
+fn always() {}
diff --git a/rust/ql/integration-tests/options/src/lib.rs b/rust/ql/integration-tests/options/src/lib.rs
@@ -0,0 +1,3 @@
+mod arch;
+mod features;
+mod cfg;
diff --git a/rust/ql/integration-tests/options/test_options.py b/rust/ql/integration-tests/options/test_options.py
@@ -0,0 +1,37 @@
+import pytest
+import platform
+import os
+
+
+@pytest.mark.ql_test("arch_functions.ql", expected=f".{platform.system()}.expected")
+def test_default(codeql, rust):
+    codeql.database.create()
+
+@pytest.mark.ql_test("arch_functions.ql", expected=".Windows.expected")
+def test_target_windows(codeql, rust):
+    codeql.database.create(extractor_option="cargo_target=x86_64-pc-windows-msvc")
+
+@pytest.mark.ql_test("arch_functions.ql", expected=".Darwin.expected")
+def test_target_macos(codeql, rust):
+    codeql.database.create(extractor_option="cargo_target=aarch64-apple-darwin")
+
+@pytest.mark.ql_test("arch_functions.ql", expected=".Linux.expected")
+def test_target_linux(codeql, rust):
+    codeql.database.create(extractor_option="cargo_target=x86_64-unknown-linux-gnu")
+
+@pytest.mark.ql_test("cfg_functions.ql", expected=".override.expected")
+@pytest.mark.ql_test("arch_functions.ql", expected=f".{platform.system()}.expected")
+def test_cfg_override(codeql, rust):
+    # currently codeql CLI has a limitation not allow to pass `=` in values via `--extractor-option`
+    os.environ["CODEQL_EXTRACTOR_RUST_OPTION_CARGO_CFG_OVERRIDES"] = "cfg_flag,cfg_key=value,-test"
+    codeql.database.create()
+
+@pytest.mark.ql_test("arch_functions.ql", expected=f".{platform.system()}.expected")
+@pytest.mark.parametrize("features",
+                         [
+                             pytest.param(p,
+                                          marks=pytest.mark.ql_test("feature_functions.ql", expected=f".{e}.expected"))
+                             for p, e in (("foo", "foo"), ("bar", "bar"), ("*", "all"), ("foo,bar", "all"))
+                         ])
+def test_features(codeql, rust, features):
+    codeql.database.create(extractor_option=f"cargo_features={features}")

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+\| src/cfg.rs:7:1:8:19 \| cfg_no_flag \|`
	`2`	`+\| src/cfg.rs:10:1:11:18 \| cfg_no_key \|`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+\| src/cfg.rs:1:1:2:16 \| cfg_flag \|`
	`2`	`+\| src/cfg.rs:4:1:5:15 \| cfg_key \|`
	`3`	`+\| src/cfg.rs:13:1:14:15 \| no_test \|`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+\| src/features.rs:1:1:2:11 \| foo \|`
	`2`	`+\| src/features.rs:4:1:5:11 \| bar \|`
	`3`	`+\| src/features.rs:7:1:7:14 \| always \|`