cache/__tests__/restoreOnly.test.ts

178 lines
5.4 KiB
TypeScript
Raw Normal View History

GA for granular cache (#1035) * Add example for Haskell Stack * Revert "Add example for Haskell Stack" * Basic implementation * Updated variable name * Adding wrapper class * Changed logs to warnings * added debug logs * experimenting * Test * test * new try * test * Impl separated * Reverted wrapper changes * Added test cases * Some cleanup * Formatted document * Fixed test cases issues * Slight modification for test cases check * Updated new actions' input descriptions * Reverted custom asks implemented and added wrapper * refactor into a generic outputter * Readme draft for new actions * Generated dist * Fixed breaking test case * Removed return type in promise * Removed commented lines * Calling methods from same file * dist * update save as well * fix merge * Changes for beta release * Update dist folder * Fixed formatting * dist * Add support for gzip fallback for restore of old cache on windows * Fixed test cases * Fixed test cases * Added restore only and save only test cases * Updated new actions dist files * Removed comments * Fixed inputs * Renamed variables and added tests * Fixed breaking test case * Fixed review comments and tests * added stateprovider changes * Deleted stateprovider tests until added * Added stateprovider test cases * Fixed breaking test case * Updated outputs of restore action * Changes for beta release * Update dist folder * Add support for gzip fallback for restore of old cache on windows * update for new beta release * Update save/action.yml Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com> * Update restore/action.yml Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com> * Update restore/action.yml Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com> * Update restore/action.yml Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com> * Update restore/action.yml Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com> * Added more assertions as values can't be checked * Removed unused code * Merged beta branch and resolved conflicts * Added save readme * Updates to save readme * Renamed output * Added cache hit info in readme * Update restore/README.md Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com> * Update restore/README.md Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com> * Update restore/README.md Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com> * Update save/README.md Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com> * Update save/README.md Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com> * Removed verbose statements * Repositioned new actions introduction * Added test case for restore state * Addressed review comments * nit * nit: added language to code blocks * Updated beta version to 3.2.0-beta.1 * Added stateprovider mock implementations * Linting errors fixed * Save-only warning added * Updated return ID to -2 * Removed -2 error code * Removed comment * Updated cache npm lib version * Updated license version * Updated releases.md * Updated readme with the new actions in what's new Co-authored-by: Malo Bourgon <mbourgon@gmail.com> Co-authored-by: Vipul <vsvipul@github.com> Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com> Co-authored-by: Tanuj Kumar Mishra <tanuj077@users.noreply.github.com> Co-authored-by: Sampark Sharma <phantsure@github.com>
2022-12-21 21:08:44 +07:00
import * as cache from "@actions/cache";
import * as core from "@actions/core";
import { Events, RefKey } from "../src/constants";
import run from "../src/restoreOnly";
import * as actionUtils from "../src/utils/actionUtils";
import * as testUtils from "../src/utils/testUtils";
jest.mock("../src/utils/actionUtils");
beforeAll(() => {
jest.spyOn(actionUtils, "isExactKeyMatch").mockImplementation(
(key, cacheResult) => {
const actualUtils = jest.requireActual("../src/utils/actionUtils");
return actualUtils.isExactKeyMatch(key, cacheResult);
}
);
jest.spyOn(actionUtils, "isValidEvent").mockImplementation(() => {
const actualUtils = jest.requireActual("../src/utils/actionUtils");
return actualUtils.isValidEvent();
});
jest.spyOn(actionUtils, "getInputAsArray").mockImplementation(
(name, options) => {
const actualUtils = jest.requireActual("../src/utils/actionUtils");
return actualUtils.getInputAsArray(name, options);
}
);
});
beforeEach(() => {
process.env[Events.Key] = Events.Push;
process.env[RefKey] = "refs/heads/feature-branch";
jest.spyOn(actionUtils, "isGhes").mockImplementation(() => false);
jest.spyOn(actionUtils, "isCacheFeatureAvailable").mockImplementation(
() => true
);
});
afterEach(() => {
testUtils.clearInputs();
delete process.env[Events.Key];
delete process.env[RefKey];
});
test("restore with no cache found", async () => {
const path = "node_modules";
const key = "node-test";
testUtils.setInputs({
path: path,
key
});
const infoMock = jest.spyOn(core, "info");
const failedMock = jest.spyOn(core, "setFailed");
const outputMock = jest.spyOn(core, "setOutput");
const restoreCacheMock = jest
.spyOn(cache, "restoreCache")
.mockImplementationOnce(() => {
return Promise.resolve(undefined);
});
await run();
expect(restoreCacheMock).toHaveBeenCalledTimes(1);
expect(restoreCacheMock).toHaveBeenCalledWith([path], key, []);
expect(outputMock).toHaveBeenCalledWith("cache-primary-key", key);
expect(outputMock).toHaveBeenCalledTimes(1);
expect(failedMock).toHaveBeenCalledTimes(0);
expect(infoMock).toHaveBeenCalledWith(
`Cache not found for input keys: ${key}`
);
});
test("restore with restore keys and no cache found", async () => {
const path = "node_modules";
const key = "node-test";
const restoreKey = "node-";
testUtils.setInputs({
path: path,
key,
restoreKeys: [restoreKey]
});
const infoMock = jest.spyOn(core, "info");
const failedMock = jest.spyOn(core, "setFailed");
const outputMock = jest.spyOn(core, "setOutput");
const restoreCacheMock = jest
.spyOn(cache, "restoreCache")
.mockImplementationOnce(() => {
return Promise.resolve(undefined);
});
await run();
expect(restoreCacheMock).toHaveBeenCalledTimes(1);
expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [restoreKey]);
expect(outputMock).toHaveBeenCalledWith("cache-primary-key", key);
expect(failedMock).toHaveBeenCalledTimes(0);
expect(infoMock).toHaveBeenCalledWith(
`Cache not found for input keys: ${key}, ${restoreKey}`
);
});
test("restore with cache found for key", async () => {
const path = "node_modules";
const key = "node-test";
testUtils.setInputs({
path: path,
key
});
const infoMock = jest.spyOn(core, "info");
const failedMock = jest.spyOn(core, "setFailed");
const outputMock = jest.spyOn(core, "setOutput");
const restoreCacheMock = jest
.spyOn(cache, "restoreCache")
.mockImplementationOnce(() => {
return Promise.resolve(key);
});
await run();
expect(restoreCacheMock).toHaveBeenCalledTimes(1);
expect(restoreCacheMock).toHaveBeenCalledWith([path], key, []);
expect(outputMock).toHaveBeenCalledWith("cache-primary-key", key);
expect(outputMock).toHaveBeenCalledWith("cache-hit", "true");
expect(outputMock).toHaveBeenCalledWith("cache-matched-key", key);
expect(outputMock).toHaveBeenCalledTimes(3);
expect(infoMock).toHaveBeenCalledWith(`Cache restored from key: ${key}`);
expect(failedMock).toHaveBeenCalledTimes(0);
});
test("restore with cache found for restore key", async () => {
const path = "node_modules";
const key = "node-test";
const restoreKey = "node-";
testUtils.setInputs({
path: path,
key,
restoreKeys: [restoreKey]
});
const infoMock = jest.spyOn(core, "info");
const failedMock = jest.spyOn(core, "setFailed");
const outputMock = jest.spyOn(core, "setOutput");
const restoreCacheMock = jest
.spyOn(cache, "restoreCache")
.mockImplementationOnce(() => {
return Promise.resolve(restoreKey);
});
await run();
expect(restoreCacheMock).toHaveBeenCalledTimes(1);
expect(restoreCacheMock).toHaveBeenCalledWith([path], key, [restoreKey]);
expect(outputMock).toHaveBeenCalledWith("cache-primary-key", key);
expect(outputMock).toHaveBeenCalledWith("cache-hit", "false");
expect(outputMock).toHaveBeenCalledWith("cache-matched-key", restoreKey);
expect(outputMock).toHaveBeenCalledTimes(3);
expect(infoMock).toHaveBeenCalledWith(
`Cache restored from key: ${restoreKey}`
);
expect(failedMock).toHaveBeenCalledTimes(0);
});