Factor out test mode determination code

github · Apr 28, 2022 · 7c2be06 · 7c2be06
1 parent 0c3c093
commit 7c2be06
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 12 deletions.
diff --git a/lib/actions-util.js b/lib/actions-util.js
diff --git a/lib/actions-util.js.map b/lib/actions-util.js.map
diff --git a/lib/upload-lib.js b/lib/upload-lib.js
diff --git a/lib/upload-lib.js.map b/lib/upload-lib.js.map
diff --git a/lib/util.js b/lib/util.js
diff --git a/lib/util.js.map b/lib/util.js.map
diff --git a/src/actions-util.ts b/src/actions-util.ts
@@ -15,6 +15,7 @@ import {
   GITHUB_DOTCOM_URL,
   isGitHubGhesVersionBelow,
   isHTTPError,
+  isInTestMode,
   UserError,
 } from "./util";
 
@@ -763,8 +764,7 @@ export async function sendStatusReport<S extends StatusReportBase>(
   const statusReportJSON = JSON.stringify(statusReport);
   core.debug(`Sending status report: ${statusReportJSON}`);
   // If in test mode we don't want to upload the results
-  const testMode = process.env["TEST_MODE"] === "true" || false;
-  if (testMode) {
+  if (isInTestMode()) {
     core.debug("In test mode. Status reports are not uploaded.");
     return true;
   }

diff --git a/src/upload-lib.ts b/src/upload-lib.ts
@@ -98,8 +98,7 @@ async function uploadPayload(
   logger.info("Uploading results");
 
   // If in test mode we don't want to upload the results
-  const testMode = process.env["TEST_MODE"] === "true" || false;
-  if (testMode) {
+  if (util.isInTestMode()) {
     const payloadSaveFile = path.join(
       actionsUtil.getTemporaryDirectory(),
       "payload.json"

diff --git a/src/util.ts b/src/util.ts
@@ -742,3 +742,12 @@ export async function checkActionVersion(version: string) {
     }
   }
 }
+
+/*
+ * Returns whether we are in test mode.
+ *
+ * In test mode, we don't upload SARIF results or status reports to the GitHub API.
+ */
+export function isInTestMode(): boolean {
+  return process.env["TEST_MODE"] === "true" || false;
+}