Add tests for shouldSkipOverlayAnalysis

Author: henrymercer

src/overlay/status.test.ts

@@ -1,9 +1,19 @@
+import * as fs from "fs";
+import * as path from "path";
+
+import * as actionsCache from "@actions/cache";
 import test from "ava";
+import * as sinon from "sinon";
 
-import { mockCodeQLVersion, setupTests } from "../testing-utils";
-import { DiskUsage } from "../util";
+import {
+  getRecordingLogger,
+  LoggedMessage,
+  mockCodeQLVersion,
+  setupTests,
+} from "../testing-utils";
+import { DiskUsage, withTmpDir } from "../util";
 
-import { getCacheKey } from "./status";
+import { getCacheKey, shouldSkipOverlayAnalysis } from "./status";
 
 setupTests(test);
 
@@ -61,3 +71,102 @@ test("getCacheKey rounds disk space down to nearest 10 GiB", async (t) => {
     "codeql-overlay-status-javascript-2.20.0-runner-10GB",
   );
 });
+
+test("shouldSkipOverlayAnalysis returns false when no cached status exists", async (t) => {
+  await withTmpDir(async (tmpDir) => {
+    process.env["RUNNER_TEMP"] = tmpDir;
+    const codeql = mockCodeQLVersion("2.20.0");
+    const messages: LoggedMessage[] = [];
+    const logger = getRecordingLogger(messages);
+
+    sinon.stub(actionsCache, "restoreCache").resolves(undefined);
+
+    const result = await shouldSkipOverlayAnalysis(
+      codeql,
+      ["javascript"],
+      makeDiskUsage(50),
+      logger,
+    );
+
+    t.false(result);
+    t.true(
+      messages.some(
+        (m) =>
+          m.type === "debug" &&
+          typeof m.message === "string" &&
+          m.message.includes("No cached overlay status found."),
+      ),
+    );
+  });
+});
+
+test("shouldSkipOverlayAnalysis returns true when cached status indicates failed build", async (t) => {
+  await withTmpDir(async (tmpDir) => {
+    process.env["RUNNER_TEMP"] = tmpDir;
+    const codeql = mockCodeQLVersion("2.20.0");
+    const messages: LoggedMessage[] = [];
+    const logger = getRecordingLogger(messages);
+
+    const status = {
+      attemptedToBuildOverlayBaseDatabase: true,
+      builtOverlayBaseDatabase: false,
+    };
+
+    // Stub restoreCache to write the status file and return a key
+    sinon.stub(actionsCache, "restoreCache").callsFake(async (paths) => {
+      const statusFile = paths[0];
+      await fs.promises.mkdir(path.dirname(statusFile), { recursive: true });
+      await fs.promises.writeFile(statusFile, JSON.stringify(status));
+      return "found-key";
+    });
+
+    const result = await shouldSkipOverlayAnalysis(
+      codeql,
+      ["javascript"],
+      makeDiskUsage(50),
+      logger,
+    );
+
+    t.true(result);
+  });
+});
+
+test("shouldSkipOverlayAnalysis returns false when cached status indicates successful build", async (t) => {
+  await withTmpDir(async (tmpDir) => {
+    process.env["RUNNER_TEMP"] = tmpDir;
+    const codeql = mockCodeQLVersion("2.20.0");
+    const messages: LoggedMessage[] = [];
+    const logger = getRecordingLogger(messages);
+
+    const status = {
+      attemptedToBuildOverlayBaseDatabase: true,
+      builtOverlayBaseDatabase: true,
+    };
+
+    sinon.stub(actionsCache, "restoreCache").callsFake(async (paths) => {
+      const statusFile = paths[0];
+      await fs.promises.mkdir(path.dirname(statusFile), { recursive: true });
+      await fs.promises.writeFile(statusFile, JSON.stringify(status));
+      return "found-key";
+    });
+
+    const result = await shouldSkipOverlayAnalysis(
+      codeql,
+      ["javascript"],
+      makeDiskUsage(50),
+      logger,
+    );
+
+    t.false(result);
+    t.true(
+      messages.some(
+        (m) =>
+          m.type === "debug" &&
+          typeof m.message === "string" &&
+          m.message.includes(
+            "Cached overlay status does not indicate a previous unsuccessful attempt",
+          ),
+      ),
+    );
+  });
+});