Just: introduce common verbs

.github/workflows/python-tooling.yml

@@ -5,9 +5,10 @@ on:
     paths:
       - "misc/bazel/**"
       - "misc/codegen/**"
+      - "misc/just/**"
       - "misc/scripts/models-as-data/*.py"
       - "*.bazel*"
-      - .github/workflows/codegen.yml
+      - .github/workflows/python-tooling.yml
       - .pre-commit-config.yaml
     branches:
       - main
@@ -33,3 +34,7 @@ jobs:
         shell: bash
         run: |
           bazel test //misc/codegen/...
+      - name: Run just tooling tests
+        shell: bash
+        run: |
+          bazel test //misc/just/...

actions/justfile

@@ -0,0 +1,9 @@
+import '../lib.just'
+
+[group('build')]
+build: (_build_dist "actions")
+
+roots := [source_dir() / 'ql/test']
+
+[group('test')]
+language-tests *EXTRA_ARGS: (_language_tests (roots ++ EXTRA_ARGS))

actions/ql/integration-tests/justfile

@@ -0,0 +1,8 @@
+import "../../../lib.just"
+
+# Integration tests are slow and need an internal checkout, so they only run when
+# asked for by name.
+explicit_verbs := ['test']
+
+[no-cd]
+test *ARGS=".": (_integration_test ARGS)

actions/ql/justfile

@@ -0,0 +1,6 @@
+import "../../lib.just"
+
+[no-cd]
+format *ARGS=".": (_format_ql ARGS)
+
+consistency_queries := ""

actions/ql/test/justfile

@@ -0,0 +1,11 @@
+import "../justfile"
+
+# A whole language test suite is slow, so it only runs when asked for by name.
+explicit_verbs := ['test']
+
+base_flags := []
+
+all_checks := default_db_checks
+
+[no-cd]
+test *ARGS=".": (_codeql_test "actions" (base_flags ++ prepend('--extra-check=', all_checks) ++ ARGS))

cpp/justfile

@@ -0,0 +1,10 @@
+import '../lib.just'
+import? '../../cpp-coding-standards.just'
+
+[group('build')]
+build: (_build_dist "cpp")
+
+roots := [source_dir() / 'ql/test', SEMMLE_CODE / 'semmlecode-cpp-tests']
+
+[group('test')]
+language-tests *EXTRA_ARGS: (_language_tests (roots ++ EXTRA_ARGS))

cpp/ql/consistency-queries/badLocations.ql

@@ -0,0 +1,9 @@
+import cpp
+
+// Locations should either be :0:0:0:0 locations (UnknownLocation, or
+// a whole file), or all 4 fields should be positive.
+from Location l
+where
+  [l.getStartLine(), l.getEndLine(), l.getStartColumn(), l.getEndColumn()] != 0 and
+  [l.getStartLine(), l.getEndLine(), l.getStartColumn(), l.getEndColumn()] < 1
+select l

cpp/ql/consistency-queries/nullInToString.ql

@@ -0,0 +1,5 @@
+import cpp
+
+from Element e
+where e.toString().matches("%(null)%")
+select e

cpp/ql/consistency-queries/qlpack.yml

@@ -0,0 +1,6 @@
+name: codeql/cpp-consistency-queries
+groups: [cpp, test, consistency-queries]
+dependencies:
+  codeql/cpp-all: ${workspace}
+extractor: cpp
+warnOnImplicitThis: true

cpp/ql/consistency-queries/unusedLocations.ql

@@ -0,0 +1,10 @@
+import cpp
+
+from Location l
+where
+  not any(Element e).getLocation() = l and
+  not any(LambdaCapture lc).getLocation() = l and
+  not any(MacroAccess ma).getActualLocation() = l and
+  not any(NamespaceDeclarationEntry nde).getBodyLocation() = l and
+  not any(XmlLocatable xml).getLocation() = l
+select l

cpp/ql/consistency-queries/variableDeclarationsWithoutTypes.ql

@@ -0,0 +1,5 @@
+import cpp
+
+from VariableDeclarationEntry i
+where not exists(i.getType())
+select i

cpp/ql/consistency-queries/variablesWithoutTypes.ql

@@ -0,0 +1,5 @@
+import cpp
+
+from Variable i
+where not exists(i.getType())
+select i

cpp/ql/integration-tests/justfile

@@ -0,0 +1,8 @@
+import "../../../lib.just"
+
+# Integration tests are slow and need an internal checkout, so they only run when
+# asked for by name.
+explicit_verbs := ['test']
+
+[no-cd]
+test *ARGS=".": (_integration_test ARGS)

cpp/ql/justfile

@@ -0,0 +1,6 @@
+import "../../lib.just"
+
+[no-cd]
+format *ARGS=".": (_format_ql ARGS)
+
+consistency_queries := source_dir() / "consistency-queries"

cpp/ql/test/justfile

@@ -0,0 +1,11 @@
+import "../justfile"
+
+# A whole language test suite is slow, so it only runs when asked for by name.
+explicit_verbs := ['test']
+
+base_flags := ['--include-location-in-star']
+
+all_checks := default_db_checks ++ ['--check-undefined-labels', '--check-unused-labels', '--consistency-queries=' + consistency_queries]
+
+[no-cd]
+test *ARGS=".": (_codeql_test "cpp" (base_flags ++ prepend('--extra-check=', all_checks) ++ ARGS))

csharp/justfile

@@ -0,0 +1,9 @@
+import '../lib.just'
+
+[group('build')]
+build: (_build_dist "csharp")
+
+roots := [source_dir() / 'ql/test']
+
+[group('test')]
+language-tests *EXTRA_ARGS: (_language_tests (roots ++ EXTRA_ARGS))

csharp/ql/integration-tests/justfile

@@ -0,0 +1,8 @@
+import "../../../lib.just"
+
+# Integration tests are slow and need an internal checkout, so they only run when
+# asked for by name.
+explicit_verbs := ['test']
+
+[no-cd]
+test *ARGS=".": (_integration_test ARGS)

csharp/ql/justfile

@@ -0,0 +1,6 @@
+import "../../lib.just"
+
+[no-cd]
+format *ARGS=".": (_format_ql ARGS)
+
+consistency_queries := source_dir() / "consistency-queries"

csharp/ql/test/justfile

@@ -0,0 +1,11 @@
+import "../justfile"
+
+# A whole language test suite is slow, so it only runs when asked for by name.
+explicit_verbs := ['test']
+
+base_flags := []
+
+all_checks := default_db_checks ++ ['--check-undefined-labels', '--check-repeated-labels', '--check-redefined-labels', '--additional-packs=ql', '--consistency-queries=' + consistency_queries]
+
+[no-cd]
+test *ARGS=".": (_codeql_test "csharp" (base_flags ++ prepend('--extra-check=', all_checks) ++ ARGS))

go/justfile

@@ -0,0 +1,17 @@
+import '../lib.just'
+
+[group('build')]
+build: (_build_dist "go")
+
+roots := [source_dir() / 'ql/test']
+
+# The `IncorrectIntegerConversion` query treats `math.MaxInt`/`math.MaxUint` differently on 32- and
+# 64-bit targets, so we run its test under `GOARCH=386` as well. `GOOS=linux` because
+# `GOOS=darwin GOARCH=386` is no longer supported.
+roots_386 := [source_dir() / 'ql/test/query-tests/Security/CWE-681/IncorrectIntegerConversion.qlref']
+
+[group('test')]
+language-tests *EXTRA_ARGS: (_language_tests (roots ++ EXTRA_ARGS))
+
+[group('test')]
+language-tests-386 *EXTRA_ARGS: (_language_tests (roots_386 ++ ['GOOS=linux', 'GOARCH=386'] ++ EXTRA_ARGS))

go/ql/integration-tests/justfile

@@ -0,0 +1,8 @@
+import "../../../lib.just"
+
+# Integration tests are slow and need an internal checkout, so they only run when
+# asked for by name.
+explicit_verbs := ['test']
+
+[no-cd]
+test *ARGS=".": (_integration_test ARGS)

go/ql/justfile

@@ -0,0 +1,6 @@
+import "../../lib.just"
+
+[no-cd]
+format *ARGS=".": (_format_ql ARGS)
+
+consistency_queries := source_dir() / "consistency-queries"

go/ql/test/justfile

@@ -0,0 +1,11 @@
+import "../justfile"
+
+# A whole language test suite is slow, so it only runs when asked for by name.
+explicit_verbs := ['test']
+
+base_flags := []
+
+all_checks := default_db_checks ++ ['--check-undefined-labels', '--check-unused-labels', '--check-repeated-labels', '--check-redefined-labels', '--check-use-before-definition', '--consistency-queries=' + consistency_queries]
+
+[no-cd]
+test *ARGS=".": (_codeql_test "go" (base_flags ++ prepend('--extra-check=', all_checks) ++ ARGS))

java/justfile

@@ -0,0 +1,4 @@
+import '../lib.just'
+
+[group('build')]
+build: (_build_dist "java")

java/ql/integration-tests/justfile

@@ -0,0 +1,8 @@
+import "../../../lib.just"
+
+# Integration tests are slow and need an internal checkout, so they only run when
+# asked for by name.
+explicit_verbs := ['test']
+
+[no-cd]
+test *ARGS=".": (_integration_test ARGS)

java/ql/justfile

@@ -0,0 +1,6 @@
+import "../../lib.just"
+
+[no-cd]
+format *ARGS=".": (_format_ql ARGS)
+
+consistency_queries := source_dir() / "consistency-queries"

java/ql/test-kotlin1/justfile

@@ -0,0 +1,14 @@
+import "../justfile"
+
+# These are CI shards of the Kotlin language tests, too long to run by accident,
+# so a verb coming from above passes over them and they run only when this
+# directory is named.
+explicit_verbs := ['test']
+
+# Kotlin tests may fail the diags.ql consistency test if the diagnostic limit is set.
+base_flags := ['CODEQL_EXTRACTOR_KOTLIN_DIAGNOSTIC_LIMIT=']
+
+all_checks := default_db_checks ++ ['--check-undefined-labels', '--check-repeated-labels', '--check-redefined-labels', '--check-use-before-definition', '--consistency-queries=' + consistency_queries]
+
+[no-cd]
+test *ARGS=".": (_codeql_test "java" (base_flags ++ prepend('--extra-check=', all_checks) ++ ARGS))

java/ql/test-kotlin2/justfile

@@ -0,0 +1,14 @@
+import "../justfile"
+
+# These are CI shards of the Kotlin language tests, too long to run by accident,
+# so a verb coming from above passes over them and they run only when this
+# directory is named.
+explicit_verbs := ['test']
+
+# Kotlin tests may fail the diags.ql consistency test if the diagnostic limit is set.
+base_flags := ['CODEQL_EXTRACTOR_KOTLIN_DIAGNOSTIC_LIMIT=', 'CODEQL_KOTLIN_LEGACY_TEST_EXTRACTION_KOTLIN2=true']
+
+all_checks := default_db_checks ++ ['--check-undefined-labels', '--check-repeated-labels', '--check-redefined-labels', '--check-use-before-definition', '--consistency-queries=' + consistency_queries]
+
+[no-cd]
+test *ARGS=".": (_codeql_test "java" (base_flags ++ prepend('--extra-check=', all_checks) ++ ARGS))

java/ql/test/justfile

@@ -0,0 +1,12 @@
+import "../justfile"
+
+# A whole language test suite is slow, so it only runs when asked for by name.
+explicit_verbs := ['test']
+
+# Kotlin tests may fail the diags.ql consistency test if the diagnostic limit is set.
+base_flags := ['CODEQL_EXTRACTOR_KOTLIN_DIAGNOSTIC_LIMIT=']
+
+all_checks := default_db_checks ++ ['--check-undefined-labels', '--check-repeated-labels', '--check-redefined-labels', '--check-use-before-definition', '--consistency-queries=' + consistency_queries]
+
+[no-cd]
+test *ARGS=".": (_codeql_test "java" (base_flags ++ prepend('--extra-check=', all_checks) ++ ARGS))

javascript/justfile

@@ -0,0 +1,9 @@
+import '../lib.just'
+
+[group('build')]
+build: (_build_dist "javascript")
+
+roots := [source_dir() / 'ql/test']
+
+[group('test')]
+language-tests *EXTRA_ARGS: (_language_tests (roots ++ EXTRA_ARGS))

javascript/ql/integration-tests/justfile

@@ -0,0 +1,8 @@
+import "../../../lib.just"
+
+# Integration tests are slow and need an internal checkout, so they only run when
+# asked for by name.
+explicit_verbs := ['test']
+
+[no-cd]
+test *ARGS=".": (_integration_test ARGS)

javascript/ql/justfile

@@ -0,0 +1,6 @@
+import "../../lib.just"
+
+[no-cd]
+format *ARGS=".": (_format_ql ARGS)
+
+consistency_queries := ""

javascript/ql/test/justfile

@@ -0,0 +1,11 @@
+import "../justfile"
+
+# A whole language test suite is slow, so it only runs when asked for by name.
+explicit_verbs := ['test']
+
+base_flags := []
+
+all_checks := default_db_checks
+
+[no-cd]
+test *ARGS=".": (_codeql_test "javascript" (base_flags ++ prepend('--extra-check=', all_checks) ++ ARGS))

justfile

@@ -0,0 +1,9 @@
+# see misc/just/README.md for an overview
+
+import 'lib.just'
+import 'misc/just/forward.just'
+
+# bazel files live all over the repository rather than under any one language, so they
+# are formatted from here. `format` itself is the forwarder, hence `_root_`; see
+# misc/just/README.md.
+_root_format *ARGS=".": (_format_bazel ARGS)

lib.just

@@ -0,0 +1 @@
+import "misc/just/lib.just"

misc/codegen/justfile

@@ -0,0 +1,5 @@
+import "../just/lib.just"
+
+test *ARGS: (_bazel (['test', '@codeql//misc/codegen/...'] ++ ARGS))
+
+format *ARGS=".": (_format_py ARGS)

misc/just/BUILD.bazel

@@ -0,0 +1,27 @@
+load("@rules_python//python:defs.bzl", "py_library", "py_test")
+
+py_library(
+    name = "tooling",
+    srcs = [
+        "codeql_test_run.py",
+        "forward_command.py",
+        "language_tests.py",
+        "run_on_files.py",
+    ],
+    imports = ["."],
+    visibility = ["//visibility:public"],
+)
+
+[
+    py_test(
+        name = src[:-len(".py")],
+        size = "small",
+        srcs = [src],
+        deps = [":tooling"],
+    )
+    for src in glob(["test_*.py"])
+]
+
+test_suite(
+    name = "test",
+)