Rename secondary run to uploadFailureInfo

Author: mbg

lib/init-action-post.js

@@ -45,7 +45,7 @@ test("init-post action with debug mode off", async (t) => {
     const uploadAllAvailableDebugArtifactsSpy = sinon.spy();
     const printDebugLogsSpy = sinon.spy();
 
-    await initActionPostHelper.run(
+    await initActionPostHelper.uploadFailureInfo(
       uploadAllAvailableDebugArtifactsSpy,
       printDebugLogsSpy,
       codeql.createStubCodeQL({}),
@@ -68,7 +68,7 @@ test("init-post action with debug mode on", async (t) => {
     const uploadAllAvailableDebugArtifactsSpy = sinon.spy();
     const printDebugLogsSpy = sinon.spy();
 
-    await initActionPostHelper.run(
+    await initActionPostHelper.uploadFailureInfo(
       uploadAllAvailableDebugArtifactsSpy,
       printDebugLogsSpy,
       codeql.createStubCodeQL({}),
@@ -332,7 +332,7 @@ test("saves overlay status when overlay-base analysis did not complete successfu
 
     const stubCodeQL = codeql.createStubCodeQL({});
 
-    await initActionPostHelper.run(
+    await initActionPostHelper.uploadFailureInfo(
       sinon.spy(),
       sinon.spy(),
       stubCodeQL,
@@ -392,7 +392,7 @@ test("does not save overlay status when OverlayAnalysisStatusSave feature flag i
       .stub(overlayStatus, "saveOverlayStatus")
       .resolves(true);
 
-    await initActionPostHelper.run(
+    await initActionPostHelper.uploadFailureInfo(
       sinon.spy(),
       sinon.spy(),
       codeql.createStubCodeQL({}),
@@ -429,7 +429,7 @@ test("does not save overlay status when build successful", async (t) => {
       .stub(overlayStatus, "saveOverlayStatus")
       .resolves(true);
 
-    await initActionPostHelper.run(
+    await initActionPostHelper.uploadFailureInfo(
       sinon.spy(),
       sinon.spy(),
       codeql.createStubCodeQL({}),
@@ -465,7 +465,7 @@ test("does not save overlay status when overlay not enabled", async (t) => {
       .stub(overlayStatus, "saveOverlayStatus")
       .resolves(true);
 
-    await initActionPostHelper.run(
+    await initActionPostHelper.uploadFailureInfo(
       sinon.spy(),
       sinon.spy(),
       codeql.createStubCodeQL({}),

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

@@ -158,7 +158,21 @@ export async function tryUploadSarifIfRunFailed(
   }
 }
 
-export async function run(
+/**
+ * Handles the majority of the `post-init` step logic which, depending on the configuration,
+ * mainly involves uploading a SARIF file with information about the failued run, debug
+ * artifacts, and performing clean-up operations.
+ *
+ * @param uploadAllAvailableDebugArtifacts A function with which to upload debug artifacts.
+ * @param printDebugLogs A function with which to print debug logs.
+ * @param codeql The CodeQL CLI instance.
+ * @param config The CodeQL Action configuration.
+ * @param repositoryNwo The name and owner of the repository.
+ * @param features Information about enabled features.
+ * @param logger The logger to use.
+ * @returns The results of uploading the SARIF file for the failure.
+ */
+export async function uploadFailureInfo(
   uploadAllAvailableDebugArtifacts: (
     codeql: CodeQL,
     config: Config,
@@ -171,7 +185,7 @@ export async function run(
   repositoryNwo: RepositoryNwo,
   features: FeatureEnablement,
   logger: Logger,
-) {
+): Promise<UploadFailedSarifResult> {
   await recordOverlayStatus(codeql, config, features, logger);
 
   const uploadFailedSarifResult = await tryUploadSarifIfRunFailed(

src/init-action-post-helper.ts

@@ -77,7 +77,7 @@ async function run(startedAt: Date) {
     } else {
       const codeql = await getCodeQL(config.codeQLCmd);
 
-      uploadFailedSarifResult = await initActionPostHelper.run(
+      uploadFailedSarifResult = await initActionPostHelper.uploadFailureInfo(
         debugArtifacts.tryUploadAllAvailableDebugArtifacts,
         printDebugLogs,
         codeql,