Add unit test for typical workflow

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

@@ -1,12 +1,21 @@
 import test from "ava";
 import * as sinon from "sinon";
 
+import * as actionsUtil from "./actions-util";
+import * as codeql from "./codeql";
 import * as configUtils from "./config-utils";
+import { Feature } from "./feature-flags";
 import * as initActionPostHelper from "./init-action-post-helper";
 import { getRunnerLogger } from "./logging";
 import { parseRepositoryNwo } from "./repository";
-import { createFeatures, setupTests } from "./testing-utils";
+import {
+  createFeatures,
+  getRecordingLogger,
+  setupTests,
+} from "./testing-utils";
+import * as uploadLib from "./upload-lib";
 import * as util from "./util";
+import * as workflow from "./workflow";
 
 setupTests(test);
 
@@ -75,3 +84,87 @@ test("post: init action with debug mode on", async (t) => {
     t.assert(printDebugLogsSpy.called);
   });
 });
+
+test("uploads failed SARIF run for typical workflow", async (t) => {
+  const config = {
+    codeQLCmd: "codeql",
+    debugMode: true,
+    languages: [],
+    packs: [],
+  } as unknown as configUtils.Config;
+  const messages = [];
+  process.env["GITHUB_JOB"] = "analyze";
+  process.env["GITHUB_WORKSPACE"] =
+    "/home/runner/work/codeql-action/codeql-action";
+  sinon.stub(actionsUtil, "getRequiredInput").withArgs("matrix").returns("{}");
+
+  const codeqlObject = await codeql.getCodeQLForTesting();
+  sinon.stub(codeql, "getCodeQL").resolves(codeqlObject);
+  const diagnosticsExportStub = sinon.stub(codeqlObject, "diagnosticsExport");
+
+  sinon.stub(workflow, "getWorkflow").resolves({
+    name: "CodeQL",
+    on: {
+      push: {
+        branches: ["main"],
+      },
+      pull_request: {
+        branches: ["main"],
+      },
+    },
+    jobs: {
+      analyze: {
+        name: "CodeQL Analysis",
+        "runs-on": "ubuntu-latest",
+        steps: [
+          {
+            name: "Checkout repository",
+            uses: "actions/checkout@v3",
+          },
+          {
+            name: "Initialize CodeQL",
+            uses: "github/codeql-action/init@v2",
+            with: {
+              languages: "javascript",
+            },
+          },
+          {
+            name: "Perform CodeQL Analysis",
+            uses: "github/codeql-action/analyze@v2",
+            with: {
+              category: "my-category",
+            },
+          },
+        ],
+      },
+    },
+  });
+
+  const uploadFromActions = sinon.stub(uploadLib, "uploadFromActions");
+  uploadFromActions.resolves({ sarifID: "42" } as uploadLib.UploadResult);
+  const waitForProcessing = sinon.stub(uploadLib, "waitForProcessing");
+
+  await initActionPostHelper.uploadFailedSarif(
+    config,
+    parseRepositoryNwo("github/codeql-action"),
+    createFeatures([Feature.UploadFailedSarifEnabled]),
+    getRecordingLogger(messages)
+  );
+  t.deepEqual(messages, []);
+  t.true(
+    diagnosticsExportStub.calledOnceWith(sinon.match.string, "my-category")
+  );
+  t.true(
+    uploadFromActions.calledOnceWith(
+      sinon.match.string,
+      sinon.match.string,
+      "my-category",
+      sinon.match.any
+    )
+  );
+  t.true(
+    waitForProcessing.calledOnceWith(sinon.match.any, "42", sinon.match.any, {
+      isUnsuccessfulExecution: true,
+    })
+  );
+});

src/init-action-post-helper.ts

@@ -16,7 +16,7 @@ import {
   getWorkflow,
 } from "./workflow";
 
-async function uploadFailedSarif(
+export async function uploadFailedSarif(
   config: Config,
   repositoryNwo: RepositoryNwo,
   featureEnablement: FeatureEnablement,

src/workflow.ts

@@ -8,12 +8,15 @@ import * as api from "./api-client";
 import { getRequiredEnvParam } from "./util";
 
 interface WorkflowJobStep {
-  run: any;
+  name?: string;
+  run?: any;
   uses?: string;
   with?: { [key: string]: string };
 }
 
 interface WorkflowJob {
+  name?: string;
+  "runs-on"?: string;
   steps?: WorkflowJobStep[];
 }
 
@@ -33,6 +36,7 @@ interface WorkflowTriggers {
 }
 
 export interface Workflow {
+  name?: string;
   jobs?: { [key: string]: WorkflowJob };
   on?: string | string[] | WorkflowTriggers;
 }