Add unit tests for uploadPayload

src/upload-lib.test.ts

@@ -1,9 +1,14 @@
 import * as fs from "fs";
 import * as path from "path";
 
-import test from "ava";
+import * as github from "@actions/github";
+import { HTTPError } from "@actions/tool-cache";
+import test, { ExecutionContext } from "ava";
+import * as sinon from "sinon";
 
+import * as analyses from "./analyses";
 import { AnalysisKind, CodeQuality, CodeScanning } from "./analyses";
+import * as api from "./api-client";
 import { getRunnerLogger, Logger } from "./logging";
 import { setupTests } from "./testing-utils";
 import * as uploadLib from "./upload-lib";
@@ -867,3 +872,123 @@ function createMockSarif(id?: string, tool?: string) {
     ],
   };
 }
+
+const uploadPayloadMacro = test.macro({
+  exec: async (
+    t: ExecutionContext<unknown>,
+    options: {
+      analysis: analyses.AnalysisConfig;
+      body: (
+        t: ExecutionContext<unknown>,
+        upload: () => Promise<string>,
+        requestStub: sinon.SinonStub,
+        mockData: {
+          payload: { sarif: string; commit_sha: string };
+          owner: string;
+          repo: string;
+          response: {
+            status: number;
+            data: { id: string };
+            headers: any;
+            url: string;
+          };
+        },
+      ) => void | Promise<void>;
+    },
+  ) => {
+    const mockData = {
+      payload: { sarif: "base64data", commit_sha: "abc123" },
+      owner: "test-owner",
+      repo: "test-repo",
+      response: {
+        status: 200,
+        data: { id: "uploaded-sarif-id" },
+        headers: {},
+        url: options.analysis.target,
+      },
+    };
+
+    const client = github.getOctokit("123");
+    sinon.stub(api, "getApiClient").value(() => client);
+    const requestStub = sinon.stub(client, "request");
+
+    const upload = async () =>
+      uploadLib.uploadPayload(
+        mockData.payload,
+        {
+          owner: mockData.owner,
+          repo: mockData.repo,
+        },
+        getRunnerLogger(true),
+        options.analysis,
+      );
+
+    await options.body(t, upload, requestStub, mockData);
+  },
+  title: (providedTitle = "", options: { analysis: analyses.AnalysisConfig }) =>
+    `uploadPayload - ${options.analysis.name} - ${providedTitle}`,
+});
+
+for (const analysis of [CodeScanning, CodeQuality]) {
+  test("uploads successfully", uploadPayloadMacro, {
+    analysis,
+    body: async (t, upload, requestStub, mockData) => {
+      requestStub
+        .withArgs(analysis.target, {
+          owner: mockData.owner,
+          repo: mockData.repo,
+          data: mockData.payload,
+        })
+        .onFirstCall()
+        .returns(Promise.resolve(mockData.response));
+      const result = await upload();
+      t.is(result, mockData.response.data.id);
+      t.true(requestStub.calledOnce);
+    },
+  });
+
+  for (const envVar of [
+    "CODEQL_ACTION_SKIP_SARIF_UPLOAD",
+    "CODEQL_ACTION_TEST_MODE",
+  ]) {
+    test(`skips upload when ${envVar} is set`, uploadPayloadMacro, {
+      analysis,
+      body: async (t, upload, requestStub, mockData) =>
+        withTmpDir(async (tmpDir) => {
+          process.env.RUNNER_TEMP = tmpDir;
+          process.env[envVar] = "true";
+          const result = await upload();
+          t.is(result, "dummy-sarif-id");
+          t.false(requestStub.called);
+
+          const payloadFile = path.join(
+            tmpDir,
+            `payload-${analysis.kind}.json`,
+          );
+          t.true(fs.existsSync(payloadFile));
+
+          const savedPayload = JSON.parse(fs.readFileSync(payloadFile, "utf8"));
+          t.deepEqual(savedPayload, mockData.payload);
+        }),
+    });
+  }
+
+  test("handles error", uploadPayloadMacro, {
+    analysis,
+    body: async (t, upload, requestStub) => {
+      const wrapApiConfigurationErrorStub = sinon.stub(
+        api,
+        "wrapApiConfigurationError",
+      );
+      const originalError = new HTTPError(404);
+      const wrappedError = new Error("Wrapped error message");
+      requestStub.rejects(originalError);
+      wrapApiConfigurationErrorStub
+        .withArgs(originalError)
+        .returns(wrappedError);
+      await t.throwsAsync(upload, {
+        is: wrappedError,
+      });
+    },
+  });
+}

src/upload-lib.ts

@@ -346,9 +346,12 @@ function getAutomationID(
   return api.computeAutomationID(analysis_key, environment);
 }
 
-// Upload the given payload.
-// If the request fails then this will retry a small number of times.
-async function uploadPayload(
+/**
+ * Upload the given payload.
+ * If the request fails then this will retry a small number of times.
+ * This is exported for testing purposes only.
+ */
+export async function uploadPayload(
   payload: any,
   repositoryNwo: RepositoryNwo,
   logger: Logger,