295 lines
10 KiB
TypeScript
295 lines
10 KiB
TypeScript
import * as core from '@actions/core';
|
|
import * as cache from '@actions/cache';
|
|
import * as glob from '@actions/glob';
|
|
import path from 'path';
|
|
|
|
import * as utils from '../src/cache-utils';
|
|
import {run} from '../src/cache-save';
|
|
import {State} from '../src/constants';
|
|
|
|
describe('run', () => {
|
|
const yarnFileHash =
|
|
'b8a0bae5243251f7c07dd52d1f78ff78281dfefaded700a176261b6b54fa245b';
|
|
const npmFileHash =
|
|
'abf7c9b306a3149dcfba4673e2362755503bcceaab46f0e4e6fee0ade493e20c';
|
|
const pnpmFileHash =
|
|
'26309058093e84713f38869c50cf1cee9b08155ede874ec1b44ce3fca8c68c70';
|
|
const commonPath = '/some/random/path';
|
|
process.env['GITHUB_WORKSPACE'] = path.join(__dirname, 'data');
|
|
|
|
let inputs = {} as any;
|
|
|
|
let getInputSpy: jest.SpyInstance;
|
|
let infoSpy: jest.SpyInstance;
|
|
let warningSpy: jest.SpyInstance;
|
|
let debugSpy: jest.SpyInstance;
|
|
let setFailedSpy: jest.SpyInstance;
|
|
let getStateSpy: jest.SpyInstance;
|
|
let saveCacheSpy: jest.SpyInstance;
|
|
let getCommandOutputSpy: jest.SpyInstance;
|
|
let hashFilesSpy: jest.SpyInstance;
|
|
|
|
beforeEach(() => {
|
|
getInputSpy = jest.spyOn(core, 'getInput');
|
|
getInputSpy.mockImplementation((name: string) => inputs[name]);
|
|
|
|
infoSpy = jest.spyOn(core, 'info');
|
|
infoSpy.mockImplementation(() => undefined);
|
|
|
|
warningSpy = jest.spyOn(core, 'warning');
|
|
warningSpy.mockImplementation(() => undefined);
|
|
|
|
setFailedSpy = jest.spyOn(core, 'setFailed');
|
|
setFailedSpy.mockImplementation(() => undefined);
|
|
|
|
debugSpy = jest.spyOn(core, 'debug');
|
|
debugSpy.mockImplementation(() => undefined);
|
|
|
|
getStateSpy = jest.spyOn(core, 'getState');
|
|
|
|
// cache
|
|
saveCacheSpy = jest.spyOn(cache, 'saveCache');
|
|
saveCacheSpy.mockImplementation(() => undefined);
|
|
|
|
// glob
|
|
hashFilesSpy = jest.spyOn(glob, 'hashFiles');
|
|
hashFilesSpy.mockImplementation((pattern: string) => {
|
|
if (pattern.includes('package-lock.json')) {
|
|
return npmFileHash;
|
|
} else if (pattern.includes('yarn.lock')) {
|
|
return yarnFileHash;
|
|
} else {
|
|
return '';
|
|
}
|
|
});
|
|
|
|
// utils
|
|
getCommandOutputSpy = jest.spyOn(utils, 'getCommandOutput');
|
|
});
|
|
|
|
describe('Package manager validation', () => {
|
|
it('Package manager is not provided, skip caching', async () => {
|
|
inputs['cache'] = '';
|
|
|
|
await run();
|
|
|
|
expect(setFailedSpy).not.toHaveBeenCalled();
|
|
expect(infoSpy).not.toHaveBeenCalled();
|
|
expect(saveCacheSpy).not.toHaveBeenCalled();
|
|
expect(debugSpy).toHaveBeenLastCalledWith(
|
|
"Caching for '' is not supported"
|
|
);
|
|
});
|
|
|
|
it('Package manager is not valid, skip caching', async () => {
|
|
inputs['cache'] = 'yarn3';
|
|
|
|
await run();
|
|
|
|
expect(setFailedSpy).not.toHaveBeenCalled();
|
|
expect(infoSpy).not.toHaveBeenCalled();
|
|
expect(saveCacheSpy).not.toHaveBeenCalled();
|
|
expect(debugSpy).toHaveBeenLastCalledWith(
|
|
"Caching for 'yarn3' is not supported"
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('Validate unchanged cache is not saved', () => {
|
|
it('should not save cache for yarn1', async () => {
|
|
inputs['cache'] = 'yarn';
|
|
getStateSpy.mockImplementation(() => yarnFileHash);
|
|
getCommandOutputSpy
|
|
.mockImplementationOnce(() => '1.2.3')
|
|
.mockImplementationOnce(() => `${commonPath}/yarn1`);
|
|
|
|
await run();
|
|
|
|
expect(getInputSpy).toHaveBeenCalled();
|
|
expect(getStateSpy).toHaveBeenCalledTimes(2);
|
|
expect(getCommandOutputSpy).toHaveBeenCalledTimes(2);
|
|
expect(debugSpy).toHaveBeenCalledWith(`yarn path is ${commonPath}/yarn1`);
|
|
expect(debugSpy).toHaveBeenCalledWith('Consumed yarn version is 1.2.3');
|
|
expect(infoSpy).toHaveBeenCalledWith(
|
|
`Cache hit occurred on the primary key ${yarnFileHash}, not saving cache.`
|
|
);
|
|
expect(setFailedSpy).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should not save cache for yarn2', async () => {
|
|
inputs['cache'] = 'yarn';
|
|
getStateSpy.mockImplementation(() => yarnFileHash);
|
|
getCommandOutputSpy
|
|
.mockImplementationOnce(() => '2.2.3')
|
|
.mockImplementationOnce(() => `${commonPath}/yarn2`);
|
|
|
|
await run();
|
|
|
|
expect(getInputSpy).toHaveBeenCalled();
|
|
expect(getStateSpy).toHaveBeenCalledTimes(2);
|
|
expect(getCommandOutputSpy).toHaveBeenCalledTimes(2);
|
|
expect(debugSpy).toHaveBeenCalledWith(`yarn path is ${commonPath}/yarn2`);
|
|
expect(debugSpy).toHaveBeenCalledWith('Consumed yarn version is 2.2.3');
|
|
expect(infoSpy).toHaveBeenCalledWith(
|
|
`Cache hit occurred on the primary key ${yarnFileHash}, not saving cache.`
|
|
);
|
|
expect(setFailedSpy).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should not save cache for npm', async () => {
|
|
inputs['cache'] = 'npm';
|
|
getStateSpy.mockImplementation(() => npmFileHash);
|
|
getCommandOutputSpy.mockImplementationOnce(() => `${commonPath}/npm`);
|
|
|
|
await run();
|
|
|
|
expect(getInputSpy).toHaveBeenCalled();
|
|
expect(getStateSpy).toHaveBeenCalledTimes(2);
|
|
expect(getCommandOutputSpy).toHaveBeenCalledTimes(1);
|
|
expect(debugSpy).toHaveBeenCalledWith(`npm path is ${commonPath}/npm`);
|
|
expect(infoSpy).toHaveBeenCalledWith(
|
|
`Cache hit occurred on the primary key ${npmFileHash}, not saving cache.`
|
|
);
|
|
expect(setFailedSpy).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should not save cache for pnpm', async () => {
|
|
inputs['cache'] = 'pnpm';
|
|
getStateSpy.mockImplementation(() => pnpmFileHash);
|
|
getCommandOutputSpy.mockImplementationOnce(() => `${commonPath}/pnpm`);
|
|
|
|
await run();
|
|
|
|
expect(getInputSpy).toHaveBeenCalled();
|
|
expect(getStateSpy).toHaveBeenCalledTimes(2);
|
|
expect(getCommandOutputSpy).toHaveBeenCalledTimes(1);
|
|
expect(debugSpy).toHaveBeenCalledWith(`pnpm path is ${commonPath}/pnpm`);
|
|
expect(infoSpy).toHaveBeenCalledWith(
|
|
`Cache hit occurred on the primary key ${pnpmFileHash}, not saving cache.`
|
|
);
|
|
expect(setFailedSpy).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
describe('action saves the cache', () => {
|
|
it('saves cache from yarn 1', async () => {
|
|
inputs['cache'] = 'yarn';
|
|
getStateSpy.mockImplementation((name: string) => {
|
|
if (name === State.CacheMatchedKey) {
|
|
return yarnFileHash;
|
|
} else {
|
|
return npmFileHash;
|
|
}
|
|
});
|
|
getCommandOutputSpy
|
|
.mockImplementationOnce(() => '1.2.3')
|
|
.mockImplementationOnce(() => `${commonPath}/yarn1`);
|
|
|
|
await run();
|
|
|
|
expect(getInputSpy).toHaveBeenCalled();
|
|
expect(getStateSpy).toHaveBeenCalledTimes(2);
|
|
expect(getCommandOutputSpy).toHaveBeenCalledTimes(2);
|
|
expect(debugSpy).toHaveBeenCalledWith(`yarn path is ${commonPath}/yarn1`);
|
|
expect(debugSpy).toHaveBeenCalledWith('Consumed yarn version is 1.2.3');
|
|
expect(infoSpy).not.toHaveBeenCalledWith(
|
|
`Cache hit occurred on the primary key ${yarnFileHash}, not saving cache.`
|
|
);
|
|
expect(saveCacheSpy).toHaveBeenCalled();
|
|
expect(infoSpy).toHaveBeenLastCalledWith(
|
|
`Cache saved with the key: ${npmFileHash}`
|
|
);
|
|
expect(setFailedSpy).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('saves cache from yarn 2', async () => {
|
|
inputs['cache'] = 'yarn';
|
|
getStateSpy.mockImplementation((name: string) => {
|
|
if (name === State.CacheMatchedKey) {
|
|
return yarnFileHash;
|
|
} else {
|
|
return npmFileHash;
|
|
}
|
|
});
|
|
getCommandOutputSpy
|
|
.mockImplementationOnce(() => '2.2.3')
|
|
.mockImplementationOnce(() => `${commonPath}/yarn2`);
|
|
|
|
await run();
|
|
|
|
expect(getInputSpy).toHaveBeenCalled();
|
|
expect(getStateSpy).toHaveBeenCalledTimes(2);
|
|
expect(getCommandOutputSpy).toHaveBeenCalledTimes(2);
|
|
expect(debugSpy).toHaveBeenCalledWith(`yarn path is ${commonPath}/yarn2`);
|
|
expect(debugSpy).toHaveBeenCalledWith('Consumed yarn version is 2.2.3');
|
|
expect(infoSpy).not.toHaveBeenCalledWith(
|
|
`Cache hit occurred on the primary key ${yarnFileHash}, not saving cache.`
|
|
);
|
|
expect(saveCacheSpy).toHaveBeenCalled();
|
|
expect(infoSpy).toHaveBeenLastCalledWith(
|
|
`Cache saved with the key: ${npmFileHash}`
|
|
);
|
|
expect(setFailedSpy).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('saves cache from npm', async () => {
|
|
inputs['cache'] = 'npm';
|
|
getStateSpy.mockImplementation((name: string) => {
|
|
if (name === State.CacheMatchedKey) {
|
|
return npmFileHash;
|
|
} else {
|
|
return yarnFileHash;
|
|
}
|
|
});
|
|
getCommandOutputSpy.mockImplementationOnce(() => `${commonPath}/npm`);
|
|
|
|
await run();
|
|
|
|
expect(getInputSpy).toHaveBeenCalled();
|
|
expect(getStateSpy).toHaveBeenCalledTimes(2);
|
|
expect(getCommandOutputSpy).toHaveBeenCalledTimes(1);
|
|
expect(debugSpy).toHaveBeenCalledWith(`npm path is ${commonPath}/npm`);
|
|
expect(infoSpy).not.toHaveBeenCalledWith(
|
|
`Cache hit occurred on the primary key ${npmFileHash}, not saving cache.`
|
|
);
|
|
expect(saveCacheSpy).toHaveBeenCalled();
|
|
expect(infoSpy).toHaveBeenLastCalledWith(
|
|
`Cache saved with the key: ${yarnFileHash}`
|
|
);
|
|
expect(setFailedSpy).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('saves cache from pnpm', async () => {
|
|
inputs['cache'] = 'pnpm';
|
|
getStateSpy.mockImplementation((name: string) => {
|
|
if (name === State.CacheMatchedKey) {
|
|
return pnpmFileHash;
|
|
} else {
|
|
return npmFileHash;
|
|
}
|
|
});
|
|
getCommandOutputSpy.mockImplementationOnce(() => `${commonPath}/pnpm`);
|
|
|
|
await run();
|
|
|
|
expect(getInputSpy).toHaveBeenCalled();
|
|
expect(getStateSpy).toHaveBeenCalledTimes(2);
|
|
expect(getCommandOutputSpy).toHaveBeenCalledTimes(1);
|
|
expect(debugSpy).toHaveBeenCalledWith(`pnpm path is ${commonPath}/pnpm`);
|
|
expect(infoSpy).not.toHaveBeenCalledWith(
|
|
`Cache hit occurred on the primary key ${pnpmFileHash}, not saving cache.`
|
|
);
|
|
expect(saveCacheSpy).toHaveBeenCalled();
|
|
expect(infoSpy).toHaveBeenLastCalledWith(
|
|
`Cache saved with the key: ${npmFileHash}`
|
|
);
|
|
expect(setFailedSpy).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
afterEach(() => {
|
|
jest.resetAllMocks();
|
|
jest.clearAllMocks();
|
|
});
|
|
});
|