Swift: add tests for RUN_UNDER support

redsun82 · redsun82 · commit 3acd4486a395 · 2022-11-02T12:09:13.000+01:00
While I would have preferred to add a proper unit test, this required
more infrastructure for mocking system calls. Instead I made `qltest.sh`
accept a `//codeql-extractor-env` header and used that to write a QL
test exercising the `RUN_UNDER` functionality.
diff --git a/swift/ql/test/extractor-tests/run_under/Strings.expected b/swift/ql/test/extractor-tests/run_under/Strings.expected
@@ -0,0 +1,2 @@
+| run_under: $CODEQL_EXTRACTOR_SWIFT_ROOT/tools/$CODEQL_PLATFORM/extractor -sdk $CODEQL_EXTRACTOR_SWIFT_ROOT/qltest/$CODEQL_PLATFORM/sdk -c -primary-file filtered_in.swift |
+| run_under: $CODEQL_EXTRACTOR_SWIFT_ROOT/tools/$CODEQL_PLATFORM/extractor -sdk $CODEQL_EXTRACTOR_SWIFT_ROOT/qltest/$CODEQL_PLATFORM/sdk -c -primary-file unfiltered.swift |
diff --git a/swift/ql/test/extractor-tests/run_under/Strings.ql b/swift/ql/test/extractor-tests/run_under/Strings.ql
@@ -0,0 +1,4 @@
+import swift
+
+from StringLiteralExpr s
+select s.getValue()
diff --git a/swift/ql/test/extractor-tests/run_under/filtered_in.swift b/swift/ql/test/extractor-tests/run_under/filtered_in.swift
@@ -0,0 +1 @@
+//codeql-extractor-env: CODEQL_EXTRACTOR_SWIFT_RUN_UNDER=./run_under.sh CODEQL_EXTRACTOR_SWIFT_RUN_UNDER_FILTER=filtered_in\.swift
diff --git a/swift/ql/test/extractor-tests/run_under/filtered_out.swift b/swift/ql/test/extractor-tests/run_under/filtered_out.swift
@@ -0,0 +1 @@
+//codeql-extractor-env: CODEQL_EXTRACTOR_SWIFT_RUN_UNDER=./run_under.sh CODEQL_EXTRACTOR_SWIFT_RUN_UNDER_FILTER=filtered_in\.swift
diff --git a/swift/ql/test/extractor-tests/run_under/normal.swift b/swift/ql/test/extractor-tests/run_under/normal.swift
diff --git a/swift/ql/test/extractor-tests/run_under/run_under.sh b/swift/ql/test/extractor-tests/run_under/run_under.sh
@@ -0,0 +1,7 @@
+ARGS=$(echo $@ | sed 's='$CODEQL_EXTRACTOR_SWIFT_ROOT'=$CODEQL_EXTRACTOR_SWIFT_ROOT=g; s/'$CODEQL_PLATFORM'/$CODEQL_PLATFORM/g')
+
+cat > $CODEQL_EXTRACTOR_SWIFT_TRAP_DIR/$$.trap << EOF
+string_literal_exprs(*, "run_under: $ARGS")
+EOF
+
+"$@"
diff --git a/swift/ql/test/extractor-tests/run_under/unfiltered.swift b/swift/ql/test/extractor-tests/run_under/unfiltered.swift
@@ -0,0 +1 @@
+//codeql-extractor-env: CODEQL_EXTRACTOR_SWIFT_RUN_UNDER=./run_under.sh
diff --git a/swift/tools/qltest.sh b/swift/tools/qltest.sh
@@ -10,10 +10,12 @@ EXTRACTOR="$CODEQL_EXTRACTOR_SWIFT_ROOT/tools/$CODEQL_PLATFORM/extractor"
 SDK="$CODEQL_EXTRACTOR_SWIFT_ROOT/qltest/$CODEQL_PLATFORM/sdk"
 
 for src in *.swift; do
+  env=()
   opts=(-sdk "$SDK" -c -primary-file "$src")
   opts+=($(sed -n '1 s=//codeql-extractor-options:==p' $src))
+  env+=($(sed -n '1 s=//codeql-extractor-env:==p' $src))
   echo -e "calling extractor with flags: ${opts[@]}\n" >> $QLTEST_LOG
-  if ! "$EXTRACTOR" "${opts[@]}" >> $QLTEST_LOG 2>&1; then
+  if ! env "${env[@]}" "$EXTRACTOR" "${opts[@]}" >> $QLTEST_LOG 2>&1; then
     FAILED=1
   fi
 done
diff --git a/swift/tools/test/qltest/extractor_env/a.swift b/swift/tools/test/qltest/extractor_env/a.swift
@@ -0,0 +1 @@
+//codeql-extractor-env: VAR1=foo
diff --git a/swift/tools/test/qltest/extractor_env/b.swift b/swift/tools/test/qltest/extractor_env/b.swift
@@ -0,0 +1 @@
+//codeql-extractor-env: VAR1=bar VAR2=baz
diff --git a/swift/tools/test/qltest/extractor_env/test.py b/swift/tools/test/qltest/extractor_env/test.py
@@ -0,0 +1,16 @@
+from swift.tools.test.qltest.utils import *
+
+set_dummy_extractor('''
+set -x
+
+if [[ " $@ " =~ a.swift ]]; then 
+    [[ "$VAR1" == "foo" && "$VAR2" == "" ]] || exit 1
+elif [[ " $@ " =~ b.swift ]]; then
+    [[ "$VAR1" == "bar" && "$VAR2" == "baz" ]] || exit 1
+fi
+''')
+run_qltest()
+assert_extractor_executed_with(
+    "a.swift",
+    "b.swift",
+)
diff --git a/swift/tools/test/qltest/utils.py b/swift/tools/test/qltest/utils.py
@@ -65,4 +65,4 @@ def assert_extractor_executed_with(*flags):
                 actual = actual[len(expected_prefix):]
             assert actual, f"\nnot encountered: {expected}"
             assert expected, f"\nunexpected: {actual}"
-            assert actual == expected, f"\nexpecting: {actual}\ngot:       {expected}"
+            assert actual == expected, f"\nexpecting: {expected}\ngot:       {actual}"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+\| run_under: $CODEQL_EXTRACTOR_SWIFT_ROOT/tools/$CODEQL_PLATFORM/extractor -sdk $CODEQL_EXTRACTOR_SWIFT_ROOT/qltest/$CODEQL_PLATFORM/sdk -c -primary-file filtered_in.swift \|`
	`2`	`+\| run_under: $CODEQL_EXTRACTOR_SWIFT_ROOT/tools/$CODEQL_PLATFORM/extractor -sdk $CODEQL_EXTRACTOR_SWIFT_ROOT/qltest/$CODEQL_PLATFORM/sdk -c -primary-file unfiltered.swift \|`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+//codeql-extractor-env: CODEQL_EXTRACTOR_SWIFT_RUN_UNDER=./run_under.sh CODEQL_EXTRACTOR_SWIFT_RUN_UNDER_FILTER=filtered_in\.swift`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+//codeql-extractor-env: VAR1=bar VAR2=baz`