Just: use --all-checks and --codeql special flags, and relativize…

… flags in forwarder
github · redsun82 · Jul 4, 2025 · Jul 4, 2025 · Jul 4, 2025 · Jul 4, 2025
commit 6e14111337ca02bdc6a65e228ddd6aa4f912f4e9
@@ -0,0 +1,3 @@
+import '../misc/just/lib.just'
+
+build: (_build "java")
@@ -0,0 +1,6 @@
+import "../../misc/just/lib.just"
+
+[no-cd]
+format *ARGS=".": (_ql_format ARGS)
+
+consistency_queries := source_dir() / "consistency-queries"
@@ -0,0 +1,15 @@
+import "../justfile"
+
+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 all_checks ARGS)
diff --git a/misc/just/codeql-test-run.ts b/misc/just/codeql-test-run.ts
@@ -1,6 +1,7 @@
 import * as child_process from "child_process";
 import * as path from "path";
 import * as os from "os";
+import * as fs from "fs";
 
 function invoke(
     invocation: string[],
@@ -28,65 +29,68 @@ type Args = {
     tests: string[];
     flags: string[];
     env: string[];
-    build: boolean;
-    testing_level: number;
+    codeql: string;
+    all: boolean;
 };
 
 function parseArgs(args: Args, argv: string) {
-    argv.split(/(?<!\\) /).forEach((arg) => {
-        if (arg === "--no-build") {
-            args.build = false;
-        } else if (arg.startsWith("-")) {
-            args.flags.push(arg);
-        } else if (/^[A-Z_][A-Z_0-9]*=.*$/.test(arg)) {
-            args.env.push(arg);
-        } else if (/^\++$/.test(arg)) {
-            args.testing_level = Math.max(args.testing_level, arg.length);
-        } else if (arg !== "") {
-            args.tests.push(arg);
-        }
-    });
+    argv.split(/(?<!\\) /)
+        .map((arg) => arg.replace("\\ ", " "))
+        .forEach((arg) => {
+            if (arg.startsWith("--codeql=")) {
+                args.codeql = arg.split("=")[1];
+            } else if (arg === "+" || arg === "--all-checks") {
+                args.all = true;
+            } else if (arg.startsWith("-")) {
+                args.flags.push(arg);
+            } else if (/^[A-Z_][A-Z_0-9]*=.*$/.test(arg)) {
+                args.env.push(arg);
+            } else if (arg !== "") {
+                args.tests.push(arg);
+            }
+        });
 }
 
 function codeqlTestRun(argv: string[]): number {
-    const [language, extra_args, ...plus] = argv;
-    let codeql = process.env["SEMMLE_CODE"]
-        ? path.join(
-              process.env["SEMMLE_CODE"],
-              "target",
-              "intree",
-              `codeql-${language}`,
-              "codeql",
-          )
-        : "codeql";
+    const semmle_code = process.env["SEMMLE_CODE"];
+    const [language, base_args, all_args, extra_args] = argv;
     const ram_per_thread = process.platform === "linux" ? 3000 : 2048;
     const cpus = os.cpus().length;
     let args: Args = {
         tests: [],
         flags: [`--ram=${ram_per_thread * cpus}`, `-j${cpus}`],
         env: [],
-        build: true,
-        testing_level: 0,
+        codeql: semmle_code ? "build" : "host",
+        all: false,
     };
+    parseArgs(args, base_args);
     parseArgs(args, extra_args);
-    for (let i = 0; i < Math.min(plus.length, args.testing_level); i++) {
-        parseArgs(args, plus[i]);
+    if (args.all) {
+        parseArgs(args, all_args);
+    }
+    if (!semmle_code && (args.codeql === "build" || args.codeql === "built")) {
+        console.error(
+            "Using `--codeql=build` or `--codeql=built` requires working with the internal repository",
+        );
+        return 1;
     }
     if (args.tests.length === 0) {
         args.tests.push(".");
     }
-    if (args.build && process.env["SEMMLE_CODE"]) {
-        // If SEMMLE_CODE is set, we are in the semmle-code repo, so we build the codeql binary.
-        // Otherwise, we use codeql from PATH.
+    if (args.codeql === "build") {
         if (
             invoke(["python3", "build", `target/intree/codeql-${language}`], {
-                cwd: process.env["SEMMLE_CODE"],
+                cwd: semmle_code,
             }) !== 0
         ) {
             return 1;
         }
     }
-    process.env["CODEQL_CONFIG_FILE"] ||= "."; // disable the default implicit config file, but keep an explicit one
+    if (args.codeql !== "host") {
+        // disable the default implicit config file, but keep an explicit one
+        // this is the same behavior wrt to `--codeql` as the integration test runner
+        process.env["CODEQL_CONFIG_FILE"] ||= ".";
+    }
     // Set and unset environment variables
     args.env.forEach((envVar) => {
         const [key, value] = envVar.split("=", 2);
@@ -101,6 +105,31 @@ function codeqlTestRun(argv: string[]): number {
             process.exit(1);
         }
     });
+    let codeql;
+    if (args.codeql === "built" || args.codeql === "build") {
+        codeql = path.join(
+            semmle_code!,
+            "target",
+            "intree",
+            `codeql-${language}`,
+            "codeql",
+        );
+    } else if (args.codeql === "host") {
+        codeql = "codeql";
+    } else {
+        codeql = args.codeql;
+        if (fs.lstatSync(codeql).isDirectory()) {
+            codeql = path.join(codeql, "codeql");
+            if (process.platform === "win32") {
+                codeql += ".exe";
+            }
+        }
+        if (!fs.existsSync(codeql)) {
+            console.error(`CodeQL executable not found: ${codeql}`);
+            return 1;
+        }
+    }
+
     return invoke([codeql, "test", "run", ...args.flags, "--", ...args.tests], {
         log_prefix: args.env.join(" "),
     });

diff --git a/misc/just/forward-command.ts b/misc/just/forward-command.ts
@@ -36,8 +36,8 @@ function forwardCommand(args: string[]): number {
     }
     process.env[envVariable] = "true";
     const cmdArgs = args.slice(1);
-    // non-positional arguments are flags, repeated + (used by language tests) or environment variable settings
-    const is_non_positional = /^(-.*|\++|[A-Z_][A-Z_0-9]*=.*)$/;
+    // non-positional arguments are flags, + (used by language tests) or environment variable settings
+    const is_non_positional = /^(-.*|\+|[A-Z_][A-Z_0-9]*=.*)$/;
     const flags = cmdArgs.filter((arg) => is_non_positional.test(arg));
     const positionalArgs = cmdArgs.filter(
         (arg) => !is_non_positional.test(arg),
@@ -55,11 +55,26 @@ function forwardCommand(args: string[]): number {
     if (relativeArgs.length === 1 && relativeArgs[0] === ".") {
         relativeArgs = [];
     }
+    let relativeFlags = flags.map((arg) => {
+        // this might break in specific corner cases, but is good enough for most uses
+        // workaround if this doesn't work is to not use the forwarder (call just directly in the relevant directory)
+        if (arg.includes("=") && arg.includes(path.sep)) {
+            let [flags, flag_arg] = arg.split("=", 2);
+            flag_arg = flag_arg
+                .split(path.delimiter)
+                .map((p) =>
+                    path.isAbsolute(p) ? p : path.relative(commonPath, p),
+                )
+                .join(path.delimiter);
+            return `${flags}=${flag_arg}`;
+        }
+        return arg;
+    });
 
     const invocation = [
         process.env["JUST_EXECUTABLE"] || "just",
         cmd,
-        ...flags,
+        ...relativeFlags,
         ...relativeArgs,
     ];
     console.log(`-> ${commonPath}: just ${invocation.slice(1).join(" ")}`);

diff --git a/misc/just/lib.just b/misc/just/lib.just
@@ -38,7 +38,7 @@ default_db_checks := """\
 """
 
 [no-cd, positional-arguments, no-exit-message]
-@_codeql_test LANGUAGE +ARGS:
+@_codeql_test LANGUAGE BASE_FLAGS ALL_CHECKS_FLAGS EXTRA_ARGS:
     {{ tsx }} "{{ source_dir() }}/codeql-test-run.ts" "$@"
 
 

@@ -3,9 +3,8 @@ import "../../misc/just/lib.just"
 [no-cd]
 format *ARGS=".": (_ql_format ARGS)
 
-db_checks := default_db_checks
-
-consistency := "--consistency-queries=" + source_dir() / "consistency-queries"
+all_checks := default_db_checks + """\
+     --consistency-queries=""" + source_dir() / "consistency-queries"
 
 [no-cd]
-test *ARGS=".": (_codeql_test "rust" ARGS db_checks consistency)
+test *ARGS=".": (_codeql_test "rust" "" all_checks ARGS)
@@ -3,13 +3,12 @@ import "../../misc/just/lib.just"
 [no-cd]
 format *ARGS=".": (_ql_format ARGS)
 
-db_checks := default_db_checks + """\
+all_checks := default_db_checks + """\
     --check-repeated-labels \
     --check-redefined-labels \
     --check-use-before-definition \
-"""
+    --consistency-queries=""" + source_dir() / "consistency-queries"
 
-consistency := "--consistency-queries=" + source_dir() / "consistency-queries"
 
 [no-cd]
-test *ARGS=".": (_codeql_test "swift" ARGS db_checks consistency)
+test *ARGS=".": (_codeql_test "swift" "" all_checks ARGS)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		import '../misc/just/lib.just'

		build: (_build "java")