Test loading of ML-powered queries

lib/config-utils.js

@@ -26,6 +26,7 @@ const yaml = __importStar(require("js-yaml"));
 const semver = __importStar(require("semver"));
 const api = __importStar(require("./api-client"));
 const externalQueries = __importStar(require("./external-queries"));
+const feature_flags_1 = require("./feature-flags");
 const languages_1 = require("./languages");
 // Property names from the user-supplied config file.
 const NAME_PROPERTY = "name";
@@ -126,7 +127,7 @@ async function addBuiltinSuiteQueries(languages, codeQL, resultMap, packs, suite
     // the ML-powered queries.
     if (languages.includes("javascript") &&
         (found === "security-extended" || found === "security-and-quality") &&
-        (await featureFlags.getMlPoweredQueriesEnabled())) {
+        (await featureFlags.getValue(feature_flags_1.FeatureFlag.MlPoweredQueriesEnabled))) {
         if (!packs.javascript) {
             packs.javascript = [];
         }

lib/config-utils.test.js

@@ -868,6 +868,46 @@ parseInputAndConfigErrorMacro.title = (providedTitle) => `Parse Packs input and
 (0, ava_1.default)("input with two languages", parseInputAndConfigErrorMacro, {}, "c/d", [languages_1.Language.cpp, languages_1.Language.csharp], /multi-language analysis/);
 (0, ava_1.default)("input with + only", parseInputAndConfigErrorMacro, {}, " + ", [languages_1.Language.cpp], /remove the '\+'/);
 (0, ava_1.default)("input with invalid pack name", parseInputAndConfigErrorMacro, {}, " xxx", [languages_1.Language.cpp], /"xxx" is not a valid pack/);
-// errors
-// input w invalid pack name
+async function mlPoweredQueriesMacro(t, isMlPoweredQueriesFlagEnabled, queriesInput, shouldRunMlPoweredQueries) {
+    return await util.withTmpDir(async (tmpDir) => {
+        const codeQL = (0, codeql_1.setCodeQL)({
+            async resolveQueries() {
+                return {
+                    byLanguage: {
+                        javascript: { "fake-query.ql": {} },
+                    },
+                    noDeclaredLanguage: {},
+                    multipleDeclaredLanguages: {},
+                };
+            },
+        });
+        const { packs } = await configUtils.initConfig("javascript", queriesInput, undefined, undefined, undefined, false, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeQL, tmpDir, gitHubVersion, sampleApiDetails, (0, feature_flags_1.createFeatureFlags)(isMlPoweredQueriesFlagEnabled
+            ? [feature_flags_1.FeatureFlag.MlPoweredQueriesEnabled]
+            : []), (0, logging_1.getRunnerLogger)(true));
+        if (shouldRunMlPoweredQueries) {
+            t.deepEqual(packs, {
+                [languages_1.Language.javascript]: [
+                    {
+                        packName: "codeql/javascript-experimental-atm-queries",
+                        version: (0, semver_1.clean)("0.0.1"),
+                    },
+                ],
+            });
+        }
+        else {
+            t.deepEqual(packs, {});
+        }
+    });
+}
+mlPoweredQueriesMacro.title = (_providedTitle, isMlPoweredQueriesFlagEnabled, queriesInput, shouldRunMlPoweredQueries) => {
+    const queriesInputDescription = queriesInput
+        ? `'queries: ${queriesInput}'`
+        : "default config";
+    return `ML-powered queries ${shouldRunMlPoweredQueries ? "are" : "aren't"} loaded for ${queriesInputDescription} when feature flag is ${isMlPoweredQueriesFlagEnabled ? "enabled" : "disabled"}`;
+};
+// macro, isMlPoweredQueriesFlagEnabled, queriesInput, shouldRunMlPoweredQueries
+(0, ava_1.default)(mlPoweredQueriesMacro, false, "security-extended", false);
+(0, ava_1.default)(mlPoweredQueriesMacro, true, undefined, false);
+(0, ava_1.default)(mlPoweredQueriesMacro, true, "security-extended", true);
+(0, ava_1.default)(mlPoweredQueriesMacro, true, "security-and-quality", true);
 //# sourceMappingURL=config-utils.test.js.map

src/config-utils.test.ts

@@ -9,7 +9,7 @@ import * as sinon from "sinon";
 import * as api from "./api-client";
 import { getCachedCodeQL, setCodeQL } from "./codeql";
 import * as configUtils from "./config-utils";
-import { createFeatureFlags } from "./feature-flags";
+import { createFeatureFlags, FeatureFlag } from "./feature-flags";
 import { Language } from "./languages";
 import { getRunnerLogger } from "./logging";
 import { setupTests } from "./testing-utils";
@@ -1654,5 +1654,80 @@ test(
   /"xxx" is not a valid pack/
 );
 
-// errors
-// input w invalid pack name
+async function mlPoweredQueriesMacro(
+  t: ExecutionContext,
+  isMlPoweredQueriesFlagEnabled: boolean,
+  queriesInput: string | undefined,
+  shouldRunMlPoweredQueries: boolean
+) {
+  return await util.withTmpDir(async (tmpDir) => {
+    const codeQL = setCodeQL({
+      async resolveQueries() {
+        return {
+          byLanguage: {
+            javascript: { "fake-query.ql": {} },
+          },
+          noDeclaredLanguage: {},
+          multipleDeclaredLanguages: {},
+        };
+      },
+    });
+
+    const { packs } = await configUtils.initConfig(
+      "javascript",
+      queriesInput,
+      undefined,
+      undefined,
+      undefined,
+      false,
+      { owner: "github", repo: "example " },
+      tmpDir,
+      tmpDir,
+      codeQL,
+      tmpDir,
+      gitHubVersion,
+      sampleApiDetails,
+      createFeatureFlags(
+        isMlPoweredQueriesFlagEnabled
+          ? [FeatureFlag.MlPoweredQueriesEnabled]
+          : []
+      ),
+      getRunnerLogger(true)
+    );
+    if (shouldRunMlPoweredQueries) {
+      t.deepEqual(packs as unknown, {
+        [Language.javascript]: [
+          {
+            packName: "codeql/javascript-experimental-atm-queries",
+            version: clean("0.0.1"),
+          },
+        ],
+      });
+    } else {
+      t.deepEqual(packs as unknown, {});
+    }
+  });
+}
+
+mlPoweredQueriesMacro.title = (
+  _providedTitle: string,
+  isMlPoweredQueriesFlagEnabled: boolean,
+  queriesInput: string | undefined,
+  shouldRunMlPoweredQueries: boolean
+) => {
+  const queriesInputDescription = queriesInput
+    ? `'queries: ${queriesInput}'`
+    : "default config";
+
+  return `ML-powered queries ${
+    shouldRunMlPoweredQueries ? "are" : "aren't"
+  } loaded for ${queriesInputDescription} when feature flag is ${
+    isMlPoweredQueriesFlagEnabled ? "enabled" : "disabled"
+  }`;
+};
+
+// macro, isMlPoweredQueriesFlagEnabled, queriesInput, shouldRunMlPoweredQueries
+test(mlPoweredQueriesMacro, false, "security-extended", false);
+test(mlPoweredQueriesMacro, true, undefined, false);
+test(mlPoweredQueriesMacro, true, "security-extended", true);
+test(mlPoweredQueriesMacro, true, "security-and-quality", true);

src/config-utils.ts

@@ -7,7 +7,7 @@ import * as semver from "semver";
 import * as api from "./api-client";
 import { CodeQL, ResolveQueriesOutput } from "./codeql";
 import * as externalQueries from "./external-queries";
-import { FeatureFlags } from "./feature-flags";
+import { FeatureFlag, FeatureFlags } from "./feature-flags";
 import { Language, parseLanguage } from "./languages";
 import { Logger } from "./logging";
 import { RepositoryNwo } from "./repository";
@@ -279,7 +279,7 @@ async function addBuiltinSuiteQueries(
   if (
     languages.includes("javascript") &&
     (found === "security-extended" || found === "security-and-quality") &&
-    (await featureFlags.getMlPoweredQueriesEnabled())
+    (await featureFlags.getValue(FeatureFlag.MlPoweredQueriesEnabled))
   ) {
     if (!packs.javascript) {
       packs.javascript = [];