Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2f5e7bc67f | ||
|
|
206711cbe5 | ||
|
|
b14f4022d8 | ||
|
|
bd99bd231d | ||
|
|
4339b0e932 | ||
|
|
1548e57b4d | ||
|
|
531fb92ec6 | ||
|
|
b7cb6a40fe | ||
|
|
c30b20366b | ||
|
|
5dad9f39cb | ||
|
|
cb7b0d3c71 | ||
|
|
271d3664f3 | ||
|
|
983058cf21 | ||
|
|
b85984b901 | ||
|
|
04dc609ffb | ||
|
|
e527cd1281 | ||
|
|
dac4b78fe8 | ||
|
|
7a9c28ba04 | ||
|
|
0b52ee96c3 | ||
|
|
249bb27705 | ||
|
|
78f94bcee2 | ||
|
|
bb3997c8bc | ||
|
|
eb399fcd4f | ||
|
|
017211e1b1 |
@@ -10,26 +10,24 @@ jobs:
|
||||
build:
|
||||
# The type of runner that the job will run on
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
issues: write
|
||||
pull-requests: write
|
||||
|
||||
# Steps represent a sequence of tasks that will be executed as part of the job
|
||||
steps:
|
||||
- uses: actions/stale@eb5cf3af3ac0a1aa4c9c45633dd1ae542a27a899 #v10.3.0
|
||||
name: Setting issue as idle
|
||||
- uses: actions/stale@4391f3da665fdf50b6810c1a66712fb9ba21aa93 #v11.0.0
|
||||
name: Mark idle issues and PRs and close inactive ones
|
||||
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-message: 'This issue is idle after 60 days with no activity. It will be closed in 14 days if there is no further activity.'
|
||||
stale-issue-label: 'idle'
|
||||
days-before-stale: 14
|
||||
days-before-close: -1
|
||||
close-issue-message: 'Closing this issue after 14 more days with no activity since it was marked idle.'
|
||||
stale-pr-message: 'This PR is idle after 60 days with no activity. It will be closed in 14 days if there is no further activity.'
|
||||
stale-pr-label: 'idle'
|
||||
close-pr-message: 'Closing this PR after 14 more days with no activity since it was marked idle.'
|
||||
days-before-stale: 60
|
||||
days-before-close: 14
|
||||
remove-stale-when-updated: true
|
||||
operations-per-run: 100
|
||||
exempt-issue-labels: 'backlog'
|
||||
|
||||
- uses: actions/stale@eb5cf3af3ac0a1aa4c9c45633dd1ae542a27a899 #v10.3.0
|
||||
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'
|
||||
days-before-stale: 14
|
||||
days-before-close: -1
|
||||
operations-per-run: 100
|
||||
|
||||
@@ -22,7 +22,7 @@ jobs:
|
||||
PR_BASE_REF: ${{ github.event.pull_request.base.ref }}
|
||||
steps:
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
- name: npm install and build
|
||||
id: action-npm-build
|
||||
run: |
|
||||
|
||||
@@ -10,7 +10,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
|
||||
- name: Enforce Prettier
|
||||
run: npx prettier --check .
|
||||
|
||||
@@ -13,6 +13,6 @@ jobs:
|
||||
permissions:
|
||||
actions: read
|
||||
contents: write
|
||||
uses: Azure/action-release-workflows/.github/workflows/release_js_project.yaml@3c677ba5ab58f5c5c1a6f0cfb176b333b1f27405 # v1.0.3
|
||||
uses: Azure/action-release-workflows/.github/workflows/release_js_project.yaml@a391b701462581f586d0e8a68e60b04aa47dc4a9 # v1.2.0
|
||||
with:
|
||||
changelogPath: ./CHANGELOG.md
|
||||
|
||||
@@ -22,7 +22,7 @@ jobs:
|
||||
fail-fast: false
|
||||
runs-on: ${{ matrix.os }}
|
||||
steps:
|
||||
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
|
||||
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
|
||||
- name: Run L0 tests.
|
||||
run: |
|
||||
|
||||
@@ -62,3 +62,6 @@ node_modules
|
||||
coverage
|
||||
|
||||
# Transpiled JS
|
||||
|
||||
# Planning docs
|
||||
docs/
|
||||
|
||||
@@ -1,5 +1,31 @@
|
||||
# Change Log
|
||||
|
||||
## [5.1.0] - 2026-11-09
|
||||
|
||||
### Added
|
||||
|
||||
- #281 [Read the Helm version from a .tool-versions file with the version-file input](https://github.com/Azure/setup-helm/pull/281)
|
||||
- #293 [Resolve the latest patch for a major.minor version](https://github.com/Azure/setup-helm/pull/293)
|
||||
- #315 [Add configurable checksum verification and fallback download mirrors](https://github.com/Azure/setup-helm/pull/315)
|
||||
|
||||
### Fixed
|
||||
|
||||
- #292 [Preserve subpath base URLs when constructing Helm download URLs](https://github.com/Azure/setup-helm/pull/292)
|
||||
- #303 [Retry latest-version lookups and add the latest-fallback opt-out](https://github.com/Azure/setup-helm/pull/303)
|
||||
|
||||
### Security
|
||||
|
||||
- #313 [Update Undici security fixes](https://github.com/Azure/setup-helm/pull/313)
|
||||
- #307 [Update Undici](https://github.com/Azure/setup-helm/pull/307)
|
||||
- #298 [Update Undici](https://github.com/Azure/setup-helm/pull/298)
|
||||
|
||||
### Changed
|
||||
|
||||
- #314 [Update the built-in Helm fallback from v3.18.4 to v4.3.1](https://github.com/Azure/setup-helm/pull/314)
|
||||
- #311 [Enable stale cleanup after 74 inactive days](https://github.com/Azure/setup-helm/pull/311)
|
||||
- #306 [Update the shared release workflow](https://github.com/Azure/setup-helm/pull/306)
|
||||
- Update remaining dependency groups, development tools, and workflow actions (#290, #291, #294, #295, #297, #299, #301, #305, #308, #309, #316)
|
||||
|
||||
## [5.0.1] - 2026-06-23
|
||||
|
||||
### Fixed
|
||||
|
||||
@@ -4,7 +4,7 @@ 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 support Helm3.
|
||||
Acceptable values are `latest` or any semantic version string such as `v4.3.1`. The `latest` value follows Helm's current stable release and can change major versions.
|
||||
|
||||
```yaml
|
||||
- uses: azure/setup-helm@v5
|
||||
@@ -13,8 +13,59 @@ Acceptable values are latest or any semantic version string like v3.5.0 Use this
|
||||
id: install
|
||||
```
|
||||
|
||||
Alternatively, the version can be read from a [`.tool-versions`](https://asdf-vm.com/manage/configuration.html) file (the format used by [asdf](https://asdf-vm.com/) and [mise](https://mise.jdx.dev/)) via the `version-file` input:
|
||||
|
||||
```yaml
|
||||
- uses: azure/setup-helm@v5.0.0
|
||||
with:
|
||||
version-file: .tool-versions
|
||||
id: install
|
||||
```
|
||||
|
||||
The action reads the version declared for the `helm` tool, for example:
|
||||
|
||||
```
|
||||
helm 4.3.1
|
||||
```
|
||||
|
||||
If both `version` and `version-file` are set, an explicitly requested `version` takes precedence and `version-file` is ignored (a warning is emitted). Because `version` defaults to `latest`, `version-file` is only ignored when you set `version` to a specific value other than `latest`; if `version` is left at its default, the version from `version-file` is used.
|
||||
|
||||
> [!NOTE]
|
||||
> If something goes wrong with fetching the latest version the action will use the hardcoded default version (currently v3.18.3). If you rely on a certain version higher than the default, you should explicitly use that version instead of latest.
|
||||
> If fetching the latest version fails, the action retries a few times and then uses the built-in fallback version (currently v4.3.1). This is a last-known stable version and can become a major version behind what `latest` resolves to. To fail the step with the underlying error instead, set `latest-fallback` to `'false'`:
|
||||
>
|
||||
> ```yaml
|
||||
> - uses: azure/setup-helm@v5
|
||||
> with:
|
||||
> version: 'latest'
|
||||
> latest-fallback: 'false'
|
||||
> ```
|
||||
>
|
||||
> If you rely on a certain version, you should explicitly request that version instead of `latest`.
|
||||
|
||||
Freshly downloaded Helm archives are verified against the SHA-256 checksum published beside the archive before extraction. With the default `checksum-policy: auto`, the action verifies a matching checksum when one is available as a bare 64-character hexadecimal digest at `<archive-url>.sha256`; when the checksum is not found, the action warns and continues downloading. Existing tool-cache entries continue to be reused without downloading or re-verifying the archive.
|
||||
|
||||
Set `checksum-policy` to control this behavior:
|
||||
|
||||
- `auto` (default): verify checksums when available and warn when they are absent.
|
||||
- `required`: require a valid matching checksum from every download location.
|
||||
- `if-available`: explicitly select the same verify-or-warn behavior as `auto`.
|
||||
- `disabled`: skip checksum verification and emit a warning.
|
||||
|
||||
Malformed or mismatched checksums always fail unless verification is explicitly `disabled`. In `if-available` and `auto` modes, only a checksum response of HTTP 404 or 410 is treated as absent; other download errors fail closed.
|
||||
|
||||
Because each checksum is retrieved from the same mirror as its archive, verification detects corruption or an incomplete mirror sync; it does not protect against a mirror that has been compromised together with its checksum files.
|
||||
|
||||
An optional fallback mirror can be used when version resolution, archive download, or checksum verification fails against the primary location:
|
||||
|
||||
```yaml
|
||||
- uses: azure/setup-helm@v5
|
||||
with:
|
||||
version: 'v4.3.1'
|
||||
downloadBaseURL: 'https://primary.example/helm'
|
||||
downloadBaseURLFallback: 'https://fallback.example/helm'
|
||||
```
|
||||
|
||||
The fallback archive follows the same checksum policy as the primary mirror. This capability follows the use case proposed by @mvtavares in [#227](https://github.com/Azure/setup-helm/pull/227).
|
||||
|
||||
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
|
||||
|
||||
+16
-1
@@ -3,8 +3,11 @@ description: 'Install a specific version of helm binary. Acceptable values are l
|
||||
inputs:
|
||||
version:
|
||||
description: 'Version of helm'
|
||||
required: true
|
||||
required: false
|
||||
default: 'latest'
|
||||
version-file:
|
||||
description: 'Path to a .tool-versions file to read the helm version from'
|
||||
required: false
|
||||
token:
|
||||
description: GitHub token. Used to be required to fetch the latest version
|
||||
required: false
|
||||
@@ -14,6 +17,18 @@ inputs:
|
||||
description: 'Set the download base URL'
|
||||
required: false
|
||||
default: 'https://get.helm.sh'
|
||||
downloadBaseURLFallback:
|
||||
description: 'Fallback base URL used when version resolution, download, or checksum verification fails against downloadBaseURL'
|
||||
required: false
|
||||
default: ''
|
||||
checksum-policy:
|
||||
description: "Checksum verification policy: 'auto' verifies checksums when available and warns when absent; 'required' always requires them; 'if-available' is an explicit alias for auto behavior; 'disabled' skips verification"
|
||||
required: false
|
||||
default: 'auto'
|
||||
latest-fallback:
|
||||
description: "When 'version' is 'latest' and the latest version cannot be determined after retrying, install the built-in default version instead of failing. Set to 'false' to fail the step instead, since the built-in default can be a major version behind what 'latest' resolves to."
|
||||
required: false
|
||||
default: 'true'
|
||||
outputs:
|
||||
helm-path:
|
||||
description: 'Path to the cached helm binary'
|
||||
|
||||
+1051
-170
File diff suppressed because it is too large
Load Diff
Generated
+810
-560
File diff suppressed because it is too large
Load Diff
+6
-6
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "setuphelm",
|
||||
"version": "5.0.1",
|
||||
"version": "5.1.0",
|
||||
"private": true,
|
||||
"description": "Setup helm",
|
||||
"author": "Anumita Shenoy",
|
||||
@@ -12,7 +12,7 @@
|
||||
"@actions/io": "^3.0.2",
|
||||
"@actions/tool-cache": "4.0.0",
|
||||
"@octokit/action": "^8.0.4",
|
||||
"semver": "^7.8.5"
|
||||
"semver": "^7.8.6"
|
||||
},
|
||||
"main": "lib/index.js",
|
||||
"scripts": {
|
||||
@@ -25,11 +25,11 @@
|
||||
"prepare": "husky"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^26.0.0",
|
||||
"@types/node": "^26.6.6",
|
||||
"esbuild": "^0.28",
|
||||
"husky": "^9.1.7",
|
||||
"prettier": "^3.8.4",
|
||||
"typescript": "^6.0.3",
|
||||
"vitest": "^4"
|
||||
"prettier": "^3.9.10",
|
||||
"typescript": "^7.0.2",
|
||||
"vitest": "^5"
|
||||
}
|
||||
}
|
||||
|
||||
+748
-22
@@ -1,5 +1,7 @@
|
||||
import {vi, describe, test, expect, afterEach} from 'vitest'
|
||||
import * as path from 'path'
|
||||
import {createHash} from 'crypto'
|
||||
import {Readable} from 'stream'
|
||||
|
||||
// Mock os module
|
||||
vi.mock('os', async (importOriginal) => {
|
||||
@@ -19,7 +21,9 @@ vi.mock('fs', async (importOriginal) => {
|
||||
readdirSync: vi.fn(),
|
||||
statSync: vi.fn(),
|
||||
chmodSync: vi.fn(),
|
||||
readFileSync: vi.fn()
|
||||
readFileSync: vi.fn(),
|
||||
createReadStream: vi.fn(),
|
||||
existsSync: vi.fn()
|
||||
}
|
||||
})
|
||||
|
||||
@@ -61,10 +65,23 @@ import * as core from '@actions/core'
|
||||
|
||||
describe('run.ts', () => {
|
||||
const downloadBaseURL = 'https://test.tld'
|
||||
const archive = Buffer.from('helm archive')
|
||||
const archiveChecksum = createHash('sha256').update(archive).digest('hex')
|
||||
|
||||
const mockVerifiedDownload = () => {
|
||||
vi.mocked(toolCache.downloadTool)
|
||||
.mockResolvedValueOnce('pathToChecksum')
|
||||
.mockResolvedValueOnce('pathToTool')
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(archiveChecksum)
|
||||
vi.mocked(fs.createReadStream).mockReturnValue(
|
||||
Readable.from([archive]) as fs.ReadStream
|
||||
)
|
||||
}
|
||||
|
||||
// Cleanup mocks after each test to ensure that subsequent tests are not affected by the mocks.
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks()
|
||||
vi.useRealTimers()
|
||||
})
|
||||
|
||||
test('getExecutableExtension() - return .exe when os is Windows', () => {
|
||||
@@ -81,6 +98,19 @@ describe('run.ts', () => {
|
||||
expect(os.platform).toHaveBeenCalled()
|
||||
})
|
||||
|
||||
test('getChecksumPolicy() - default to auto and reject invalid values', () => {
|
||||
expect(run.getChecksumPolicy('')).toBe('auto')
|
||||
expect(run.getChecksumPolicy(' REQUIRED ')).toBe('required')
|
||||
expect(() => run.getChecksumPolicy('warn')).toThrow(
|
||||
"Invalid checksum-policy 'warn'"
|
||||
)
|
||||
})
|
||||
|
||||
test('resolveChecksumPolicy() - auto verifies checksums when available', () => {
|
||||
expect(run.resolveChecksumPolicy('auto')).toBe('if-available')
|
||||
expect(run.resolveChecksumPolicy('required')).toBe('required')
|
||||
})
|
||||
|
||||
test('getHelmDownloadURL() - return the URL to download helm for Linux amd64', () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
@@ -139,28 +169,542 @@ describe('run.ts', () => {
|
||||
expect(os.platform).toHaveBeenCalled()
|
||||
})
|
||||
|
||||
test('getLatestHelmVersion() - return the latest version of HELM', async () => {
|
||||
const res = {
|
||||
status: 200,
|
||||
text: async () => 'v9.99.999'
|
||||
} as Response
|
||||
vi.stubGlobal('fetch', vi.fn().mockReturnValue(res))
|
||||
expect(await run.getLatestHelmVersion()).toBe('v9.99.999')
|
||||
test('getHelmDownloadURL() - preserve a subpath base URL without a trailing slash', () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
|
||||
const expected =
|
||||
'https://mirror.example/kubernetes/helm/helm-v3.8.0-linux-amd64.tar.gz'
|
||||
expect(
|
||||
run.getHelmDownloadURL(
|
||||
'https://mirror.example/kubernetes/helm',
|
||||
'v3.8.0'
|
||||
)
|
||||
).toBe(expected)
|
||||
})
|
||||
|
||||
test('getLatestHelmVersion() - return the stable version of HELM when simulating a network error', async () => {
|
||||
const errorMessage: string = 'Network Error'
|
||||
vi.stubGlobal(
|
||||
'fetch',
|
||||
vi.fn().mockRejectedValueOnce(new Error(errorMessage))
|
||||
test('getHelmDownloadURL() - preserve a subpath base URL with a trailing slash', () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
|
||||
const expected =
|
||||
'https://mirror.example/kubernetes/helm/helm-v3.8.0-linux-amd64.tar.gz'
|
||||
expect(
|
||||
run.getHelmDownloadURL(
|
||||
'https://mirror.example/kubernetes/helm/',
|
||||
'v3.8.0'
|
||||
)
|
||||
).toBe(expected)
|
||||
})
|
||||
|
||||
const latestVersionResponse = (version: string) =>
|
||||
({
|
||||
ok: true,
|
||||
status: 200,
|
||||
text: async () => version
|
||||
}) as Response
|
||||
|
||||
// Runs a getLatestHelmVersion() call under fake timers so the retry
|
||||
// backoff does not slow the test down.
|
||||
const getLatestHelmVersionWithoutDelay = async (
|
||||
fallbackToDefault?: boolean
|
||||
) => {
|
||||
vi.useFakeTimers()
|
||||
const pending = run.getLatestHelmVersion(fallbackToDefault)
|
||||
// Attach a no-op handler so a rejection is not reported as unhandled
|
||||
// while the timers are being advanced; the caller still awaits it.
|
||||
pending.catch(() => {})
|
||||
await vi.runAllTimersAsync()
|
||||
return pending
|
||||
}
|
||||
|
||||
test('getLatestHelmVersion() - return the latest version of HELM', async () => {
|
||||
const fetchSpy = vi
|
||||
.spyOn(globalThis, 'fetch')
|
||||
.mockResolvedValue(latestVersionResponse('v9.99.999'))
|
||||
expect(await run.getLatestHelmVersion()).toBe('v9.99.999')
|
||||
expect(fetchSpy).toHaveBeenCalledTimes(1)
|
||||
})
|
||||
|
||||
test('getLatestHelmVersion() - retry a transient failure and return the latest version', async () => {
|
||||
const fetchSpy = vi
|
||||
.spyOn(globalThis, 'fetch')
|
||||
.mockRejectedValueOnce(new Error('Network Error'))
|
||||
.mockResolvedValueOnce({ok: false, status: 503} as Response)
|
||||
.mockResolvedValueOnce(latestVersionResponse('v9.99.999'))
|
||||
expect(await getLatestHelmVersionWithoutDelay()).toBe('v9.99.999')
|
||||
expect(fetchSpy).toHaveBeenCalledTimes(3)
|
||||
expect(core.warning).not.toHaveBeenCalled()
|
||||
})
|
||||
|
||||
test('getLatestHelmVersion() - cancel the unread body of a non-success response before retrying', async () => {
|
||||
const cancel = vi.fn()
|
||||
const fetchSpy = vi
|
||||
.spyOn(globalThis, 'fetch')
|
||||
.mockResolvedValueOnce(
|
||||
new Response(new ReadableStream({cancel}), {status: 503})
|
||||
)
|
||||
.mockResolvedValueOnce(latestVersionResponse('v9.99.999'))
|
||||
expect(await getLatestHelmVersionWithoutDelay()).toBe('v9.99.999')
|
||||
expect(cancel).toHaveBeenCalledTimes(1)
|
||||
expect(cancel.mock.invocationCallOrder[0]).toBeLessThan(
|
||||
fetchSpy.mock.invocationCallOrder[1]
|
||||
)
|
||||
expect(await run.getLatestHelmVersion()).toBe(run.stableHelmVersion)
|
||||
})
|
||||
|
||||
test('getLatestHelmVersion() - return the stable version of HELM when every attempt fails', async () => {
|
||||
const errorMessage: string = 'Network Error'
|
||||
const fetchSpy = vi
|
||||
.spyOn(globalThis, 'fetch')
|
||||
.mockRejectedValue(new Error(errorMessage))
|
||||
expect(await getLatestHelmVersionWithoutDelay()).toBe('v4.3.1')
|
||||
expect(fetchSpy).toHaveBeenCalledTimes(3)
|
||||
expect(core.warning).toHaveBeenCalledWith(
|
||||
`Error while fetching latest Helm release: ${errorMessage}. Using default version v4.3.1. Set 'latest-fallback' to 'false' to fail the step instead`
|
||||
)
|
||||
})
|
||||
|
||||
test('getLatestHelmVersion() - throw when every attempt fails and the fallback is off', async () => {
|
||||
const errorMessage: string = 'Network Error'
|
||||
const fetchSpy = vi
|
||||
.spyOn(globalThis, 'fetch')
|
||||
.mockRejectedValue(new Error(errorMessage))
|
||||
await expect(getLatestHelmVersionWithoutDelay(false)).rejects.toThrow(
|
||||
`Unable to determine the latest Helm version: ${errorMessage}`
|
||||
)
|
||||
expect(fetchSpy).toHaveBeenCalledTimes(3)
|
||||
expect(core.warning).not.toHaveBeenCalled()
|
||||
})
|
||||
|
||||
test('getValidVersion() - return version with v prepended', () => {
|
||||
expect(run.getValidVersion('3.8.0')).toBe('v3.8.0')
|
||||
})
|
||||
|
||||
test('parseToolVersions() - return the helm version from .tool-versions content', () => {
|
||||
const content = ['nodejs 20.11.0', 'helm 3.14.0', 'terraform 1.7.0'].join(
|
||||
'\n'
|
||||
)
|
||||
expect(run.parseToolVersions(content)).toBe('3.14.0')
|
||||
})
|
||||
|
||||
test('parseToolVersions() - ignore comments and blank lines', () => {
|
||||
const content = ['# tools', '', ' helm 3.15.2 ', ''].join('\n')
|
||||
expect(run.parseToolVersions(content)).toBe('3.15.2')
|
||||
})
|
||||
|
||||
test('parseToolVersions() - return the first version when several are listed', () => {
|
||||
expect(run.parseToolVersions('helm 3.14.0 3.13.0')).toBe('3.14.0')
|
||||
})
|
||||
|
||||
test('parseToolVersions() - return empty string when helm is not declared', () => {
|
||||
expect(run.parseToolVersions('nodejs 20.11.0')).toBe('')
|
||||
})
|
||||
|
||||
test('getVersionFromToolVersionsFile() - read the helm version from a file', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true)
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('helm 3.14.0')
|
||||
|
||||
expect(run.getVersionFromToolVersionsFile('.tool-versions')).toBe(
|
||||
'3.14.0'
|
||||
)
|
||||
expect(fs.readFileSync).toHaveBeenCalledWith('.tool-versions', 'utf8')
|
||||
})
|
||||
|
||||
test('getVersionFromToolVersionsFile() - throw when the file does not exist', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(false)
|
||||
|
||||
expect(() =>
|
||||
run.getVersionFromToolVersionsFile('missing.tool-versions')
|
||||
).toThrow("The version-file 'missing.tool-versions' does not exist")
|
||||
})
|
||||
|
||||
test('getVersionFromToolVersionsFile() - throw when no helm version is present', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true)
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('nodejs 20.11.0')
|
||||
|
||||
expect(() =>
|
||||
run.getVersionFromToolVersionsFile('.tool-versions')
|
||||
).toThrow("No helm version found in '.tool-versions'")
|
||||
})
|
||||
|
||||
test('getVersionFromToolVersionsFile() - throw when the helm version is not valid', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true)
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('helm latest')
|
||||
|
||||
expect(() =>
|
||||
run.getVersionFromToolVersionsFile('.tool-versions')
|
||||
).toThrow(
|
||||
"The helm version 'latest' in '.tool-versions' is not valid. Provide a full version (e.g. '3.14.0') or a major.minor version (e.g. '3.14' or '3.14.x')"
|
||||
)
|
||||
})
|
||||
|
||||
test('getVersionFromToolVersionsFile() - accept a major.minor version', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true)
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('helm 3.14')
|
||||
|
||||
expect(run.getVersionFromToolVersionsFile('.tool-versions')).toBe('3.14')
|
||||
})
|
||||
|
||||
test('isSemVerShaped() - accept semver-shaped versions with or without a v prefix', () => {
|
||||
expect(run.isSemVerShaped('3.14.0')).toBe(true)
|
||||
expect(run.isSemVerShaped('v3.14.0')).toBe(true)
|
||||
expect(run.isSemVerShaped('3.14.0-rc.1')).toBe(true)
|
||||
})
|
||||
|
||||
test('isSemVerShaped() - reject values that are not semver-shaped', () => {
|
||||
expect(run.isSemVerShaped('latest')).toBe(false)
|
||||
expect(run.isSemVerShaped('3.14')).toBe(false)
|
||||
expect(run.isSemVerShaped('abc')).toBe(false)
|
||||
})
|
||||
|
||||
test('isMajorMinorShaped() - accept major.minor with or without a v prefix', () => {
|
||||
expect(run.isMajorMinorShaped('3.14')).toBe(true)
|
||||
expect(run.isMajorMinorShaped('v3.14')).toBe(true)
|
||||
})
|
||||
|
||||
test('isMajorMinorShaped() - accept a wildcard patch (.x / .*)', () => {
|
||||
expect(run.isMajorMinorShaped('3.14.x')).toBe(true)
|
||||
expect(run.isMajorMinorShaped('v3.14.x')).toBe(true)
|
||||
expect(run.isMajorMinorShaped('3.14.*')).toBe(true)
|
||||
expect(run.isMajorMinorShaped('v3.14.*')).toBe(true)
|
||||
})
|
||||
|
||||
test('isMajorMinorShaped() - reject full versions and other values', () => {
|
||||
expect(run.isMajorMinorShaped('3.14.0')).toBe(false)
|
||||
expect(run.isMajorMinorShaped('latest')).toBe(false)
|
||||
expect(run.isMajorMinorShaped('3')).toBe(false)
|
||||
})
|
||||
|
||||
// Stubs the download chain so run() resolves to a cached helm binary,
|
||||
// letting these tests focus on version-vs-version-file resolution.
|
||||
const stubDownloadChain = () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.mocked(toolCache.find).mockReturnValue('pathToCachedDir')
|
||||
vi.mocked(fs.chmodSync).mockImplementation(() => {})
|
||||
vi.mocked(fs.readdirSync).mockReturnValue([
|
||||
'helm' as unknown as fs.Dirent<NonSharedBuffer>
|
||||
])
|
||||
vi.mocked(fs.statSync).mockReturnValue({
|
||||
isDirectory: () => false
|
||||
} as fs.Stats)
|
||||
}
|
||||
|
||||
const inputs = (
|
||||
version: string,
|
||||
versionFile: string,
|
||||
latestFallback: string = '',
|
||||
downloadFallback: string = ''
|
||||
) =>
|
||||
vi.mocked(core.getInput).mockImplementation((name: string) => {
|
||||
if (name === 'version') return version
|
||||
if (name === 'version-file') return versionFile
|
||||
if (name === 'downloadBaseURL') return downloadBaseURL
|
||||
if (name === 'downloadBaseURLFallback') return downloadFallback
|
||||
if (name === 'latest-fallback') return latestFallback
|
||||
return ''
|
||||
})
|
||||
|
||||
test('run() - resolve the version from version-file when version is not set', async () => {
|
||||
stubDownloadChain()
|
||||
inputs('', '.tool-versions')
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true)
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('helm 3.14.0')
|
||||
|
||||
await run.run()
|
||||
|
||||
expect(core.warning).not.toHaveBeenCalled()
|
||||
expect(toolCache.find).toHaveBeenCalledWith('helm', 'v3.14.0')
|
||||
expect(core.setOutput).toHaveBeenCalledWith(
|
||||
'helm-path',
|
||||
path.join('pathToCachedDir', 'helm')
|
||||
)
|
||||
})
|
||||
|
||||
test('run() - resolve the version from version-file when version is left at the latest default', async () => {
|
||||
stubDownloadChain()
|
||||
inputs('latest', '.tool-versions')
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true)
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('helm 3.14.0')
|
||||
|
||||
await run.run()
|
||||
|
||||
expect(core.warning).not.toHaveBeenCalled()
|
||||
expect(toolCache.find).toHaveBeenCalledWith('helm', 'v3.14.0')
|
||||
})
|
||||
|
||||
test('run() - warn and prefer version over version-file when both are set', async () => {
|
||||
stubDownloadChain()
|
||||
inputs('3.5.0', '.tool-versions')
|
||||
|
||||
await run.run()
|
||||
|
||||
expect(core.warning).toHaveBeenCalledWith(
|
||||
`Both 'version' and 'version-file' inputs are specified, only 'version' will be used.`
|
||||
)
|
||||
expect(fs.readFileSync).not.toHaveBeenCalled()
|
||||
expect(toolCache.find).toHaveBeenCalledWith('helm', 'v3.5.0')
|
||||
})
|
||||
|
||||
// Spies on global fetch so HEAD probes report the given set of versions as
|
||||
// existing (200) and everything else as missing (404). Using vi.spyOn (rather
|
||||
// than vi.stubGlobal) lets restoreAllMocks() in afterEach reliably restore the
|
||||
// real fetch, so the mock never leaks into later tests.
|
||||
const stubPatchProbes = (existing: string[]) => {
|
||||
const present = new Set(existing)
|
||||
vi.spyOn(globalThis, 'fetch').mockImplementation(async (input) => {
|
||||
const version =
|
||||
String(input).match(/helm-(v\d+\.\d+\.\d+)-/)?.[1] ?? ''
|
||||
const ok = present.has(version)
|
||||
return {ok, status: ok ? 200 : 404} as Response
|
||||
})
|
||||
}
|
||||
|
||||
test('helmPatchExists() - return true when the artifact responds 200', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.spyOn(globalThis, 'fetch').mockResolvedValue({
|
||||
ok: true,
|
||||
status: 200
|
||||
} as Response)
|
||||
|
||||
expect(await run.helmPatchExists(downloadBaseURL, 'v3.14.4')).toBe(true)
|
||||
})
|
||||
|
||||
test('helmPatchExists() - return false when the artifact responds 404', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.spyOn(globalThis, 'fetch').mockResolvedValue({
|
||||
ok: false,
|
||||
status: 404
|
||||
} as Response)
|
||||
|
||||
expect(await run.helmPatchExists(downloadBaseURL, 'v3.14.99')).toBe(false)
|
||||
})
|
||||
|
||||
test('helmPatchExists() - throw on a non-404 error status', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.spyOn(globalThis, 'fetch').mockResolvedValue({
|
||||
ok: false,
|
||||
status: 429
|
||||
} as Response)
|
||||
|
||||
await expect(
|
||||
run.helmPatchExists(downloadBaseURL, 'v3.14.4')
|
||||
).rejects.toThrow('Unexpected HTTP 429')
|
||||
})
|
||||
|
||||
test('resolveLatestPatchVersion() - return the newest existing patch', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
stubPatchProbes(['v3.14.0', 'v3.14.1', 'v3.14.2', 'v3.14.3', 'v3.14.4'])
|
||||
|
||||
expect(await run.resolveLatestPatchVersion(downloadBaseURL, '3.14')).toBe(
|
||||
'v3.14.4'
|
||||
)
|
||||
})
|
||||
|
||||
test('resolveLatestPatchVersion() - use the blob listing in a single request when supported', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
const listing =
|
||||
'<EnumerationResults>' +
|
||||
'<Blob><Name>helm-v3.14.0-linux-amd64.tar.gz</Name></Blob>' +
|
||||
'<Blob><Name>helm-v3.14.0-rc.1-linux-amd64.tar.gz</Name></Blob>' +
|
||||
'<Blob><Name>helm-v3.14.4-linux-amd64.tar.gz</Name></Blob>' +
|
||||
'<Blob><Name>helm-v3.14.4-linux-amd64.tar.gz.sha256</Name></Blob>' +
|
||||
'</EnumerationResults>'
|
||||
const fetchSpy = vi.spyOn(globalThis, 'fetch').mockResolvedValue({
|
||||
ok: true,
|
||||
text: async () => listing
|
||||
} as Response)
|
||||
|
||||
expect(await run.resolveLatestPatchVersion(downloadBaseURL, '3.14')).toBe(
|
||||
'v3.14.4'
|
||||
)
|
||||
// A single listing request; no per-patch HEAD probing.
|
||||
expect(fetchSpy).toHaveBeenCalledTimes(1)
|
||||
})
|
||||
|
||||
test('resolveLatestPatchVersion() - fall back to probing when listing is unavailable', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
const present = new Set(['v3.14.0', 'v3.14.1', 'v3.14.2'])
|
||||
vi.spyOn(globalThis, 'fetch').mockImplementation(async (input) => {
|
||||
const url = String(input)
|
||||
if (url.includes('comp=list')) {
|
||||
return {ok: false, status: 404} as Response
|
||||
}
|
||||
const version = url.match(/helm-(v\d+\.\d+\.\d+)-/)?.[1] ?? ''
|
||||
const ok = present.has(version)
|
||||
return {ok, status: ok ? 200 : 404} as Response
|
||||
})
|
||||
|
||||
expect(await run.resolveLatestPatchVersion(downloadBaseURL, '3.14')).toBe(
|
||||
'v3.14.2'
|
||||
)
|
||||
})
|
||||
|
||||
test('resolveLatestPatchViaListing() - return null when the response is not a listing', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.spyOn(globalThis, 'fetch').mockResolvedValue({
|
||||
ok: true,
|
||||
text: async () => '<html>directory index, not a blob listing</html>'
|
||||
} as Response)
|
||||
|
||||
expect(
|
||||
await run.resolveLatestPatchViaListing(downloadBaseURL, '3', '14')
|
||||
).toBeNull()
|
||||
})
|
||||
|
||||
test('resolveLatestPatchVersion() - tolerate a skipped patch number', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
stubPatchProbes(['v3.14.0', 'v3.14.1', 'v3.14.3'])
|
||||
|
||||
expect(
|
||||
await run.resolveLatestPatchVersion(downloadBaseURL, 'v3.14')
|
||||
).toBe('v3.14.3')
|
||||
})
|
||||
|
||||
test('resolveLatestPatchVersion() - accept a wildcard patch (.x / .*)', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
stubPatchProbes(['v3.12.0', 'v3.12.1', 'v3.12.2', 'v3.12.3'])
|
||||
|
||||
expect(
|
||||
await run.resolveLatestPatchVersion(downloadBaseURL, 'v3.12.x')
|
||||
).toBe('v3.12.3')
|
||||
expect(
|
||||
await run.resolveLatestPatchVersion(downloadBaseURL, '3.12.*')
|
||||
).toBe('v3.12.3')
|
||||
})
|
||||
|
||||
test('resolveLatestPatchVersion() - throw when the minor has no releases', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
stubPatchProbes([])
|
||||
|
||||
await expect(
|
||||
run.resolveLatestPatchVersion(downloadBaseURL, '9.99')
|
||||
).rejects.toThrow('No Helm releases found for 9.99')
|
||||
})
|
||||
|
||||
test('resolveLatestPatchVersion() - propagate network errors', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.spyOn(globalThis, 'fetch').mockRejectedValue(
|
||||
new Error('Network Error')
|
||||
)
|
||||
|
||||
await expect(
|
||||
run.resolveLatestPatchVersion(downloadBaseURL, '3.14')
|
||||
).rejects.toThrow('Network Error')
|
||||
})
|
||||
|
||||
test('resolveLatestPatchVersion() - throw when the host reports every patch as existing', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.spyOn(globalThis, 'fetch').mockResolvedValue({ok: true} as Response)
|
||||
|
||||
await expect(
|
||||
run.resolveLatestPatchVersion(downloadBaseURL, '3.14')
|
||||
).rejects.toThrow('exceeded 100 probes')
|
||||
})
|
||||
|
||||
test('run() - fail when latest cannot be determined and latest-fallback is false', async () => {
|
||||
stubDownloadChain()
|
||||
inputs('latest', '', 'false')
|
||||
vi.spyOn(globalThis, 'fetch').mockRejectedValue(
|
||||
new Error('Network Error')
|
||||
)
|
||||
vi.useFakeTimers()
|
||||
|
||||
const pending = run.run()
|
||||
pending.catch(() => {})
|
||||
await vi.runAllTimersAsync()
|
||||
await expect(pending).rejects.toThrow(
|
||||
'Unable to determine the latest Helm version: Network Error'
|
||||
)
|
||||
|
||||
expect(toolCache.find).not.toHaveBeenCalled()
|
||||
})
|
||||
|
||||
test('run() - install the default version when latest cannot be determined and latest-fallback is left at its default', async () => {
|
||||
stubDownloadChain()
|
||||
inputs('latest', '')
|
||||
vi.spyOn(globalThis, 'fetch').mockRejectedValue(
|
||||
new Error('Network Error')
|
||||
)
|
||||
vi.useFakeTimers()
|
||||
|
||||
const pending = run.run()
|
||||
await vi.runAllTimersAsync()
|
||||
await pending
|
||||
|
||||
expect(core.warning).toHaveBeenCalledWith(
|
||||
expect.stringContaining(run.stableHelmVersion)
|
||||
)
|
||||
expect(toolCache.find).toHaveBeenCalledWith('helm', run.stableHelmVersion)
|
||||
})
|
||||
|
||||
test('run() - resolve the latest patch for a major.minor version input', async () => {
|
||||
stubDownloadChain()
|
||||
inputs('3.14', '')
|
||||
stubPatchProbes(['v3.14.0', 'v3.14.1', 'v3.14.2', 'v3.14.3', 'v3.14.4'])
|
||||
|
||||
await run.run()
|
||||
|
||||
expect(toolCache.find).toHaveBeenCalledWith('helm', 'v3.14.4')
|
||||
})
|
||||
|
||||
test('run() - resolve a major.minor version from the fallback mirror', async () => {
|
||||
stubDownloadChain()
|
||||
inputs('3.14', '', '', 'https://fallback.tld')
|
||||
vi.spyOn(globalThis, 'fetch').mockImplementation(async (input) => {
|
||||
const url = String(input)
|
||||
if (url.startsWith(downloadBaseURL)) {
|
||||
throw new Error('Primary unavailable')
|
||||
}
|
||||
return {
|
||||
ok: true,
|
||||
text: async () =>
|
||||
'<EnumerationResults><Blob><Name>helm-v3.14.4-linux-amd64.tar.gz</Name></Blob></EnumerationResults>'
|
||||
} as Response
|
||||
})
|
||||
|
||||
await run.run()
|
||||
|
||||
expect(toolCache.find).toHaveBeenCalledWith('helm', 'v3.14.4')
|
||||
expect(core.warning).toHaveBeenCalledWith(
|
||||
expect.stringContaining("Trying fallback 'https://fallback.tld'")
|
||||
)
|
||||
})
|
||||
|
||||
test('run() - resolve the latest patch for a wildcard patch version input', async () => {
|
||||
stubDownloadChain()
|
||||
inputs('v3.12.x', '')
|
||||
stubPatchProbes(['v3.12.0', 'v3.12.1', 'v3.12.2', 'v3.12.3'])
|
||||
|
||||
await run.run()
|
||||
|
||||
expect(toolCache.find).toHaveBeenCalledWith('helm', 'v3.12.3')
|
||||
})
|
||||
|
||||
test('run() - resolve the latest patch for a major.minor version-file entry', async () => {
|
||||
stubDownloadChain()
|
||||
inputs('', '.tool-versions')
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true)
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('helm 3.14')
|
||||
stubPatchProbes(['v3.14.0', 'v3.14.1', 'v3.14.2', 'v3.14.3', 'v3.14.4'])
|
||||
|
||||
await run.run()
|
||||
|
||||
expect(toolCache.find).toHaveBeenCalledWith('helm', 'v3.14.4')
|
||||
})
|
||||
|
||||
test('walkSync() - return path to the all files matching fileToFind in dir', () => {
|
||||
vi.mocked(fs.readdirSync).mockImplementation((file, _?) => {
|
||||
if (file == 'mainFolder')
|
||||
@@ -264,9 +808,7 @@ describe('run.ts', () => {
|
||||
|
||||
test('downloadHelm() - download helm and return path to it', async () => {
|
||||
vi.mocked(toolCache.find).mockReturnValue('')
|
||||
vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
|
||||
const response = JSON.stringify([{tag_name: 'v4.0.0'}])
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(response)
|
||||
mockVerifiedDownload()
|
||||
vi.mocked(os.platform).mockReturnValue('win32')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.mocked(fs.chmodSync).mockImplementation(() => {})
|
||||
@@ -285,7 +827,12 @@ describe('run.ts', () => {
|
||||
path.join('pathToCachedDir', 'helm.exe')
|
||||
)
|
||||
expect(toolCache.find).toHaveBeenCalledWith('helm', 'v4.0.0')
|
||||
expect(toolCache.downloadTool).toHaveBeenCalledWith(
|
||||
expect(toolCache.downloadTool).toHaveBeenNthCalledWith(
|
||||
1,
|
||||
'https://test.tld/helm-v4.0.0-windows-amd64.zip.sha256'
|
||||
)
|
||||
expect(toolCache.downloadTool).toHaveBeenNthCalledWith(
|
||||
2,
|
||||
'https://test.tld/helm-v4.0.0-windows-amd64.zip'
|
||||
)
|
||||
expect(fs.chmodSync).toHaveBeenCalledWith('pathToTool', '755')
|
||||
@@ -306,10 +853,12 @@ describe('run.ts', () => {
|
||||
|
||||
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}`
|
||||
`Failed to download and verify Helm from location ${downloadUrl}`
|
||||
)
|
||||
expect(toolCache.find).toHaveBeenCalledWith('helm', 'v3.2.1')
|
||||
expect(toolCache.downloadTool).toHaveBeenCalledWith(`${downloadUrl}`)
|
||||
expect(toolCache.downloadTool).toHaveBeenCalledWith(
|
||||
`${downloadUrl}.sha256`
|
||||
)
|
||||
})
|
||||
|
||||
test('downloadHelm() - return path to helm tool with same version from toolCache', async () => {
|
||||
@@ -341,9 +890,8 @@ describe('run.ts', () => {
|
||||
|
||||
test('downloadHelm() - throw error is helm is not found in path', async () => {
|
||||
vi.mocked(toolCache.find).mockReturnValue('')
|
||||
vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
|
||||
mockVerifiedDownload()
|
||||
vi.mocked(toolCache.cacheDir).mockResolvedValue('pathToCachedDir')
|
||||
vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
|
||||
vi.mocked(toolCache.extractZip).mockResolvedValue('extractedPath')
|
||||
vi.mocked(os.platform).mockReturnValue('win32')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
@@ -365,4 +913,182 @@ describe('run.ts', () => {
|
||||
expect(fs.chmodSync).toHaveBeenCalledWith('pathToTool', '755')
|
||||
expect(toolCache.extractZip).toHaveBeenCalledWith('pathToTool')
|
||||
})
|
||||
|
||||
test('downloadAndVerifyHelm() - reject a checksum mismatch', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.mocked(toolCache.downloadTool)
|
||||
.mockResolvedValueOnce('pathToChecksum')
|
||||
.mockResolvedValueOnce('pathToTool')
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('0'.repeat(64))
|
||||
vi.mocked(fs.createReadStream).mockReturnValue(
|
||||
Readable.from([archive]) as fs.ReadStream
|
||||
)
|
||||
|
||||
await expect(
|
||||
run.downloadAndVerifyHelm(downloadBaseURL, 'v3.18.4')
|
||||
).rejects.toThrow('SHA-256 checksum mismatch')
|
||||
})
|
||||
|
||||
test('downloadAndVerifyHelm() - reject an invalid checksum file', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.mocked(toolCache.downloadTool).mockResolvedValueOnce('pathToChecksum')
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('not-a-checksum')
|
||||
|
||||
await expect(
|
||||
run.downloadAndVerifyHelm(downloadBaseURL, 'v3.18.4')
|
||||
).rejects.toThrow('Invalid SHA-256 checksum')
|
||||
})
|
||||
|
||||
test('downloadAndVerifyHelm() - auto mode warns and continues when a custom mirror has no checksum', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.mocked(toolCache.downloadTool)
|
||||
.mockRejectedValueOnce(new toolCache.HTTPError(404))
|
||||
.mockResolvedValueOnce('pathToTool')
|
||||
|
||||
await expect(
|
||||
run.downloadAndVerifyHelm(downloadBaseURL, 'v3.18.4')
|
||||
).resolves.toBe('pathToTool')
|
||||
expect(toolCache.downloadTool).toHaveBeenNthCalledWith(
|
||||
1,
|
||||
'https://test.tld/helm-v3.18.4-linux-amd64.tar.gz.sha256'
|
||||
)
|
||||
expect(toolCache.downloadTool).toHaveBeenNthCalledWith(
|
||||
2,
|
||||
'https://test.tld/helm-v3.18.4-linux-amd64.tar.gz'
|
||||
)
|
||||
expect(core.warning).toHaveBeenCalledWith(
|
||||
expect.stringContaining('continuing without verification')
|
||||
)
|
||||
})
|
||||
|
||||
test('downloadAndVerifyHelm() - auto mode warns when get.helm.sh has no checksum', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.mocked(toolCache.downloadTool)
|
||||
.mockRejectedValueOnce(new toolCache.HTTPError(404))
|
||||
.mockResolvedValueOnce('pathToTool')
|
||||
|
||||
await expect(
|
||||
run.downloadAndVerifyHelm('https://get.helm.sh', 'v3.18.4')
|
||||
).resolves.toBe('pathToTool')
|
||||
expect(toolCache.downloadTool).toHaveBeenCalledTimes(2)
|
||||
expect(core.warning).toHaveBeenCalledWith(
|
||||
expect.stringContaining('continuing without verification')
|
||||
)
|
||||
})
|
||||
|
||||
test('downloadAndVerifyHelm() - required mode blocks a missing checksum', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.mocked(toolCache.downloadTool).mockRejectedValueOnce(
|
||||
new toolCache.HTTPError(404)
|
||||
)
|
||||
|
||||
await expect(
|
||||
run.downloadAndVerifyHelm(downloadBaseURL, 'v3.18.4', 'required')
|
||||
).rejects.toThrow('Unexpected HTTP response: 404')
|
||||
expect(toolCache.downloadTool).toHaveBeenCalledTimes(1)
|
||||
expect(core.warning).not.toHaveBeenCalled()
|
||||
})
|
||||
|
||||
test('downloadAndVerifyHelm() - if-available mode does not ignore checksum server errors', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.mocked(toolCache.downloadTool).mockRejectedValueOnce(
|
||||
new toolCache.HTTPError(503)
|
||||
)
|
||||
|
||||
await expect(
|
||||
run.downloadAndVerifyHelm(downloadBaseURL, 'v3.18.4', 'if-available')
|
||||
).rejects.toThrow('Unexpected HTTP response: 503')
|
||||
expect(toolCache.downloadTool).toHaveBeenCalledTimes(1)
|
||||
})
|
||||
|
||||
test('downloadAndVerifyHelm() - disabled mode downloads without requesting a checksum', async () => {
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.mocked(toolCache.downloadTool).mockResolvedValueOnce('pathToTool')
|
||||
|
||||
await expect(
|
||||
run.downloadAndVerifyHelm(downloadBaseURL, 'v3.18.4', 'disabled')
|
||||
).resolves.toBe('pathToTool')
|
||||
expect(toolCache.downloadTool).toHaveBeenCalledWith(
|
||||
'https://test.tld/helm-v3.18.4-linux-amd64.tar.gz'
|
||||
)
|
||||
expect(toolCache.downloadTool).toHaveBeenCalledTimes(1)
|
||||
expect(core.warning).toHaveBeenCalledWith(
|
||||
expect.stringContaining('Checksum verification is disabled')
|
||||
)
|
||||
})
|
||||
|
||||
test('downloadHelm() - use a verified fallback after a primary checksum mismatch', async () => {
|
||||
vi.mocked(toolCache.find).mockReturnValue('')
|
||||
vi.mocked(os.platform).mockReturnValue('win32')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.mocked(toolCache.downloadTool)
|
||||
.mockResolvedValueOnce('primaryChecksum')
|
||||
.mockResolvedValueOnce('primaryTool')
|
||||
.mockResolvedValueOnce('fallbackChecksum')
|
||||
.mockResolvedValueOnce('fallbackTool')
|
||||
vi.mocked(fs.readFileSync).mockImplementation((file) =>
|
||||
file === 'primaryChecksum' ? '0'.repeat(64) : archiveChecksum
|
||||
)
|
||||
vi.mocked(fs.createReadStream).mockImplementation(
|
||||
() => Readable.from([archive]) as fs.ReadStream
|
||||
)
|
||||
vi.mocked(fs.chmodSync).mockImplementation(() => {})
|
||||
vi.mocked(toolCache.extractZip).mockResolvedValue('extractedPath')
|
||||
vi.mocked(toolCache.cacheDir).mockResolvedValue('pathToCachedDir')
|
||||
vi.mocked(fs.readdirSync).mockReturnValue([
|
||||
'helm.exe' as unknown as fs.Dirent<NonSharedBuffer>
|
||||
])
|
||||
vi.mocked(fs.statSync).mockReturnValue({
|
||||
isDirectory: () => false
|
||||
} as fs.Stats)
|
||||
|
||||
expect(
|
||||
await run.downloadHelm(
|
||||
downloadBaseURL,
|
||||
'v3.18.4',
|
||||
'https://fallback.tld'
|
||||
)
|
||||
).toBe(path.join('pathToCachedDir', 'helm.exe'))
|
||||
expect(toolCache.downloadTool).toHaveBeenNthCalledWith(
|
||||
3,
|
||||
'https://fallback.tld/helm-v3.18.4-windows-amd64.zip.sha256'
|
||||
)
|
||||
expect(toolCache.downloadTool).toHaveBeenNthCalledWith(
|
||||
4,
|
||||
'https://fallback.tld/helm-v3.18.4-windows-amd64.zip'
|
||||
)
|
||||
expect(toolCache.extractZip).toHaveBeenCalledWith('fallbackTool')
|
||||
expect(core.warning).toHaveBeenCalledWith(
|
||||
expect.stringContaining('Trying fallback')
|
||||
)
|
||||
})
|
||||
|
||||
test('downloadHelm() - fail when primary and fallback verification fail', async () => {
|
||||
vi.mocked(toolCache.find).mockReturnValue('')
|
||||
vi.mocked(os.platform).mockReturnValue('linux')
|
||||
vi.mocked(os.arch).mockReturnValue('x64')
|
||||
vi.mocked(toolCache.downloadTool)
|
||||
.mockResolvedValueOnce('primaryChecksum')
|
||||
.mockResolvedValueOnce('primaryTool')
|
||||
.mockResolvedValueOnce('fallbackChecksum')
|
||||
.mockResolvedValueOnce('fallbackTool')
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('0'.repeat(64))
|
||||
vi.mocked(fs.createReadStream).mockImplementation(
|
||||
() => Readable.from([archive]) as fs.ReadStream
|
||||
)
|
||||
|
||||
await expect(
|
||||
run.downloadHelm(downloadBaseURL, 'v3.18.4', 'https://fallback.tld')
|
||||
).rejects.toThrow(
|
||||
"Failed to download and verify Helm from 'https://test.tld' and fallback 'https://fallback.tld'"
|
||||
)
|
||||
expect(toolCache.extractTar).not.toHaveBeenCalled()
|
||||
})
|
||||
})
|
||||
|
||||
+411
-23
@@ -5,28 +5,77 @@ import * as os from 'os'
|
||||
import * as path from 'path'
|
||||
import * as util from 'util'
|
||||
import * as fs from 'fs'
|
||||
import {createHash} from 'crypto'
|
||||
|
||||
import * as toolCache from '@actions/tool-cache'
|
||||
import * as core from '@actions/core'
|
||||
|
||||
const helmToolName = 'helm'
|
||||
export const stableHelmVersion = 'v3.18.4'
|
||||
export const stableHelmVersion = 'v4.3.1'
|
||||
|
||||
export type ChecksumPolicy = 'auto' | 'required' | 'if-available' | 'disabled'
|
||||
|
||||
export async function run() {
|
||||
let version = core.getInput('version', {required: true})
|
||||
let version = core.getInput('version')
|
||||
const versionFile = core.getInput('version-file')
|
||||
|
||||
if (version !== 'latest' && version[0] !== 'v') {
|
||||
core.info('Getting latest Helm version')
|
||||
version = getValidVersion(version)
|
||||
if (versionFile) {
|
||||
if (version && version !== 'latest') {
|
||||
core.warning(
|
||||
`Both 'version' and 'version-file' inputs are specified, only 'version' will be used.`
|
||||
)
|
||||
} else {
|
||||
version = getVersionFromToolVersionsFile(versionFile)
|
||||
core.info(`Resolved Helm version '${version}' from '${versionFile}'`)
|
||||
}
|
||||
}
|
||||
if (version.toLocaleLowerCase() === 'latest') {
|
||||
version = await getLatestHelmVersion()
|
||||
|
||||
if (!version) {
|
||||
version = 'latest'
|
||||
}
|
||||
|
||||
const downloadBaseURL = core.getInput('downloadBaseURL', {required: false})
|
||||
const downloadBaseURLFallback = core.getInput('downloadBaseURLFallback', {
|
||||
required: false
|
||||
})
|
||||
const checksumPolicy = getChecksumPolicy(
|
||||
core.getInput('checksum-policy', {required: false})
|
||||
)
|
||||
|
||||
if (version.toLocaleLowerCase() === 'latest') {
|
||||
// Only an explicit 'false' turns the fallback off, matching the
|
||||
// input's default.
|
||||
const fallbackToDefault =
|
||||
core.getInput('latest-fallback').toLowerCase() !== 'false'
|
||||
version = await getLatestHelmVersion(fallbackToDefault)
|
||||
} else if (isMajorMinorShaped(version)) {
|
||||
try {
|
||||
version = await resolveLatestPatchVersion(downloadBaseURL, version)
|
||||
} catch (error) {
|
||||
if (!downloadBaseURLFallback) {
|
||||
throw error
|
||||
}
|
||||
core.warning(
|
||||
`Unable to resolve the latest Helm patch from '${downloadBaseURL}': ${error instanceof Error ? error.message : String(error)}. Trying fallback '${downloadBaseURLFallback}'`
|
||||
)
|
||||
version = await resolveLatestPatchVersion(
|
||||
downloadBaseURLFallback,
|
||||
version
|
||||
)
|
||||
}
|
||||
core.info(`Resolved latest patch Helm version to '${version}'`)
|
||||
} else if (version[0] !== 'v') {
|
||||
version = getValidVersion(version)
|
||||
core.info(`Normalized Helm version to '${version}'`)
|
||||
}
|
||||
|
||||
core.startGroup(`Installing ${version}`)
|
||||
const cachedPath = await downloadHelm(downloadBaseURL, version)
|
||||
const cachedPath = await downloadHelm(
|
||||
downloadBaseURL,
|
||||
version,
|
||||
downloadBaseURLFallback,
|
||||
checksumPolicy
|
||||
)
|
||||
core.endGroup()
|
||||
|
||||
try {
|
||||
@@ -46,20 +95,263 @@ export function getValidVersion(version: string): string {
|
||||
return 'v' + version
|
||||
}
|
||||
|
||||
// Gets the latest helm version or returns a default stable if getting latest fails
|
||||
export async function getLatestHelmVersion(): Promise<string> {
|
||||
export function getChecksumPolicy(value: string): ChecksumPolicy {
|
||||
const policy = value.trim().toLowerCase() || 'auto'
|
||||
if (
|
||||
policy !== 'auto' &&
|
||||
policy !== 'required' &&
|
||||
policy !== 'if-available' &&
|
||||
policy !== 'disabled'
|
||||
) {
|
||||
throw new Error(
|
||||
`Invalid checksum-policy '${value}'. Expected auto, required, if-available, or disabled`
|
||||
)
|
||||
}
|
||||
return policy
|
||||
}
|
||||
|
||||
// Matches a complete semantic version (major.minor.patch with optional
|
||||
// pre-release / build metadata). This is the official regex suggested at
|
||||
// https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
|
||||
// with an added optional leading 'v' to accept Helm-style tags (e.g. 'v3.14.0').
|
||||
const semVerShape =
|
||||
/^v?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/
|
||||
|
||||
// Returns true when version looks like a semantic version
|
||||
export function isSemVerShaped(version: string): boolean {
|
||||
return semVerShape.test(version)
|
||||
}
|
||||
|
||||
// Matches a major.minor version with an optional leading 'v' and either no
|
||||
// patch component or a wildcard patch ('.x' / '.*'), e.g. '3.14', 'v3.14',
|
||||
// '3.14.x', 'v3.14.*'.
|
||||
const majorMinorShape = /^v?\d+\.\d+(?:\.[x*])?$/
|
||||
|
||||
// Returns true when version is a major.minor value (optionally with a wildcard
|
||||
// patch such as '.x' or '.*')
|
||||
export function isMajorMinorShaped(version: string): boolean {
|
||||
return majorMinorShape.test(version)
|
||||
}
|
||||
|
||||
// Reads a .tool-versions file and returns the helm version declared in it
|
||||
export function getVersionFromToolVersionsFile(filePath: string): string {
|
||||
if (!fs.existsSync(filePath)) {
|
||||
throw new Error(`The version-file '${filePath}' does not exist`)
|
||||
}
|
||||
const content = fs.readFileSync(filePath, 'utf8')
|
||||
const version = parseToolVersions(content)
|
||||
if (!version) {
|
||||
throw new Error(`No helm version found in '${filePath}'`)
|
||||
}
|
||||
if (!isSemVerShaped(version) && !isMajorMinorShaped(version)) {
|
||||
throw new Error(
|
||||
`The helm version '${version}' in '${filePath}' is not valid. Provide a full version (e.g. '3.14.0') or a major.minor version (e.g. '3.14' or '3.14.x')`
|
||||
)
|
||||
}
|
||||
return version
|
||||
}
|
||||
|
||||
// Parses .tool-versions content (asdf/mise format) and returns the first
|
||||
// helm version, or an empty string when none is declared. Lines look like
|
||||
// `helm 3.14.0`; comments (#) and blank lines are ignored.
|
||||
export function parseToolVersions(content: string): string {
|
||||
for (const line of content.split(/\r?\n/)) {
|
||||
const trimmed = line.trim()
|
||||
if (!trimmed || trimmed.startsWith('#')) {
|
||||
continue
|
||||
}
|
||||
const [tool, version] = trimmed.split(/\s+/)
|
||||
if (tool === helmToolName && version) {
|
||||
return version
|
||||
}
|
||||
}
|
||||
return ''
|
||||
}
|
||||
|
||||
const latestVersionURL = 'https://get.helm.sh/helm-latest-version'
|
||||
|
||||
// Number of attempts made to fetch the latest version before giving up, and
|
||||
// the wait before the second attempt (each further wait doubles the previous).
|
||||
const latestVersionAttempts = 3
|
||||
const latestVersionRetryDelayMs = 1000
|
||||
|
||||
// Fetches the latest helm version. A failed request or a non-2xx response is
|
||||
// retried with a short backoff, so a single transient failure does not decide
|
||||
// the outcome. Throws the last error once every attempt has failed.
|
||||
export async function fetchLatestHelmVersion(): Promise<string> {
|
||||
let delayMs = latestVersionRetryDelayMs
|
||||
for (let attempt = 1; ; attempt++) {
|
||||
try {
|
||||
const response = await fetch(latestVersionURL)
|
||||
if (!response.ok) {
|
||||
// The body is never read, so cancel it to release the connection
|
||||
// before the next attempt.
|
||||
await response.body?.cancel()
|
||||
throw new Error(
|
||||
`Unexpected HTTP ${response.status} from ${latestVersionURL}`
|
||||
)
|
||||
}
|
||||
return (await response.text()).trim()
|
||||
} catch (err) {
|
||||
if (attempt >= latestVersionAttempts) {
|
||||
throw err
|
||||
}
|
||||
core.info(
|
||||
`Attempt ${attempt} of ${latestVersionAttempts} to fetch the latest Helm version failed: ${err instanceof Error ? err.message : String(err)}. Retrying in ${delayMs}ms`
|
||||
)
|
||||
await new Promise((resolve) => setTimeout(resolve, delayMs))
|
||||
delayMs *= 2
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Gets the latest helm version. When it cannot be determined, returns the
|
||||
// built-in default version with a warning, or throws when fallbackToDefault
|
||||
// is off. The default version can be a major behind what 'latest' resolves
|
||||
// to, so the warning names the input that turns the fallback off.
|
||||
export async function getLatestHelmVersion(
|
||||
fallbackToDefault = true
|
||||
): Promise<string> {
|
||||
try {
|
||||
const response = await fetch('https://get.helm.sh/helm-latest-version')
|
||||
const release = (await response.text()).trim()
|
||||
return release
|
||||
return await fetchLatestHelmVersion()
|
||||
} catch (err) {
|
||||
const message = err instanceof Error ? err.message : String(err)
|
||||
if (!fallbackToDefault) {
|
||||
throw new Error(
|
||||
`Unable to determine the latest Helm version: ${message}. Set 'latest-fallback' to 'true' to install the default version ${stableHelmVersion} instead, or request a specific version`
|
||||
)
|
||||
}
|
||||
core.warning(
|
||||
`Error while fetching latest Helm release: ${err instanceof Error ? err.message : String(err)}. Using default version ${stableHelmVersion}`
|
||||
`Error while fetching latest Helm release: ${message}. Using default version ${stableHelmVersion}. Set 'latest-fallback' to 'false' to fail the step instead`
|
||||
)
|
||||
return stableHelmVersion
|
||||
}
|
||||
}
|
||||
|
||||
// Number of consecutive missing patches to probe before concluding the walk,
|
||||
// and an upper bound to keep resolution from running unbounded.
|
||||
const patchLookahead = 3
|
||||
const maxPatch = 100
|
||||
|
||||
// Sends a HEAD request for the given version's download URL. Returns true when
|
||||
// the artifact exists (2xx) and false only when it is definitively absent
|
||||
// (404). Any other status (403/405/429/5xx, ...) and genuine network errors are
|
||||
// thrown, so transient failures, rate-limiting, or a host that disallows HEAD
|
||||
// are never mistaken for a missing patch.
|
||||
export async function helmPatchExists(
|
||||
baseURL: string,
|
||||
version: string
|
||||
): Promise<boolean> {
|
||||
const url = getHelmDownloadURL(baseURL, version)
|
||||
const response = await fetch(url, {method: 'HEAD'})
|
||||
if (response.ok) {
|
||||
return true
|
||||
}
|
||||
if (response.status === 404) {
|
||||
return false
|
||||
}
|
||||
throw new Error(
|
||||
`Unexpected HTTP ${response.status} while checking for Helm artifact at ${url}`
|
||||
)
|
||||
}
|
||||
|
||||
// Attempts to resolve the latest patch in a single request via the Azure Blob
|
||||
// container-listing API that backs get.helm.sh. Returns the newest stable patch
|
||||
// version, or null when the host does not support listing (any non-listing
|
||||
// response, empty result, or error) so the caller can fall back to probing.
|
||||
// Only 'major.minor.patch-<platform>' names are matched, so prereleases and
|
||||
// sidecar files (.sha256, ...) are ignored.
|
||||
export async function resolveLatestPatchViaListing(
|
||||
baseURL: string,
|
||||
major: string,
|
||||
minor: string
|
||||
): Promise<string | null> {
|
||||
let body: string
|
||||
try {
|
||||
const listURL = new URL(baseURL)
|
||||
listURL.searchParams.set('restype', 'container')
|
||||
listURL.searchParams.set('comp', 'list')
|
||||
listURL.searchParams.set('prefix', `helm-v${major}.${minor}.`)
|
||||
const response = await fetch(listURL.toString())
|
||||
if (!response.ok) {
|
||||
return null
|
||||
}
|
||||
body = await response.text()
|
||||
} catch {
|
||||
return null
|
||||
}
|
||||
|
||||
if (!body.includes('<EnumerationResults')) {
|
||||
return null
|
||||
}
|
||||
|
||||
const patchPattern = new RegExp(
|
||||
`helm-v${major}\\.${minor}\\.(\\d+)-(?:darwin|linux|windows)`,
|
||||
'g'
|
||||
)
|
||||
let latestPatch = -1
|
||||
for (const match of body.matchAll(patchPattern)) {
|
||||
const patch = Number(match[1])
|
||||
if (patch > latestPatch) {
|
||||
latestPatch = patch
|
||||
}
|
||||
}
|
||||
|
||||
if (latestPatch < 0) {
|
||||
return null
|
||||
}
|
||||
return `v${major}.${minor}.${latestPatch}`
|
||||
}
|
||||
|
||||
// Resolves a major.minor value (e.g. '3.14' or 'v3.14') to the newest available
|
||||
// patch (e.g. 'v3.14.4'). Fast path: a single container-listing request (which
|
||||
// get.helm.sh supports). When the host does not support listing, it falls back
|
||||
// to probing the download host for sequential patches. Only 'major.minor.n'
|
||||
// artifacts are considered, so prereleases are never selected.
|
||||
export async function resolveLatestPatchVersion(
|
||||
baseURL: string,
|
||||
version: string
|
||||
): Promise<string> {
|
||||
const [major, minor] = (
|
||||
version[0] === 'v' ? version.slice(1) : version
|
||||
).split('.')
|
||||
|
||||
const listed = await resolveLatestPatchViaListing(baseURL, major, minor)
|
||||
if (listed) {
|
||||
return listed
|
||||
}
|
||||
|
||||
if (!(await helmPatchExists(baseURL, `v${major}.${minor}.0`))) {
|
||||
throw new Error(`No Helm releases found for ${major}.${minor}`)
|
||||
}
|
||||
|
||||
let latestPatch = 0
|
||||
let consecutiveMisses = 0
|
||||
for (
|
||||
let patch = 1;
|
||||
patch <= maxPatch && consecutiveMisses < patchLookahead;
|
||||
patch++
|
||||
) {
|
||||
if (await helmPatchExists(baseURL, `v${major}.${minor}.${patch}`)) {
|
||||
latestPatch = patch
|
||||
consecutiveMisses = 0
|
||||
} else {
|
||||
consecutiveMisses++
|
||||
}
|
||||
}
|
||||
|
||||
// The look-ahead is what should end the walk. Exhausting maxPatch without a
|
||||
// trailing run of misses means the host answered 200 for every probe (e.g. a
|
||||
// catch-all mirror), so the resolved version cannot be trusted.
|
||||
if (consecutiveMisses < patchLookahead) {
|
||||
throw new Error(
|
||||
`Unable to resolve latest patch for ${major}.${minor} (exceeded ${maxPatch} probes)`
|
||||
)
|
||||
}
|
||||
|
||||
return `v${major}.${minor}.${latestPatch}`
|
||||
}
|
||||
|
||||
export function getArch(): string {
|
||||
return os.arch() === 'x64' ? 'amd64' : os.arch()
|
||||
}
|
||||
@@ -78,13 +370,84 @@ export function getExecutableExtension(): string {
|
||||
|
||||
export function getHelmDownloadURL(baseURL: string, version: string): string {
|
||||
const urlPath = `helm-${version}-${getPlatform()}-${getArch()}.${getArchiveExtension()}`
|
||||
const url = new URL(urlPath, baseURL)
|
||||
// Ensure the base ends with '/' so a subpath mirror (e.g.
|
||||
// 'https://example/kubernetes/helm') is preserved; otherwise URL resolution
|
||||
// replaces the last path segment and points at the wrong location.
|
||||
const base = baseURL.endsWith('/') ? baseURL : `${baseURL}/`
|
||||
const url = new URL(urlPath, base)
|
||||
return url.toString()
|
||||
}
|
||||
|
||||
export async function downloadAndVerifyHelm(
|
||||
baseURL: string,
|
||||
version: string,
|
||||
policy: ChecksumPolicy = 'auto'
|
||||
): Promise<string> {
|
||||
const downloadURL = getHelmDownloadURL(baseURL, version)
|
||||
const effectivePolicy = resolveChecksumPolicy(policy)
|
||||
|
||||
if (effectivePolicy === 'disabled') {
|
||||
core.warning(
|
||||
`Checksum verification is disabled for Helm downloads from '${baseURL}'`
|
||||
)
|
||||
return toolCache.downloadTool(downloadURL)
|
||||
}
|
||||
|
||||
let checksum: string | undefined
|
||||
try {
|
||||
const checksumPath = await toolCache.downloadTool(`${downloadURL}.sha256`)
|
||||
checksum = fs.readFileSync(checksumPath, 'utf8').trim()
|
||||
} catch (error) {
|
||||
if (
|
||||
effectivePolicy === 'if-available' &&
|
||||
isChecksumNotFoundError(error)
|
||||
) {
|
||||
core.warning(
|
||||
`No SHA-256 checksum is available for ${downloadURL}; continuing without verification. Set checksum-policy to 'required' to fail instead.`
|
||||
)
|
||||
return toolCache.downloadTool(downloadURL)
|
||||
}
|
||||
throw error
|
||||
}
|
||||
|
||||
if (!/^[a-fA-F0-9]{64}$/.test(checksum)) {
|
||||
throw new Error(`Invalid SHA-256 checksum from ${downloadURL}.sha256`)
|
||||
}
|
||||
|
||||
const archivePath = await toolCache.downloadTool(downloadURL)
|
||||
const hash = createHash('sha256')
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
const archive = fs.createReadStream(archivePath)
|
||||
archive.on('data', (chunk) => hash.update(chunk))
|
||||
archive.on('error', reject)
|
||||
archive.on('end', resolve)
|
||||
})
|
||||
const actual = hash.digest('hex')
|
||||
if (actual.toLowerCase() !== checksum.toLowerCase()) {
|
||||
throw new Error(`SHA-256 checksum mismatch for ${downloadURL}`)
|
||||
}
|
||||
|
||||
return archivePath
|
||||
}
|
||||
|
||||
export function resolveChecksumPolicy(
|
||||
policy: ChecksumPolicy
|
||||
): Exclude<ChecksumPolicy, 'auto'> {
|
||||
return policy === 'auto' ? 'if-available' : policy
|
||||
}
|
||||
|
||||
function isChecksumNotFoundError(error: unknown): boolean {
|
||||
return (
|
||||
error instanceof toolCache.HTTPError &&
|
||||
(error.httpStatusCode === 404 || error.httpStatusCode === 410)
|
||||
)
|
||||
}
|
||||
|
||||
export async function downloadHelm(
|
||||
baseURL: string,
|
||||
version: string
|
||||
version: string,
|
||||
fallbackBaseURL?: string,
|
||||
checksumPolicy: ChecksumPolicy = 'auto'
|
||||
): Promise<string> {
|
||||
let cachedToolpath = toolCache.find(helmToolName, version)
|
||||
if (cachedToolpath) {
|
||||
@@ -93,15 +456,40 @@ export async function downloadHelm(
|
||||
core.info(`Downloading '${version}' from '${baseURL}'`)
|
||||
let helmDownloadPath
|
||||
try {
|
||||
helmDownloadPath = await toolCache.downloadTool(
|
||||
getHelmDownloadURL(baseURL, version)
|
||||
helmDownloadPath = await downloadAndVerifyHelm(
|
||||
baseURL,
|
||||
version,
|
||||
checksumPolicy
|
||||
)
|
||||
} catch (exception) {
|
||||
} catch (error) {
|
||||
if (fallbackBaseURL) {
|
||||
core.warning(
|
||||
`Unable to download and verify Helm from '${baseURL}': ${error instanceof Error ? error.message : String(error)}. Trying fallback '${fallbackBaseURL}'`
|
||||
)
|
||||
try {
|
||||
helmDownloadPath = await downloadAndVerifyHelm(
|
||||
fallbackBaseURL,
|
||||
version,
|
||||
checksumPolicy
|
||||
)
|
||||
} catch (fallbackError) {
|
||||
throw new Error(
|
||||
`Failed to download and verify Helm from '${baseURL}' and fallback '${fallbackBaseURL}': ${fallbackError instanceof Error ? fallbackError.message : String(fallbackError)}`
|
||||
)
|
||||
}
|
||||
} else {
|
||||
throw new Error(
|
||||
`Failed to download and verify Helm from location ${getHelmDownloadURL(
|
||||
baseURL,
|
||||
version
|
||||
)}: ${error instanceof Error ? error.message : String(error)}`
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
if (!helmDownloadPath) {
|
||||
throw new Error(
|
||||
`Failed to download Helm from location ${getHelmDownloadURL(
|
||||
baseURL,
|
||||
version
|
||||
)}`
|
||||
`Failed to download and verify Helm version '${version}'`
|
||||
)
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user