Swift: prepare integration tests for internal running

codeql-workspace.yml

@@ -28,7 +28,6 @@ provide:
   - "misc/suite-helpers/qlpack.yml"
   - "ruby/extractor-pack/codeql-extractor.yml"
   - "swift/extractor-pack/codeql-extractor.yml"
-  - "swift/integration-tests/qlpack.yml"
   - "ql/extractor-pack/codeql-extractor.yml"
   - ".github/codeql/extensions/**/codeql-pack.yml"
 

swift/.python-version

@@ -1 +1 @@
-3.8.14
+3.11

swift/actions/run-integration-tests/action.yml

@@ -18,7 +18,7 @@ runs:
     - name: Run integration tests
       shell: bash
       run: |
-        python swift/integration-tests/runner.py --compilation-cache "${{ steps.query-cache.outputs.cache-dir }}"
+        python swift/ql/integration-tests/runner.py --compilation-cache "${{ steps.query-cache.outputs.cache-dir }}"
       env:
         SEMMLE_DEBUG_TRACER: 10000
     - name: Upload test logs
@@ -27,5 +27,5 @@ runs:
       with:
         name: swift-integration-tests-logs-${{ runner.os }}
         path: |
-          swift/integration-tests/**/db/log
+          swift/ql/integration-tests/**/db/log
         retention-days: 1

swift/logging/tests/assertion-diagnostics/BUILD.bazel

@@ -17,5 +17,5 @@ py_test(
         "diagnostics.expected",
         ":assert-false",
     ],
-    deps = ["//swift/integration-tests:integration_tests"],
+    deps = ["//swift/ql/integration-tests:utils"],
 )

swift/logging/tests/assertion-diagnostics/test.py

@@ -2,7 +2,7 @@
 import os
 import subprocess
 # We have to use importlib due to the '-' in the path
-diagnostics_test_utils = importlib.import_module("swift.integration-tests.diagnostics_test_utils")
+diagnostics_test_utils = importlib.import_module("swift.ql.integration-tests.diagnostics_test_utils")
 
 test_dir = "swift/logging/tests/assertion-diagnostics"
 

swift/integration-tests/.gitignore → swift/ql/integration-tests/.gitignore

@@ -6,5 +6,5 @@ xcuserdata/
 DerivedData/
 .swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
 *.actual
-db
+test-db
 *.swiftmodule

swift/integration-tests/BUILD.bazel → swift/ql/integration-tests/BUILD.bazel

@@ -1,5 +1,5 @@
 py_library(
-    name = "integration_tests",
+    name = "utils",
     srcs = [
         "create_database_utils.py",
         "diagnostics_test_utils.py",

swift/integration-tests/create_database_utils.py → swift/ql/integration-tests/create_database_utils.py

@@ -27,8 +27,8 @@ def runUnsuccessfully(cmd):
 def run_codeql_database_create(cmds, lang, keep_trap=True, db=None, runFunction=runSuccessfully):
     """ db parameter is here solely for compatibility with the internal test runner """
     assert lang == 'swift'
-    codeql_root = pathlib.Path(__file__).parents[2]
-    shutil.rmtree("db", ignore_errors=True)
+    codeql_root = pathlib.Path(__file__).parents[3]
+    shutil.rmtree("test-db", ignore_errors=True)
     cmd = [
         "codeql", "database", "create",
         "-s", ".", "-l", "swift", f"--search-path={codeql_root}", "--no-cleanup",
@@ -37,5 +37,5 @@ def run_codeql_database_create(cmds, lang, keep_trap=True, db=None, runFunction=
         cmd.append("--keep-trap")
     for c in cmds:
         cmd += ["-c", c]
-    cmd.append("db")
+    cmd.append("test-db")
     runFunction(cmd)

swift/integration-tests/diagnostics_test_utils.py → swift/ql/integration-tests/diagnostics_test_utils.py

@@ -50,7 +50,7 @@ def _normalize_json(data):
     return "\n".join(entries)
 
 
-def check_diagnostics(test_dir=".", test_db="db", actual = None):
+def check_diagnostics(test_dir=".", test_db="test-db", actual = None):
     test_dir = pathlib.Path(test_dir)
     test_db = pathlib.Path(test_db)
     if actual is None:

swift/ql/integration-tests/posix-only/deduplication/Relevant.qll

@@ -0,0 +1,5 @@
+import swift
+
+predicate relevant(Locatable loc) {
+  loc.getLocation().getFile().getName().matches("%/swift/ql/integration-tests/%/Sources/%")
+}

swift/integration-tests/posix-only/frontend-invocations/test.py → swift/ql/integration-tests/posix-only/frontend-invocations/test.py

@@ -5,15 +5,16 @@
 
 run_codeql_database_create([
     './build.sh',
-], lang='swift')
+], lang='swift',
+)
 
 with open('hashes.expected', 'w') as expected:
     for f in sorted(Path().glob("*.swiftmodule")):
         with open(f, 'rb') as module:
             print(f.name, sha256(module.read()).hexdigest(), file=expected)
 
 with open('hashes.actual', 'w') as actual:
-    hashes = [(s.name, s.resolve().name) for s in Path("db/working/swift-extraction-artifacts/store").iterdir()]
+    hashes = [(s.name, s.resolve().name) for s in Path("test-db/working/swift-extraction-artifacts/store").iterdir()]
     hashes.sort()
     for module, hash in hashes:
         print(module, hash, file=actual)

swift/ql/integration-tests/qlpack.yml

@@ -0,0 +1,4 @@
+dependencies:
+  codeql/swift-all: '*'
+  codeql/swift-queries: '*'
+warnOnImplicitThis: true

swift/integration-tests/runner.py → swift/ql/integration-tests/runner.py

@@ -17,6 +17,7 @@
 import platform
 
 this_dir = pathlib.Path(__file__).parent.resolve()
+codeql_root = this_dir.parents[2]
 
 def options():
     p = argparse.ArgumentParser()
@@ -30,7 +31,7 @@ def options():
 
 
 def execute_test(path):
-    shutil.rmtree(path.parent / "db", ignore_errors=True)
+    shutil.rmtree(path.parent / "test-db", ignore_errors=True)
     return subprocess.run([sys.executable, "-u", path.name], cwd=path.parent).returncode == 0
 
 def skipped(test):
@@ -51,18 +52,18 @@ def main(opts):
         return False
 
     os.environ["PYTHONPATH"] = str(this_dir)
+    os.environ["CODEQL_CONFIG_FILE"] = "/dev/null"
     failed_db_creation = []
     succesful_db_creation = []
     for t in tests:
         (succesful_db_creation if execute_test(t) else failed_db_creation).append(t)
 
     if succesful_db_creation:
-        codeql_root = this_dir.parents[1]
         cmd = [
             "codeql", "test", "run",
             f"--additional-packs={codeql_root}",
             "--keep-databases",
-            "--dataset=db/db-swift",
+            "--dataset=test-db/db-swift",
             f"--threads={opts.threads}",
         ]
         if opts.check_databases: