From 3c2869130293c64b6b8f11a974994589048c821c Mon Sep 17 00:00:00 2001 From: Tommy Barnes Date: Mon, 3 Jan 2022 14:50:34 -0500 Subject: [PATCH] Did some reorganizing of code in run.ts, moved run.test.ts into /src, and put some helpers into helpers.ts in /src. --- src/helpers.ts | 32 +++++++++ src/run.test.ts | 183 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 215 insertions(+) create mode 100644 src/helpers.ts create mode 100644 src/run.test.ts diff --git a/src/helpers.ts b/src/helpers.ts new file mode 100644 index 0000000..2a0a225 --- /dev/null +++ b/src/helpers.ts @@ -0,0 +1,32 @@ +import * as os from 'os'; +import * as util from 'util'; + +export function getKubectlArch(): string { + const arch = os.arch(); + if (arch === 'x64') { + return 'amd64'; + } + return arch; +} + +export function getkubectlDownloadURL(version: string, arch: string): string { + switch (os.type()) { + case 'Linux': + return util.format('https://storage.googleapis.com/kubernetes-release/release/%s/bin/linux/%s/kubectl', version, arch); + + case 'Darwin': + return util.format('https://storage.googleapis.com/kubernetes-release/release/%s/bin/darwin/%s/kubectl', version, arch); + + case 'Windows_NT': + default: + return util.format('https://storage.googleapis.com/kubernetes-release/release/%s/bin/windows/%s/kubectl.exe', version, arch); + + } +} + +export function getExecutableExtension(): string { + if (os.type().match(/^Win/)) { + return '.exe'; + } + return ''; +} \ No newline at end of file diff --git a/src/run.test.ts b/src/run.test.ts new file mode 100644 index 0000000..23b3fb6 --- /dev/null +++ b/src/run.test.ts @@ -0,0 +1,183 @@ +import * as run from './run' +import * as helpers from './helpers' +import * as os from 'os'; +import * as toolCache from '@actions/tool-cache'; +import * as fs from 'fs'; +import * as path from 'path'; +import * as core from '@actions/core'; +import * as util from 'util'; + +describe('Testing all functions in run file.', () => { + test('getExecutableExtension() - return .exe when os is Windows', () => { + jest.spyOn(os, 'type').mockReturnValue('Windows_NT'); + + expect(helpers.getExecutableExtension()).toBe('.exe'); + expect(os.type).toBeCalled(); + }); + + test('getExecutableExtension() - return empty string for non-windows OS', () => { + jest.spyOn(os, 'type').mockReturnValue('Darwin'); + + expect(helpers.getExecutableExtension()).toBe(''); + expect(os.type).toBeCalled(); + }); + + test.each([ + ['arm', 'arm'], + ['arm64', 'arm64'], + ['x64', 'amd64'] + ])("getKubectlArch() - return on %s os arch %s kubectl arch", (osArch, kubectlArch) => { + jest.spyOn(os, 'arch').mockReturnValue(osArch); + + expect(helpers.getKubectlArch()).toBe(kubectlArch); + expect(os.arch).toBeCalled(); + }); + + test.each([ + ['arm'], + ['arm64'], + ['amd64'] + ])('getkubectlDownloadURL() - return the URL to download %s kubectl for Linux', (arch) => { + jest.spyOn(os, 'type').mockReturnValue('Linux'); + const kubectlLinuxUrl = util.format('https://storage.googleapis.com/kubernetes-release/release/v1.15.0/bin/linux/%s/kubectl', arch); + + expect(helpers.getkubectlDownloadURL('v1.15.0', arch)).toBe(kubectlLinuxUrl); + expect(os.type).toBeCalled(); + }); + + test.each([ + ['arm'], + ['arm64'], + ['amd64'] + ])('getkubectlDownloadURL() - return the URL to download %s kubectl for Darwin', (arch) => { + jest.spyOn(os, 'type').mockReturnValue('Darwin'); + const kubectlDarwinUrl = util.format('https://storage.googleapis.com/kubernetes-release/release/v1.15.0/bin/darwin/%s/kubectl', arch); + + expect(helpers.getkubectlDownloadURL('v1.15.0', arch)).toBe(kubectlDarwinUrl); + expect(os.type).toBeCalled(); + }); + + test.each([ + ['arm'], + ['arm64'], + ['amd64'] + ])('getkubectlDownloadURL() - return the URL to download %s kubectl for Windows', (arch) => { + jest.spyOn(os, 'type').mockReturnValue('Windows_NT'); + + const kubectlWindowsUrl = util.format('https://storage.googleapis.com/kubernetes-release/release/v1.15.0/bin/windows/%s/kubectl.exe', arch); + expect(helpers.getkubectlDownloadURL('v1.15.0', arch)).toBe(kubectlWindowsUrl); + expect(os.type).toBeCalled(); + }); + + test('getStableKubectlVersion() - download stable version file, read version and return it', async () => { + jest.spyOn(toolCache, 'downloadTool').mockReturnValue(Promise.resolve('pathToTool')); + jest.spyOn(fs, 'readFileSync').mockReturnValue('v1.20.4'); + + expect(await run.getStableKubectlVersion()).toBe('v1.20.4'); + expect(toolCache.downloadTool).toBeCalled(); + expect(fs.readFileSync).toBeCalledWith('pathToTool', 'utf8'); + }); + + test('getStableKubectlVersion() - return default v1.15.0 if version read is empty', async () => { + jest.spyOn(toolCache, 'downloadTool').mockReturnValue(Promise.resolve('pathToTool')); + jest.spyOn(fs, 'readFileSync').mockReturnValue(''); + + expect(await run.getStableKubectlVersion()).toBe('v1.15.0'); + expect(toolCache.downloadTool).toBeCalled(); + expect(fs.readFileSync).toBeCalledWith('pathToTool', 'utf8'); + }); + + test('getStableKubectlVersion() - return default v1.15.0 if unable to download file', async () => { + jest.spyOn(toolCache, 'downloadTool').mockRejectedValue('Unable to download.'); + + expect(await run.getStableKubectlVersion()).toBe('v1.15.0'); + expect(toolCache.downloadTool).toBeCalled(); + }); + + test('downloadKubectl() - download kubectl, add it to toolCache and return path to it', async () => { + jest.spyOn(toolCache, 'find').mockReturnValue(''); + jest.spyOn(toolCache, 'downloadTool').mockReturnValue(Promise.resolve('pathToTool')); + jest.spyOn(toolCache, 'cacheFile').mockReturnValue(Promise.resolve('pathToCachedTool')); + jest.spyOn(os, 'type').mockReturnValue('Windows_NT'); + jest.spyOn(fs, 'chmodSync').mockImplementation(() => { }); + + expect(await run.downloadKubectl('v1.15.0')).toBe(path.join('pathToCachedTool', 'kubectl.exe')); + expect(toolCache.find).toBeCalledWith('kubectl', 'v1.15.0'); + expect(toolCache.downloadTool).toBeCalled(); + expect(toolCache.cacheFile).toBeCalled(); + expect(os.type).toBeCalled(); + expect(fs.chmodSync).toBeCalledWith(path.join('pathToCachedTool', 'kubectl.exe'), '777'); + }); + + test('downloadKubectl() - throw DownloadKubectlFailed error when unable to download kubectl', async () => { + jest.spyOn(toolCache, 'find').mockReturnValue(''); + jest.spyOn(toolCache, 'downloadTool').mockRejectedValue('Unable to download kubectl.'); + + await expect(run.downloadKubectl('v1.15.0')).rejects.toThrow('DownloadKubectlFailed'); + expect(toolCache.find).toBeCalledWith('kubectl', 'v1.15.0'); + expect(toolCache.downloadTool).toBeCalled(); + }); + + test('downloadKubectl() - throw kubectl not found error when receive 404 response', async () => { + const kubectlVersion = 'v1.15.0' + const arch = 'arm128'; + + jest.spyOn(os, 'arch').mockReturnValue(arch); + jest.spyOn(toolCache, 'find').mockReturnValue(''); + jest.spyOn(toolCache, 'downloadTool').mockImplementation(_ => { + throw new toolCache.HTTPError(404); + }); + + await expect(run.downloadKubectl(kubectlVersion)).rejects + .toThrow(util.format("Kubectl '%s' for '%s' arch not found.", kubectlVersion, arch)); + expect(os.arch).toBeCalled(); + expect(toolCache.find).toBeCalledWith('kubectl', kubectlVersion); + expect(toolCache.downloadTool).toBeCalled(); + }); + + test('downloadKubectl() - return path to existing cache of kubectl', async () => { + jest.spyOn(toolCache, 'find').mockReturnValue('pathToCachedTool'); + jest.spyOn(os, 'type').mockReturnValue('Windows_NT'); + jest.spyOn(fs, 'chmodSync').mockImplementation(() => { }); + jest.spyOn(toolCache, 'downloadTool'); + + expect(await run.downloadKubectl('v1.15.0')).toBe(path.join('pathToCachedTool', 'kubectl.exe')); + expect(toolCache.find).toBeCalledWith('kubectl', 'v1.15.0'); + expect(os.type).toBeCalled(); + expect(fs.chmodSync).toBeCalledWith(path.join('pathToCachedTool', 'kubectl.exe'), '777'); + expect(toolCache.downloadTool).not.toBeCalled(); + }); + + test('run() - download specified version and set output', async () => { + jest.spyOn(core, 'getInput').mockReturnValue('v1.15.5'); + jest.spyOn(toolCache, 'find').mockReturnValue('pathToCachedTool'); + jest.spyOn(os, 'type').mockReturnValue('Windows_NT'); + jest.spyOn(fs, 'chmodSync').mockImplementation(); + jest.spyOn(core, 'addPath').mockImplementation(); + jest.spyOn(console, 'log').mockImplementation(); + jest.spyOn(core, 'setOutput').mockImplementation(); + + expect(await run.run()).toBeUndefined(); + expect(core.getInput).toBeCalledWith('version', { 'required': true }); + expect(core.addPath).toBeCalledWith('pathToCachedTool'); + expect(core.setOutput).toBeCalledWith('kubectl-path', path.join('pathToCachedTool', 'kubectl.exe')); + }); + + test('run() - get latest version, download it and set output', async () => { + jest.spyOn(core, 'getInput').mockReturnValue('latest'); + jest.spyOn(toolCache, 'downloadTool').mockReturnValue(Promise.resolve('pathToTool')); + jest.spyOn(fs, 'readFileSync').mockReturnValue('v1.20.4'); + jest.spyOn(toolCache, 'find').mockReturnValue('pathToCachedTool'); + jest.spyOn(os, 'type').mockReturnValue('Windows_NT'); + jest.spyOn(fs, 'chmodSync').mockImplementation(); + jest.spyOn(core, 'addPath').mockImplementation(); + jest.spyOn(console, 'log').mockImplementation(); + jest.spyOn(core, 'setOutput').mockImplementation(); + + expect(await run.run()).toBeUndefined(); + expect(toolCache.downloadTool).toBeCalledWith('https://storage.googleapis.com/kubernetes-release/release/stable.txt'); + expect(core.getInput).toBeCalledWith('version', { 'required': true }); + expect(core.addPath).toBeCalledWith('pathToCachedTool'); + expect(core.setOutput).toBeCalledWith('kubectl-path', path.join('pathToCachedTool', 'kubectl.exe')); + }); +}); \ No newline at end of file