Don't invoke CLI when command not supported

github · Jun 15, 2023 · 7a9f099 · 7a9f099
1 parent 899b5a2
commit 7a9f099
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 12 deletions.
diff --git a/lib/codeql.js b/lib/codeql.js
diff --git a/lib/codeql.js.map b/lib/codeql.js.map
diff --git a/lib/resolve-environment.js b/lib/resolve-environment.js
diff --git a/lib/resolve-environment.js.map b/lib/resolve-environment.js.map
diff --git a/src/codeql.ts b/src/codeql.ts
@@ -304,6 +304,11 @@ export const CODEQL_VERSION_SECURITY_EXPERIMENTAL_SUITE = "2.12.1";
  */
 export const CODEQL_VERSION_INIT_WITH_QLCONFIG = "2.12.4";
 
+/**
+ * Versions 2.13.4+ of the CodeQL CLI support the `resolve build-environment` command.
+ */
+export const CODEQL_VERSION_RESOLVE_ENVIRONMENT = "2.13.4";
+
 /**
  * Set up CodeQL CLI access.
  *

diff --git a/src/resolve-environment.ts b/src/resolve-environment.ts
@@ -1,6 +1,7 @@
-import { getCodeQL } from "./codeql";
+import { CODEQL_VERSION_RESOLVE_ENVIRONMENT, getCodeQL } from "./codeql";
 import { Language } from "./languages";
 import { Logger } from "./logging";
+import * as util from "./util";
 
 export async function runResolveBuildEnvironment(
   cmd: string,
@@ -10,12 +11,29 @@ export async function runResolveBuildEnvironment(
 ) {
   logger.startGroup(`Attempting to resolve build environment for ${language}`);
 
-  if (workingDir !== undefined) {
-    logger.info(`Using ${workingDir} as the working directory.`);
+  const codeql = await getCodeQL(cmd);
+  let result = {};
+
+  // If the CodeQL version in use does not support the `resolve build-environment`
+  // command, just return an empty configuration. Otherwise invoke the CLI.
+  if (
+    !(await util.codeQlVersionAbove(
+      codeql,
+      CODEQL_VERSION_RESOLVE_ENVIRONMENT
+    ))
+  ) {
+    logger.warning(
+      "Unsupported CodeQL CLI version for `resolve build-environment` command, " +
+        "returning an empty configuration."
+    );
+  } else {
+    if (workingDir !== undefined) {
+      logger.info(`Using ${workingDir} as the working directory.`);
+    }
+
+    result = await codeql.resolveBuildEnvironment(workingDir, language);
   }
 
-  const codeql = await getCodeQL(cmd);
-  const result = await codeql.resolveBuildEnvironment(workingDir, language);
   logger.endGroup();
   return result;
 }