actions/setup-node
1
0
Fork 0
mirror of https://github.com/actions/setup-node.git synced 2024-11-14 11:38:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

failure check fix

Browse Source
This commit is contained in:
Aparna Jyothi 2024-09-13 16:14:09 +05:30
parent 0a6e5f078b
commit ce2cdf5444
1 changed files with 118 additions and 210 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

180
__tests__/cache-utils.test.ts
View File

@ -12,8 +12,8 @@ import {
import fs from 'fs'; import fs from 'fs';
import * as cacheUtils from '../src/cache-utils'; import * as cacheUtils from '../src/cache-utils';
import * as glob from '@actions/glob'; import * as glob from '@actions/glob';
import {Globber} from '@actions/glob'; import { Globber } from '@actions/glob';
import {MockGlobber} from './mock/glob-mock'; import { MockGlobber } from './mock/glob-mock';
describe('cache-utils', () => { describe('cache-utils', () => {
const versionYarn1 = '1.2.3'; const versionYarn1 = '1.2.3';
@ -26,32 +26,26 @@ describe('cache-utils', () => {
let fsRealPathSyncSpy: jest.SpyInstance; let fsRealPathSyncSpy: jest.SpyInstance;
beforeEach(() => { beforeEach(() => {
console.log('::stop-commands::stoptoken');
process.env['GITHUB_WORKSPACE'] = path.join(__dirname, 'data'); process.env['GITHUB_WORKSPACE'] = path.join(__dirname, 'data');
debugSpy = jest.spyOn(core, 'debug'); debugSpy = jest.spyOn(core, 'debug');
debugSpy.mockImplementation(msg => {}); debugSpy.mockImplementation(() => {});
info = jest.spyOn(core, 'info'); info = jest.spyOn(core, 'info');
warningSpy = jest.spyOn(core, 'warning'); warningSpy = jest.spyOn(core, 'warning');
isFeatureAvailable = jest.spyOn(cache, 'isFeatureAvailable'); isFeatureAvailable = jest.spyOn(cache, 'isFeatureAvailable');
getCommandOutputSpy = jest.spyOn(utils, 'getCommandOutput'); getCommandOutputSpy = jest.spyOn(utils, 'getCommandOutput');
fsRealPathSyncSpy = jest.spyOn(fs, 'realpathSync'); fsRealPathSyncSpy = jest.spyOn(fs, 'realpathSync');
fsRealPathSyncSpy.mockImplementation(dirName => { fsRealPathSyncSpy.mockImplementation(dirName => dirName);
return dirName;
});
}); });
afterEach(() => { afterEach(() => {
jest.resetAllMocks(); jest.resetAllMocks();
jest.clearAllMocks(); process.env['GITHUB_SERVER_URL'] = ''; // Ensure environment variables are cleaned up
//jest.restoreAllMocks();
}); });
afterAll(async () => { afterAll(async () => {
console.log('::stoptoken::');
jest.restoreAllMocks(); jest.restoreAllMocks();
}, 100000); }, 100000);
@ -65,9 +59,7 @@ describe('cache-utils', () => {
['npm7', null] ['npm7', null]
])('getPackageManagerInfo for %s is %o', async (packageManager, result) => { ])('getPackageManagerInfo for %s is %o', async (packageManager, result) => {
getCommandOutputSpy.mockImplementationOnce(() => versionYarn1); getCommandOutputSpy.mockImplementationOnce(() => versionYarn1);
await expect(utils.getPackageManagerInfo(packageManager)).resolves.toBe( await expect(utils.getPackageManagerInfo(packageManager)).resolves.toBe(result);
result
);
}); });
}); });
@ -81,7 +73,7 @@ describe('cache-utils', () => {
); );
}); });
it('isCacheFeatureAvailable for GHES has an interhal error', () => { it('isCacheFeatureAvailable for GHES has an internal error', () => {
isFeatureAvailable.mockImplementation(() => false); isFeatureAvailable.mockImplementation(() => false);
process.env['GITHUB_SERVER_URL'] = ''; process.env['GITHUB_SERVER_URL'] = '';
isCacheFeatureAvailable(); isCacheFeatureAvailable();
@ -96,12 +88,6 @@ describe('cache-utils', () => {
expect(isCacheFeatureAvailable()).toStrictEqual(true); expect(isCacheFeatureAvailable()).toStrictEqual(true);
}); });
afterEach(() => {
process.env['GITHUB_SERVER_URL'] = '';
jest.resetAllMocks();
jest.clearAllMocks();
});
describe('getCacheDirectoriesPaths', () => { describe('getCacheDirectoriesPaths', () => {
let existsSpy: jest.SpyInstance; let existsSpy: jest.SpyInstance;
let lstatSpy: jest.SpyInstance; let lstatSpy: jest.SpyInstance;
@ -117,10 +103,8 @@ describe('cache-utils', () => {
})); }));
globCreateSpy = jest.spyOn(glob, 'create'); globCreateSpy = jest.spyOn(glob, 'create');
globCreateSpy.mockImplementation( globCreateSpy.mockImplementation(
(pattern: string): Promise<Globber> => (pattern: string): Promise<Globber> => MockGlobber.create(['/foo', '/bar'])
MockGlobber.create(['/foo', '/bar'])
); );
resetProjectDirectoriesMemoized(); resetProjectDirectoriesMemoized();
@ -139,29 +123,18 @@ describe('cache-utils', () => {
[supportedPackageManagers.pnpm, ''], [supportedPackageManagers.pnpm, ''],
[supportedPackageManagers.pnpm, '/dir/file.lock'], [supportedPackageManagers.pnpm, '/dir/file.lock'],
[supportedPackageManagers.pnpm, '/**/file.lock'] [supportedPackageManagers.pnpm, '/**/file.lock']
])( ])('getCacheDirectoriesPaths should return one dir for non yarn', async (packageManagerInfo, cacheDependency) => {
'getCacheDirectoriesPaths should return one dir for non yarn',
async (packageManagerInfo, cacheDependency) => {
getCommandOutputSpy.mockImplementation(() => 'foo'); getCommandOutputSpy.mockImplementation(() => 'foo');
const dirs = await cacheUtils.getCacheDirectories( const dirs = await cacheUtils.getCacheDirectories(packageManagerInfo, cacheDependency);
packageManagerInfo,
cacheDependency
);
expect(dirs).toEqual(['foo']); expect(dirs).toEqual(['foo']);
// to do not call for a version
// call once for get cache folder
expect(getCommandOutputSpy).toHaveBeenCalledTimes(1); expect(getCommandOutputSpy).toHaveBeenCalledTimes(1);
} });
);
it('getCacheDirectoriesPaths should return one dir for yarn without cacheDependency', async () => { it('getCacheDirectoriesPaths should return one dir for yarn without cacheDependency', async () => {
getCommandOutputSpy.mockImplementation(() => 'foo'); getCommandOutputSpy.mockImplementation(() => 'foo');
const dirs = await cacheUtils.getCacheDirectories( const dirs = await cacheUtils.getCacheDirectories(supportedPackageManagers.yarn, '');
supportedPackageManagers.yarn,
''
);
expect(dirs).toEqual(['foo']); expect(dirs).toEqual(['foo']);
}); });
@ -175,168 +148,107 @@ describe('cache-utils', () => {
[supportedPackageManagers.yarn, ''], [supportedPackageManagers.yarn, ''],
[supportedPackageManagers.yarn, '/dir/file.lock'], [supportedPackageManagers.yarn, '/dir/file.lock'],
[supportedPackageManagers.yarn, '/**/file.lock'] [supportedPackageManagers.yarn, '/**/file.lock']
])( ])('getCacheDirectoriesPaths should throw for getCommandOutput returning empty', async (packageManagerInfo, cacheDependency) => {
'getCacheDirectoriesPaths should throw for getCommandOutput returning empty',
async (packageManagerInfo, cacheDependency) => {
getCommandOutputSpy.mockImplementation((command: string) => getCommandOutputSpy.mockImplementation((command: string) =>
// return empty string to indicate getCacheFolderPath failed
// --version still works
command.includes('version') ? '1.' : '' command.includes('version') ? '1.' : ''
); );
await expect( await expect(cacheUtils.getCacheDirectories(packageManagerInfo, cacheDependency)).rejects.toThrow();
cacheUtils.getCacheDirectories(packageManagerInfo, cacheDependency) });
).rejects.toThrow(); //'Could not get cache folder path for /dir');
}
);
it.each([ it.each([
[supportedPackageManagers.yarn, '/dir/file.lock'], [supportedPackageManagers.yarn, '/dir/file.lock'],
[supportedPackageManagers.yarn, '/**/file.lock'] [supportedPackageManagers.yarn, '/**/file.lock']
])( ])('getCacheDirectoriesPaths should not throw in case of having no directories', async (packageManagerInfo, cacheDependency) => {
'getCacheDirectoriesPaths should nothrow in case of having not directories',
async (packageManagerInfo, cacheDependency) => {
lstatSpy.mockImplementation(arg => ({ lstatSpy.mockImplementation(arg => ({
isDirectory: () => false isDirectory: () => false
})); }));
await cacheUtils.getCacheDirectories( await cacheUtils.getCacheDirectories(packageManagerInfo, cacheDependency);
packageManagerInfo,
cacheDependency
);
expect(warningSpy).toHaveBeenCalledTimes(1); expect(warningSpy).toHaveBeenCalledTimes(1);
expect(warningSpy).toHaveBeenCalledWith( expect(warningSpy).toHaveBeenCalledWith(
`No existing directories found containing cache-dependency-path="${cacheDependency}"` `No existing directories found containing cache-dependency-path="${cacheDependency}"`
); );
} });
);
it.each(['1.1.1', '2.2.2'])( it.each(['1.1.1', '2.2.2'])('getCacheDirectoriesPaths yarn v%s should return one dir without cacheDependency', async version => {
'getCacheDirectoriesPaths yarn v%s should return one dir without cacheDependency',
async version => {
getCommandOutputSpy.mockImplementationOnce(() => version); getCommandOutputSpy.mockImplementationOnce(() => version);
getCommandOutputSpy.mockImplementationOnce(() => `foo${version}`); getCommandOutputSpy.mockImplementationOnce(() => `foo${version}`);
const dirs = await cacheUtils.getCacheDirectories( const dirs = await cacheUtils.getCacheDirectories(supportedPackageManagers.yarn, '');
supportedPackageManagers.yarn,
''
);
expect(dirs).toEqual([`foo${version}`]); expect(dirs).toEqual([`foo${version}`]);
} });
);
it.each(['1.1.1', '2.2.2'])( it.each(['1.1.1', '2.2.2'])('getCacheDirectoriesPaths yarn v%s should return 2 dirs with globbed cacheDependency', async version => {
'getCacheDirectoriesPaths yarn v%s should return 2 dirs with globbed cacheDependency',
async version => {
let dirNo = 1; let dirNo = 1;
getCommandOutputSpy.mockImplementation((command: string) => getCommandOutputSpy.mockImplementation((command: string) =>
command.includes('version') ? version : `file_${version}_${dirNo++}` command.includes('version') ? version : `file_${version}_${dirNo++}`
); );
globCreateSpy.mockImplementation( globCreateSpy.mockImplementation(
(pattern: string): Promise<Globber> => (pattern: string): Promise<Globber> => MockGlobber.create(['/tmp/dir1/file', '/tmp/dir2/file'])
MockGlobber.create(['/tmp/dir1/file', '/tmp/dir2/file'])
); );
const dirs = await cacheUtils.getCacheDirectories( const dirs = await cacheUtils.getCacheDirectories(supportedPackageManagers.yarn, '/tmp/**/file');
supportedPackageManagers.yarn,
'/tmp/**/file'
);
expect(dirs).toEqual([`file_${version}_1`, `file_${version}_2`]); expect(dirs).toEqual([`file_${version}_1`, `file_${version}_2`]);
} });
);
it.each(['1.1.1', '2.2.2'])( it.each(['1.1.1', '2.2.2'])('getCacheDirectoriesPaths yarn v%s should return 2 dirs with globbed cacheDependency expanding to duplicates', async version => {
'getCacheDirectoriesPaths yarn v%s should return 2 dirs with globbed cacheDependency expanding to duplicates',
async version => {
let dirNo = 1; let dirNo = 1;
getCommandOutputSpy.mockImplementation((command: string) => getCommandOutputSpy.mockImplementation((command: string) =>
command.includes('version') ? version : `file_${version}_${dirNo++}` command.includes('version') ? version : `file_${version}_${dirNo++}`
); );
globCreateSpy.mockImplementation( globCreateSpy.mockImplementation(
(pattern: string): Promise<Globber> => (pattern: string): Promise<Globber> => MockGlobber.create([
MockGlobber.create([
'/tmp/dir1/file', '/tmp/dir1/file',
'/tmp/dir2/file', '/tmp/dir2/file',
'/tmp/dir1/file' '/tmp/dir1/file'
]) ])
); );
const dirs = await cacheUtils.getCacheDirectories( const dirs = await cacheUtils.getCacheDirectories(supportedPackageManagers.yarn, '/tmp/**/file');
supportedPackageManagers.yarn,
'/tmp/**/file'
);
expect(dirs).toEqual([`file_${version}_1`, `file_${version}_2`]); expect(dirs).toEqual([`file_${version}_1`, `file_${version}_2`]);
} });
);
it.each(['1.1.1', '2.2.2'])( it.each(['1.1.1', '2.2.2'])('getCacheDirectoriesPaths yarn v%s should return 2 unique dirs despite duplicate cache directories', async version => {
'getCacheDirectoriesPaths yarn v%s should return 2 uniq dirs despite duplicate cache directories',
async version => {
let dirNo = 1; let dirNo = 1;
getCommandOutputSpy.mockImplementation((command: string) => getCommandOutputSpy.mockImplementation((command: string) =>
command.includes('version') command.includes('version') ? version : `file_${version}_${dirNo++ % 2}`
? version
: `file_${version}_${dirNo++ % 2}`
); );
globCreateSpy.mockImplementation( globCreateSpy.mockImplementation(
(pattern: string): Promise<Globber> => (pattern: string): Promise<Globber> => MockGlobber.create([
MockGlobber.create([
'/tmp/dir1/file', '/tmp/dir1/file',
'/tmp/dir2/file', '/tmp/dir2/file',
'/tmp/dir3/file' '/tmp/dir3/file'
]) ])
); );
const dirs = await cacheUtils.getCacheDirectories( const dirs = await cacheUtils.getCacheDirectories(supportedPackageManagers.yarn, '/tmp/**/file');
supportedPackageManagers.yarn,
'/tmp/**/file'
);
expect(dirs).toEqual([`file_${version}_1`, `file_${version}_0`]); expect(dirs).toEqual([`file_${version}_1`, `file_${version}_0`]);
expect(getCommandOutputSpy).toHaveBeenCalledTimes(6); expect(getCommandOutputSpy).toHaveBeenCalledTimes(6);
expect(getCommandOutputSpy).toHaveBeenCalledWith('yarn --version', '/tmp/dir1');
expect(getCommandOutputSpy).toHaveBeenCalledWith('yarn --version', '/tmp/dir2');
expect(getCommandOutputSpy).toHaveBeenCalledWith('yarn --version', '/tmp/dir3');
expect(getCommandOutputSpy).toHaveBeenCalledWith( expect(getCommandOutputSpy).toHaveBeenCalledWith(
'yarn --version', version.startsWith('1.') ? 'yarn cache dir' : 'yarn config get cacheFolder',
'/tmp/dir1' '/tmp/dir1'
); );
expect(getCommandOutputSpy).toHaveBeenCalledWith( expect(getCommandOutputSpy).toHaveBeenCalledWith(
'yarn --version', version.startsWith('1.') ? 'yarn cache dir' : 'yarn config get cacheFolder',
'/tmp/dir2' '/tmp/dir2'
); );
expect(getCommandOutputSpy).toHaveBeenCalledWith( expect(getCommandOutputSpy).toHaveBeenCalledWith(
'yarn --version', version.startsWith('1.') ? 'yarn cache dir' : 'yarn config get cacheFolder',
'/tmp/dir3' '/tmp/dir3'
); );
expect(getCommandOutputSpy).toHaveBeenCalledWith( });
version.startsWith('1.')
? 'yarn cache dir'
: 'yarn config get cacheFolder',
'/tmp/dir1'
);
expect(getCommandOutputSpy).toHaveBeenCalledWith(
version.startsWith('1.')
? 'yarn cache dir'
: 'yarn config get cacheFolder',
'/tmp/dir2'
);
expect(getCommandOutputSpy).toHaveBeenCalledWith(
version.startsWith('1.')
? 'yarn cache dir'
: 'yarn config get cacheFolder',
'/tmp/dir3'
);
}
);
it.each(['1.1.1', '2.2.2'])( it.each(['1.1.1', '2.2.2'])('getCacheDirectoriesPaths yarn v%s should return 4 dirs with multiple globs', async version => {
'getCacheDirectoriesPaths yarn v%s should return 4 dirs with multiple globs',
async version => {
// simulate wrong indents
const cacheDependencyPath = `/tmp/dir1/file const cacheDependencyPath = `/tmp/dir1/file
/tmp/dir2/file /tmp/dir2/file
/tmp/**/file /tmp/**/file
`; `;
globCreateSpy.mockImplementation( globCreateSpy.mockImplementation(
(pattern: string): Promise<Globber> => (pattern: string): Promise<Globber> => MockGlobber.create([
MockGlobber.create([
'/tmp/dir1/file', '/tmp/dir1/file',
'/tmp/dir2/file', '/tmp/dir2/file',
'/tmp/dir3/file', '/tmp/dir3/file',
@ -347,17 +259,13 @@ describe('cache-utils', () => {
getCommandOutputSpy.mockImplementation((command: string) => getCommandOutputSpy.mockImplementation((command: string) =>
command.includes('version') ? version : `file_${version}_${dirNo++}` command.includes('version') ? version : `file_${version}_${dirNo++}`
); );
const dirs = await cacheUtils.getCacheDirectories( const dirs = await cacheUtils.getCacheDirectories(supportedPackageManagers.yarn, cacheDependencyPath);
supportedPackageManagers.yarn,
cacheDependencyPath
);
expect(dirs).toEqual([ expect(dirs).toEqual([
`file_${version}_1`, `file_${version}_1`,
`file_${version}_2`, `file_${version}_2`,
`file_${version}_3`, `file_${version}_3`,
`file_${version}_4` `file_${version}_4`
]); ]);
} });
);
}); });
}); });