mirror of
https://github.com/actions/setup-node
synced 2024-12-22 21:22:42 +00:00
962678f22c
* Add ESLinter and update Prettier * Update eslint config * Update dependencies * Rebuild action * Update package.json * Updates docs * Update docs
402 lines
13 KiB
TypeScript
402 lines
13 KiB
TypeScript
import * as core from '@actions/core';
|
|
import * as io from '@actions/io';
|
|
import * as tc from '@actions/tool-cache';
|
|
import * as httpm from '@actions/http-client';
|
|
import * as exec from '@actions/exec';
|
|
import * as cache from '@actions/cache';
|
|
import fs from 'fs';
|
|
import cp from 'child_process';
|
|
import osm from 'os';
|
|
import path from 'path';
|
|
import * as main from '../src/main';
|
|
import * as auth from '../src/authutil';
|
|
import {INodeVersion} from '../src/distributions/base-models';
|
|
|
|
import nodeTestDist from './data/node-dist-index.json';
|
|
import nodeTestDistNightly from './data/node-nightly-index.json';
|
|
import nodeTestDistRc from './data/node-rc-index.json';
|
|
import nodeV8CanaryTestDist from './data/v8-canary-dist-index.json';
|
|
|
|
describe('setup-node', () => {
|
|
let inputs = {} as any;
|
|
let os = {} as any;
|
|
|
|
let inSpy: jest.SpyInstance;
|
|
let findSpy: jest.SpyInstance;
|
|
let findAllVersionsSpy: jest.SpyInstance;
|
|
let cnSpy: jest.SpyInstance;
|
|
let logSpy: jest.SpyInstance;
|
|
let warningSpy: jest.SpyInstance;
|
|
let platSpy: jest.SpyInstance;
|
|
let archSpy: jest.SpyInstance;
|
|
let dlSpy: jest.SpyInstance;
|
|
let exSpy: jest.SpyInstance;
|
|
let cacheSpy: jest.SpyInstance;
|
|
let dbgSpy: jest.SpyInstance;
|
|
let whichSpy: jest.SpyInstance;
|
|
let existsSpy: jest.SpyInstance;
|
|
let mkdirpSpy: jest.SpyInstance;
|
|
let execSpy: jest.SpyInstance;
|
|
let authSpy: jest.SpyInstance;
|
|
let isCacheActionAvailable: jest.SpyInstance;
|
|
let getExecOutputSpy: jest.SpyInstance;
|
|
let getJsonSpy: jest.SpyInstance;
|
|
|
|
beforeEach(() => {
|
|
// @actions/core
|
|
console.log('::stop-commands::stoptoken'); // Disable executing of runner commands when running tests in actions
|
|
process.env['GITHUB_PATH'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out
|
|
process.env['GITHUB_OUTPUT'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out
|
|
inputs = {};
|
|
inSpy = jest.spyOn(core, 'getInput');
|
|
inSpy.mockImplementation(name => inputs[name]);
|
|
|
|
// node
|
|
os = {};
|
|
platSpy = jest.spyOn(osm, 'platform');
|
|
platSpy.mockImplementation(() => os['platform']);
|
|
archSpy = jest.spyOn(osm, 'arch');
|
|
archSpy.mockImplementation(() => os['arch']);
|
|
execSpy = jest.spyOn(cp, 'execSync');
|
|
|
|
// @actions/tool-cache
|
|
findSpy = jest.spyOn(tc, 'find');
|
|
findAllVersionsSpy = jest.spyOn(tc, 'findAllVersions');
|
|
dlSpy = jest.spyOn(tc, 'downloadTool');
|
|
exSpy = jest.spyOn(tc, 'extractTar');
|
|
cacheSpy = jest.spyOn(tc, 'cacheDir');
|
|
// getDistSpy = jest.spyOn(im, 'getVersionsFromDist');
|
|
|
|
// http-client
|
|
getJsonSpy = jest.spyOn(httpm.HttpClient.prototype, 'getJson');
|
|
|
|
// io
|
|
whichSpy = jest.spyOn(io, 'which');
|
|
existsSpy = jest.spyOn(fs, 'existsSync');
|
|
mkdirpSpy = jest.spyOn(io, 'mkdirP');
|
|
|
|
// @actions/tool-cache
|
|
isCacheActionAvailable = jest.spyOn(cache, 'isFeatureAvailable');
|
|
isCacheActionAvailable.mockImplementation(() => false);
|
|
|
|
// disable authentication portion for installer tests
|
|
authSpy = jest.spyOn(auth, 'configAuthentication');
|
|
authSpy.mockImplementation(() => {});
|
|
|
|
getJsonSpy.mockImplementation(url => {
|
|
let res: any;
|
|
if (url.includes('/rc')) {
|
|
res = <INodeVersion[]>nodeTestDistRc;
|
|
} else if (url.includes('/nightly')) {
|
|
res = <INodeVersion[]>nodeTestDistNightly;
|
|
} else {
|
|
res = <INodeVersion[]>nodeTestDist;
|
|
}
|
|
|
|
return {result: res};
|
|
});
|
|
|
|
// writes
|
|
cnSpy = jest.spyOn(process.stdout, 'write');
|
|
logSpy = jest.spyOn(core, 'info');
|
|
dbgSpy = jest.spyOn(core, 'debug');
|
|
warningSpy = jest.spyOn(core, 'warning');
|
|
cnSpy.mockImplementation(line => {
|
|
// uncomment to debug
|
|
// process.stderr.write('write:' + line + '\n');
|
|
});
|
|
logSpy.mockImplementation(line => {
|
|
// uncomment to debug
|
|
// process.stderr.write('log:' + line + '\n');
|
|
});
|
|
dbgSpy.mockImplementation(msg => {
|
|
// uncomment to see debug output
|
|
// process.stderr.write(msg + '\n');
|
|
});
|
|
warningSpy.mockImplementation(msg => {
|
|
// uncomment to debug
|
|
// process.stderr.write('log:' + msg + '\n');
|
|
});
|
|
|
|
// @actions/exec
|
|
getExecOutputSpy = jest.spyOn(exec, 'getExecOutput');
|
|
getExecOutputSpy.mockImplementation(() => 'v16.15.0-rc.1');
|
|
});
|
|
|
|
afterEach(() => {
|
|
jest.resetAllMocks();
|
|
jest.clearAllMocks();
|
|
//jest.restoreAllMocks();
|
|
});
|
|
|
|
afterAll(async () => {
|
|
console.log('::stoptoken::'); // Re-enable executing of runner commands when running tests in actions
|
|
jest.restoreAllMocks();
|
|
}, 100000);
|
|
|
|
//--------------------------------------------------
|
|
// Found in cache tests
|
|
//--------------------------------------------------
|
|
|
|
it('finds version in cache with stable true', async () => {
|
|
inputs['node-version'] = '12.0.0-rc.1';
|
|
inputs.stable = 'true';
|
|
|
|
const toolPath = path.normalize('/cache/node/12.0.0-rc.1/x64');
|
|
findSpy.mockImplementation(() => toolPath);
|
|
await main.run();
|
|
|
|
expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`);
|
|
});
|
|
|
|
it('finds version in cache with stable not supplied', async () => {
|
|
inputs['node-version'] = '12.0.0-rc.1';
|
|
|
|
inSpy.mockImplementation(name => inputs[name]);
|
|
|
|
const toolPath = path.normalize('/cache/node/12.0.0-rc.1/x64');
|
|
findSpy.mockImplementation(() => toolPath);
|
|
await main.run();
|
|
|
|
expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`);
|
|
});
|
|
|
|
it('finds version in cache and adds it to the path', async () => {
|
|
inputs['node-version'] = '12.0.0-rc.1';
|
|
|
|
inSpy.mockImplementation(name => inputs[name]);
|
|
|
|
const toolPath = path.normalize('/cache/node/12.0.0-rc.1/x64');
|
|
findSpy.mockImplementation(() => toolPath);
|
|
await main.run();
|
|
|
|
const expPath = path.join(toolPath, 'bin');
|
|
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`);
|
|
});
|
|
|
|
it('handles unhandled find error and reports error', async () => {
|
|
const errMsg = 'unhandled error message';
|
|
inputs['node-version'] = '12.0.0-rc.1';
|
|
|
|
findSpy.mockImplementation(() => {
|
|
throw new Error(errMsg);
|
|
});
|
|
|
|
await main.run();
|
|
|
|
expect(cnSpy).toHaveBeenCalledWith('::error::' + errMsg + osm.EOL);
|
|
});
|
|
|
|
it('falls back to a version from node dist', async () => {
|
|
os.platform = 'linux';
|
|
os.arch = 'x64';
|
|
|
|
const versionSpec = '13.0.0-rc.0';
|
|
|
|
inputs['node-version'] = versionSpec;
|
|
inputs['always-auth'] = false;
|
|
inputs['token'] = 'faketoken';
|
|
|
|
// ... but not in the local cache
|
|
findSpy.mockImplementation(() => '');
|
|
|
|
dlSpy.mockImplementation(async () => '/some/temp/path');
|
|
const toolPath = path.normalize('/cache/node/13.0.0-rc.0/x64');
|
|
exSpy.mockImplementation(async () => '/some/other/temp/path');
|
|
cacheSpy.mockImplementation(async () => toolPath);
|
|
|
|
await main.run();
|
|
|
|
const expPath = path.join(toolPath, 'bin');
|
|
|
|
expect(dlSpy).toHaveBeenCalled();
|
|
expect(exSpy).toHaveBeenCalled();
|
|
expect(logSpy).toHaveBeenCalledWith('Extracting ...');
|
|
expect(logSpy).toHaveBeenCalledWith('Done');
|
|
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`);
|
|
});
|
|
|
|
it('does not find a version that does not exist', async () => {
|
|
os.platform = 'linux';
|
|
os.arch = 'x64';
|
|
|
|
const versionSpec = '9.99.9-rc.1';
|
|
inputs['node-version'] = versionSpec;
|
|
|
|
findSpy.mockImplementation(() => '');
|
|
await main.run();
|
|
|
|
expect(cnSpy).toHaveBeenCalledWith(
|
|
`::error::Unable to find Node version '${versionSpec}' for platform ${os.platform} and architecture ${os.arch}.${osm.EOL}`
|
|
);
|
|
});
|
|
|
|
it('reports a failed download', async () => {
|
|
const errMsg = 'unhandled download message';
|
|
os.platform = 'linux';
|
|
os.arch = 'x64';
|
|
|
|
const versionSpec = '14.7.0-rc.1';
|
|
|
|
inputs['node-version'] = versionSpec;
|
|
inputs['always-auth'] = false;
|
|
inputs['token'] = 'faketoken';
|
|
|
|
findSpy.mockImplementation(() => '');
|
|
findAllVersionsSpy.mockImplementation(() => []);
|
|
dlSpy.mockImplementation(() => {
|
|
throw new Error(errMsg);
|
|
});
|
|
await main.run();
|
|
|
|
expect(cnSpy).toHaveBeenCalledWith(`::error::${errMsg}${osm.EOL}`);
|
|
});
|
|
|
|
it('acquires specified architecture of node', async () => {
|
|
for (const {arch, version, osSpec} of [
|
|
{arch: 'x86', version: '13.4.0-rc.0', osSpec: 'win32'},
|
|
{arch: 'x86', version: '14.15.5-rc.0', osSpec: 'win32'}
|
|
]) {
|
|
os.platform = osSpec;
|
|
os.arch = arch;
|
|
const fileExtension = os.platform === 'win32' ? '7z' : 'tar.gz';
|
|
const platform = {
|
|
linux: 'linux',
|
|
darwin: 'darwin',
|
|
win32: 'win'
|
|
}[os.platform];
|
|
|
|
inputs['node-version'] = version;
|
|
inputs['architecture'] = arch;
|
|
inputs['always-auth'] = false;
|
|
inputs['token'] = 'faketoken';
|
|
|
|
const expectedUrl = `https://nodejs.org/download/rc/v${version}/node-v${version}-${platform}-${arch}.${fileExtension}`;
|
|
|
|
// ... but not in the local cache
|
|
findSpy.mockImplementation(() => '');
|
|
findAllVersionsSpy.mockImplementation(() => []);
|
|
|
|
dlSpy.mockImplementation(async () => '/some/temp/path');
|
|
const toolPath = path.normalize(`/cache/node/${version}/${arch}`);
|
|
exSpy.mockImplementation(async () => '/some/other/temp/path');
|
|
cacheSpy.mockImplementation(async () => toolPath);
|
|
|
|
await main.run();
|
|
expect(dlSpy).toHaveBeenCalled();
|
|
expect(logSpy).toHaveBeenCalledWith(
|
|
`Acquiring ${version} - ${arch} from ${expectedUrl}`
|
|
);
|
|
}
|
|
}, 100000);
|
|
|
|
describe('rc versions', () => {
|
|
it.each([
|
|
[
|
|
'13.10.1-rc.0',
|
|
'13.10.1-rc.0',
|
|
'https://nodejs.org/download/rc/v13.10.1-rc.0/node-v13.10.1-rc.0-linux-x64.tar.gz'
|
|
],
|
|
[
|
|
'14.15.5-rc.1',
|
|
'14.15.5-rc.1',
|
|
'https://nodejs.org/download/rc/v14.15.5-rc.1/node-v14.15.5-rc.1-linux-x64.tar.gz'
|
|
],
|
|
[
|
|
'16.17.0-rc.1',
|
|
'16.17.0-rc.1',
|
|
'https://nodejs.org/download/rc/v16.17.0-rc.1/node-v16.17.0-rc.1-linux-x64.tar.gz'
|
|
],
|
|
[
|
|
'17.0.0-rc.1',
|
|
'17.0.0-rc.1',
|
|
'https://nodejs.org/download/rc/v17.0.0-rc.1/node-v17.0.0-rc.1-linux-x64.tar.gz'
|
|
],
|
|
[
|
|
'19.0.0-rc.2',
|
|
'19.0.0-rc.2',
|
|
'https://nodejs.org/download/rc/v19.0.0-rc.2/node-v19.0.0-rc.2-linux-x64.tar.gz'
|
|
]
|
|
])(
|
|
'finds the versions in the index.json and installs it',
|
|
async (input, expectedVersion, expectedUrl) => {
|
|
const toolPath = path.normalize(`/cache/node/${expectedVersion}/x64`);
|
|
|
|
findSpy.mockImplementation(() => '');
|
|
findAllVersionsSpy.mockImplementation(() => []);
|
|
dlSpy.mockImplementation(async () => '/some/temp/path');
|
|
exSpy.mockImplementation(async () => '/some/other/temp/path');
|
|
cacheSpy.mockImplementation(async () => toolPath);
|
|
|
|
inputs['node-version'] = input;
|
|
os['arch'] = 'x64';
|
|
os['platform'] = 'linux';
|
|
// act
|
|
await main.run();
|
|
|
|
// assert
|
|
expect(logSpy).toHaveBeenCalledWith('Extracting ...');
|
|
expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...');
|
|
expect(cnSpy).toHaveBeenCalledWith(
|
|
`::add-path::${path.join(toolPath, 'bin')}${osm.EOL}`
|
|
);
|
|
}
|
|
);
|
|
|
|
it.each([
|
|
['13.10.1-rc.0', '13.10.1-rc.0'],
|
|
['14.15.5-rc.1', '14.15.5-rc.1'],
|
|
['16.17.0-rc.1', '16.17.0-rc.1'],
|
|
['17.0.0-rc.1', '17.0.0-rc.1']
|
|
])(
|
|
'finds the %s version in the hostedToolcache',
|
|
async (input, expectedVersion) => {
|
|
const toolPath = path.normalize(`/cache/node/${expectedVersion}/x64`);
|
|
findSpy.mockImplementation((_, version) =>
|
|
path.normalize(`/cache/node/${version}/x64`)
|
|
);
|
|
findAllVersionsSpy.mockReturnValue([
|
|
'2.2.2-rc.2',
|
|
'1.1.1-rc.1',
|
|
'99.1.1',
|
|
expectedVersion,
|
|
'88.1.1',
|
|
'3.3.3-rc.3'
|
|
]);
|
|
|
|
inputs['node-version'] = input;
|
|
os['arch'] = 'x64';
|
|
os['platform'] = 'linux';
|
|
|
|
// act
|
|
await main.run();
|
|
|
|
// assert
|
|
expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`);
|
|
expect(cnSpy).toHaveBeenCalledWith(
|
|
`::add-path::${path.join(toolPath, 'bin')}${osm.EOL}`
|
|
);
|
|
}
|
|
);
|
|
|
|
it('throws an error if version is not found', async () => {
|
|
const versionSpec = '19.0.0-rc.3';
|
|
|
|
findSpy.mockImplementation(() => '');
|
|
findAllVersionsSpy.mockImplementation(() => []);
|
|
dlSpy.mockImplementation(async () => '/some/temp/path');
|
|
exSpy.mockImplementation(async () => '/some/other/temp/path');
|
|
|
|
inputs['node-version'] = versionSpec;
|
|
os['arch'] = 'x64';
|
|
os['platform'] = 'linux';
|
|
// act
|
|
await main.run();
|
|
|
|
// assert
|
|
expect(cnSpy).toHaveBeenCalledWith(
|
|
`::error::Unable to find Node version '${versionSpec}' for platform ${os.platform} and architecture ${os.arch}.${osm.EOL}`
|
|
);
|
|
});
|
|
});
|
|
});
|