Merge pull request #17841 from github/redsun82/rust-fix-qltest-macos

Rust: fix qltest on macOS, and add CI cross-platform testing of it

rust/ql/integration-tests/qltest/failing_cargo_check/does_not_compile.rs

@@ -0,0 +1,5 @@
+fn foo() {
+    wat
+    is
+    this?
+}

rust/ql/integration-tests/qltest/failing_cargo_check/functions.ql

@@ -0,0 +1,5 @@
+import rust
+
+from Function f
+where exists(f.getLocation().getFile().getRelativePath())
+select f

rust/ql/integration-tests/qltest/failing_cargo_check/options

@@ -0,0 +1 @@
+qltest_cargo_check: true

rust/ql/integration-tests/qltest/lib/functions.expected

@@ -0,0 +1 @@
+| test.rs:1:1:1:11 | foo |

rust/ql/integration-tests/qltest/lib/functions.ql

@@ -0,0 +1,5 @@
+import rust
+
+from Function f
+where exists(f.getLocation().getFile().getRelativePath())
+select f

rust/ql/integration-tests/qltest/lib/test.rs

@@ -0,0 +1 @@
+fn foo() {}

rust/ql/integration-tests/qltest/main/functions.expected

@@ -0,0 +1,2 @@
+| main.rs:1:1:1:12 | main |
+| test.rs:1:1:1:11 | foo |

rust/ql/integration-tests/qltest/main/functions.ql

@@ -0,0 +1,5 @@
+import rust
+
+from Function f
+where exists(f.getLocation().getFile().getRelativePath())
+select f

rust/ql/integration-tests/qltest/main/main.rs

@@ -0,0 +1 @@
+fn main() {}

rust/ql/integration-tests/qltest/main/test.rs

@@ -0,0 +1 @@
+fn foo() {}

rust/ql/integration-tests/qltest/qlpack.yml

@@ -0,0 +1,5 @@
+dependencies:
+  codeql/rust-queries: '*'
+  codeql/rust-all: '*'
+extractor: rust
+warnOnImplicitThis: true

rust/ql/integration-tests/qltest/test.py

@@ -0,0 +1,17 @@
+import runs_on
+# these tests are meant to exercise QL test running on multiple platforms
+# therefore they don't rely on integration test built-in QL test running
+# (which skips `qltest.{sh,cmd}`)
+
+def test_lib(codeql, rust, cwd):
+    codeql.test.run("lib", threads=1)
+
+def test_main(codeql, rust):
+    codeql.test.run("main", threads=1)
+
+def test_failing_cargo_check(codeql, rust):
+    out = codeql.test.run("failing_cargo_check", threads=1, show_extractor_output=True,
+                          _assert_failure=True, _capture="stderr")
+    # TODO: QL test output redirection is currently broken on windows, leaving it up for follow-up work
+    if not runs_on.windows:
+        assert "requested cargo check failed" in out

rust/tools/qltest.cmd

@@ -3,7 +3,7 @@
 set "RUST_BACKTRACE=full"
 set "QLTEST_LOG=%CODEQL_EXTRACTOR_RUST_LOG_DIR%/qltest.log"
 
-type NUL && "%CODEQL_EXTRACTOR_RUST_ROOT%/tools/%CODEQL_PLATFORM%/extractor" --qltest >"%QLTEST_LOG%"
+type NUL && "%CODEQL_EXTRACTOR_RUST_ROOT%/tools/%CODEQL_PLATFORM%/extractor" --qltest >"%QLTEST_LOG%" 2>&1
 
 if %ERRORLEVEL% neq 0 (
     type "%QLTEST_LOG%"

rust/tools/qltest.sh

@@ -4,7 +4,7 @@ set -eu
 
 export RUST_BACKTRACE=full
 QLTEST_LOG="$CODEQL_EXTRACTOR_RUST_LOG_DIR"/qltest.log
-if ! "$CODEQL_EXTRACTOR_RUST_ROOT/tools/$CODEQL_PLATFORM/extractor" --qltest &>> "$QLTEST_LOG"; then
+if ! "$CODEQL_EXTRACTOR_RUST_ROOT/tools/$CODEQL_PLATFORM/extractor" --qltest >> "$QLTEST_LOG" 2>&1; then
   cat "$QLTEST_LOG"
   exit 1
 fi