import * as cache from "@actions/cache"; import * as core from "@actions/core"; import { Events, Outputs, RefKey, State } from "../src/constants"; import * as actionUtils from "../src/utils/actionUtils"; import * as testUtils from "../src/utils/testUtils"; jest.mock("@actions/core"); jest.mock("@actions/cache"); beforeAll(() => { jest.spyOn(core, "getInput").mockImplementation((name, options) => { return jest.requireActual("@actions/core").getInput(name, options); }); }); afterEach(() => { delete process.env[Events.Key]; delete process.env[RefKey]; }); test("isGhes returns true if server url is not github.com", () => { try { process.env["GITHUB_SERVER_URL"] = "http://example.com"; expect(actionUtils.isGhes()).toBe(true); } finally { process.env["GITHUB_SERVER_URL"] = undefined; } }); test("isGhes returns false when server url is github.com", () => { try { process.env["GITHUB_SERVER_URL"] = "http://github.com"; expect(actionUtils.isGhes()).toBe(false); } finally { process.env["GITHUB_SERVER_URL"] = undefined; } }); test("isExactKeyMatch with undefined cache key returns false", () => { const key = "linux-rust"; const cacheKey = undefined; expect(actionUtils.isExactKeyMatch(key, cacheKey)).toBe(false); }); test("isExactKeyMatch with empty cache key returns false", () => { const key = "linux-rust"; const cacheKey = ""; expect(actionUtils.isExactKeyMatch(key, cacheKey)).toBe(false); }); test("isExactKeyMatch with different keys returns false", () => { const key = "linux-rust"; const cacheKey = "linux-"; expect(actionUtils.isExactKeyMatch(key, cacheKey)).toBe(false); }); test("isExactKeyMatch with different key accents returns false", () => { const key = "linux-áccent"; const cacheKey = "linux-accent"; expect(actionUtils.isExactKeyMatch(key, cacheKey)).toBe(false); }); test("isExactKeyMatch with same key returns true", () => { const key = "linux-rust"; const cacheKey = "linux-rust"; expect(actionUtils.isExactKeyMatch(key, cacheKey)).toBe(true); }); test("isExactKeyMatch with same key and different casing returns true", () => { const key = "linux-rust"; const cacheKey = "LINUX-RUST"; expect(actionUtils.isExactKeyMatch(key, cacheKey)).toBe(true); }); test("setOutputAndState with undefined entry to set cache-hit output", () => { const key = "linux-rust"; const cacheKey = undefined; const setOutputMock = jest.spyOn(core, "setOutput"); const saveStateMock = jest.spyOn(core, "saveState"); actionUtils.setOutputAndState(key, cacheKey); expect(setOutputMock).toHaveBeenCalledWith(Outputs.CacheHit, "false"); expect(setOutputMock).toHaveBeenCalledTimes(1); expect(saveStateMock).toHaveBeenCalledTimes(0); }); test("setOutputAndState with exact match to set cache-hit output and state", () => { const key = "linux-rust"; const cacheKey = "linux-rust"; const setOutputMock = jest.spyOn(core, "setOutput"); const saveStateMock = jest.spyOn(core, "saveState"); actionUtils.setOutputAndState(key, cacheKey); expect(setOutputMock).toHaveBeenCalledWith(Outputs.CacheHit, "true"); expect(setOutputMock).toHaveBeenCalledTimes(1); expect(saveStateMock).toHaveBeenCalledWith(State.CacheMatchedKey, cacheKey); expect(saveStateMock).toHaveBeenCalledTimes(1); }); test("setOutputAndState with no exact match to set cache-hit output and state", () => { const key = "linux-rust"; const cacheKey = "linux-rust-bb828da54c148048dd17899ba9fda624811cfb43"; const setOutputMock = jest.spyOn(core, "setOutput"); const saveStateMock = jest.spyOn(core, "saveState"); actionUtils.setOutputAndState(key, cacheKey); expect(setOutputMock).toHaveBeenCalledWith(Outputs.CacheHit, "false"); expect(setOutputMock).toHaveBeenCalledTimes(1); expect(saveStateMock).toHaveBeenCalledWith(State.CacheMatchedKey, cacheKey); expect(saveStateMock).toHaveBeenCalledTimes(1); }); test("getCacheState with no state returns undefined", () => { const getStateMock = jest.spyOn(core, "getState"); getStateMock.mockImplementation(() => { return ""; }); const state = actionUtils.getCacheState(); expect(state).toBe(undefined); expect(getStateMock).toHaveBeenCalledWith(State.CacheMatchedKey); expect(getStateMock).toHaveBeenCalledTimes(1); }); test("getCacheState with valid state", () => { const cacheKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43"; const getStateMock = jest.spyOn(core, "getState"); getStateMock.mockImplementation(() => { return cacheKey; }); const state = actionUtils.getCacheState(); expect(state).toEqual(cacheKey); expect(getStateMock).toHaveBeenCalledWith(State.CacheMatchedKey); expect(getStateMock).toHaveBeenCalledTimes(1); }); test("logWarning logs a message with a warning prefix", () => { const message = "A warning occurred."; const infoMock = jest.spyOn(core, "info"); actionUtils.logWarning(message); expect(infoMock).toHaveBeenCalledWith(`[warning]${message}`); }); test("isValidEvent returns false for event that does not have a branch or tag", () => { const event = "foo"; process.env[Events.Key] = event; const isValidEvent = actionUtils.isValidEvent(); expect(isValidEvent).toBe(false); }); test("isValidEvent returns true for event that has a ref", () => { const event = Events.Push; process.env[Events.Key] = event; process.env[RefKey] = "ref/heads/feature"; const isValidEvent = actionUtils.isValidEvent(); expect(isValidEvent).toBe(true); }); test("getInputAsArray returns empty array if not required and missing", () => { expect(actionUtils.getInputAsArray("foo")).toEqual([]); }); test("getInputAsArray throws error if required and missing", () => { expect(() => actionUtils.getInputAsArray("foo", { required: true }) ).toThrowError(); }); test("getInputAsArray handles single line correctly", () => { testUtils.setInput("foo", "bar"); expect(actionUtils.getInputAsArray("foo")).toEqual(["bar"]); }); test("getInputAsArray handles multiple lines correctly", () => { testUtils.setInput("foo", "bar\nbaz"); expect(actionUtils.getInputAsArray("foo")).toEqual(["bar", "baz"]); }); test("getInputAsArray handles different new lines correctly", () => { testUtils.setInput("foo", "bar\r\nbaz"); expect(actionUtils.getInputAsArray("foo")).toEqual(["bar", "baz"]); }); test("getInputAsArray handles empty lines correctly", () => { testUtils.setInput("foo", "\n\nbar\n\nbaz\n\n"); expect(actionUtils.getInputAsArray("foo")).toEqual(["bar", "baz"]); }); test("getInputAsArray sorts files correctly", () => { testUtils.setInput( "foo", "bar\n!baz\nwaldo\nqux\nquux\ncorge\ngrault\ngarply" ); expect(actionUtils.getInputAsArray("foo")).toEqual([ "!baz", "bar", "corge", "garply", "grault", "quux", "qux", "waldo" ]); }); test("getInputAsArray removes spaces after ! at the beginning", () => { testUtils.setInput( "foo", "! bar\n! baz\n! qux\n!quux\ncorge\ngrault! garply\n!\r\t waldo" ); expect(actionUtils.getInputAsArray("foo")).toEqual([ "!bar", "!baz", "!quux", "!qux", "!waldo", "corge", "grault! garply" ]); }); test("getInputAsInt returns undefined if input not set", () => { expect(actionUtils.getInputAsInt("undefined")).toBeUndefined(); }); test("getInputAsInt returns value if input is valid", () => { testUtils.setInput("foo", "8"); expect(actionUtils.getInputAsInt("foo")).toBe(8); }); test("getInputAsInt returns undefined if input is invalid or NaN", () => { testUtils.setInput("foo", "bar"); expect(actionUtils.getInputAsInt("foo")).toBeUndefined(); }); test("getInputAsInt throws if required and value missing", () => { expect(() => actionUtils.getInputAsInt("undefined", { required: true }) ).toThrowError(); }); test("isCacheFeatureAvailable for ac enabled", () => { jest.spyOn(cache, "isFeatureAvailable").mockImplementation(() => true); expect(actionUtils.isCacheFeatureAvailable()).toBe(true); }); test("isCacheFeatureAvailable for ac disabled on GHES", () => { jest.spyOn(cache, "isFeatureAvailable").mockImplementation(() => false); const message = `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 upgradeSee 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`; const infoMock = jest.spyOn(core, "info"); try { process.env["GITHUB_SERVER_URL"] = "http://example.com"; expect(actionUtils.isCacheFeatureAvailable()).toBe(false); expect(infoMock).toHaveBeenCalledWith(`[warning]${message}`); } finally { delete process.env["GITHUB_SERVER_URL"]; } }); test("isCacheFeatureAvailable for ac disabled on dotcom", () => { jest.spyOn(cache, "isFeatureAvailable").mockImplementation(() => false); const message = "An internal error has occurred in cache backend. Please check https://www.githubstatus.com/ for any ongoing issue in actions."; const infoMock = jest.spyOn(core, "info"); try { process.env["GITHUB_SERVER_URL"] = "http://github.com"; expect(actionUtils.isCacheFeatureAvailable()).toBe(false); expect(infoMock).toHaveBeenCalledWith(`[warning]${message}`); } finally { delete process.env["GITHUB_SERVER_URL"]; } });