Add unit tests for post: hook run methods

src/analyze-action-post-helper.test.ts

@@ -0,0 +1,57 @@
+import test from "ava";
+import * as sinon from "sinon";
+
+import * as actionsUtil from "./actions-util";
+import * as analyzeActionPostHelper from "./analyze-action-post-helper";
+import * as configUtils from "./config-utils";
+import { setupTests } from "./testing-utils";
+import * as util from "./util";
+
+setupTests(test);
+
+test("post: analyze action with debug mode off", async (t) => {
+  return await util.withTmpDir(async (tmpDir) => {
+    process.env["RUNNER_TEMP"] = tmpDir;
+
+    const gitHubVersion: util.GitHubVersion = {
+      type: util.GitHubVariant.DOTCOM,
+    };
+    sinon.stub(configUtils, "getConfig").resolves({
+      debugMode: false,
+      gitHubVersion,
+      languages: [],
+      packs: [],
+    } as unknown as configUtils.Config);
+
+    const uploadSarifSpy = sinon.spy();
+
+    await analyzeActionPostHelper.run(uploadSarifSpy);
+
+    t.assert(uploadSarifSpy.notCalled);
+  });
+});
+
+test("post: analyze action with debug mode on", async (t) => {
+  return await util.withTmpDir(async (tmpDir) => {
+    process.env["RUNNER_TEMP"] = tmpDir;
+
+    const gitHubVersion: util.GitHubVersion = {
+      type: util.GitHubVariant.DOTCOM,
+    };
+    sinon.stub(configUtils, "getConfig").resolves({
+      debugMode: true,
+      gitHubVersion,
+      languages: [],
+      packs: [],
+    } as unknown as configUtils.Config);
+
+    const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
+    requiredInputStub.withArgs("output").returns("fake-output-dir");
+
+    const uploadSarifSpy = sinon.spy();
+
+    await analyzeActionPostHelper.run(uploadSarifSpy);
+
+    t.assert(uploadSarifSpy.called);
+  });
+});

src/analyze-action-post-helper.ts

@@ -0,0 +1,26 @@
+// REVIEW: What do you think about the name of this file?
+import * as core from "@actions/core";
+
+import * as actionsUtil from "./actions-util";
+import { getConfig } from "./config-utils";
+import { getActionsLogger } from "./logging";
+
+export async function run(uploadSarifDebugArtifact: Function) {
+  const logger = getActionsLogger();
+
+  const config = await getConfig(actionsUtil.getTemporaryDirectory(), logger);
+  if (config === undefined) {
+    throw new Error(
+      "Config file could not be found at expected location. Did the 'init' action fail to start?"
+    );
+  }
+
+  // Upload Actions SARIF artifacts for debugging
+  if (config?.debugMode) {
+    core.info(
+      "Debug mode is on. Uploading available SARIF files as Actions debugging artifact..."
+    );
+    const outputDir = actionsUtil.getRequiredInput("output");
+    await uploadSarifDebugArtifact(config, outputDir);
+  }
+}

src/analyze-action-post.test.ts

@@ -1 +0,0 @@
-// TODO(angelapwen): Test run() here

src/analyze-action-post.ts

@@ -5,34 +5,12 @@
  */
 import * as core from "@actions/core";
 
-import * as actionsUtil from "./actions-util";
-import { getConfig } from "./config-utils";
+import * as analyzeActionPostHelper from "./analyze-action-post-helper";
 import * as debugArtifacts from "./debug-artifacts";
-import { getActionsLogger } from "./logging";
-
-async function run(uploadSarifDebugArtifact: Function) {
-  const logger = getActionsLogger();
-
-  const config = await getConfig(actionsUtil.getTemporaryDirectory(), logger);
-  if (config === undefined) {
-    throw new Error(
-      "Config file could not be found at expected location. Did the 'init' action fail to start?"
-    );
-  }
-
-  // Upload Actions SARIF artifacts for debugging
-  if (config?.debugMode) {
-    core.info(
-      "Debug mode is on. Uploading available SARIF files as Actions debugging artifact..."
-    );
-    const outputDir = actionsUtil.getRequiredInput("output");
-    await uploadSarifDebugArtifact(config, outputDir);
-  }
-}
 
 async function runWrapper() {
   try {
-    await run(debugArtifacts.uploadSarifDebugArtifact);
+    await analyzeActionPostHelper.run(debugArtifacts.uploadSarifDebugArtifact);
   } catch (error) {
     core.setFailed(`analyze post-action step failed: ${error}`);
     console.log(error);

src/init-action-post-helper.test.ts

@@ -0,0 +1,69 @@
+import test from "ava";
+import * as sinon from "sinon";
+
+import * as configUtils from "./config-utils";
+import * as initActionPostHelper from "./init-action-post-helper";
+import { setupTests } from "./testing-utils";
+import * as util from "./util";
+
+setupTests(test);
+
+test("post: init action with debug mode off", async (t) => {
+  return await util.withTmpDir(async (tmpDir) => {
+    process.env["RUNNER_TEMP"] = tmpDir;
+
+    const gitHubVersion: util.GitHubVersion = {
+      type: util.GitHubVariant.DOTCOM,
+    };
+    sinon.stub(configUtils, "getConfig").resolves({
+      debugMode: false,
+      gitHubVersion,
+      languages: [],
+      packs: [],
+    } as unknown as configUtils.Config);
+
+    const uploadDatabaseBundleSpy = sinon.spy();
+    const uploadLogsSpy = sinon.spy();
+    const printDebugLogsSpy = sinon.spy();
+
+    await initActionPostHelper.run(
+      uploadDatabaseBundleSpy,
+      uploadLogsSpy,
+      printDebugLogsSpy
+    );
+
+    t.assert(uploadDatabaseBundleSpy.notCalled);
+    t.assert(uploadLogsSpy.notCalled);
+    t.assert(printDebugLogsSpy.notCalled);
+  });
+});
+
+test("post: init action with debug mode on", async (t) => {
+  return await util.withTmpDir(async (tmpDir) => {
+    process.env["RUNNER_TEMP"] = tmpDir;
+
+    const gitHubVersion: util.GitHubVersion = {
+      type: util.GitHubVariant.DOTCOM,
+    };
+    sinon.stub(configUtils, "getConfig").resolves({
+      debugMode: true,
+      gitHubVersion,
+      languages: [],
+      packs: [],
+    } as unknown as configUtils.Config);
+
+    const uploadDatabaseBundleSpy = sinon.spy();
+    const uploadLogsSpy = sinon.spy();
+    const printDebugLogsSpy = sinon.spy();
+
+    await initActionPostHelper.run(
+      uploadDatabaseBundleSpy,
+      uploadLogsSpy,
+      printDebugLogsSpy
+    );
+
+    t.assert(uploadDatabaseBundleSpy.called);
+    t.assert(uploadLogsSpy.called);
+    t.assert(printDebugLogsSpy.called);
+  });
+});

src/init-action-post-helper.ts

@@ -0,0 +1,32 @@
+// REVIEW: What do you think about the name of this file?
+import * as core from "@actions/core";
+
+import * as actionsUtil from "./actions-util";
+import { getConfig } from "./config-utils";
+import { getActionsLogger } from "./logging";
+
+export async function run(
+  uploadDatabaseBundleDebugArtifact: Function,
+  uploadLogsDebugArtifact: Function,
+  printDebugLogs: Function
+) {
+  const logger = getActionsLogger();
+
+  const config = await getConfig(actionsUtil.getTemporaryDirectory(), logger);
+  if (config === undefined) {
+    throw new Error(
+      "Config file could not be found at expected location. Did the 'init' action fail to start?"
+    );
+  }
+
+  // Upload appropriate Actions artifacts for debugging
+  if (config?.debugMode) {
+    core.info(
+      "Debug mode is on. Uploading available database bundles and logs as Actions debugging artifacts..."
+    );
+    await uploadDatabaseBundleDebugArtifact(config, logger);
+    await uploadLogsDebugArtifact(config);
+
+    await printDebugLogs(config);
+  }
+}

src/init-action-post.test.ts

@@ -1 +0,0 @@
-// TODO(angelapwen): Test run() here.

src/init-action-post.ts

@@ -7,39 +7,12 @@
 import * as core from "@actions/core";
 
 import * as actionsUtil from "./actions-util";
-import { getConfig } from "./config-utils";
 import * as debugArtifacts from "./debug-artifacts";
-import { getActionsLogger } from "./logging";
-
-async function run(
-  uploadDatabaseBundleDebugArtifact: Function,
-  uploadLogsDebugArtifact: Function,
-  printDebugLogs: Function
-) {
-  const logger = getActionsLogger();
-
-  const config = await getConfig(actionsUtil.getTemporaryDirectory(), logger);
-  if (config === undefined) {
-    throw new Error(
-      "Config file could not be found at expected location. Did the 'init' action fail to start?"
-    );
-  }
-
-  // Upload appropriate Actions artifacts for debugging
-  if (config?.debugMode) {
-    core.info(
-      "Debug mode is on. Uploading available database bundles and logs as Actions debugging artifacts..."
-    );
-    await uploadDatabaseBundleDebugArtifact(config, logger);
-    await uploadLogsDebugArtifact(config);
-
-    await printDebugLogs(config);
-  }
-}
+import * as initActionPostHelper from "./init-action-post-helper";
 
 async function runWrapper() {
   try {
-    await run(
+    await initActionPostHelper.run(
       debugArtifacts.uploadDatabaseBundleDebugArtifact,
       debugArtifacts.uploadLogsDebugArtifact,
       actionsUtil.printDebugLogs