Simplify definitions of environment variables

src/actions-util.test.ts

@@ -5,7 +5,7 @@ import test from "ava";
 import * as sinon from "sinon";
 
 import * as actionsutil from "./actions-util";
-import * as sharedEnv from "./shared-environment";
+import { EnvVar } from "./environment";
 import { setupActionsVars, setupTests } from "./testing-utils";
 import { initializeEnvironment, withTmpDir } from "./util";
 
@@ -211,7 +211,7 @@ test("computeAutomationID()", async (t) => {
 
 test("initializeEnvironment", (t) => {
   initializeEnvironment("1.2.3");
-  t.deepEqual(process.env.CODEQL_ACTION_VERSION, "1.2.3");
+  t.deepEqual(process.env[EnvVar.VERSION], "1.2.3");
 });
 
 test("isAnalyzingDefaultBranch()", async (t) => {
@@ -303,8 +303,7 @@ test("createStatusReportBase", async (t) => {
     t.assert(statusReport.action_name === "init");
     t.assert(statusReport.action_oid === "unknown");
     t.assert(
-      statusReport.started_at ===
-        process.env[sharedEnv.CODEQL_WORKFLOW_STARTED_AT]
+      statusReport.started_at === process.env[EnvVar.WORKFLOW_STARTED_AT]
     );
     t.assert(
       statusReport.action_started_at ===

src/actions-util.ts

@@ -9,7 +9,7 @@ import { JSONSchemaForNPMPackageJsonFiles } from "@schemastore/package";
 
 import * as api from "./api-client";
 import { Config } from "./config-utils";
-import * as sharedEnv from "./shared-environment";
+import { EnvVar } from "./environment";
 import {
   doesDirectoryExist,
   getCachedCodeQlVersion,
@@ -443,32 +443,25 @@ export async function createStatusReportBase(
 ): Promise<StatusReportBase> {
   const commitOid = getOptionalInput("sha") || process.env["GITHUB_SHA"] || "";
   const ref = await getRef();
-  const jobRunUUID = process.env[sharedEnv.JOB_RUN_UUID] || "";
+  const jobRunUUID = process.env[EnvVar.JOB_RUN_UUID] || "";
   const workflowRunID = getWorkflowRunID();
   const workflowRunAttempt = getWorkflowRunAttempt();
   const workflowName = process.env["GITHUB_WORKFLOW"] || "";
   const jobName = process.env["GITHUB_JOB"] || "";
   const analysis_key = await getAnalysisKey();
-  let workflowStartedAt = process.env[sharedEnv.CODEQL_WORKFLOW_STARTED_AT];
+  let workflowStartedAt = process.env[EnvVar.WORKFLOW_STARTED_AT];
   if (workflowStartedAt === undefined) {
     workflowStartedAt = actionStartedAt.toISOString();
-    core.exportVariable(
-      sharedEnv.CODEQL_WORKFLOW_STARTED_AT,
-      workflowStartedAt
-    );
+    core.exportVariable(EnvVar.WORKFLOW_STARTED_AT, workflowStartedAt);
   }
   const runnerOs = getRequiredEnvParam("RUNNER_OS");
   const codeQlCliVersion = getCachedCodeQlVersion();
   const actionRef = process.env["GITHUB_ACTION_REF"];
-  const testingEnvironment =
-    process.env[sharedEnv.CODEQL_ACTION_TESTING_ENVIRONMENT] || "";
+  const testingEnvironment = process.env[EnvVar.TESTING_ENVIRONMENT] || "";
   // re-export the testing environment variable so that it is available to subsequent steps,
   // even if it was only set for this step
   if (testingEnvironment !== "") {
-    core.exportVariable(
-      sharedEnv.CODEQL_ACTION_TESTING_ENVIRONMENT,
-      testingEnvironment
-    );
+    core.exportVariable(EnvVar.TESTING_ENVIRONMENT, testingEnvironment);
   }
 
   const statusReport: StatusReportBase = {

src/analyze-action.ts

@@ -19,14 +19,11 @@ import { runAutobuild } from "./autobuild";
 import { getCodeQL } from "./codeql";
 import { Config, getConfig } from "./config-utils";
 import { uploadDatabases } from "./database-upload";
+import { EnvVar } from "./environment";
 import { Features } from "./feature-flags";
 import { Language } from "./languages";
 import { getActionsLogger, Logger } from "./logging";
 import { parseRepositoryNwo } from "./repository";
-import {
-  CODEQL_ACTION_ANALYZE_DID_COMPLETE_SUCCESSFULLY,
-  CODEQL_ACTION_DID_AUTOBUILD_GOLANG,
-} from "./shared-environment";
 import { getTotalCacheSize, uploadTrapCaches } from "./trap-caching";
 import * as uploadLib from "./upload-lib";
 import { UploadResult } from "./upload-lib";
@@ -144,7 +141,7 @@ async function runAutobuildIfLegacyGoWorkflow(config: Config, logger: Logger) {
   if (!config.languages.includes(Language.go)) {
     return;
   }
-  if (process.env[CODEQL_ACTION_DID_AUTOBUILD_GOLANG] === "true") {
+  if (process.env[EnvVar.DID_AUTOBUILD_GOLANG] === "true") {
     logger.debug("Won't run Go autobuild since it has already been run.");
     return;
   }
@@ -308,10 +305,7 @@ async function run() {
         `expect-error input was set to true but no error was thrown.`
       );
     }
-    core.exportVariable(
-      CODEQL_ACTION_ANALYZE_DID_COMPLETE_SUCCESSFULLY,
-      "true"
-    );
+    core.exportVariable(EnvVar.ANALYZE_DID_COMPLETE_SUCCESSFULLY, "true");
   } catch (unwrappedError) {
     const error = wrapError(unwrappedError);
     if (

src/autobuild-action.ts

@@ -12,9 +12,9 @@ import {
 import { getGitHubVersion } from "./api-client";
 import { determineAutobuildLanguages, runAutobuild } from "./autobuild";
 import * as configUtils from "./config-utils";
+import { EnvVar } from "./environment";
 import { Language } from "./languages";
 import { getActionsLogger } from "./logging";
-import { CODEQL_ACTION_DID_AUTOBUILD_GOLANG } from "./shared-environment";
 import {
   checkGitHubVersionInRange,
   initializeEnvironment,
@@ -89,7 +89,7 @@ async function run() {
         currentLanguage = language;
         await runAutobuild(language, config, logger);
         if (language === Language.go) {
-          core.exportVariable(CODEQL_ACTION_DID_AUTOBUILD_GOLANG, "true");
+          core.exportVariable(EnvVar.DID_AUTOBUILD_GOLANG, "true");
         }
       }
     }

src/environment.ts

@@ -0,0 +1,60 @@
+export enum EnvVar {
+  /** Set to true when the `analyze` Action completes successfully. */
+  ANALYZE_DID_COMPLETE_SUCCESSFULLY = "CODEQL_ACTION_ANALYZE_DID_COMPLETE_SUCCESSFULLY",
+
+  /** Set to "true" when the CodeQL Action has invoked the Go autobuilder. */
+  DID_AUTOBUILD_GOLANG = "CODEQL_ACTION_DID_AUTOBUILD_GOLANG",
+
+  /**
+   * Used to disable the SARIF post-processing in the Action that removes duplicate locations from
+   * notifications in the `run[].invocations[].toolExecutionNotifications` SARIF property.
+   */
+  DISABLE_DUPLICATE_LOCATION_FIX = "CODEQL_ACTION_DISABLE_DUPLICATE_LOCATION_FIX",
+
+  /**
+   * If set to the "true" string, then the CodeQL Action is using its
+   * own deprecated and non-standard way of scanning for multiple
+   * languages.
+   */
+  FEATURE_MULTI_LANGUAGE = "CODEQL_ACTION_FEATURE_MULTI_LANGUAGE",
+
+  /**
+   * If set to the "true" string, then the CodeQL Action is using its
+   * own sandwiched workflow mechanism.
+   */
+  FEATURE_SANDWICH = "CODEQL_ACTION_FEATURE_SANDWICH",
+
+  /**
+   * If set to a truthy value, then the CodeQL Action might combine SARIF
+   * output from several `interpret-results` runs for the same language.
+   */
+  FEATURE_SARIF_COMBINE = "CODEQL_ACTION_FEATURE_SARIF_COMBINE",
+
+  /**
+   * If set to the "true" string, then the CodeQL Action will upload SARIF,
+   * not the CLI.
+   */
+  FEATURE_WILL_UPLOAD = "CODEQL_ACTION_FEATURE_WILL_UPLOAD",
+
+  /** UUID representing the current job run. */
+  JOB_RUN_UUID = "JOB_RUN_UUID",
+
+  ODASA_TRACER_CONFIGURATION = "ODASA_TRACER_CONFIGURATION",
+
+  /** Used to disable uploading SARIF results or status reports to the GitHub API */
+  TEST_MODE = "CODEQL_ACTION_TEST_MODE",
+
+  TESTING_ENVIRONMENT = "CODEQL_ACTION_TESTING_ENVIRONMENT",
+
+  /** Semver of the CodeQL Action as specified in `package.json`. */
+  VERSION = "CODEQL_ACTION_VERSION",
+
+  /**
+   * The time at which the first action (normally init) started executing.
+   * If a workflow invokes a different action without first invoking the init
+   * action (i.e. the upload action is being used by a third-party integrator)
+   * then this variable will be assigned the start time of the action invoked
+   * rather that the init action.
+   */
+  WORKFLOW_STARTED_AT = "CODEQL_WORKFLOW_STARTED_AT",
+}

src/init-action-post-helper.ts

@@ -3,10 +3,10 @@ import * as core from "@actions/core";
 import * as actionsUtil from "./actions-util";
 import { getCodeQL } from "./codeql";
 import { Config, getConfig } from "./config-utils";
+import { EnvVar } from "./environment";
 import { Feature, FeatureEnablement } from "./feature-flags";
 import { Logger } from "./logging";
 import { RepositoryNwo } from "./repository";
-import { CODEQL_ACTION_ANALYZE_DID_COMPLETE_SUCCESSFULLY } from "./shared-environment";
 import * as uploadLib from "./upload-lib";
 import {
   getRequiredEnvParam,
@@ -114,7 +114,7 @@ export async function tryUploadSarifIfRunFailed(
   features: FeatureEnablement,
   logger: Logger
 ): Promise<UploadFailedSarifResult> {
-  if (process.env[CODEQL_ACTION_ANALYZE_DID_COMPLETE_SUCCESSFULLY] !== "true") {
+  if (process.env[EnvVar.ANALYZE_DID_COMPLETE_SUCCESSFULLY] !== "true") {
     try {
       return await maybeUploadFailedSarif(
         config,

src/init-action.ts

@@ -16,6 +16,7 @@ import {
 import { getGitHubVersion } from "./api-client";
 import { CodeQL } from "./codeql";
 import * as configUtils from "./config-utils";
+import { EnvVar } from "./environment";
 import { Feature, Features } from "./feature-flags";
 import {
   initCodeQL,
@@ -27,7 +28,6 @@ import {
 import { Language } from "./languages";
 import { getActionsLogger, Logger } from "./logging";
 import { parseRepositoryNwo } from "./repository";
-import * as sharedEnv from "./shared-environment";
 import { getTotalCacheSize } from "./trap-caching";
 import {
   checkForTimeout,
@@ -214,7 +214,7 @@ async function run() {
     logger
   );
 
-  core.exportVariable(sharedEnv.JOB_RUN_UUID, uuidV4());
+  core.exportVariable(EnvVar.JOB_RUN_UUID, uuidV4());
 
   try {
     const workflowErrors = await validateWorkflow(logger);

src/shared-environment.ts

@@ -1,76 +0,0 @@
-/**
- * Environment variables to be set by codeql-action and used by the
- * CLI.
- */
-export enum EnvVar {
-  /**
-   * Semver of the codeql-action as specified in package.json.
-   */
-  VERSION = "CODEQL_ACTION_VERSION",
-
-  /**
-   * If set to a truthy value, then the codeql-action might combine SARIF
-   * output from several `interpret-results` runs for the same Language.
-   */
-  FEATURE_SARIF_COMBINE = "CODEQL_ACTION_FEATURE_SARIF_COMBINE",
-
-  /**
-   * If set to the "true" string, then the codeql-action will upload SARIF,
-   * not the cli.
-   */
-  FEATURE_WILL_UPLOAD = "CODEQL_ACTION_FEATURE_WILL_UPLOAD",
-
-  /**
-   * If set to the "true" string, then the codeql-action is using its
-   * own deprecated and non-standard way of scanning for multiple
-   * languages.
-   */
-  FEATURE_MULTI_LANGUAGE = "CODEQL_ACTION_FEATURE_MULTI_LANGUAGE",
-
-  /**
-   * If set to the "true" string, then the codeql-action is using its
-   * own sandwiched workflow mechanism
-   */
-  FEATURE_SANDWICH = "CODEQL_ACTION_FEATURE_SANDWICH",
-}
-
-/**
- * Environment variable that is set to true when the CodeQL Action has invoked
- * the Go autobuilder.
- */
-export const CODEQL_ACTION_DID_AUTOBUILD_GOLANG =
-  "CODEQL_ACTION_DID_AUTOBUILD_GOLANG";
-
-/**
- * This environment variable is set to true when the `analyze` Action
- * completes successfully.
- */
-export const CODEQL_ACTION_ANALYZE_DID_COMPLETE_SUCCESSFULLY =
-  "CODEQL_ACTION_ANALYZE_DID_COMPLETE_SUCCESSFULLY";
-
-export const CODEQL_ACTION_TESTING_ENVIRONMENT =
-  "CODEQL_ACTION_TESTING_ENVIRONMENT";
-
-/** Used to disable uploading SARIF results or status reports to the GitHub API */
-export const CODEQL_ACTION_TEST_MODE = "CODEQL_ACTION_TEST_MODE";
-
-/**
- * Used to disable the SARIF post-processing in the Action that removes duplicate locations from
- * notifications in the `run[].invocations[].toolExecutionNotifications` SARIF property.
- */
-export const CODEQL_ACTION_DISABLE_DUPLICATE_LOCATION_FIX =
-  "CODEQL_ACTION_DISABLE_DUPLICATE_LOCATION_FIX";
-
-/**
- * The time at which the first action (normally init) started executing.
- * If a workflow invokes a different action without first invoking the init
- * action (i.e. the upload action is being used by a third-party integrator)
- * then this variable will be assigned the start time of the action invoked
- * rather that the init action.
- */
-export const CODEQL_WORKFLOW_STARTED_AT = "CODEQL_WORKFLOW_STARTED_AT";
-
-export const ODASA_TRACER_CONFIGURATION = "ODASA_TRACER_CONFIGURATION";
-
-/** UUID representing the current job run. */
-export const JOB_RUN_UUID = "JOB_RUN_UUID";

src/upload-lib.ts

@@ -10,10 +10,10 @@ import * as jsonschema from "jsonschema";
 
 import * as actionsUtil from "./actions-util";
 import * as api from "./api-client";
+import { EnvVar } from "./environment";
 import * as fingerprints from "./fingerprints";
 import { Logger } from "./logging";
 import { parseRepositoryNwo, RepositoryNwo } from "./repository";
-import { CODEQL_WORKFLOW_STARTED_AT } from "./shared-environment";
 import * as util from "./util";
 import { SarifFile, SarifResult, SarifRun, wrapError } from "./util";
 import * as workflow from "./workflow";
@@ -287,7 +287,7 @@ export function buildPayload(
     workflow_run_attempt: workflowRunAttempt,
     checkout_uri: checkoutURI,
     environment,
-    started_at: process.env[CODEQL_WORKFLOW_STARTED_AT],
+    started_at: process.env[EnvVar.WORKFLOW_STARTED_AT],
     tool_names: toolNames,
     base_ref: undefined as undefined | string,
     base_sha: undefined as undefined | string,

src/util.ts

@@ -16,14 +16,10 @@ import {
   parsePacksSpecification,
   prettyPrintPack,
 } from "./config-utils";
+import { EnvVar } from "./environment";
 import { Feature, FeatureEnablement } from "./feature-flags";
 import { Language } from "./languages";
 import { Logger } from "./logging";
-import {
-  CODEQL_ACTION_DISABLE_DUPLICATE_LOCATION_FIX,
-  CODEQL_ACTION_TEST_MODE,
-  EnvVar,
-} from "./shared-environment";
 
 /**
  * Specifies bundle versions that are known to be broken
@@ -630,7 +626,7 @@ export function getMlPoweredJsQueriesStatus(config: Config): string {
  * In test mode, we don't upload SARIF results or status reports to the GitHub API.
  */
 export function isInTestMode(): boolean {
-  return process.env[CODEQL_ACTION_TEST_MODE] === "true";
+  return process.env[EnvVar.TEST_MODE] === "true";
 }
 
 /**
@@ -894,10 +890,10 @@ export function fixInvalidNotificationsInFile(
   outputPath: string,
   logger: Logger
 ): void {
-  if (process.env[CODEQL_ACTION_DISABLE_DUPLICATE_LOCATION_FIX] === "true") {
+  if (process.env[EnvVar.DISABLE_DUPLICATE_LOCATION_FIX] === "true") {
     logger.info(
       "SARIF notification object duplicate location fix disabled by the " +
-        `${CODEQL_ACTION_DISABLE_DUPLICATE_LOCATION_FIX} environment variable.`
+        `${EnvVar.DISABLE_DUPLICATE_LOCATION_FIX} environment variable.`
     );
     fs.renameSync(inputPath, outputPath);
   } else {

src/workflow.ts

@@ -6,6 +6,7 @@ import * as core from "@actions/core";
 import * as yaml from "js-yaml";
 
 import * as api from "./api-client";
+import { EnvVar } from "./environment";
 import { Logger } from "./logging";
 import { getRequiredEnvParam, isInTestMode } from "./util";
 
@@ -391,8 +392,7 @@ function getInputOrThrow(
 function getAnalyzeActionName() {
   if (
     isInTestMode() ||
-    process.env["CODEQL_ACTION_TESTING_ENVIRONMENT"] ===
-      "codeql-action-pr-checks"
+    process.env[EnvVar.TESTING_ENVIRONMENT] === "codeql-action-pr-checks"
   ) {
     return "./analyze";
   } else {