Compare commits
31 Commits
Author | SHA1 | Date | |
---|---|---|---|
fe7b79cd5e | |||
df50d879fa | |||
08d7123a4a | |||
0a0c55a4c3 | |||
d00ce1cb5e | |||
4c255dde26 | |||
ec8dd7c209 | |||
efbd96d464 | |||
859dc38e9a | |||
0788eb3317 | |||
208de6bd49 | |||
1f87a575d0 | |||
d336b89352 | |||
ac5ee1fca8 | |||
638a523e0c | |||
0a7ec47357 | |||
3419a8fa8f | |||
f77071b246 | |||
a4617735aa | |||
2dafda840c | |||
b70d33f56d | |||
3c00c0152f | |||
22d14750db | |||
a22741c887 | |||
f850d12cb3 | |||
17cd77473c | |||
484a64052d | |||
6e32762c2e | |||
17c21ab68c | |||
7f0153c54c | |||
a14110f6e6 |
36
.github/ISSUE_TEMPLATE/bugReportForm.yml
vendored
Normal file
36
.github/ISSUE_TEMPLATE/bugReportForm.yml
vendored
Normal file
@ -0,0 +1,36 @@
|
||||
name: Bug Report
|
||||
description: File a bug report specifying all inputs you provided for the action, we will respond to this thread with any questions.
|
||||
title: 'Bug: '
|
||||
labels: ['bug', 'triage']
|
||||
assignees: '@Azure/aks-atlanta'
|
||||
body:
|
||||
- type: textarea
|
||||
id: What-happened
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: Tell us what happened and how is it different from the expected?
|
||||
placeholder: Tell us what you see!
|
||||
validations:
|
||||
required: true
|
||||
- type: checkboxes
|
||||
id: Version
|
||||
attributes:
|
||||
label: Version
|
||||
options:
|
||||
- label: I am using the latest version
|
||||
required: true
|
||||
- type: input
|
||||
id: Runner
|
||||
attributes:
|
||||
label: Runner
|
||||
description: What runner are you using?
|
||||
placeholder: Mention the runner info (self-hosted, operating system)
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: Logs
|
||||
attributes:
|
||||
label: Relevant log output
|
||||
description: Run in debug mode for the most verbose logs. Please feel free to attach a screenshot of the logs
|
||||
validations:
|
||||
required: true
|
6
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
6
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,6 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: GitHub Action "setup-helm" Support
|
||||
url: https://github.com/Azure/setup-helm
|
||||
security: https://github.com/Azure/setup-helm/blob/main/SECURITY.md
|
||||
about: Please ask and answer questions here.
|
13
.github/ISSUE_TEMPLATE/featureRequestForm.yml
vendored
Normal file
13
.github/ISSUE_TEMPLATE/featureRequestForm.yml
vendored
Normal file
@ -0,0 +1,13 @@
|
||||
name: Feature Request
|
||||
description: File a Feature Request form, we will respond to this thread with any questions.
|
||||
title: 'Feature Request: '
|
||||
labels: ['Feature']
|
||||
assignees: '@Azure/aks-atlanta'
|
||||
body:
|
||||
- type: textarea
|
||||
id: Feature_request
|
||||
attributes:
|
||||
label: Feature request
|
||||
description: Provide example functionality and links to relevant docs
|
||||
validations:
|
||||
required: true
|
@ -4,7 +4,4 @@ about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: need-to-triage
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
16
.github/workflows/defaultLabels.yml
vendored
16
.github/workflows/defaultLabels.yml
vendored
@ -3,7 +3,7 @@ name: setting-default-labels
|
||||
# Controls when the action will run.
|
||||
on:
|
||||
schedule:
|
||||
- cron: "0 0/3 * * *"
|
||||
- cron: '0 0/3 * * *'
|
||||
|
||||
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
|
||||
jobs:
|
||||
@ -13,23 +13,23 @@ jobs:
|
||||
|
||||
# Steps represent a sequence of tasks that will be executed as part of the job
|
||||
steps:
|
||||
- uses: actions/stale@v3
|
||||
- uses: actions/stale@v9
|
||||
name: Setting issue as idle
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
stale-issue-message: "This issue is idle because it has been open for 14 days with no activity."
|
||||
stale-issue-label: "idle"
|
||||
stale-issue-message: 'This issue is idle because it has been open for 14 days with no activity.'
|
||||
stale-issue-label: 'idle'
|
||||
days-before-stale: 14
|
||||
days-before-close: -1
|
||||
operations-per-run: 100
|
||||
exempt-issue-labels: "backlog"
|
||||
exempt-issue-labels: 'backlog'
|
||||
|
||||
- uses: actions/stale@v3
|
||||
- uses: actions/stale@v9
|
||||
name: Setting PR as idle
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
stale-pr-message: "This PR is idle because it has been open for 14 days with no activity."
|
||||
stale-pr-label: "idle"
|
||||
stale-pr-message: 'This PR is idle because it has been open for 14 days with no activity.'
|
||||
stale-pr-label: 'idle'
|
||||
days-before-stale: 14
|
||||
days-before-close: -1
|
||||
operations-per-run: 100
|
||||
|
34
.github/workflows/integration-tests.yml
vendored
34
.github/workflows/integration-tests.yml
vendored
@ -1,21 +1,21 @@
|
||||
name: "Trigger Integration tests"
|
||||
name: 'Trigger Integration tests'
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- "releases/*"
|
||||
- 'releases/*'
|
||||
jobs:
|
||||
trigger-integration-tests:
|
||||
name: Trigger Integration tests
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
HELM_3_8_0: "v3.8.0"
|
||||
HELM_3_7_2: "v3.7.2"
|
||||
HELM_NO_V: "3.5.0"
|
||||
HELM_3_8_0: 'v3.8.0'
|
||||
HELM_3_7_2: 'v3.7.2'
|
||||
HELM_NO_V: '3.5.0'
|
||||
PR_BASE_REF: ${{ github.event.pull_request.base.ref }}
|
||||
steps:
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@v2
|
||||
uses: actions/checkout@v4
|
||||
- name: npm install and build
|
||||
id: action-npm-build
|
||||
run: |
|
||||
@ -63,3 +63,25 @@ jobs:
|
||||
else
|
||||
echo "HELM VERSION $HELM_3_5_0 INSTALLED SUCCESSFULLY"
|
||||
fi
|
||||
- name: Setup helm latest version
|
||||
uses: ./
|
||||
with:
|
||||
version: latest
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
- name: Validate latest
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
HELM_LATEST=$(gh release list \
|
||||
--repo helm/helm \
|
||||
--exclude-drafts \
|
||||
--exclude-pre-releases \
|
||||
--limit 1 | awk '{print $4}')
|
||||
|
||||
if [[ $(helm version) != *$HELM_LATEST* ]]; then
|
||||
echo "HELM VERSION INCORRECT: HELM VERSION DOES NOT CONTAIN $HELM_LATEST"
|
||||
echo "HELM VERSION OUTPUT: $(helm version)"
|
||||
exit 1
|
||||
else
|
||||
echo "HELM VERSION $HELM_LATEST INSTALLED SUCCESSFULLY"
|
||||
fi
|
||||
|
18
.github/workflows/prettify-code.yml
vendored
Normal file
18
.github/workflows/prettify-code.yml
vendored
Normal file
@ -0,0 +1,18 @@
|
||||
name: 'Run prettify'
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
prettier:
|
||||
name: Prettier Check
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Enforce Prettier
|
||||
uses: actionsx/prettier@v3
|
||||
with:
|
||||
args: --check .
|
20
.github/workflows/release-pr.yml
vendored
20
.github/workflows/release-pr.yml
vendored
@ -1,14 +1,18 @@
|
||||
name: Create release PR
|
||||
name: Release Project
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- CHANGELOG.md
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
release:
|
||||
description: "Define release version (ex: v1, v2, v3)"
|
||||
required: true
|
||||
|
||||
jobs:
|
||||
release-pr:
|
||||
uses: OliverMKing/javascript-release-workflow/.github/workflows/release-pr.yml@main
|
||||
release:
|
||||
permissions:
|
||||
actions: read
|
||||
contents: write
|
||||
uses: Azure/action-release-workflows/.github/workflows/release_js_project.yaml@v1
|
||||
with:
|
||||
release: ${{ github.event.inputs.release }}
|
||||
changelogPath: ./CHANGELOG.md
|
||||
|
8
.github/workflows/unit-tests.yml
vendored
8
.github/workflows/unit-tests.yml
vendored
@ -1,19 +1,19 @@
|
||||
name: "Run unit tests."
|
||||
name: 'Run unit tests.'
|
||||
on: # rebuild any PRs and main branch changes
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- "releases/*"
|
||||
- 'releases/*'
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- "releases/*"
|
||||
- 'releases/*'
|
||||
|
||||
jobs:
|
||||
build: # make sure build/ci works properly
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Run L0 tests.
|
||||
run: |
|
||||
|
3
.gitignore
vendored
3
.gitignore
vendored
@ -11,8 +11,6 @@ pids
|
||||
*.seed
|
||||
*.pid.lock
|
||||
|
||||
# Directory for instrumented libs generated by jscoverage/JSCover
|
||||
lib-cov
|
||||
|
||||
# Coverage directory used by tools like istanbul
|
||||
coverage
|
||||
@ -64,4 +62,3 @@ node_modules
|
||||
coverage
|
||||
|
||||
# Transpiled JS
|
||||
lib/
|
||||
|
4
.prettierignore
Normal file
4
.prettierignore
Normal file
@ -0,0 +1,4 @@
|
||||
# dependencies
|
||||
/node_modules
|
||||
coverage
|
||||
/lib
|
8
.prettierrc.json
Normal file
8
.prettierrc.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"trailingComma": "none",
|
||||
"bracketSpacing": false,
|
||||
"semi": false,
|
||||
"tabWidth": 3,
|
||||
"singleQuote": true,
|
||||
"printWidth": 80
|
||||
}
|
13
CHANGELOG.md
Normal file
13
CHANGELOG.md
Normal file
@ -0,0 +1,13 @@
|
||||
# Change Log
|
||||
|
||||
## [4.2.0] - 2024-04-15
|
||||
|
||||
- #124 Fix OS detection and download OS-native archive extension
|
||||
|
||||
## [4.1.0] - 2024-03-01
|
||||
|
||||
- #130 switches to use Helm published file to read latest version instead of using GitHub releases
|
||||
|
||||
## [4.0.0] - 2024-02-12
|
||||
|
||||
- #121 update to node20 as node16 is deprecated
|
17
README.md
17
README.md
@ -1,20 +1,25 @@
|
||||
# Setup Helm
|
||||
|
||||
Install a specific version of helm binary on the runner.
|
||||
|
||||
## Example
|
||||
|
||||
Acceptable values are latest or any semantic version string like v3.5.0 Use this action in workflow to define which version of helm will be used. v2 of this action only supports Helm3.
|
||||
Acceptable values are latest or any semantic version string like v3.5.0 Use this action in workflow to define which version of helm will be used. v2+ of this action only support Helm3.
|
||||
|
||||
```yaml
|
||||
- uses: azure/setup-helm@v1
|
||||
- uses: azure/setup-helm@v4.2.0
|
||||
with:
|
||||
version: '<version>' # default is latest stable
|
||||
version: '<version>' # default is latest (stable)
|
||||
id: install
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> If something goes wrong with fetching the latest version the action will use the hardcoded default stable version (currently v3.13.3). If you rely on a certain version higher than the default, you should explicitly use that version instead of latest.
|
||||
|
||||
The cached helm binary path is prepended to the PATH environment variable as well as stored in the helm-path output variable.
|
||||
Refer to the action metadata file for details about all the inputs https://github.com/Azure/setup-helm/blob/master/action.yml
|
||||
|
||||
# Contributing
|
||||
## 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
|
||||
@ -27,3 +32,7 @@ provided by the bot. You will only need to do this once across all repos using o
|
||||
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.
|
||||
|
||||
## Support
|
||||
|
||||
setup-helm is an open source project that is [**not** covered by the Microsoft Azure support policy](https://support.microsoft.com/en-us/help/2941892/support-for-linux-and-open-source-technology-in-azure). [Please search open issues here](https://github.com/Azure/setup-helm/issues), and if your issue isn't already represented please [open a new one](https://github.com/Azure/setup-helm/issues/new/choose). The project maintainers will respond to the best of their abilities.
|
||||
|
16
SECURITY.md
16
SECURITY.md
@ -4,7 +4,7 @@
|
||||
|
||||
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [many more](https://opensource.microsoft.com/).
|
||||
|
||||
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [definition](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)) of a security vulnerability, please report it to us as described below.
|
||||
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [definition](<https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)>) of a security vulnerability, please report it to us as described below.
|
||||
|
||||
## Reporting Security Issues
|
||||
|
||||
@ -18,13 +18,13 @@ You should receive a response within 24 hours. If for some reason you do not, pl
|
||||
|
||||
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
|
||||
|
||||
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
|
||||
* Full paths of source file(s) related to the manifestation of the issue
|
||||
* The location of the affected source code (tag/branch/commit or direct URL)
|
||||
* Any special configuration required to reproduce the issue
|
||||
* Step-by-step instructions to reproduce the issue
|
||||
* Proof-of-concept or exploit code (if possible)
|
||||
* Impact of the issue, including how an attacker might exploit the issue
|
||||
- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
|
||||
- Full paths of source file(s) related to the manifestation of the issue
|
||||
- The location of the affected source code (tag/branch/commit or direct URL)
|
||||
- Any special configuration required to reproduce the issue
|
||||
- Step-by-step instructions to reproduce the issue
|
||||
- Proof-of-concept or exploit code (if possible)
|
||||
- Impact of the issue, including how an attacker might exploit the issue
|
||||
|
||||
This information will help us triage your report more quickly.
|
||||
|
||||
|
25
action.yml
25
action.yml
@ -1,15 +1,24 @@
|
||||
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"
|
||||
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"
|
||||
description: 'Version of helm'
|
||||
required: true
|
||||
default: "latest"
|
||||
default: 'latest'
|
||||
token:
|
||||
description: GitHub token. Used to be required to fetch the latest version
|
||||
required: false
|
||||
deprecationMessage: 'GitHub token is no longer required'
|
||||
default: '${{ github.token }}'
|
||||
downloadBaseURL:
|
||||
description: 'Set the download base URL'
|
||||
required: false
|
||||
default: 'https://get.helm.sh'
|
||||
outputs:
|
||||
helm-path:
|
||||
description: "Path to the cached helm binary"
|
||||
description: 'Path to the cached helm binary'
|
||||
branding:
|
||||
color: "blue"
|
||||
color: 'blue'
|
||||
runs:
|
||||
using: "node16"
|
||||
main: "lib/index.js"
|
||||
using: 'node20'
|
||||
main: 'lib/index.js'
|
||||
|
@ -8,11 +8,11 @@ module.exports = {
|
||||
},
|
||||
verbose: true,
|
||||
coverageThreshold: {
|
||||
"global": {
|
||||
"branches": 0,
|
||||
"functions": 14,
|
||||
"lines": 27,
|
||||
"statements": 27
|
||||
global: {
|
||||
branches: 0,
|
||||
functions: 14,
|
||||
lines: 27,
|
||||
statements: 27
|
||||
}
|
||||
}
|
||||
}
|
30846
lib/index.js
Normal file
30846
lib/index.js
Normal file
File diff suppressed because one or more lines are too long
10461
package-lock.json
generated
10461
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
33
package.json
33
package.json
@ -1,30 +1,35 @@
|
||||
{
|
||||
"name": "setuphelm",
|
||||
"version": "0.0.0",
|
||||
"version": "4.2.0",
|
||||
"private": true,
|
||||
"description": "Setup helm",
|
||||
"author": "Anumita Shenoy",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@actions/core": "^1.2.6",
|
||||
"@actions/exec": "^1.0.0",
|
||||
"@actions/io": "^1.0.0",
|
||||
"@actions/tool-cache": "1.1.2",
|
||||
"@octokit/graphql": "^4.6.1",
|
||||
"semver": "^6.1.0"
|
||||
"@actions/core": "^1.10.0",
|
||||
"@actions/exec": "^1.1.1",
|
||||
"@actions/io": "^1.1.2",
|
||||
"@actions/tool-cache": "2.0.1",
|
||||
"@octokit/action": "^6.0.7",
|
||||
"ncc": "^0.3.6",
|
||||
"semver": "^7.5.4"
|
||||
},
|
||||
"main": "lib/index.js",
|
||||
"scripts": {
|
||||
"prebuild": "npm i ncc",
|
||||
"build": "ncc build src/run.ts -o lib",
|
||||
"test": "jest",
|
||||
"test-coverage": "jest --coverage"
|
||||
"test-coverage": "jest --coverage",
|
||||
"format": "prettier --write .",
|
||||
"format-check": "prettier --check ."
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/jest": "^26.0.0",
|
||||
"@types/node": "^12.0.10",
|
||||
"@vercel/ncc": "^0.33.1",
|
||||
"jest": "^26.0.1",
|
||||
"ts-jest": "^26.0.0",
|
||||
"typescript": "^3.5.2"
|
||||
"@types/jest": "^29.5.11",
|
||||
"@types/node": "^20.11.8",
|
||||
"@vercel/ncc": "^0.38.1",
|
||||
"jest": "^29.7.0",
|
||||
"prettier": "^3.2.5",
|
||||
"ts-jest": "^29.1.2",
|
||||
"typescript": "^5.3.3"
|
||||
}
|
||||
}
|
||||
|
485
src/run.test.ts
485
src/run.test.ts
@ -1,268 +1,299 @@
|
||||
import * as run from "./run";
|
||||
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 run from './run'
|
||||
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'
|
||||
|
||||
describe("run.ts", () => {
|
||||
test("getExecutableExtension() - return .exe when os is Windows", () => {
|
||||
jest.spyOn(os, "type").mockReturnValue("Windows_NT");
|
||||
describe('run.ts', () => {
|
||||
const downloadBaseURL = 'https://test.tld'
|
||||
|
||||
expect(run.getExecutableExtension()).toBe(".exe");
|
||||
expect(os.type).toBeCalled();
|
||||
});
|
||||
// Cleanup mocks after each test to ensure that subsequent tests are not affected by the mocks.
|
||||
afterEach(() => {
|
||||
jest.restoreAllMocks()
|
||||
})
|
||||
|
||||
test("getExecutableExtension() - return empty string for non-windows OS", () => {
|
||||
jest.spyOn(os, "type").mockReturnValue("Darwin");
|
||||
test('getExecutableExtension() - return .exe when os is Windows', () => {
|
||||
jest.spyOn(os, 'platform').mockReturnValue('win32')
|
||||
|
||||
expect(run.getExecutableExtension()).toBe("");
|
||||
expect(os.type).toBeCalled();
|
||||
});
|
||||
expect(run.getExecutableExtension()).toBe('.exe')
|
||||
expect(os.platform).toHaveBeenCalled()
|
||||
})
|
||||
|
||||
test("getHelmDownloadURL() - return the URL to download helm for Linux", () => {
|
||||
jest.spyOn(os, "type").mockReturnValue("Linux");
|
||||
jest.spyOn(os, "arch").mockReturnValueOnce("unknown");
|
||||
const kubectlLinuxUrl = "https://get.helm.sh/helm-v3.8.0-linux-amd64.zip";
|
||||
test('getExecutableExtension() - return empty string for non-windows OS', () => {
|
||||
jest.spyOn(os, 'platform').mockReturnValue('darwin')
|
||||
|
||||
expect(run.getHelmDownloadURL("v3.8.0")).toBe(kubectlLinuxUrl);
|
||||
expect(os.type).toBeCalled();
|
||||
expect(os.arch).toBeCalled();
|
||||
expect(run.getExecutableExtension()).toBe('')
|
||||
expect(os.platform).toHaveBeenCalled()
|
||||
})
|
||||
|
||||
// arm64
|
||||
jest.spyOn(os, "type").mockReturnValue("Linux");
|
||||
jest.spyOn(os, "arch").mockReturnValueOnce("arm64");
|
||||
const kubectlLinuxArm64Url =
|
||||
"https://get.helm.sh/helm-v3.8.0-linux-arm64.zip";
|
||||
test('getHelmDownloadURL() - return the URL to download helm for Linux amd64', () => {
|
||||
jest.spyOn(os, 'platform').mockReturnValue('linux')
|
||||
jest.spyOn(os, 'arch').mockReturnValue('x64')
|
||||
const expected = 'https://test.tld/helm-v3.8.0-linux-amd64.tar.gz'
|
||||
|
||||
expect(run.getHelmDownloadURL("v3.8.0")).toBe(kubectlLinuxArm64Url);
|
||||
expect(os.type).toBeCalled();
|
||||
expect(os.arch).toBeCalled();
|
||||
});
|
||||
expect(run.getHelmDownloadURL(downloadBaseURL, 'v3.8.0')).toBe(expected)
|
||||
expect(os.platform).toHaveBeenCalled()
|
||||
expect(os.arch).toHaveBeenCalled()
|
||||
})
|
||||
|
||||
test("getHelmDownloadURL() - return the URL to download helm for Darwin", () => {
|
||||
jest.spyOn(os, "type").mockReturnValue("Darwin");
|
||||
jest.spyOn(os, "arch").mockReturnValueOnce("unknown");
|
||||
const kubectlDarwinUrl = "https://get.helm.sh/helm-v3.8.0-darwin-amd64.zip";
|
||||
test('getHelmDownloadURL() - return the URL to download helm for Linux arm64', () => {
|
||||
jest.spyOn(os, 'platform').mockReturnValue('linux')
|
||||
jest.spyOn(os, 'arch').mockReturnValue('arm64')
|
||||
const expected = 'https://test.tld/helm-v3.8.0-linux-arm64.tar.gz'
|
||||
|
||||
expect(run.getHelmDownloadURL("v3.8.0")).toBe(kubectlDarwinUrl);
|
||||
expect(os.type).toBeCalled();
|
||||
expect(os.arch).toBeCalled();
|
||||
expect(run.getHelmDownloadURL(downloadBaseURL, 'v3.8.0')).toBe(expected)
|
||||
expect(os.platform).toHaveBeenCalled()
|
||||
expect(os.arch).toHaveBeenCalled()
|
||||
})
|
||||
|
||||
// arm64
|
||||
jest.spyOn(os, "type").mockReturnValue("Darwin");
|
||||
jest.spyOn(os, "arch").mockReturnValueOnce("arm64");
|
||||
const kubectlDarwinArm64Url =
|
||||
"https://get.helm.sh/helm-v3.8.0-darwin-arm64.zip";
|
||||
test('getHelmDownloadURL() - return the URL to download helm for Darwin x64', () => {
|
||||
jest.spyOn(os, 'platform').mockReturnValue('darwin')
|
||||
jest.spyOn(os, 'arch').mockReturnValue('x64')
|
||||
const expected = 'https://test.tld/helm-v3.8.0-darwin-amd64.tar.gz'
|
||||
|
||||
expect(run.getHelmDownloadURL("v3.8.0")).toBe(kubectlDarwinArm64Url);
|
||||
expect(os.type).toBeCalled();
|
||||
expect(os.arch).toBeCalled();
|
||||
});
|
||||
expect(run.getHelmDownloadURL(downloadBaseURL, 'v3.8.0')).toBe(expected)
|
||||
expect(os.platform).toHaveBeenCalled()
|
||||
expect(os.arch).toHaveBeenCalled()
|
||||
})
|
||||
|
||||
test("getValidVersion() - return version with v prepended", () => {
|
||||
expect(run.getValidVersion("3.8.0")).toBe("v3.8.0");
|
||||
});
|
||||
test('getHelmDownloadURL() - return the URL to download helm for Darwin arm64', () => {
|
||||
jest.spyOn(os, 'platform').mockReturnValue('darwin')
|
||||
jest.spyOn(os, 'arch').mockReturnValue('arm64')
|
||||
const expected = 'https://test.tld/helm-v3.8.0-darwin-arm64.tar.gz'
|
||||
|
||||
test("getHelmDownloadURL() - return the URL to download helm for Windows", () => {
|
||||
jest.spyOn(os, "type").mockReturnValue("Windows_NT");
|
||||
expect(run.getHelmDownloadURL(downloadBaseURL, 'v3.8.0')).toBe(expected)
|
||||
expect(os.platform).toHaveBeenCalled()
|
||||
expect(os.arch).toHaveBeenCalled()
|
||||
})
|
||||
|
||||
const kubectlWindowsUrl =
|
||||
"https://get.helm.sh/helm-v3.8.0-windows-amd64.zip";
|
||||
expect(run.getHelmDownloadURL("v3.8.0")).toBe(kubectlWindowsUrl);
|
||||
expect(os.type).toBeCalled();
|
||||
});
|
||||
test('getHelmDownloadURL() - return the URL to download helm for Windows', () => {
|
||||
jest.spyOn(os, 'platform').mockReturnValue('win32')
|
||||
jest.spyOn(os, 'arch').mockReturnValue('x64')
|
||||
|
||||
test("getLatestHelmVersion() - return the latest version of HELM", async () => {
|
||||
try {
|
||||
expect(await run.getLatestHelmVersion()).toBe("v3.8.0");
|
||||
} catch (e) {
|
||||
return e;
|
||||
}
|
||||
});
|
||||
const expected = 'https://test.tld/helm-v3.8.0-windows-amd64.zip'
|
||||
expect(run.getHelmDownloadURL(downloadBaseURL, 'v3.8.0')).toBe(expected)
|
||||
expect(os.platform).toHaveBeenCalled()
|
||||
})
|
||||
|
||||
test("walkSync() - return path to the all files matching fileToFind in dir", () => {
|
||||
jest.spyOn(fs, "readdirSync").mockImplementation((file, _) => {
|
||||
if (file == "mainFolder")
|
||||
test('getLatestHelmVersion() - return the latest version of HELM', async () => {
|
||||
const res = {
|
||||
status: 200,
|
||||
text: async () => 'v9.99.999'
|
||||
} as Response
|
||||
global.fetch = jest.fn().mockReturnValue(res)
|
||||
expect(await run.getLatestHelmVersion()).toBe('v9.99.999')
|
||||
})
|
||||
|
||||
test('getLatestHelmVersion() - return the stable version of HELM when simulating a network error', async () => {
|
||||
const errorMessage: string = 'Network Error'
|
||||
global.fetch = jest.fn().mockRejectedValueOnce(new Error(errorMessage))
|
||||
expect(await run.getLatestHelmVersion()).toBe('v3.13.3')
|
||||
})
|
||||
|
||||
test('getValidVersion() - return version with v prepended', () => {
|
||||
expect(run.getValidVersion('3.8.0')).toBe('v3.8.0')
|
||||
})
|
||||
|
||||
test('walkSync() - return path to the all files matching fileToFind in dir', () => {
|
||||
jest.spyOn(fs, 'readdirSync').mockImplementation((file, _) => {
|
||||
if (file == 'mainFolder')
|
||||
return [
|
||||
"file1" as unknown as fs.Dirent,
|
||||
"file2" as unknown as fs.Dirent,
|
||||
"folder1" as unknown as fs.Dirent,
|
||||
"folder2" as unknown as fs.Dirent,
|
||||
];
|
||||
if (file == path.join("mainFolder", "folder1"))
|
||||
'file1' as unknown as fs.Dirent,
|
||||
'file2' as unknown as fs.Dirent,
|
||||
'folder1' as unknown as fs.Dirent,
|
||||
'folder2' as unknown as fs.Dirent
|
||||
]
|
||||
if (file == path.join('mainFolder', 'folder1'))
|
||||
return [
|
||||
"file11" as unknown as fs.Dirent,
|
||||
"file12" as unknown as fs.Dirent,
|
||||
];
|
||||
if (file == path.join("mainFolder", "folder2"))
|
||||
'file11' as unknown as fs.Dirent,
|
||||
'file12' as unknown as fs.Dirent
|
||||
]
|
||||
if (file == path.join('mainFolder', 'folder2'))
|
||||
return [
|
||||
"file21" as unknown as fs.Dirent,
|
||||
"file22" as unknown as fs.Dirent,
|
||||
];
|
||||
});
|
||||
jest.spyOn(core, "debug").mockImplementation();
|
||||
jest.spyOn(fs, "statSync").mockImplementation((file) => {
|
||||
'file21' as unknown as fs.Dirent,
|
||||
'file22' as unknown as fs.Dirent
|
||||
]
|
||||
return []
|
||||
})
|
||||
jest.spyOn(core, 'debug').mockImplementation()
|
||||
jest.spyOn(fs, 'statSync').mockImplementation((file) => {
|
||||
const isDirectory =
|
||||
(file as string).toLowerCase().indexOf("file") == -1 ? true : false;
|
||||
return { isDirectory: () => isDirectory } as fs.Stats;
|
||||
});
|
||||
(file as string).toLowerCase().indexOf('file') == -1 ? true : false
|
||||
return {isDirectory: () => isDirectory} as fs.Stats
|
||||
})
|
||||
|
||||
expect(run.walkSync("mainFolder", null, "file21")).toEqual([
|
||||
path.join("mainFolder", "folder2", "file21"),
|
||||
]);
|
||||
expect(fs.readdirSync).toBeCalledTimes(3);
|
||||
expect(fs.statSync).toBeCalledTimes(8);
|
||||
});
|
||||
expect(run.walkSync('mainFolder', null, 'file21')).toEqual([
|
||||
path.join('mainFolder', 'folder2', 'file21')
|
||||
])
|
||||
expect(fs.readdirSync).toHaveBeenCalledTimes(3)
|
||||
expect(fs.statSync).toHaveBeenCalledTimes(8)
|
||||
})
|
||||
|
||||
test("walkSync() - return empty array if no file with name fileToFind exists", () => {
|
||||
jest.spyOn(fs, "readdirSync").mockImplementation((file, _) => {
|
||||
if (file == "mainFolder")
|
||||
test('walkSync() - return empty array if no file with name fileToFind exists', () => {
|
||||
jest.spyOn(fs, 'readdirSync').mockImplementation((file, _) => {
|
||||
if (file == 'mainFolder')
|
||||
return [
|
||||
"file1" as unknown as fs.Dirent,
|
||||
"file2" as unknown as fs.Dirent,
|
||||
"folder1" as unknown as fs.Dirent,
|
||||
"folder2" as unknown as fs.Dirent,
|
||||
];
|
||||
if (file == path.join("mainFolder", "folder1"))
|
||||
'file1' as unknown as fs.Dirent,
|
||||
'file2' as unknown as fs.Dirent,
|
||||
'folder1' as unknown as fs.Dirent,
|
||||
'folder2' as unknown as fs.Dirent
|
||||
]
|
||||
if (file == path.join('mainFolder', 'folder1'))
|
||||
return [
|
||||
"file11" as unknown as fs.Dirent,
|
||||
"file12" as unknown as fs.Dirent,
|
||||
];
|
||||
if (file == path.join("mainFolder", "folder2"))
|
||||
'file11' as unknown as fs.Dirent,
|
||||
'file12' as unknown as fs.Dirent
|
||||
]
|
||||
if (file == path.join('mainFolder', 'folder2'))
|
||||
return [
|
||||
"file21" as unknown as fs.Dirent,
|
||||
"file22" as unknown as fs.Dirent,
|
||||
];
|
||||
});
|
||||
jest.spyOn(core, "debug").mockImplementation();
|
||||
jest.spyOn(fs, "statSync").mockImplementation((file) => {
|
||||
'file21' as unknown as fs.Dirent,
|
||||
'file22' as unknown as fs.Dirent
|
||||
]
|
||||
return []
|
||||
})
|
||||
jest.spyOn(core, 'debug').mockImplementation()
|
||||
jest.spyOn(fs, 'statSync').mockImplementation((file) => {
|
||||
const isDirectory =
|
||||
(file as string).toLowerCase().indexOf("file") == -1 ? true : false;
|
||||
return { isDirectory: () => isDirectory } as fs.Stats;
|
||||
});
|
||||
(file as string).toLowerCase().indexOf('file') == -1 ? true : false
|
||||
return {isDirectory: () => isDirectory} as fs.Stats
|
||||
})
|
||||
|
||||
expect(run.walkSync("mainFolder", null, "helm.exe")).toEqual([]);
|
||||
expect(fs.readdirSync).toBeCalledTimes(3);
|
||||
expect(fs.statSync).toBeCalledTimes(8);
|
||||
});
|
||||
expect(run.walkSync('mainFolder', null, 'helm.exe')).toEqual([])
|
||||
expect(fs.readdirSync).toHaveBeenCalledTimes(3)
|
||||
expect(fs.statSync).toHaveBeenCalledTimes(8)
|
||||
})
|
||||
|
||||
test("findHelm() - change access permissions and find the helm in given directory", () => {
|
||||
jest.spyOn(fs, "chmodSync").mockImplementation(() => {});
|
||||
jest.spyOn(fs, "readdirSync").mockImplementation((file, _) => {
|
||||
if (file == "mainFolder") return ["helm.exe" as unknown as fs.Dirent];
|
||||
});
|
||||
jest.spyOn(fs, "statSync").mockImplementation((file) => {
|
||||
test('findHelm() - change access permissions and find the helm in given directory', () => {
|
||||
jest.spyOn(fs, 'chmodSync').mockImplementation(() => {})
|
||||
jest.spyOn(fs, 'readdirSync').mockImplementation((file, _) => {
|
||||
if (file == 'mainFolder') return ['helm.exe' as unknown as fs.Dirent]
|
||||
return []
|
||||
})
|
||||
jest.spyOn(fs, 'statSync').mockImplementation((file) => {
|
||||
const isDirectory =
|
||||
(file as string).indexOf("folder") == -1 ? false : true;
|
||||
return { isDirectory: () => isDirectory } as fs.Stats;
|
||||
});
|
||||
jest.spyOn(os, "type").mockReturnValue("Windows_NT");
|
||||
(file as string).indexOf('folder') == -1 ? false : true
|
||||
return {isDirectory: () => isDirectory} as fs.Stats
|
||||
})
|
||||
jest.spyOn(os, 'platform').mockReturnValue('win32')
|
||||
|
||||
expect(run.findHelm("mainFolder")).toBe(
|
||||
path.join("mainFolder", "helm.exe")
|
||||
);
|
||||
});
|
||||
expect(run.findHelm('mainFolder')).toBe(
|
||||
path.join('mainFolder', 'helm.exe')
|
||||
)
|
||||
})
|
||||
|
||||
test("findHelm() - throw error if executable not found", () => {
|
||||
jest.spyOn(fs, "chmodSync").mockImplementation(() => {});
|
||||
jest.spyOn(fs, "readdirSync").mockImplementation((file, _) => {
|
||||
if (file == "mainFolder") return [];
|
||||
});
|
||||
jest.spyOn(fs, "statSync").mockImplementation((file) => {
|
||||
return { isDirectory: () => true } as fs.Stats;
|
||||
});
|
||||
jest.spyOn(os, "type").mockReturnValue("Windows_NT");
|
||||
expect(() => run.findHelm("mainFolder")).toThrow(
|
||||
"Helm executable not found in path mainFolder"
|
||||
);
|
||||
});
|
||||
test('findHelm() - throw error if executable not found', () => {
|
||||
jest.spyOn(fs, 'chmodSync').mockImplementation(() => {})
|
||||
jest.spyOn(fs, 'readdirSync').mockImplementation((file, _) => {
|
||||
if (file == 'mainFolder') return []
|
||||
return []
|
||||
})
|
||||
jest.spyOn(fs, 'statSync').mockImplementation((file) => {
|
||||
return {isDirectory: () => true} as fs.Stats
|
||||
})
|
||||
jest.spyOn(os, 'platform').mockReturnValue('win32')
|
||||
|
||||
test("downloadHelm() - download helm and return path to it", async () => {
|
||||
jest.spyOn(toolCache, "find").mockReturnValue("");
|
||||
jest.spyOn(toolCache, "downloadTool").mockResolvedValue("pathToTool");
|
||||
const response = JSON.stringify([{ tag_name: "v4.0.0" }]);
|
||||
jest.spyOn(fs, "readFileSync").mockReturnValue(response);
|
||||
jest.spyOn(os, "type").mockReturnValue("Windows_NT");
|
||||
jest.spyOn(fs, "chmodSync").mockImplementation(() => {});
|
||||
jest.spyOn(toolCache, "extractZip").mockResolvedValue("pathToUnzippedHelm");
|
||||
jest.spyOn(toolCache, "cacheDir").mockResolvedValue("pathToCachedDir");
|
||||
expect(() => run.findHelm('mainFolder')).toThrow(
|
||||
'Helm executable not found in path mainFolder'
|
||||
)
|
||||
})
|
||||
|
||||
test('downloadHelm() - download helm and return path to it', async () => {
|
||||
jest.spyOn(toolCache, 'find').mockReturnValue('')
|
||||
jest.spyOn(toolCache, 'downloadTool').mockResolvedValue('pathToTool')
|
||||
const response = JSON.stringify([{tag_name: 'v4.0.0'}])
|
||||
jest.spyOn(fs, 'readFileSync').mockReturnValue(response)
|
||||
jest.spyOn(os, 'platform').mockReturnValue('win32')
|
||||
jest.spyOn(fs, 'chmodSync').mockImplementation(() => {})
|
||||
jest.spyOn(toolCache, 'extractZip').mockResolvedValue('extractedPath')
|
||||
jest.spyOn(toolCache, 'cacheDir').mockResolvedValue('pathToCachedDir')
|
||||
jest
|
||||
.spyOn(fs, "readdirSync")
|
||||
.mockImplementation((file, _) => ["helm.exe" as unknown as fs.Dirent]);
|
||||
jest.spyOn(fs, "statSync").mockImplementation((file) => {
|
||||
.spyOn(fs, 'readdirSync')
|
||||
.mockImplementation((file, _) => ['helm.exe' as unknown as fs.Dirent])
|
||||
jest.spyOn(fs, 'statSync').mockImplementation((file) => {
|
||||
const isDirectory =
|
||||
(file as string).indexOf("folder") == -1 ? false : true;
|
||||
return { isDirectory: () => isDirectory } as fs.Stats;
|
||||
});
|
||||
(file as string).indexOf('folder') == -1 ? false : true
|
||||
return {isDirectory: () => isDirectory} as fs.Stats
|
||||
})
|
||||
|
||||
expect(await run.downloadHelm("v4.0.0")).toBe(
|
||||
path.join("pathToCachedDir", "helm.exe")
|
||||
);
|
||||
expect(toolCache.find).toBeCalledWith("helm", "v4.0.0");
|
||||
expect(toolCache.downloadTool).toBeCalledWith(
|
||||
"https://get.helm.sh/helm-v4.0.0-windows-amd64.zip"
|
||||
);
|
||||
expect(fs.chmodSync).toBeCalledWith("pathToTool", "777");
|
||||
expect(toolCache.extractZip).toBeCalledWith("pathToTool");
|
||||
expect(fs.chmodSync).toBeCalledWith(
|
||||
path.join("pathToCachedDir", "helm.exe"),
|
||||
"777"
|
||||
);
|
||||
});
|
||||
expect(await run.downloadHelm(downloadBaseURL, 'v4.0.0')).toBe(
|
||||
path.join('pathToCachedDir', 'helm.exe')
|
||||
)
|
||||
expect(toolCache.find).toHaveBeenCalledWith('helm', 'v4.0.0')
|
||||
expect(toolCache.downloadTool).toHaveBeenCalledWith(
|
||||
'https://test.tld/helm-v4.0.0-windows-amd64.zip'
|
||||
)
|
||||
expect(fs.chmodSync).toHaveBeenCalledWith('pathToTool', '777')
|
||||
expect(toolCache.extractZip).toHaveBeenCalledWith('pathToTool')
|
||||
expect(fs.chmodSync).toHaveBeenCalledWith(
|
||||
path.join('pathToCachedDir', 'helm.exe'),
|
||||
'777'
|
||||
)
|
||||
})
|
||||
|
||||
test("downloadHelm() - throw error if unable to download", async () => {
|
||||
jest.spyOn(toolCache, "find").mockReturnValue("");
|
||||
jest.spyOn(toolCache, "downloadTool").mockImplementation(async () => {
|
||||
throw "Unable to download";
|
||||
});
|
||||
jest.spyOn(os, "type").mockReturnValue("Windows_NT");
|
||||
test('downloadHelm() - throw error if unable to download', async () => {
|
||||
jest.spyOn(toolCache, 'find').mockReturnValue('')
|
||||
jest.spyOn(toolCache, 'downloadTool').mockImplementation(async () => {
|
||||
throw 'Unable to download'
|
||||
})
|
||||
jest.spyOn(os, 'platform').mockReturnValue('win32')
|
||||
|
||||
await expect(run.downloadHelm("v3.2.1")).rejects.toThrow(
|
||||
"Failed to download Helm from location https://get.helm.sh/helm-v3.2.1-windows-amd64.zip"
|
||||
);
|
||||
expect(toolCache.find).toBeCalledWith("helm", "v3.2.1");
|
||||
expect(toolCache.downloadTool).toBeCalledWith(
|
||||
"https://get.helm.sh/helm-v3.2.1-windows-amd64.zip"
|
||||
);
|
||||
});
|
||||
const downloadUrl = 'https://test.tld/helm-v3.2.1-windows-amd64.zip'
|
||||
await expect(run.downloadHelm(downloadBaseURL, 'v3.2.1')).rejects.toThrow(
|
||||
`Failed to download Helm from location ${downloadUrl}`
|
||||
)
|
||||
expect(toolCache.find).toHaveBeenCalledWith('helm', 'v3.2.1')
|
||||
expect(toolCache.downloadTool).toHaveBeenCalledWith(`${downloadUrl}`)
|
||||
})
|
||||
|
||||
test("downloadHelm() - return path to helm tool with same version from toolCache", async () => {
|
||||
jest.spyOn(toolCache, "find").mockReturnValue("pathToCachedDir");
|
||||
jest.spyOn(fs, "chmodSync").mockImplementation(() => {});
|
||||
|
||||
expect(await run.downloadHelm("v3.2.1")).toBe(
|
||||
path.join("pathToCachedDir", "helm.exe")
|
||||
);
|
||||
expect(toolCache.find).toBeCalledWith("helm", "v3.2.1");
|
||||
expect(fs.chmodSync).toBeCalledWith(
|
||||
path.join("pathToCachedDir", "helm.exe"),
|
||||
"777"
|
||||
);
|
||||
});
|
||||
|
||||
test("downloadHelm() - throw error is helm is not found in path", async () => {
|
||||
jest.spyOn(toolCache, "find").mockReturnValue("");
|
||||
jest.spyOn(toolCache, "downloadTool").mockResolvedValue("pathToTool");
|
||||
jest.spyOn(os, "type").mockReturnValue("Windows_NT");
|
||||
jest.spyOn(fs, "chmodSync").mockImplementation();
|
||||
jest.spyOn(toolCache, "extractZip").mockResolvedValue("pathToUnzippedHelm");
|
||||
jest.spyOn(toolCache, "cacheDir").mockResolvedValue("pathToCachedDir");
|
||||
jest.spyOn(fs, "readdirSync").mockImplementation((file, _) => []);
|
||||
jest.spyOn(fs, "statSync").mockImplementation((file) => {
|
||||
test('downloadHelm() - return path to helm tool with same version from toolCache', async () => {
|
||||
jest.spyOn(toolCache, 'find').mockReturnValue('pathToCachedDir')
|
||||
jest.spyOn(toolCache, 'cacheDir').mockResolvedValue('pathToCachedDir')
|
||||
jest.spyOn(toolCache, 'downloadTool').mockResolvedValue('pathToTool')
|
||||
jest.spyOn(toolCache, 'extractZip').mockResolvedValue('extractedPath')
|
||||
jest.spyOn(os, 'platform').mockReturnValue('win32')
|
||||
jest.spyOn(fs, 'chmodSync').mockImplementation(() => {})
|
||||
jest
|
||||
.spyOn(fs, 'readdirSync')
|
||||
.mockReturnValue(['helm.exe' as unknown as fs.Dirent])
|
||||
jest.spyOn(fs, 'statSync').mockImplementation((file) => {
|
||||
const isDirectory =
|
||||
(file as string).indexOf("folder") == -1 ? false : true;
|
||||
return { isDirectory: () => isDirectory } as fs.Stats;
|
||||
});
|
||||
(file as string).indexOf('folder') == -1 ? false : true
|
||||
return {isDirectory: () => isDirectory} as fs.Stats
|
||||
})
|
||||
|
||||
await expect(run.downloadHelm("v3.2.1")).rejects.toThrow(
|
||||
"Helm executable not found in path pathToCachedDir"
|
||||
);
|
||||
expect(toolCache.find).toBeCalledWith("helm", "v3.2.1");
|
||||
expect(toolCache.downloadTool).toBeCalledWith(
|
||||
"https://get.helm.sh/helm-v3.2.1-windows-amd64.zip"
|
||||
);
|
||||
expect(fs.chmodSync).toBeCalledWith("pathToTool", "777");
|
||||
expect(toolCache.extractZip).toBeCalledWith("pathToTool");
|
||||
});
|
||||
});
|
||||
expect(await run.downloadHelm(downloadBaseURL, 'v3.2.1')).toBe(
|
||||
path.join('pathToCachedDir', 'helm.exe')
|
||||
)
|
||||
expect(toolCache.find).toHaveBeenCalledWith('helm', 'v3.2.1')
|
||||
expect(fs.chmodSync).toHaveBeenCalledWith(
|
||||
path.join('pathToCachedDir', 'helm.exe'),
|
||||
'777'
|
||||
)
|
||||
})
|
||||
|
||||
test('downloadHelm() - throw error is helm is not found in path', async () => {
|
||||
jest.spyOn(toolCache, 'find').mockReturnValue('')
|
||||
jest.spyOn(toolCache, 'downloadTool').mockResolvedValue('pathToTool')
|
||||
jest.spyOn(toolCache, 'cacheDir').mockResolvedValue('pathToCachedDir')
|
||||
jest.spyOn(toolCache, 'downloadTool').mockResolvedValue('pathToTool')
|
||||
jest.spyOn(toolCache, 'extractZip').mockResolvedValue('extractedPath')
|
||||
jest.spyOn(os, 'platform').mockReturnValue('win32')
|
||||
jest.spyOn(fs, 'chmodSync').mockImplementation()
|
||||
jest.spyOn(fs, 'readdirSync').mockImplementation((file, _) => [])
|
||||
jest.spyOn(fs, 'statSync').mockImplementation((file) => {
|
||||
const isDirectory =
|
||||
(file as string).indexOf('folder') == -1 ? false : true
|
||||
return {isDirectory: () => isDirectory} as fs.Stats
|
||||
})
|
||||
|
||||
await expect(run.downloadHelm(downloadBaseURL, 'v3.2.1')).rejects.toThrow(
|
||||
'Helm executable not found in path pathToCachedDir'
|
||||
)
|
||||
expect(toolCache.find).toHaveBeenCalledWith('helm', 'v3.2.1')
|
||||
expect(toolCache.downloadTool).toHaveBeenCalledWith(
|
||||
'https://test.tld/helm-v3.2.1-windows-amd64.zip'
|
||||
)
|
||||
expect(fs.chmodSync).toHaveBeenCalledWith('pathToTool', '777')
|
||||
expect(toolCache.extractZip).toHaveBeenCalledWith('pathToTool')
|
||||
})
|
||||
})
|
||||
|
205
src/run.ts
205
src/run.ts
@ -2,193 +2,158 @@
|
||||
// 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 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";
|
||||
import * as toolCache from '@actions/tool-cache'
|
||||
import * as core from '@actions/core'
|
||||
|
||||
const helmToolName = "helm";
|
||||
const stableHelmVersion = "v3.8.0";
|
||||
const helmAllReleasesUrl = "https://api.github.com/repos/helm/helm/releases";
|
||||
const helmToolName = 'helm'
|
||||
const stableHelmVersion = 'v3.13.3'
|
||||
|
||||
export async function run() {
|
||||
let version = core.getInput("version", { required: true });
|
||||
let version = core.getInput('version', {required: true})
|
||||
|
||||
if(version !== "latest" && version[0] !== "v"){
|
||||
version = getValidVersion(version);
|
||||
if (version !== 'latest' && version[0] !== 'v') {
|
||||
core.info('Getting latest Helm version')
|
||||
version = getValidVersion(version)
|
||||
}
|
||||
if (version.toLocaleLowerCase() === "latest") {
|
||||
version = await getLatestHelmVersion();
|
||||
if (version.toLocaleLowerCase() === 'latest') {
|
||||
version = await getLatestHelmVersion()
|
||||
}
|
||||
|
||||
core.debug(util.format("Downloading %s", version));
|
||||
let cachedPath = await downloadHelm(version);
|
||||
const downloadBaseURL = core.getInput('downloadBaseURL', {required: false})
|
||||
|
||||
core.startGroup(`Downloading ${version}`)
|
||||
const cachedPath = await downloadHelm(downloadBaseURL, version)
|
||||
core.endGroup()
|
||||
|
||||
try {
|
||||
if (!process.env["PATH"].startsWith(path.dirname(cachedPath))) {
|
||||
core.addPath(path.dirname(cachedPath));
|
||||
if (!process.env['PATH'].startsWith(path.dirname(cachedPath))) {
|
||||
core.addPath(path.dirname(cachedPath))
|
||||
}
|
||||
} catch {
|
||||
//do nothing, set as output variable
|
||||
}
|
||||
|
||||
console.log(
|
||||
`Helm tool version: '${version}' has been cached at ${cachedPath}`
|
||||
);
|
||||
core.setOutput("helm-path", cachedPath);
|
||||
core.info(`Helm tool version '${version}' has been cached at ${cachedPath}`)
|
||||
core.setOutput('helm-path', cachedPath)
|
||||
}
|
||||
|
||||
//Returns version with proper v before it
|
||||
// Prefixes version with v
|
||||
export function getValidVersion(version: string): string {
|
||||
return "v" + version;
|
||||
return 'v' + version
|
||||
}
|
||||
|
||||
// Downloads the helm releases JSON and parses all the recent versions of helm from it.
|
||||
// Defaults to sending stable helm version if none are valid or if it fails
|
||||
|
||||
// Gets the latest helm version or returns a default stable if getting latest fails
|
||||
export async function getLatestHelmVersion(): Promise<string> {
|
||||
const helmJSONPath: string = await toolCache.downloadTool(helmAllReleasesUrl);
|
||||
|
||||
try {
|
||||
const helmJSON = JSON.parse(fs.readFileSync(helmJSONPath, "utf-8"));
|
||||
for (let i in helmJSON) {
|
||||
if (isValidVersion(helmJSON[i].tag_name)) {
|
||||
return helmJSON[i].tag_name;
|
||||
}
|
||||
}
|
||||
const response = await fetch('https://get.helm.sh/helm-latest-version')
|
||||
const release = (await response.text()).trim()
|
||||
return release
|
||||
} catch (err) {
|
||||
core.warning(
|
||||
util.format(
|
||||
"Error while fetching the latest Helm release. Error: %s. Using default Helm version %s",
|
||||
err.toString(),
|
||||
stableHelmVersion
|
||||
`Error while fetching latest Helm release: ${err.toString()}. Using default version ${stableHelmVersion}`
|
||||
)
|
||||
);
|
||||
return stableHelmVersion;
|
||||
return stableHelmVersion
|
||||
}
|
||||
}
|
||||
|
||||
return stableHelmVersion;
|
||||
export function getArch(): string {
|
||||
return os.arch() === 'x64' ? 'amd64' : os.arch()
|
||||
}
|
||||
|
||||
// isValidVersion checks if verison is a stable release
|
||||
function isValidVersion(version: string): boolean {
|
||||
return version.indexOf("rc") == -1;
|
||||
export function getPlatform(): string {
|
||||
return os.platform() === 'win32' ? 'windows' : os.platform()
|
||||
}
|
||||
|
||||
export function getArchiveExtension(): string {
|
||||
return os.platform() === 'win32' ? 'zip' : 'tar.gz'
|
||||
}
|
||||
|
||||
export function getExecutableExtension(): string {
|
||||
if (os.type().match(/^Win/)) {
|
||||
return ".exe";
|
||||
}
|
||||
return "";
|
||||
return os.platform() === 'win32' ? '.exe' : ''
|
||||
}
|
||||
|
||||
const LINUX = "Linux";
|
||||
const MAC_OS = "Darwin";
|
||||
const WINDOWS = "Windows_NT";
|
||||
const ARM64 = "arm64";
|
||||
export function getHelmDownloadURL(version: string): string {
|
||||
const arch = os.arch();
|
||||
const operatingSystem = os.type();
|
||||
|
||||
switch (true) {
|
||||
case operatingSystem == LINUX && arch == ARM64:
|
||||
return util.format(
|
||||
"https://get.helm.sh/helm-%s-linux-arm64.zip",
|
||||
version
|
||||
);
|
||||
case operatingSystem == LINUX:
|
||||
return util.format(
|
||||
"https://get.helm.sh/helm-%s-linux-amd64.zip",
|
||||
version
|
||||
);
|
||||
|
||||
case operatingSystem == MAC_OS && arch == ARM64:
|
||||
return util.format(
|
||||
"https://get.helm.sh/helm-%s-darwin-arm64.zip",
|
||||
version
|
||||
);
|
||||
case operatingSystem == MAC_OS:
|
||||
return util.format(
|
||||
"https://get.helm.sh/helm-%s-darwin-amd64.zip",
|
||||
version
|
||||
);
|
||||
|
||||
case operatingSystem == WINDOWS:
|
||||
default:
|
||||
return util.format(
|
||||
"https://get.helm.sh/helm-%s-windows-amd64.zip",
|
||||
version
|
||||
);
|
||||
}
|
||||
export function getHelmDownloadURL(baseURL: string, version: string): string {
|
||||
const urlPath = `helm-${version}-${getPlatform()}-${getArch()}.${getArchiveExtension()}`
|
||||
const url = new URL(urlPath, baseURL)
|
||||
return url.toString()
|
||||
}
|
||||
|
||||
export async function downloadHelm(version: string): Promise<string> {
|
||||
let cachedToolpath = toolCache.find(helmToolName, version);
|
||||
export async function downloadHelm(
|
||||
baseURL: string,
|
||||
version: string
|
||||
): Promise<string> {
|
||||
let cachedToolpath = toolCache.find(helmToolName, version)
|
||||
if (!cachedToolpath) {
|
||||
let helmDownloadPath;
|
||||
let helmDownloadPath
|
||||
try {
|
||||
helmDownloadPath = await toolCache.downloadTool(
|
||||
getHelmDownloadURL(version)
|
||||
);
|
||||
getHelmDownloadURL(baseURL, version)
|
||||
)
|
||||
} catch (exception) {
|
||||
throw new Error(
|
||||
util.format(
|
||||
"Failed to download Helm from location",
|
||||
getHelmDownloadURL(version)
|
||||
`Failed to download Helm from location ${getHelmDownloadURL(
|
||||
baseURL,
|
||||
version
|
||||
)}`
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
fs.chmodSync(helmDownloadPath, "777");
|
||||
const unzipedHelmPath = await toolCache.extractZip(helmDownloadPath);
|
||||
fs.chmodSync(helmDownloadPath, '777')
|
||||
const extractedPath =
|
||||
getPlatform() === 'windows'
|
||||
? await toolCache.extractZip(helmDownloadPath)
|
||||
: await toolCache.extractTar(helmDownloadPath)
|
||||
|
||||
cachedToolpath = await toolCache.cacheDir(
|
||||
unzipedHelmPath,
|
||||
extractedPath,
|
||||
helmToolName,
|
||||
version
|
||||
);
|
||||
)
|
||||
}
|
||||
|
||||
const helmpath = findHelm(cachedToolpath);
|
||||
const helmpath = findHelm(cachedToolpath)
|
||||
if (!helmpath) {
|
||||
throw new Error(
|
||||
util.format("Helm executable not found in path", cachedToolpath)
|
||||
);
|
||||
util.format('Helm executable not found in path', cachedToolpath)
|
||||
)
|
||||
}
|
||||
|
||||
fs.chmodSync(helmpath, "777");
|
||||
return helmpath;
|
||||
fs.chmodSync(helmpath, '777')
|
||||
return helmpath
|
||||
}
|
||||
|
||||
export function findHelm(rootFolder: string): string {
|
||||
fs.chmodSync(rootFolder, "777");
|
||||
var filelist: string[] = [];
|
||||
walkSync(rootFolder, filelist, helmToolName + getExecutableExtension());
|
||||
fs.chmodSync(rootFolder, '777')
|
||||
var filelist: string[] = []
|
||||
walkSync(rootFolder, filelist, helmToolName + getExecutableExtension())
|
||||
if (!filelist || filelist.length == 0) {
|
||||
throw new Error(
|
||||
util.format("Helm executable not found in path", rootFolder)
|
||||
);
|
||||
util.format('Helm executable not found in path', rootFolder)
|
||||
)
|
||||
} else {
|
||||
return filelist[0];
|
||||
return filelist[0]
|
||||
}
|
||||
}
|
||||
|
||||
export var walkSync = function (dir, filelist, fileToFind) {
|
||||
var files = fs.readdirSync(dir);
|
||||
filelist = filelist || [];
|
||||
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);
|
||||
filelist = walkSync(path.join(dir, file), filelist, fileToFind)
|
||||
} else {
|
||||
core.debug(file);
|
||||
core.debug(file)
|
||||
if (file == fileToFind) {
|
||||
filelist.push(path.join(dir, file));
|
||||
filelist.push(path.join(dir, file))
|
||||
}
|
||||
}
|
||||
});
|
||||
return filelist;
|
||||
};
|
||||
})
|
||||
return filelist
|
||||
}
|
||||
|
||||
run().catch(core.setFailed);
|
||||
run().catch(core.setFailed)
|
||||
|
@ -2,8 +2,8 @@
|
||||
"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'. */
|
||||
"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'. */
|
||||
@ -11,8 +11,8 @@
|
||||
// "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. */
|
||||
"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. */
|
||||
@ -23,7 +23,7 @@
|
||||
|
||||
/* 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. */
|
||||
"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. */
|
||||
|
Reference in New Issue
Block a user