diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..180de518 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +# Contributing + +This project welcomes contributions and suggestions. Most contributions require you to agree to a +Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us +the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. + +When you submit a pull request, a CLA bot will automatically determine whether you need to provide +a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions +provided by the bot. You will only need to do this once across all repos using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or +contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. diff --git a/README.md b/README.md index b81a84e5..5e7946e7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ +# Setup Helm +#### Install a specific version of helm binary on the runner. + +Acceptable values are latest or any semantic version string like 1.15.0. Use this action in workflow to define which version of helm will be used. + +```yaml +- uses: azure/setup-helm@v1 + with: + version: '' # default is latest stable + id: install +``` +Refer to the action metadata file for details about all the inputs https://github.com/Azure/setup-helm/blob/master/action.yml # Contributing diff --git a/action.yml b/action.yml new file mode 100644 index 00000000..4c1e06f0 --- /dev/null +++ b/action.yml @@ -0,0 +1,15 @@ +name: 'Helm tool installer' +description: 'Install a specific version of helm binary. Acceptable values are latest or any semantic version string like 1.15.0' +inputs: + version: + description: 'Version of helm' + required: true + default: 'latest' +outputs: + helm-path: + description: 'Path to the cached helm binary' +branding: + color: 'blue' +runs: + using: 'node12' + main: 'lib/run.js' \ No newline at end of file diff --git a/lib/run.js b/lib/run.js new file mode 100644 index 00000000..94feb7a2 --- /dev/null +++ b/lib/run.js @@ -0,0 +1,126 @@ +"use strict"; +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. +var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { + function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } + return new (P || (P = Promise))(function (resolve, reject) { + function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } + function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } + function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } + step((generator = generator.apply(thisArg, _arguments || [])).next()); + }); +}; +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k]; + result["default"] = mod; + return result; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +const os = __importStar(require("os")); +const path = __importStar(require("path")); +const util = __importStar(require("util")); +const fs = __importStar(require("fs")); +const toolCache = __importStar(require("../node_modules/@actions/tool-cache")); +const core = __importStar(require("../node_modules/@actions/core")); +const helmToolName = 'helm'; +const stableHelmVersion = 'v2.14.1'; +const helmLatestReleaseUrl = 'https://api.github.com/repos/helm/helm/releases/latest'; +function getExecutableExtension() { + if (os.type().match(/^Win/)) { + return '.exe'; + } + return ''; +} +function getHelmDownloadURL(version) { + switch (os.type()) { + case 'Linux': + return util.format('https://get.helm.sh/helm-%s-linux-amd64.zip', version); + case 'Darwin': + return util.format('https://get.helm.sh/helm-%s-darwin-amd64.zip', version); + case 'Windows_NT': + default: + return util.format('https://get.helm.sh/helm-%s-windows-amd64.zip', version); + } +} +function getStableHelmVersion() { + return __awaiter(this, void 0, void 0, function* () { + return toolCache.downloadTool(helmLatestReleaseUrl).then((downloadPath) => { + const response = JSON.parse(fs.readFileSync(downloadPath, 'utf8').toString().trim()); + if (!response.tag_name) { + return stableHelmVersion; + } + return response.tag_name; + }, (error) => { + core.debug(error); + core.warning(util.format("Failed to read latest kubectl version from stable.txt. From URL %s. Using default stable version %s", helmLatestReleaseUrl, stableHelmVersion)); + return stableHelmVersion; + }); + }); +} +var walkSync = function (dir, filelist, fileToFind) { + var files = fs.readdirSync(dir); + filelist = filelist || []; + files.forEach(function (file) { + if (fs.statSync(path.join(dir, file)).isDirectory()) { + filelist = walkSync(path.join(dir, file), filelist, fileToFind); + } + else { + core.debug(file); + if (file == fileToFind) { + filelist.push(path.join(dir, file)); + } + } + }); + return filelist; +}; +function downloadHelm(version) { + return __awaiter(this, void 0, void 0, function* () { + if (!version) { + version = yield getStableHelmVersion(); + } + let cachedToolpath = toolCache.find(helmToolName, version); + if (!cachedToolpath) { + let helmDownloadPath; + try { + helmDownloadPath = yield toolCache.downloadTool(getHelmDownloadURL(version)); + } + catch (exception) { + throw new Error(util.format("Failed to download Helm from location ", getHelmDownloadURL(version))); + } + fs.chmodSync(helmDownloadPath, '777'); + const unzipedHelmPath = yield toolCache.extractZip(helmDownloadPath); + cachedToolpath = yield toolCache.cacheDir(unzipedHelmPath, helmToolName, version); + } + const helmpath = findHelm(cachedToolpath); + if (!helmpath) { + throw new Error(util.format("Helm executable not found in path ", cachedToolpath)); + } + fs.chmodSync(helmpath, '777'); + return helmpath; + }); +} +function findHelm(rootFolder) { + fs.chmodSync(rootFolder, '777'); + var filelist = []; + walkSync(rootFolder, filelist, helmToolName + getExecutableExtension()); + if (!filelist) { + throw new Error(util.format("Helm executable not found in path ", rootFolder)); + } + else { + return filelist[0]; + } +} +function run() { + return __awaiter(this, void 0, void 0, function* () { + let version = core.getInput('version', { 'required': true }); + if (version.toLocaleLowerCase() === 'latest') { + version = yield getStableHelmVersion(); + } + let cachedPath = yield downloadHelm(version); + console.log(`Helm tool version: '${version}' has been cached at ${cachedPath}`); + core.setOutput('helm-path', cachedPath); + }); +} +run().catch(core.setFailed); diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 00000000..0f291120 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,94 @@ +{ + "name": "setuphelm", + "version": "0.0.0", + "lockfileVersion": 1, + "requires": true, + "dependencies": { + "@actions/core": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.0.0.tgz", + "integrity": "sha512-aMIlkx96XH4E/2YZtEOeyrYQfhlas9jIRkfGPqMwXD095Rdkzo4lB6ZmbxPQSzD+e1M+Xsm98ZhuSMYGv/AlqA==" + }, + "@actions/exec": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@actions/exec/-/exec-1.0.0.tgz", + "integrity": "sha512-nquH0+XKng+Ll7rZfCojN7NWSbnGh+ltwUJhzfbLkmOJgxocGX2/yXcZLMyT9fa7+tByEow/NSTrBExNlEj9fw==" + }, + "@actions/io": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@actions/io/-/io-1.0.0.tgz", + "integrity": "sha512-ezrJSRdqtXtdx1WXlfYL85+40F7gB39jCK9P0jZVODW3W6xUYmu6ZOEc/UmmElUwhRyDRm1R4yNZu1Joq2kuQg==" + }, + "@actions/tool-cache": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/@actions/tool-cache/-/tool-cache-1.1.2.tgz", + "integrity": "sha512-IJczPaZr02ECa3Lgws/TJEVco9tjOujiQSZbO3dHuXXjhd5vrUtfOgGwhmz3/f97L910OraPZ8SknofUk6RvOQ==", + "requires": { + "@actions/core": "1.1.3", + "@actions/exec": "1.0.1", + "@actions/io": "1.0.1", + "semver": "6.3.0", + "typed-rest-client": "1.5.0", + "uuid": "3.3.3" + }, + "dependencies": { + "@actions/core": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.1.3.tgz", + "integrity": "sha512-2BIib53Jh4Cfm+1XNuZYYGTeRo8yiWEAUMoliMh1qQGMaqTF4VUlhhcsBylTu4qWmUx45DrY0y0XskimAHSqhw==" + }, + "@actions/exec": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@actions/exec/-/exec-1.0.1.tgz", + "integrity": "sha512-nvFkxwiicvpzNiCBF4wFBDfnBvi7xp/as7LE1hBxBxKG2L29+gkIPBiLKMVORL+Hg3JNf07AKRfl0V5djoypjQ==" + }, + "@actions/io": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@actions/io/-/io-1.0.1.tgz", + "integrity": "sha512-rhq+tfZukbtaus7xyUtwKfuiCRXd1hWSfmJNEpFgBQJ4woqPEpsBw04awicjwz9tyG2/MVhAEMfVn664Cri5zA==" + } + } + }, + "@types/node": { + "version": "12.7.4", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.7.4.tgz", + "integrity": "sha512-W0+n1Y+gK/8G2P/piTkBBN38Qc5Q1ZSO6B5H3QmPCUewaiXOo2GCAWZ4ElZCcNhjJuBSUSLGFUJnmlCn5+nxOQ==", + "dev": true + }, + "semver": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", + "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==" + }, + "tunnel": { + "version": "0.0.4", + "resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.4.tgz", + "integrity": "sha1-LTeFoVjBdMmhbcLARuxfxfF0IhM=" + }, + "typed-rest-client": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/typed-rest-client/-/typed-rest-client-1.5.0.tgz", + "integrity": "sha512-DVZRlmsfnTjp6ZJaatcdyvvwYwbWvR4YDNFDqb+qdTxpvaVP99YCpBkA8rxsLtAPjBVoDe4fNsnMIdZTiPuKWg==", + "requires": { + "tunnel": "0.0.4", + "underscore": "1.8.3" + } + }, + "typescript": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.6.2.tgz", + "integrity": "sha512-lmQ4L+J6mnu3xweP8+rOrUwzmN+MRAj7TgtJtDaXE5PMyX2kCrklhg3rvOsOIfNeAWMQWO2F1GPc1kMD2vLAfw==", + "dev": true + }, + "underscore": { + "version": "1.8.3", + "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.8.3.tgz", + "integrity": "sha1-Tz+1OxBuYJf8+ctBCfKl6b36UCI=" + }, + "uuid": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.3.3.tgz", + "integrity": "sha512-pW0No1RGHgzlpHJO1nsVrHKpOEIxkGg1xB+v0ZmdNH5OAeAwzAVrCnI2/6Mtx+Uys6iaylxa+D3g4j63IKKjSQ==" + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 00000000..033ff8d1 --- /dev/null +++ b/package.json @@ -0,0 +1,23 @@ +{ + "name": "setuphelm", + "version": "0.0.0", + "private": true, + "description": "Setup helm", + "author": "Anumita Shenoy", + "license": "MIT", + "dependencies": { + "@actions/tool-cache": "1.1.2", + "@actions/io": "^1.0.0", + "@actions/core": "^1.0.0", + "@actions/exec": "^1.0.0" + }, + "main": "lib/run.js", + "scripts": { + "build": "tsc", + "test": "echo \"Error: no test specified\" && exit 1" + }, + "devDependencies": { + "@types/node": "^12.0.10", + "typescript": "^3.5.2" + } +} diff --git a/src/run.ts b/src/run.ts new file mode 100644 index 00000000..f7232941 --- /dev/null +++ b/src/run.ts @@ -0,0 +1,121 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + +import * as os from 'os'; +import * as path from 'path'; +import * as util from 'util'; +import * as fs from 'fs'; + +import * as toolCache from '@actions/tool-cache'; +import * as core from '@actions/core'; + +const helmToolName = 'helm'; +const stableHelmVersion = 'v2.14.1'; +const helmLatestReleaseUrl = 'https://api.github.com/repos/helm/helm/releases/latest'; + +function getExecutableExtension(): string { + if (os.type().match(/^Win/)) { + return '.exe'; + } + return ''; +} + +function getHelmDownloadURL(version: string): string { + switch (os.type()) { + case 'Linux': + return util.format('https://get.helm.sh/helm-%s-linux-amd64.zip', version); + + case 'Darwin': + return util.format('https://get.helm.sh/helm-%s-darwin-amd64.zip', version); + + case 'Windows_NT': + default: + return util.format('https://get.helm.sh/helm-%s-windows-amd64.zip', version); + + } +} + +async function getStableHelmVersion(): Promise { + return toolCache.downloadTool(helmLatestReleaseUrl).then((downloadPath) => { + const response = JSON.parse(fs.readFileSync(downloadPath, 'utf8').toString().trim()); + if (!response.tag_name) + { + return stableHelmVersion; + } + + return response.tag_name; + }, (error) => { + core.debug(error); + core.warning(util.format("Failed to read latest kubectl version from stable.txt. From URL %s. Using default stable version %s", helmLatestReleaseUrl, stableHelmVersion)); + return stableHelmVersion; + }); +} + + +var walkSync = function(dir, filelist, fileToFind) { + var files = fs.readdirSync(dir); + filelist = filelist || []; + files.forEach(function(file) { + if (fs.statSync(path.join(dir, file)).isDirectory()) { + filelist = walkSync(path.join(dir, file), filelist, fileToFind); + } + else { + core.debug(file); + if(file == fileToFind) + { + filelist.push(path.join(dir, file)); + } + } + }); + return filelist; + }; + +async function downloadHelm(version: string): Promise { + if (!version) { version = await getStableHelmVersion(); } + let cachedToolpath = toolCache.find(helmToolName, version); + if (!cachedToolpath) { + let helmDownloadPath; + try { + helmDownloadPath = await toolCache.downloadTool(getHelmDownloadURL(version)); + } catch (exception) { + throw new Error(util.format("Failed to download Helm from location ", getHelmDownloadURL(version))); + } + + fs.chmodSync(helmDownloadPath, '777'); + const unzipedHelmPath = await toolCache.extractZip(helmDownloadPath); + cachedToolpath = await toolCache.cacheDir(unzipedHelmPath, helmToolName, version); + } + + const helmpath = findHelm(cachedToolpath); + if (!helmpath) { + throw new Error(util.format("Helm executable not found in path ", cachedToolpath)); + } + + fs.chmodSync(helmpath, '777'); + return helmpath; +} + +function findHelm(rootFolder: string): string { + fs.chmodSync(rootFolder, '777'); + var filelist: string[] = []; + walkSync(rootFolder, filelist, helmToolName + getExecutableExtension()); + if (!filelist) { + throw new Error(util.format("Helm executable not found in path ", rootFolder)); + } + else { + return filelist[0]; + } +} + +async function run() { + let version = core.getInput('version', { 'required': true }); + if (version.toLocaleLowerCase() === 'latest') { + version = await getStableHelmVersion(); + } + + let cachedPath = await downloadHelm(version); + console.log(`Helm tool version: '${version}' has been cached at ${cachedPath}`); + core.setOutput('helm-path', cachedPath); +} + +run().catch(core.setFailed); \ No newline at end of file diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 00000000..960dc9fa --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,63 @@ +{ + "compilerOptions": { + /* Basic Options */ + // "incremental": true, /* Enable incremental compilation */ + "target": "es6", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */ + "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */ + // "allowJs": true, /* Allow javascript files to be compiled. */ + // "checkJs": true, /* Report errors in .js files. */ + // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ + // "declaration": true, /* Generates corresponding '.d.ts' file. */ + // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + // "sourceMap": true, /* Generates corresponding '.map' file. */ + // "outFile": "./", /* Concatenate and emit output to single file. */ + "outDir": "./lib", /* Redirect output structure to the directory. */ + "rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + // "composite": true, /* Enable project compilation */ + // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ + // "removeComments": true, /* Do not emit comments to output. */ + // "noEmit": true, /* Do not emit outputs. */ + // "importHelpers": true, /* Import emit helpers from 'tslib'. */ + // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ + // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ + + /* Strict Type-Checking Options */ + "strict": true, /* Enable all strict type-checking options. */ + "noImplicitAny": false, /* Raise error on expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* Enable strict null checks. */ + // "strictFunctionTypes": true, /* Enable strict checking of function types. */ + // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ + // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ + // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ + // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ + + /* Additional Checks */ + // "noUnusedLocals": true, /* Report errors on unused locals. */ + // "noUnusedParameters": true, /* Report errors on unused parameters. */ + // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ + // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ + + /* Module Resolution Options */ + // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ + // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ + // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ + // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ + // "typeRoots": [], /* List of folders to include type definitions from. */ + // "types": [], /* Type declaration files to be included in compilation. */ + // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ + "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ + // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + + /* Source Map Options */ + // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ + // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ + + /* Experimental Options */ + // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ + // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ + }, + "exclude": ["node_modules", "**/*.test.ts"] +}