setup-go/__tests__/setup-go.test.ts

439 lines
14 KiB
TypeScript
Raw Normal View History

2020-02-09 06:21:39 +01:00
import * as core from '@actions/core';
2020-03-27 05:55:12 +01:00
import * as io from '@actions/io';
import * as tc from '@actions/tool-cache';
import fs from 'fs';
import cp from 'child_process';
2020-02-10 21:21:04 +01:00
import osm = require('os');
2020-03-27 05:55:12 +01:00
import path from 'path';
import * as main from '../src/main';
2020-02-09 06:21:39 +01:00
import * as im from '../src/installer';
let goJsonData = require('./data/golang-dl.json');
2020-03-28 00:56:10 +01:00
let matchers = require('../matchers.json');
let matcherPattern = matchers.problemMatcher[0].pattern[0];
let matcherRegExp = new RegExp(matcherPattern.regexp);
2020-02-09 06:21:39 +01:00
describe('setup-go', () => {
2020-02-10 21:21:04 +01:00
let inputs = {} as any;
let os = {} as any;
2020-02-09 06:21:39 +01:00
let inSpy: jest.SpyInstance;
2020-02-10 00:09:15 +01:00
let findSpy: jest.SpyInstance;
2020-02-09 06:21:39 +01:00
let cnSpy: jest.SpyInstance;
2020-02-10 21:21:04 +01:00
let logSpy: jest.SpyInstance;
2020-02-09 06:21:39 +01:00
let getSpy: jest.SpyInstance;
let platSpy: jest.SpyInstance;
let archSpy: jest.SpyInstance;
let dlSpy: jest.SpyInstance;
let exSpy: jest.SpyInstance;
2020-02-10 00:09:15 +01:00
let cacheSpy: jest.SpyInstance;
2020-03-27 05:55:12 +01:00
let dbgSpy: jest.SpyInstance;
let whichSpy: jest.SpyInstance;
let existsSpy: jest.SpyInstance;
let mkdirpSpy: jest.SpyInstance;
let execSpy: jest.SpyInstance;
2020-02-09 06:21:39 +01:00
beforeEach(() => {
2020-02-10 21:21:04 +01:00
// @actions/core
inputs = {};
2020-02-09 06:21:39 +01:00
inSpy = jest.spyOn(core, 'getInput');
2020-02-10 21:21:04 +01:00
inSpy.mockImplementation(name => inputs[name]);
2020-03-27 05:55:12 +01:00
// node
2020-02-10 21:21:04 +01:00
os = {};
platSpy = jest.spyOn(osm, 'platform');
platSpy.mockImplementation(() => os['platform']);
archSpy = jest.spyOn(osm, 'arch');
archSpy.mockImplementation(() => os['arch']);
2020-03-27 05:55:12 +01:00
execSpy = jest.spyOn(cp, 'execSync');
2020-02-10 21:21:04 +01:00
// @actions/tool-cache
findSpy = jest.spyOn(tc, 'find');
2020-02-09 06:29:21 +01:00
dlSpy = jest.spyOn(tc, 'downloadTool');
exSpy = jest.spyOn(tc, 'extractTar');
2020-02-10 00:09:15 +01:00
cacheSpy = jest.spyOn(tc, 'cacheDir');
2020-02-09 15:25:20 +01:00
getSpy = jest.spyOn(im, 'getVersions');
2020-02-10 21:21:04 +01:00
2020-03-27 05:55:12 +01:00
// io
whichSpy = jest.spyOn(io, 'which');
existsSpy = jest.spyOn(fs, 'existsSync');
mkdirpSpy = jest.spyOn(io, 'mkdirP');
2020-02-10 21:21:04 +01:00
// writes
cnSpy = jest.spyOn(process.stdout, 'write');
logSpy = jest.spyOn(console, 'log');
2020-03-27 05:55:12 +01:00
dbgSpy = jest.spyOn(main, '_debug');
2020-02-09 20:39:34 +01:00
getSpy.mockImplementation(() => <im.IGoVersion[]>goJsonData);
2020-02-09 06:21:39 +01:00
cnSpy.mockImplementation(line => {
// uncomment to debug
2020-02-10 21:21:04 +01:00
// process.stderr.write('write:' + line + '\n');
});
logSpy.mockImplementation(line => {
// uncomment to debug
// process.stderr.write('log:' + line + '\n');
2020-02-09 06:21:39 +01:00
});
2020-03-27 05:55:12 +01:00
dbgSpy.mockImplementation(msg => {
// uncomment to see debug output
// process.stderr.write(msg + '\n');
});
2020-02-09 06:21:39 +01:00
});
afterEach(() => {
2020-02-09 20:39:34 +01:00
jest.resetAllMocks();
2020-02-09 06:21:39 +01:00
jest.clearAllMocks();
2020-03-27 05:55:12 +01:00
//jest.restoreAllMocks();
2020-02-09 06:21:39 +01:00
});
afterAll(async () => {}, 100000);
2020-02-11 01:18:01 +01:00
it('can query versions', async () => {
let versions: im.IGoVersion[] | null = await im.getVersions(
'https://non.existant.com/path'
);
expect(versions).toBeDefined();
let l: number = versions ? versions.length : 0;
expect(l).toBe(91);
});
it('finds stable match for exact version', async () => {
os.platform = 'win32';
os.arch = 'x64';
// get request is already mocked
// spec: 1.13.7 => 1.13.7 (exact)
let match: im.IGoVersion | undefined = await im.findMatch('1.13.7', true);
expect(match).toBeDefined();
let version: string = match ? match.version : '';
expect(version).toBe('go1.13.7');
let fileName = match ? match.files[0].filename : '';
expect(fileName).toBe('go1.13.7.windows-amd64.zip');
});
2020-02-10 01:05:20 +01:00
it('finds stable match for exact dot zero version', async () => {
2020-02-10 21:21:04 +01:00
os.platform = 'darwin';
os.arch = 'x64';
2020-02-10 01:05:20 +01:00
// spec: 1.13.0 => 1.13
let match: im.IGoVersion | undefined = await im.findMatch('1.13.0', true);
expect(match).toBeDefined();
let version: string = match ? match.version : '';
expect(version).toBe('go1.13');
let fileName = match ? match.files[0].filename : '';
expect(fileName).toBe('go1.13.darwin-amd64.tar.gz');
});
it('finds latest patch version for minor version spec', async () => {
2020-02-10 21:21:04 +01:00
os.platform = 'linux';
os.arch = 'x64';
2020-02-10 01:05:20 +01:00
// spec: 1.13 => 1.13.7 (latest)
let match: im.IGoVersion | undefined = await im.findMatch('1.13', true);
expect(match).toBeDefined();
let version: string = match ? match.version : '';
expect(version).toBe('go1.13.7');
let fileName = match ? match.files[0].filename : '';
expect(fileName).toBe('go1.13.7.linux-amd64.tar.gz');
});
it('finds latest patch version for caret version spec', async () => {
2020-02-10 21:21:04 +01:00
os.platform = 'linux';
os.arch = 'x64';
2020-02-10 01:05:20 +01:00
// spec: ^1.13.6 => 1.13.7
let match: im.IGoVersion | undefined = await im.findMatch('^1.13.6', true);
expect(match).toBeDefined();
let version: string = match ? match.version : '';
expect(version).toBe('go1.13.7');
let fileName = match ? match.files[0].filename : '';
expect(fileName).toBe('go1.13.7.linux-amd64.tar.gz');
});
it('finds latest version for major version spec', async () => {
2020-02-10 21:21:04 +01:00
os.platform = 'win32';
os.arch = 'x32';
2020-02-10 01:05:20 +01:00
// spec: 1 => 1.13.7 (latest)
let match: im.IGoVersion | undefined = await im.findMatch('1', true);
expect(match).toBeDefined();
let version: string = match ? match.version : '';
expect(version).toBe('go1.13.7');
let fileName = match ? match.files[0].filename : '';
expect(fileName).toBe('go1.13.7.windows-386.zip');
});
2020-02-11 01:18:01 +01:00
it('finds unstable pre-release version', async () => {
os.platform = 'linux';
os.arch = 'x64';
// spec: 1.14, stable=false => go1.14rc1
let match: im.IGoVersion | undefined = await im.findMatch(
'1.14.0-rc1',
false
);
expect(match).toBeDefined();
let version: string = match ? match.version : '';
expect(version).toBe('go1.14rc1');
let fileName = match ? match.files[0].filename : '';
expect(fileName).toBe('go1.14rc1.linux-amd64.tar.gz');
});
2020-02-10 21:21:04 +01:00
it('evaluates to stable with input as true', async () => {
inputs['go-version'] = '1.13.0';
inputs.stable = 'true';
let toolPath = path.normalize('/cache/go/1.13.0/x64');
findSpy.mockImplementation(() => toolPath);
2020-03-27 05:55:12 +01:00
await main.run();
2020-02-10 21:21:04 +01:00
expect(logSpy).toHaveBeenCalledWith(`Setup go stable version spec 1.13.0`);
});
it('evaluates to stable with no input', async () => {
inputs['go-version'] = '1.13.0';
inSpy.mockImplementation(name => inputs[name]);
let toolPath = path.normalize('/cache/go/1.13.0/x64');
findSpy.mockImplementation(() => toolPath);
2020-03-27 05:55:12 +01:00
await main.run();
2020-02-10 21:21:04 +01:00
expect(logSpy).toHaveBeenCalledWith(`Setup go stable version spec 1.13.0`);
});
2020-02-09 06:21:39 +01:00
it('finds a version of go already in the cache', async () => {
2020-02-10 21:21:04 +01:00
inputs['go-version'] = '1.13.0';
2020-02-09 06:21:39 +01:00
let toolPath = path.normalize('/cache/go/1.13.0/x64');
2020-02-10 00:09:15 +01:00
findSpy.mockImplementation(() => toolPath);
2020-03-27 05:55:12 +01:00
await main.run();
2020-02-09 06:21:39 +01:00
let expPath = path.join(toolPath, 'bin');
});
it('finds a version in the cache and adds it to the path', async () => {
2020-02-10 21:21:04 +01:00
inputs['go-version'] = '1.13.0';
2020-02-09 06:21:39 +01:00
let toolPath = path.normalize('/cache/go/1.13.0/x64');
2020-02-10 00:09:15 +01:00
findSpy.mockImplementation(() => toolPath);
2020-03-27 05:55:12 +01:00
await main.run();
2020-02-09 06:21:39 +01:00
let expPath = path.join(toolPath, 'bin');
2020-02-10 21:21:04 +01:00
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`);
2020-02-09 06:21:39 +01:00
});
it('handles unhandled error and reports error', async () => {
let errMsg = 'unhandled error message';
2020-02-10 21:21:04 +01:00
inputs['go-version'] = '1.13.0';
2020-02-10 00:09:15 +01:00
findSpy.mockImplementation(() => {
2020-02-09 06:21:39 +01:00
throw new Error(errMsg);
});
2020-03-27 05:55:12 +01:00
await main.run();
2020-02-10 21:21:04 +01:00
expect(cnSpy).toHaveBeenCalledWith('::error::' + errMsg + osm.EOL);
2020-02-09 06:21:39 +01:00
});
2020-02-10 00:09:15 +01:00
it('downloads a version not in the cache', async () => {
2020-02-10 21:21:04 +01:00
os.platform = 'linux';
os.arch = 'x64';
inputs['go-version'] = '1.13.1';
2020-02-10 00:09:15 +01:00
findSpy.mockImplementation(() => '');
dlSpy.mockImplementation(() => '/some/temp/path');
let toolPath = path.normalize('/cache/go/1.13.0/x64');
exSpy.mockImplementation(() => '/some/other/temp/path');
cacheSpy.mockImplementation(() => toolPath);
2020-03-27 05:55:12 +01:00
await main.run();
2020-02-10 00:09:15 +01:00
let expPath = path.join(toolPath, 'bin');
expect(dlSpy).toHaveBeenCalled();
expect(exSpy).toHaveBeenCalled();
2020-02-10 21:21:04 +01:00
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`);
2020-02-10 00:09:15 +01:00
});
it('does not find a version that does not exist', async () => {
2020-02-10 21:21:04 +01:00
os.platform = 'linux';
os.arch = 'x64';
inputs['go-version'] = '9.99.9';
2020-02-10 00:09:15 +01:00
findSpy.mockImplementation(() => '');
2020-03-27 05:55:12 +01:00
await main.run();
2020-02-10 00:09:15 +01:00
expect(cnSpy).toHaveBeenCalledWith(
2020-02-10 21:21:04 +01:00
`::error::Could not find a version that satisfied version spec: 9.99.9${osm.EOL}`
2020-02-10 00:09:15 +01:00
);
});
2020-02-10 00:48:40 +01:00
it('reports a failed download', async () => {
let errMsg = 'unhandled download message';
2020-02-10 21:21:04 +01:00
os.platform = 'linux';
os.arch = 'x64';
inputs['go-version'] = '1.13.1';
2020-02-10 00:48:40 +01:00
findSpy.mockImplementation(() => '');
dlSpy.mockImplementation(() => {
throw new Error(errMsg);
});
2020-03-27 05:55:12 +01:00
await main.run();
2020-02-10 00:48:40 +01:00
expect(cnSpy).toHaveBeenCalledWith(
2020-02-10 21:21:04 +01:00
`::error::Failed to download version 1.13.1: Error: ${errMsg}${osm.EOL}`
2020-02-10 00:48:40 +01:00
);
});
it('reports empty query results', async () => {
let errMsg = 'unhandled download message';
2020-02-10 21:21:04 +01:00
os.platform = 'linux';
os.arch = 'x64';
inputs['go-version'] = '1.13.1';
2020-02-10 00:48:40 +01:00
findSpy.mockImplementation(() => '');
getSpy.mockImplementation(() => null);
2020-03-27 05:55:12 +01:00
await main.run();
2020-02-10 00:48:40 +01:00
expect(cnSpy).toHaveBeenCalledWith(
2020-02-10 21:21:04 +01:00
`::error::Failed to download version 1.13.1: Error: golang download url did not return results${osm.EOL}`
2020-02-10 00:48:40 +01:00
);
});
2020-03-27 05:55:12 +01:00
it('does not add BIN if go is not in path', async () => {
whichSpy.mockImplementation(async () => {
return '';
});
let added = await main.addBinToPath();
expect(added).toBeFalsy();
});
it('adds bin if dir not exists', async () => {
whichSpy.mockImplementation(async () => {
return '/usr/local/go/bin/go';
});
execSpy.mockImplementation(() => {
return '/Users/testuser/go';
});
mkdirpSpy.mockImplementation(async () => {});
existsSpy.mockImplementation(path => {
return false;
});
let added = await main.addBinToPath();
expect(added).toBeTruthy;
});
2020-03-28 00:56:10 +01:00
interface Annotation {
2020-03-28 00:58:10 +01:00
file: string;
line: number;
column: number;
message: string;
2020-03-28 00:56:10 +01:00
}
//
// problem matcher regex pattern tests
function testMatch(line: string): Annotation {
let annotation = <Annotation>{};
let match = matcherRegExp.exec(line);
if (match) {
annotation.line = parseInt(match[matcherPattern.line], 10);
annotation.column = parseInt(match[matcherPattern.column], 10);
annotation.file = match[matcherPattern.file].trim();
annotation.message = match[matcherPattern.message].trim();
}
return annotation;
2020-03-28 00:58:10 +01:00
}
2020-03-28 00:56:10 +01:00
2020-03-28 01:14:29 +01:00
it('matches on relative unix path', async () => {
let line = './main.go:13:2: undefined: fmt.Printl';
2020-03-28 00:56:10 +01:00
let annotation = testMatch(line);
expect(annotation).toBeDefined();
2020-03-28 01:14:29 +01:00
expect(annotation.line).toBe(13);
expect(annotation.column).toBe(2);
expect(annotation.file).toBe('./main.go');
expect(annotation.message).toBe('undefined: fmt.Printl');
2020-03-28 00:56:10 +01:00
});
2020-03-28 01:14:29 +01:00
it('matches on unix path up the tree', async () => {
let line = '../main.go:13:2: undefined: fmt.Printl';
2020-03-28 00:56:10 +01:00
let annotation = testMatch(line);
expect(annotation).toBeDefined();
2020-03-28 01:14:29 +01:00
expect(annotation.line).toBe(13);
expect(annotation.column).toBe(2);
expect(annotation.file).toBe('../main.go');
expect(annotation.message).toBe('undefined: fmt.Printl');
2020-03-28 01:21:13 +01:00
});
2020-03-28 00:56:10 +01:00
it('matches on rooted unix path', async () => {
let line = '/assert.go:4:1: missing return at end of function';
let annotation = testMatch(line);
expect(annotation).toBeDefined();
expect(annotation.line).toBe(4);
expect(annotation.column).toBe(1);
expect(annotation.file).toBe('/assert.go');
expect(annotation.message).toBe('missing return at end of function');
2020-03-28 00:58:10 +01:00
});
2020-03-28 00:56:10 +01:00
2020-03-30 16:46:01 +02:00
it('matches on unix path with spaces', async () => {
2020-03-28 01:14:29 +01:00
let line = ' ./assert.go:5:2: missing return at end of function ';
2020-03-28 00:56:10 +01:00
let annotation = testMatch(line);
expect(annotation).toBeDefined();
expect(annotation.line).toBe(5);
expect(annotation.column).toBe(2);
2020-03-28 01:14:29 +01:00
expect(annotation.file).toBe('./assert.go');
2020-03-28 00:56:10 +01:00
expect(annotation.message).toBe('missing return at end of function');
2020-03-28 00:58:10 +01:00
});
2020-03-28 00:56:10 +01:00
2020-03-30 16:46:01 +02:00
it('matches on unix path with tabs', async () => {
let line = '\t./assert.go:5:2: missing return at end of function ';
let annotation = testMatch(line);
expect(annotation).toBeDefined();
expect(annotation.line).toBe(5);
expect(annotation.column).toBe(2);
expect(annotation.file).toBe('./assert.go');
expect(annotation.message).toBe('missing return at end of function');
});
2020-03-28 01:14:29 +01:00
it('matches on relative windows path', async () => {
let line = '.\\main.go:13:2: undefined: fmt.Printl';
let annotation = testMatch(line);
expect(annotation).toBeDefined();
expect(annotation.line).toBe(13);
expect(annotation.column).toBe(2);
expect(annotation.file).toBe('.\\main.go');
expect(annotation.message).toBe('undefined: fmt.Printl');
});
it('matches on windows path up the tree', async () => {
let line = '..\\main.go:13:2: undefined: fmt.Printl';
let annotation = testMatch(line);
expect(annotation).toBeDefined();
expect(annotation.line).toBe(13);
expect(annotation.column).toBe(2);
expect(annotation.file).toBe('..\\main.go');
expect(annotation.message).toBe('undefined: fmt.Printl');
2020-03-28 01:21:13 +01:00
});
2020-03-28 01:14:29 +01:00
2020-02-11 01:18:01 +01:00
// 1.13.1 => 1.13.1
// 1.13 => 1.13.0
// 1.10beta1 => 1.10.0-beta1, 1.10rc1 => 1.10.0-rc1
// 1.8.5beta1 => 1.8.5-beta1, 1.8.5rc1 => 1.8.5-rc1
it('converts prerelease versions', async () => {
expect(im.makeSemver('1.10beta1')).toBe('1.10.0-beta1');
expect(im.makeSemver('1.10rc1')).toBe('1.10.0-rc1');
2020-02-09 06:21:39 +01:00
});
2020-02-09 06:29:21 +01:00
2020-02-11 01:18:01 +01:00
it('converts dot zero versions', async () => {
expect(im.makeSemver('1.13')).toBe('1.13.0');
});
2020-02-09 06:21:39 +01:00
2020-02-11 01:18:01 +01:00
it('does not convert exact versions', async () => {
expect(im.makeSemver('1.13.1')).toBe('1.13.1');
2020-02-09 06:21:39 +01:00
});
});