Add tests for new analysis summary feature flag

lib/codeql.test.js

@@ -668,6 +668,42 @@ const injectedConfigMacro = ava_1.default.macro({
     await codeqlObject.databaseInterpretResults("", [], "", "", "", "-v", "", stubConfig, (0, testing_utils_1.createFeatures)([]), (0, logging_1.getRunnerLogger)(true));
     t.false(runnerConstructorStub.firstCall.args[1].includes("--sarif-add-baseline-file-info"), "--sarif-add-baseline-file-info must be absent, but it is present");
 });
+const NEW_ANALYSIS_SUMMARY_TEST_CASES = [
+    {
+        featureEnabled: true,
+        codeqlVersion: "2.14.0",
+        flagPassed: true,
+        negativeFlagPassed: false,
+    },
+    {
+        featureEnabled: false,
+        codeqlVersion: "2.14.0",
+        flagPassed: false,
+        negativeFlagPassed: true,
+    },
+    {
+        featureEnabled: false,
+        codeqlVersion: "2.13.5",
+        flagPassed: false,
+        negativeFlagPassed: false,
+    },
+];
+for (const { featureEnabled, codeqlVersion, flagPassed, negativeFlagPassed, } of NEW_ANALYSIS_SUMMARY_TEST_CASES) {
+    (0, ava_1.default)(`database interpret-results passes ${flagPassed
+        ? "--new-analysis-summary"
+        : negativeFlagPassed
+            ? "--no-new-analysis-summary"
+            : "nothing"} for CodeQL CLI v${codeqlVersion} when the new analysis summary feature is ${featureEnabled ? "enabled" : "disabled"}`, async (t) => {
+        const runnerConstructorStub = stubToolRunnerConstructor();
+        const codeqlObject = await codeql.getCodeQLForTesting();
+        sinon.stub(codeqlObject, "getVersion").resolves(codeqlVersion);
+        // safeWhich throws because of the test CodeQL object.
+        sinon.stub(safeWhich, "safeWhich").resolves("");
+        await codeqlObject.databaseInterpretResults("", [], "", "", "", "-v", "", stubConfig, (0, testing_utils_1.createFeatures)(featureEnabled ? [feature_flags_1.Feature.NewAnalysisSummaryEnabled] : []), (0, logging_1.getRunnerLogger)(true));
+        t.is(runnerConstructorStub.firstCall.args[1].includes("--new-analysis-summary"), flagPassed, `--new-analysis-summary should${flagPassed ? "" : "n't"} be passed`);
+        t.is(runnerConstructorStub.firstCall.args[1].includes("--no-new-analysis-summary"), negativeFlagPassed, `--no-new-analysis-summary should${negativeFlagPassed ? "" : "n't"} be passed`);
+    });
+}
 function stubToolRunnerConstructor() {
     const runnerObjectStub = sinon.createStubInstance(toolrunner.ToolRunner);
     runnerObjectStub.exec.resolves(0);

lib/feature-flags.js

@@ -34,7 +34,7 @@ const util = __importStar(require("./util"));
 const DEFAULT_VERSION_FEATURE_FLAG_PREFIX = "default_codeql_version_";
 const DEFAULT_VERSION_FEATURE_FLAG_SUFFIX = "_enabled";
 /**
- * MapsFeature enablement as returned by the GitHub API endpoint.
+ * Feature enablement as returned by the GitHub API endpoint.
  *
  * Each value of this enum should end with `_enabled`.
  */

src/codeql.test.ts

@@ -1061,6 +1061,78 @@ test("databaseInterpretResults() does not set --sarif-add-baseline-file-info for
   );
 });
 
+const NEW_ANALYSIS_SUMMARY_TEST_CASES = [
+  {
+    featureEnabled: true,
+    codeqlVersion: "2.14.0",
+    flagPassed: true,
+    negativeFlagPassed: false,
+  },
+  {
+    featureEnabled: false,
+    codeqlVersion: "2.14.0",
+    flagPassed: false,
+    negativeFlagPassed: true,
+  },
+  {
+    featureEnabled: false,
+    codeqlVersion: "2.13.5",
+    flagPassed: false,
+    negativeFlagPassed: false,
+  },
+];
+
+for (const {
+  featureEnabled,
+  codeqlVersion,
+  flagPassed,
+  negativeFlagPassed,
+} of NEW_ANALYSIS_SUMMARY_TEST_CASES) {
+  test(`database interpret-results passes ${
+    flagPassed
+      ? "--new-analysis-summary"
+      : negativeFlagPassed
+      ? "--no-new-analysis-summary"
+      : "nothing"
+  } for CodeQL CLI v${codeqlVersion} when the new analysis summary feature is ${
+    featureEnabled ? "enabled" : "disabled"
+  }`, async (t) => {
+    const runnerConstructorStub = stubToolRunnerConstructor();
+    const codeqlObject = await codeql.getCodeQLForTesting();
+    sinon.stub(codeqlObject, "getVersion").resolves(codeqlVersion);
+    // safeWhich throws because of the test CodeQL object.
+    sinon.stub(safeWhich, "safeWhich").resolves("");
+    await codeqlObject.databaseInterpretResults(
+      "",
+      [],
+      "",
+      "",
+      "",
+      "-v",
+      "",
+      stubConfig,
+      createFeatures(featureEnabled ? [Feature.NewAnalysisSummaryEnabled] : []),
+      getRunnerLogger(true)
+    );
+    t.is(
+      runnerConstructorStub.firstCall.args[1].includes(
+        "--new-analysis-summary"
+      ),
+      flagPassed,
+      `--new-analysis-summary should${flagPassed ? "" : "n't"} be passed`
+    );
+    t.is(
+      runnerConstructorStub.firstCall.args[1].includes(
+        "--no-new-analysis-summary"
+      ),
+      negativeFlagPassed,
+      `--no-new-analysis-summary should${
+        negativeFlagPassed ? "" : "n't"
+      } be passed`
+    );
+  });
+}
+
 export function stubToolRunnerConstructor(): sinon.SinonStub<
   any[],
   toolrunner.ToolRunner