Import actions/cache @v4

src/utils/actionUtils.ts

@@ -0,0 +1,86 @@
+import * as cache from "@actions/cache";
+import * as core from "@actions/core";
+
+import { RefKey } from "../constants";
+
+export function isGhes(): boolean {
+    const ghUrl = new URL(
+        process.env["GITHUB_SERVER_URL"] || "https://github.com"
+    );
+
+    const hostname = ghUrl.hostname.trimEnd().toUpperCase();
+    const isGitHubHost = hostname === "GITHUB.COM";
+    const isGitHubEnterpriseCloudHost = hostname.endsWith(".GHE.COM");
+    const isLocalHost = hostname.endsWith(".LOCALHOST");
+
+    return !isGitHubHost && !isGitHubEnterpriseCloudHost && !isLocalHost;
+}
+
+export function isExactKeyMatch(key: string, cacheKey?: string): boolean {
+    return !!(
+        cacheKey &&
+        cacheKey.localeCompare(key, undefined, {
+            sensitivity: "accent"
+        }) === 0
+    );
+}
+
+export function logWarning(message: string): void {
+    const warningPrefix = "[warning]";
+    core.info(`${warningPrefix}${message}`);
+}
+
+// Cache token authorized for all events that are tied to a ref
+// See GitHub Context https://help.github.com/actions/automating-your-workflow-with-github-actions/contexts-and-expression-syntax-for-github-actions#github-context
+export function isValidEvent(): boolean {
+    return RefKey in process.env && Boolean(process.env[RefKey]);
+}
+
+export function getInputAsArray(
+    name: string,
+    options?: core.InputOptions
+): string[] {
+    return core
+        .getInput(name, options)
+        .split("\n")
+        .map(s => s.replace(/^!\s+/, "!").trim())
+        .filter(x => x !== "");
+}
+
+export function getInputAsInt(
+    name: string,
+    options?: core.InputOptions
+): number | undefined {
+    const value = parseInt(core.getInput(name, options));
+    if (isNaN(value) || value < 0) {
+        return undefined;
+    }
+    return value;
+}
+
+export function getInputAsBool(
+    name: string,
+    options?: core.InputOptions
+): boolean {
+    const result = core.getInput(name, options);
+    return result.toLowerCase() === "true";
+}
+
+export function isCacheFeatureAvailable(): boolean {
+    if (cache.isFeatureAvailable()) {
+        return true;
+    }
+
+    if (isGhes()) {
+        logWarning(
+            `Cache action is only supported on GHES version >= 3.5. If you are on version >=3.5 Please check with GHES admin if Actions cache service is enabled or not.
+Otherwise please upgrade to GHES version >= 3.5 and If you are also using Github Connect, please unretire the actions/cache namespace before upgrade (see https://docs.github.com/en/enterprise-server@3.5/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect#automatic-retirement-of-namespaces-for-actions-accessed-on-githubcom)`
+        );
+        return false;
+    }
+
+    logWarning(
+        "An internal error has occurred in cache backend. Please check https://www.githubstatus.com/ for any ongoing issue in actions."
+    );
+    return false;
+}

src/utils/testUtils.ts

@@ -0,0 +1,45 @@
+import { Inputs } from "../constants";
+
+// See: https://github.com/actions/toolkit/blob/master/packages/core/src/core.ts#L67
+function getInputName(name: string): string {
+    return `INPUT_${name.replace(/ /g, "_").toUpperCase()}`;
+}
+
+export function setInput(name: string, value: string): void {
+    process.env[getInputName(name)] = value;
+}
+
+interface CacheInput {
+    path: string;
+    key: string;
+    restoreKeys?: string[];
+    enableCrossOsArchive?: boolean;
+    failOnCacheMiss?: boolean;
+    lookupOnly?: boolean;
+}
+
+export function setInputs(input: CacheInput): void {
+    setInput(Inputs.Path, input.path);
+    setInput(Inputs.Key, input.key);
+    input.restoreKeys &&
+        setInput(Inputs.RestoreKeys, input.restoreKeys.join("\n"));
+    input.enableCrossOsArchive !== undefined &&
+        setInput(
+            Inputs.EnableCrossOsArchive,
+            input.enableCrossOsArchive.toString()
+        );
+    input.failOnCacheMiss !== undefined &&
+        setInput(Inputs.FailOnCacheMiss, input.failOnCacheMiss.toString());
+    input.lookupOnly !== undefined &&
+        setInput(Inputs.LookupOnly, input.lookupOnly.toString());
+}
+
+export function clearInputs(): void {
+    delete process.env[getInputName(Inputs.Path)];
+    delete process.env[getInputName(Inputs.Key)];
+    delete process.env[getInputName(Inputs.RestoreKeys)];
+    delete process.env[getInputName(Inputs.UploadChunkSize)];
+    delete process.env[getInputName(Inputs.EnableCrossOsArchive)];
+    delete process.env[getInputName(Inputs.FailOnCacheMiss)];
+    delete process.env[getInputName(Inputs.LookupOnly)];
+}