Add env var to enable file coverage on PRs

Author: henrymercer

lib/analyze-action.js

@@ -6,7 +6,11 @@ import * as github from "@actions/github";
 import * as io from "@actions/io";
 import * as yaml from "js-yaml";
 
-import { getTemporaryDirectory, PullRequestBranches } from "./actions-util";
+import {
+  getTemporaryDirectory,
+  isDefaultSetup,
+  PullRequestBranches,
+} from "./actions-util";
 import * as analyses from "./analyses";
 import { setupCppAutobuild } from "./autobuild";
 import { type CodeQL } from "./codeql";
@@ -506,9 +510,14 @@ export async function runQueries(
       if (!config.enableFileCoverageInformation) {
         const isOrgOwned =
           github.context.payload.repository?.owner.type === "Organization";
-        const reenableMessage = isOrgOwned
-          ? ` To enable file coverage information on pull requests, set the '${RepositoryPropertyName.ENABLE_FILE_COVERAGE_ON_PRS}' repository property to 'true'.`
-          : "";
+        let reenableMessage: string;
+        if (isOrgOwned) {
+          reenableMessage = ` To enable file coverage information on pull requests, set the '${RepositoryPropertyName.ENABLE_FILE_COVERAGE_ON_PRS}' repository property to 'true'.`;
+        } else if (!isDefaultSetup()) {
+          reenableMessage = ` To enable file coverage information on pull requests, set the '${EnvVar.ENABLE_FILE_COVERAGE_ON_PRS}' environment variable to 'true'.`;
+        } else {
+          reenableMessage = "";
+        }
         logger.info(
           `To speed up pull request analysis, file coverage information is only enabled when analyzing the default branch and protected branches.${reenableMessage}`,
         );

lib/init-action.js

@@ -142,6 +142,11 @@ export enum EnvVar {
    */
   ANALYSIS_KEY = "CODEQL_ACTION_ANALYSIS_KEY",
 
+  /**
+   * Whether to enable file coverage information on pull requests.
+   */
+  ENABLE_FILE_COVERAGE_ON_PRS = "CODEQL_ACTION_ENABLE_FILE_COVERAGE_ON_PRS",
+
   /** Used by Code Scanning Risk Assessment to communicate the assessment ID to the CodeQL Action. */
   RISK_ASSESSMENT_ID = "CODEQL_ACTION_RISK_ASSESSMENT_ID",
 }

src/analyze.ts

@@ -6,6 +6,7 @@ import * as sinon from "sinon";
 
 import * as actionsUtil from "./actions-util";
 import { createStubCodeQL } from "./codeql";
+import { EnvVar } from "./environment";
 import { Feature } from "./feature-flags";
 import { RepositoryPropertyName } from "./feature-flags/properties";
 import {
@@ -546,3 +547,74 @@ test("file coverage information enabled when repository property enables it on P
     ),
   );
 });
+
+test("file coverage information enabled when env var enables it on PRs", async (t) => {
+  sinon.stub(actionsUtil, "isAnalyzingPullRequest").returns(true);
+  process.env[EnvVar.ENABLE_FILE_COVERAGE_ON_PRS] = "true";
+  t.teardown(() => {
+    delete process.env[EnvVar.ENABLE_FILE_COVERAGE_ON_PRS];
+  });
+
+  const messages: LoggedMessage[] = [];
+  const logger = getRecordingLogger(messages);
+
+  t.true(
+    await getFileCoverageInformationEnabled(
+      false, // debugMode
+      parseRepositoryNwo("github/codeql-action"),
+      createFeatures([Feature.SkipFileCoverageOnPrs]),
+      {},
+      logger,
+    ),
+  );
+
+  t.true(
+    messages.some(
+      (m) =>
+        m.type === "info" &&
+        typeof m.message === "string" &&
+        m.message.includes(EnvVar.ENABLE_FILE_COVERAGE_ON_PRS),
+    ),
+  );
+});
+
+test("file coverage env var takes precedence over repository property", async (t) => {
+  sinon.stub(actionsUtil, "isAnalyzingPullRequest").returns(true);
+  process.env[EnvVar.ENABLE_FILE_COVERAGE_ON_PRS] = "true";
+  t.teardown(() => {
+    delete process.env[EnvVar.ENABLE_FILE_COVERAGE_ON_PRS];
+  });
+
+  const messages: LoggedMessage[] = [];
+  const logger = getRecordingLogger(messages);
+
+  t.true(
+    await getFileCoverageInformationEnabled(
+      false, // debugMode
+      parseRepositoryNwo("github/codeql-action"),
+      createFeatures([Feature.SkipFileCoverageOnPrs]),
+      {
+        [RepositoryPropertyName.ENABLE_FILE_COVERAGE_ON_PRS]: true,
+      },
+      logger,
+    ),
+  );
+
+  // Should mention the env var, not the repo property
+  t.true(
+    messages.some(
+      (m) =>
+        m.type === "info" &&
+        typeof m.message === "string" &&
+        m.message.includes(EnvVar.ENABLE_FILE_COVERAGE_ON_PRS),
+    ),
+  );
+  t.false(
+    messages.some(
+      (m) =>
+        m.type === "info" &&
+        typeof m.message === "string" &&
+        m.message.includes(RepositoryPropertyName.ENABLE_FILE_COVERAGE_ON_PRS),
+    ),
+  );
+});

src/environment.ts

@@ -13,6 +13,7 @@ import {
 import { GitHubApiDetails } from "./api-client";
 import { CodeQL, setupCodeQL } from "./codeql";
 import * as configUtils from "./config-utils";
+import { EnvVar } from "./environment";
 import {
   CodeQLDefaultVersionInfo,
   Feature,
@@ -317,6 +318,17 @@ export async function getFileCoverageInformationEnabled(
   // it is used to populate the status page.
   if (!isAnalyzingPullRequest()) return true;
 
+  // Allow users to opt in to file coverage on PRs via an environment variable.
+  if (process.env[EnvVar.ENABLE_FILE_COVERAGE_ON_PRS] === "true") {
+    logger.info(
+      "File coverage information on pull requests has been enabled by the " +
+        `'${EnvVar.ENABLE_FILE_COVERAGE_ON_PRS}' environment variable. ` +
+        "This may increase the time it takes to analyze pull requests, " +
+        "particularly on large repositories.",
+    );
+    return true;
+  }
+
   // Allow repository owners to opt in to file coverage on PRs via a
   // repository property.
   if (
@@ -326,8 +338,8 @@ export async function getFileCoverageInformationEnabled(
     logger.info(
       "File coverage information on pull requests has been enabled by the " +
         `'${RepositoryPropertyName.ENABLE_FILE_COVERAGE_ON_PRS}' repository property. ` +
-        "This will increase the time it takes to analyze pull requests, particularly on " +
-        "large repositories.",
+        "This may increase the time it takes to analyze pull requests, " +
+        "particularly on large repositories.",
     );
     return true;
   }