mirror of
https://github.com/Azure/setup-kubectl.git
synced 2026-04-05 20:41:41 +08:00
Compare commits
85 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5f8d8195ef | ||
|
|
08845d9b5a | ||
|
|
f59556b0f1 | ||
|
|
50eb4152fb | ||
|
|
c8baf13e34 | ||
|
|
5934a1112b | ||
|
|
06dc4a8cf1 | ||
|
|
2e986c301c | ||
|
|
1dbc167e74 | ||
|
|
6c09a723d8 | ||
|
|
a7f5116a42 | ||
|
|
ef7e8f900a | ||
|
|
8fd7ec08ee | ||
|
|
4de084982b | ||
|
|
f366ff3801 | ||
|
|
a0bf2818e7 | ||
|
|
4e102d775e | ||
|
|
15595bc664 | ||
|
|
7f8ad2a736 | ||
|
|
1afb6ec9f1 | ||
|
|
077fec007f | ||
|
|
c6e655ba3a | ||
|
|
fe12176bb9 | ||
|
|
9f0d5eaea6 | ||
|
|
4638452962 | ||
|
|
3913282e93 | ||
|
|
28eb0b81d6 | ||
|
|
da9937795e | ||
|
|
fc40d80285 | ||
|
|
f24024cf68 | ||
|
|
c0f557132b | ||
|
|
aea9a0c3b3 | ||
|
|
8528c2dbca | ||
|
|
8cade21a03 | ||
|
|
5f693c4109 | ||
|
|
c03192ebc0 | ||
|
|
44bac4685f | ||
|
|
47a0af42ba | ||
|
|
4d23b307dc | ||
|
|
42b5b7bc56 | ||
|
|
b011c9c1e8 | ||
|
|
4133c5e43f | ||
|
|
cdf8c1d057 | ||
|
|
b6296bb835 | ||
|
|
c680ff81e7 | ||
|
|
cce2d7e325 | ||
|
|
005393f25c | ||
|
|
ca5c5eeeab | ||
|
|
1812bcd3a9 | ||
|
|
1c38d79705 | ||
|
|
cc498038af | ||
|
|
83ce790aa0 | ||
|
|
773fd39d5c | ||
|
|
0fec332675 | ||
|
|
7500adf963 | ||
|
|
41a1936057 | ||
|
|
f2e9242c07 | ||
|
|
00ca972929 | ||
|
|
ff4789395b | ||
|
|
71c4c470b9 | ||
|
|
d2d46d801e | ||
|
|
2ec05092d4 | ||
|
|
8ee333116b | ||
|
|
857b11c18c | ||
|
|
fa3df0f1e2 | ||
|
|
4d5f3eda74 | ||
|
|
393d232f65 | ||
|
|
a0d66424c8 | ||
|
|
a76651a0e0 | ||
|
|
cf5fdd749b | ||
|
|
de1d5ec5de | ||
|
|
e6e81bbc41 | ||
|
|
30d747582d | ||
|
|
f4440b5470 | ||
|
|
0fd96d6276 | ||
|
|
4ef821e7ca | ||
|
|
95e0936d6e | ||
|
|
87e53e3f71 | ||
|
|
13bef3ca00 | ||
|
|
023f859e5d | ||
|
|
6bd1f0daf1 | ||
|
|
574933e749 | ||
|
|
46ce001b45 | ||
|
|
f7a3237edf | ||
|
|
9c31f8cc61 |
2
.github/CODEOWNERS
vendored
2
.github/CODEOWNERS
vendored
@ -1 +1 @@
|
||||
* @Azure/aks-atlanta
|
||||
* @Azure/cloud-native-github-action-owners
|
||||
|
||||
6
.github/workflows/codeql.yml
vendored
6
.github/workflows/codeql.yml
vendored
@ -55,11 +55,11 @@ jobs:
|
||||
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
|
||||
# Initializes the CodeQL tools for scanning.
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@17a820bf2e43b47be2c72b39cc905417bc1ab6d0 # v3.28.6
|
||||
uses: github/codeql-action/init@c10b8064de6f491fea524254123dbe5e09572f13 # v4.35.1
|
||||
with:
|
||||
languages: ${{ matrix.language }}
|
||||
build-mode: ${{ matrix.build-mode }}
|
||||
@ -86,6 +86,6 @@ jobs:
|
||||
echo ' make release'
|
||||
exit 1
|
||||
- name: Perform CodeQL Analysis
|
||||
uses: github/codeql-action/analyze@17a820bf2e43b47be2c72b39cc905417bc1ab6d0 # v3.28.6
|
||||
uses: github/codeql-action/analyze@c10b8064de6f491fea524254123dbe5e09572f13 # v4.35.1
|
||||
with:
|
||||
category: '/language:${{matrix.language}}'
|
||||
|
||||
4
.github/workflows/defaultLabels.yml
vendored
4
.github/workflows/defaultLabels.yml
vendored
@ -8,7 +8,7 @@ jobs:
|
||||
label-issues:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0
|
||||
- uses: actions/stale@b5d41d4e1d5dceea10e7104786b73624c18a190f # v10.2.0
|
||||
name: Setting issue as idle
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@ -19,7 +19,7 @@ jobs:
|
||||
operations-per-run: 100
|
||||
exempt-issue-labels: 'backlog'
|
||||
|
||||
- uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0
|
||||
- uses: actions/stale@b5d41d4e1d5dceea10e7104786b73624c18a190f # v10.2.0
|
||||
name: Setting PR as idle
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
6
.github/workflows/integration-tests.yml
vendored
6
.github/workflows/integration-tests.yml
vendored
@ -17,7 +17,7 @@ jobs:
|
||||
KUBECONFIG: /home/runner/.kube/config
|
||||
PR_BASE_REF: ${{ github.event.pull_request.base.ref }}
|
||||
steps:
|
||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
name: Checkout from PR branch
|
||||
|
||||
- id: action-npm-build
|
||||
@ -27,9 +27,11 @@ jobs:
|
||||
if [[ $PR_BASE_REF != releases/* ]]; then
|
||||
npm install
|
||||
npm run build
|
||||
# remove node_modules to match production environment where only index.js is present
|
||||
rm -rf node_modules
|
||||
fi
|
||||
|
||||
- uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
|
||||
- uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
|
||||
name: Install Python
|
||||
with:
|
||||
python-version: '3.x'
|
||||
|
||||
4
.github/workflows/prettify-code.yml
vendored
4
.github/workflows/prettify-code.yml
vendored
@ -10,10 +10,10 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
|
||||
uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
|
||||
with:
|
||||
node-version: 'lts/*'
|
||||
cache: 'npm'
|
||||
|
||||
2
.github/workflows/unit-tests.yml
vendored
2
.github/workflows/unit-tests.yml
vendored
@ -13,7 +13,7 @@ jobs:
|
||||
build: # make sure build/ci works properly
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
|
||||
- name: Build and run L0 tests.
|
||||
run: |
|
||||
|
||||
9
.husky/pre-commit
Normal file
9
.husky/pre-commit
Normal file
@ -0,0 +1,9 @@
|
||||
set +e
|
||||
npm test
|
||||
# Run format check
|
||||
npm run format-check || {
|
||||
echo ""
|
||||
echo "❌ Formatting check failed."
|
||||
echo "💡 Run 'npm run format' or 'prettier --write .' to fix formatting issues."
|
||||
exit 1
|
||||
}
|
||||
24
CHANGELOG.md
24
CHANGELOG.md
@ -1,6 +1,28 @@
|
||||
# Changelog
|
||||
|
||||
## [v4.0.0] - 2024-01-30
|
||||
## [5.0.0] - 2026-03-25
|
||||
|
||||
### Changed
|
||||
|
||||
- #233 [Update Node.js runtime from node20 to node24](https://github.com/Azure/setup-kubectl/pull/233)
|
||||
- #228 [Replace cdn.dl.k8s.io with dl.k8s.io](https://github.com/Azure/setup-kubectl/pull/228)
|
||||
- #219 [Remove download redirects, use cdn.dl.k8s.io domain](https://github.com/Azure/setup-kubectl/pull/219)
|
||||
- #190 [Update stableVersionUrl to dl.k8s.io](https://github.com/Azure/setup-kubectl/pull/190)
|
||||
- #235 [Bump undici from 6.23.0 to 6.24.1](https://github.com/Azure/setup-kubectl/pull/235)
|
||||
- #226 [Bump undici and @actions/http-client](https://github.com/Azure/setup-kubectl/pull/226)
|
||||
- #230 [Bump minimatch](https://github.com/Azure/setup-kubectl/pull/230)
|
||||
|
||||
### Added
|
||||
|
||||
- #172 [Enhance version handling: auto-resolve kubectl major.minor to latest patch](https://github.com/Azure/setup-kubectl/pull/172)
|
||||
- #171 [Add husky precommit check](https://github.com/Azure/setup-kubectl/pull/171)
|
||||
|
||||
## [4.0.1] - 2025-06-17
|
||||
|
||||
- Remove erronious 'v' prefix on previous changelog for v4.0.0 that led to "vv4.0.0" tag issue
|
||||
- Dependabot fixes
|
||||
|
||||
## [4.0.0] - 2024-01-30
|
||||
|
||||
### Changed
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
name: 'Kubectl tool installer'
|
||||
description: 'Install a specific version of kubectl binary. Acceptable values are latest or any semantic version string like 1.15.0'
|
||||
description: 'Install a specific version of kubectl binary. Acceptable values are latest or any semantic version string like "v1.15.0"'
|
||||
inputs:
|
||||
version:
|
||||
description: 'Version of kubectl'
|
||||
@ -11,5 +11,5 @@ outputs:
|
||||
branding:
|
||||
color: 'blue'
|
||||
runs:
|
||||
using: 'node20'
|
||||
using: 'node24'
|
||||
main: 'lib/index.js'
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
module.exports = {
|
||||
clearMocks: true,
|
||||
moduleFileExtensions: ['js', 'ts'],
|
||||
testEnvironment: 'node',
|
||||
testMatch: ['**/*.test.ts'],
|
||||
transform: {
|
||||
'^.+\\.ts$': 'ts-jest'
|
||||
},
|
||||
verbose: true,
|
||||
coverageThreshold: {
|
||||
global: {
|
||||
branches: 0,
|
||||
functions: 14,
|
||||
lines: 27,
|
||||
statements: 27
|
||||
}
|
||||
}
|
||||
}
|
||||
7825
package-lock.json
generated
7825
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
32
package.json
32
package.json
@ -1,14 +1,17 @@
|
||||
{
|
||||
"name": "setup-kubectl-action",
|
||||
"version": "0.0.0",
|
||||
"version": "5.0.0",
|
||||
"private": true,
|
||||
"main": "lib/index.js",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"build": "npm i ncc && npx ncc build src/index.ts -o lib",
|
||||
"test": "jest",
|
||||
"test-coverage": "jest --coverage",
|
||||
"build": "tsc --noEmit && esbuild src/index.ts --bundle --platform=node --target=node20 --format=esm --outfile=lib/index.js --banner:js=\"import { createRequire } from 'module';const require = createRequire(import.meta.url);\"",
|
||||
"typecheck": "tsc --noEmit",
|
||||
"test": "vitest run",
|
||||
"test-coverage": "vitest run --coverage",
|
||||
"format": "prettier --write .",
|
||||
"format-check": "prettier --check ."
|
||||
"format-check": "prettier --check .",
|
||||
"prepare": "husky"
|
||||
},
|
||||
"keywords": [
|
||||
"actions",
|
||||
@ -18,17 +21,16 @@
|
||||
"author": "GitHub",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@actions/core": "^1.11.1",
|
||||
"@actions/exec": "^1.0.0",
|
||||
"@actions/tool-cache": "^2.0.2"
|
||||
"@actions/core": "^3.0.0",
|
||||
"@actions/exec": "^3.0.0",
|
||||
"@actions/tool-cache": "^4.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/jest": "^29.5.14",
|
||||
"@types/node": "^22.10.10",
|
||||
"@vercel/ncc": "^0.38.3",
|
||||
"jest": "^29.7.0",
|
||||
"prettier": "3.4.2",
|
||||
"ts-jest": "^29.2.5",
|
||||
"typescript": "5.7.3"
|
||||
"@types/node": "^25.0.9",
|
||||
"esbuild": "^0.27.4",
|
||||
"husky": "^9.1.7",
|
||||
"prettier": "3.8.0",
|
||||
"typescript": "5.9.3",
|
||||
"vitest": "^4.0.18"
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
import * as os from 'os'
|
||||
import * as util from 'util'
|
||||
|
||||
import * as fs from 'fs'
|
||||
import * as core from '@actions/core'
|
||||
import * as toolCache from '@actions/tool-cache'
|
||||
export function getKubectlArch(): string {
|
||||
const arch = os.arch()
|
||||
if (arch === 'x64') {
|
||||
@ -23,6 +25,29 @@ export function getkubectlDownloadURL(version: string, arch: string): string {
|
||||
}
|
||||
}
|
||||
|
||||
export async function getLatestPatchVersion(
|
||||
major: string,
|
||||
minor: string
|
||||
): Promise<string> {
|
||||
const version = `${major}.${minor}`
|
||||
const sourceURL = `https://dl.k8s.io/release/stable-${version}.txt`
|
||||
try {
|
||||
const downloadPath = await toolCache.downloadTool(sourceURL)
|
||||
const latestPatch = fs
|
||||
.readFileSync(downloadPath, 'utf8')
|
||||
.toString()
|
||||
.trim()
|
||||
if (!latestPatch) {
|
||||
throw new Error(`No patch version found for ${version}`)
|
||||
}
|
||||
return latestPatch
|
||||
} catch (error) {
|
||||
core.debug(String(error))
|
||||
core.warning('GetLatestPatchVersionFailed')
|
||||
throw new Error(`Failed to get latest patch version for ${version}`)
|
||||
}
|
||||
}
|
||||
|
||||
export function getExecutableExtension(): string {
|
||||
if (os.type().match(/^Win/)) {
|
||||
return '.exe'
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import {run} from './run'
|
||||
import {run} from './run.js'
|
||||
import * as core from '@actions/core'
|
||||
|
||||
run().catch(core.setFailed)
|
||||
|
||||
227
src/run.test.ts
227
src/run.test.ts
@ -1,26 +1,45 @@
|
||||
import * as run from './run'
|
||||
import {
|
||||
getkubectlDownloadURL,
|
||||
getKubectlArch,
|
||||
getExecutableExtension
|
||||
} from './helpers'
|
||||
import * as os from 'os'
|
||||
import * as toolCache from '@actions/tool-cache'
|
||||
import * as fs from 'fs'
|
||||
import {vi, describe, test, expect, beforeEach} from 'vitest'
|
||||
import * as path from 'path'
|
||||
import * as core from '@actions/core'
|
||||
import * as util from 'util'
|
||||
|
||||
vi.mock('os')
|
||||
vi.mock('fs')
|
||||
vi.mock('@actions/tool-cache', async (importOriginal) => {
|
||||
const actual = await importOriginal<typeof import('@actions/tool-cache')>()
|
||||
return {
|
||||
...actual,
|
||||
downloadTool: vi.fn(),
|
||||
find: vi.fn(),
|
||||
cacheFile: vi.fn()
|
||||
}
|
||||
})
|
||||
vi.mock('@actions/core')
|
||||
|
||||
const os = await import('os')
|
||||
const fs = await import('fs')
|
||||
const toolCache = await import('@actions/tool-cache')
|
||||
const core = await import('@actions/core')
|
||||
const run = await import('./run.js')
|
||||
const {
|
||||
getkubectlDownloadURL,
|
||||
getKubectlArch,
|
||||
getExecutableExtension,
|
||||
getLatestPatchVersion
|
||||
} = await import('./helpers.js')
|
||||
|
||||
describe('Testing all functions in run file.', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
})
|
||||
test('getExecutableExtension() - return .exe when os is Windows', () => {
|
||||
jest.spyOn(os, 'type').mockReturnValue('Windows_NT')
|
||||
vi.mocked(os.type).mockReturnValue('Windows_NT')
|
||||
expect(getExecutableExtension()).toBe('.exe')
|
||||
expect(os.type).toBeCalled()
|
||||
expect(os.type).toHaveBeenCalled()
|
||||
})
|
||||
test('getExecutableExtension() - return empty string for non-windows OS', () => {
|
||||
jest.spyOn(os, 'type').mockReturnValue('Darwin')
|
||||
vi.mocked(os.type).mockReturnValue('Darwin')
|
||||
expect(getExecutableExtension()).toBe('')
|
||||
expect(os.type).toBeCalled()
|
||||
expect(os.type).toHaveBeenCalled()
|
||||
})
|
||||
test.each([
|
||||
['arm', 'arm'],
|
||||
@ -29,111 +48,101 @@ describe('Testing all functions in run file.', () => {
|
||||
])(
|
||||
'getKubectlArch() - return on %s os arch %s kubectl arch',
|
||||
(osArch, kubectlArch) => {
|
||||
jest.spyOn(os, 'arch').mockReturnValue(osArch)
|
||||
vi.mocked(os.arch).mockReturnValue(osArch as NodeJS.Architecture)
|
||||
expect(getKubectlArch()).toBe(kubectlArch)
|
||||
expect(os.arch).toBeCalled()
|
||||
expect(os.arch).toHaveBeenCalled()
|
||||
}
|
||||
)
|
||||
test.each([['arm'], ['arm64'], ['amd64']])(
|
||||
'getkubectlDownloadURL() - return the URL to download %s kubectl for Linux',
|
||||
(arch) => {
|
||||
jest.spyOn(os, 'type').mockReturnValue('Linux')
|
||||
vi.mocked(os.type).mockReturnValue('Linux')
|
||||
const kubectlLinuxUrl = util.format(
|
||||
'https://dl.k8s.io/release/v1.15.0/bin/linux/%s/kubectl',
|
||||
arch
|
||||
)
|
||||
expect(getkubectlDownloadURL('v1.15.0', arch)).toBe(kubectlLinuxUrl)
|
||||
expect(os.type).toBeCalled()
|
||||
expect(os.type).toHaveBeenCalled()
|
||||
}
|
||||
)
|
||||
test.each([['arm'], ['arm64'], ['amd64']])(
|
||||
'getkubectlDownloadURL() - return the URL to download %s kubectl for Darwin',
|
||||
(arch) => {
|
||||
jest.spyOn(os, 'type').mockReturnValue('Darwin')
|
||||
vi.mocked(os.type).mockReturnValue('Darwin')
|
||||
const kubectlDarwinUrl = util.format(
|
||||
'https://dl.k8s.io/release/v1.15.0/bin/darwin/%s/kubectl',
|
||||
arch
|
||||
)
|
||||
expect(getkubectlDownloadURL('v1.15.0', arch)).toBe(kubectlDarwinUrl)
|
||||
expect(os.type).toBeCalled()
|
||||
expect(os.type).toHaveBeenCalled()
|
||||
}
|
||||
)
|
||||
test.each([['arm'], ['arm64'], ['amd64']])(
|
||||
'getkubectlDownloadURL() - return the URL to download %s kubectl for Windows',
|
||||
(arch) => {
|
||||
jest.spyOn(os, 'type').mockReturnValue('Windows_NT')
|
||||
vi.mocked(os.type).mockReturnValue('Windows_NT')
|
||||
const kubectlWindowsUrl = util.format(
|
||||
'https://dl.k8s.io/release/v1.15.0/bin/windows/%s/kubectl.exe',
|
||||
arch
|
||||
)
|
||||
expect(getkubectlDownloadURL('v1.15.0', arch)).toBe(kubectlWindowsUrl)
|
||||
expect(os.type).toBeCalled()
|
||||
expect(os.type).toHaveBeenCalled()
|
||||
}
|
||||
)
|
||||
test('getStableKubectlVersion() - download stable version file, read version and return it', async () => {
|
||||
jest
|
||||
.spyOn(toolCache, 'downloadTool')
|
||||
.mockReturnValue(Promise.resolve('pathToTool'))
|
||||
jest.spyOn(fs, 'readFileSync').mockReturnValue('v1.20.4')
|
||||
vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('v1.20.4')
|
||||
expect(await run.getStableKubectlVersion()).toBe('v1.20.4')
|
||||
expect(toolCache.downloadTool).toBeCalled()
|
||||
expect(toolCache.downloadTool).toHaveBeenCalled()
|
||||
expect(fs.readFileSync).toHaveBeenCalledWith('pathToTool', 'utf8')
|
||||
})
|
||||
test('getStableKubectlVersion() - return default v1.15.0 if version read is empty', async () => {
|
||||
jest
|
||||
.spyOn(toolCache, 'downloadTool')
|
||||
.mockReturnValue(Promise.resolve('pathToTool'))
|
||||
jest.spyOn(fs, 'readFileSync').mockReturnValue('')
|
||||
vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('')
|
||||
expect(await run.getStableKubectlVersion()).toBe('v1.15.0')
|
||||
expect(toolCache.downloadTool).toBeCalled()
|
||||
expect(toolCache.downloadTool).toHaveBeenCalled()
|
||||
expect(fs.readFileSync).toHaveBeenCalledWith('pathToTool', 'utf8')
|
||||
})
|
||||
test('getStableKubectlVersion() - return default v1.15.0 if unable to download file', async () => {
|
||||
jest
|
||||
.spyOn(toolCache, 'downloadTool')
|
||||
.mockRejectedValue('Unable to download.')
|
||||
vi.mocked(toolCache.downloadTool).mockRejectedValue('Unable to download.')
|
||||
expect(await run.getStableKubectlVersion()).toBe('v1.15.0')
|
||||
expect(toolCache.downloadTool).toBeCalled()
|
||||
expect(toolCache.downloadTool).toHaveBeenCalled()
|
||||
})
|
||||
test('downloadKubectl() - download kubectl, add it to toolCache and return path to it', async () => {
|
||||
jest.spyOn(toolCache, 'find').mockReturnValue('')
|
||||
jest
|
||||
.spyOn(toolCache, 'downloadTool')
|
||||
.mockReturnValue(Promise.resolve('pathToTool'))
|
||||
jest
|
||||
.spyOn(toolCache, 'cacheFile')
|
||||
.mockReturnValue(Promise.resolve('pathToCachedTool'))
|
||||
jest.spyOn(os, 'type').mockReturnValue('Windows_NT')
|
||||
jest.spyOn(fs, 'chmodSync').mockImplementation(() => {})
|
||||
vi.mocked(toolCache.find).mockReturnValue('')
|
||||
vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
|
||||
vi.mocked(toolCache.cacheFile).mockResolvedValue('pathToCachedTool')
|
||||
vi.mocked(os.type).mockReturnValue('Windows_NT')
|
||||
vi.mocked(fs.chmodSync).mockImplementation(() => {})
|
||||
expect(await run.downloadKubectl('v1.15.0')).toBe(
|
||||
path.join('pathToCachedTool', 'kubectl.exe')
|
||||
)
|
||||
expect(toolCache.find).toHaveBeenCalledWith('kubectl', 'v1.15.0')
|
||||
expect(toolCache.downloadTool).toBeCalled()
|
||||
expect(toolCache.cacheFile).toBeCalled()
|
||||
expect(os.type).toBeCalled()
|
||||
expect(toolCache.downloadTool).toHaveBeenCalled()
|
||||
expect(toolCache.cacheFile).toHaveBeenCalled()
|
||||
expect(os.type).toHaveBeenCalled()
|
||||
expect(fs.chmodSync).toHaveBeenCalledWith(
|
||||
path.join('pathToCachedTool', 'kubectl.exe'),
|
||||
'775'
|
||||
)
|
||||
})
|
||||
test('downloadKubectl() - throw DownloadKubectlFailed error when unable to download kubectl', async () => {
|
||||
jest.spyOn(toolCache, 'find').mockReturnValue('')
|
||||
jest
|
||||
.spyOn(toolCache, 'downloadTool')
|
||||
.mockRejectedValue('Unable to download kubectl.')
|
||||
vi.mocked(toolCache.find).mockReturnValue('')
|
||||
vi.mocked(toolCache.downloadTool).mockRejectedValue(
|
||||
'Unable to download kubectl.'
|
||||
)
|
||||
await expect(run.downloadKubectl('v1.15.0')).rejects.toThrow(
|
||||
'DownloadKubectlFailed'
|
||||
)
|
||||
expect(toolCache.find).toHaveBeenCalledWith('kubectl', 'v1.15.0')
|
||||
expect(toolCache.downloadTool).toBeCalled()
|
||||
expect(toolCache.downloadTool).toHaveBeenCalled()
|
||||
})
|
||||
test('downloadKubectl() - throw kubectl not found error when receive 404 response', async () => {
|
||||
const kubectlVersion = 'v1.15.0'
|
||||
const arch = 'arm128'
|
||||
jest.spyOn(os, 'arch').mockReturnValue(arch)
|
||||
jest.spyOn(toolCache, 'find').mockReturnValue('')
|
||||
jest.spyOn(toolCache, 'downloadTool').mockImplementation((_) => {
|
||||
vi.mocked(os.arch).mockReturnValue(arch as NodeJS.Architecture)
|
||||
vi.mocked(toolCache.find).mockReturnValue('')
|
||||
vi.mocked(toolCache.downloadTool).mockImplementation((_) => {
|
||||
throw new toolCache.HTTPError(404)
|
||||
})
|
||||
await expect(run.downloadKubectl(kubectlVersion)).rejects.toThrow(
|
||||
@ -143,35 +152,87 @@ describe('Testing all functions in run file.', () => {
|
||||
arch
|
||||
)
|
||||
)
|
||||
expect(os.arch).toBeCalled()
|
||||
expect(os.arch).toHaveBeenCalled()
|
||||
expect(toolCache.find).toHaveBeenCalledWith('kubectl', kubectlVersion)
|
||||
expect(toolCache.downloadTool).toBeCalled()
|
||||
expect(toolCache.downloadTool).toHaveBeenCalled()
|
||||
})
|
||||
test('downloadKubectl() - return path to existing cache of kubectl', async () => {
|
||||
jest.spyOn(core, 'getInput').mockImplementation(() => 'v1.15.5')
|
||||
jest.spyOn(toolCache, 'find').mockReturnValue('pathToCachedTool')
|
||||
jest.spyOn(os, 'type').mockReturnValue('Windows_NT')
|
||||
jest.spyOn(fs, 'chmodSync').mockImplementation(() => {})
|
||||
jest.spyOn(toolCache, 'downloadTool')
|
||||
vi.mocked(core.getInput).mockImplementation(() => 'v1.15.5')
|
||||
vi.mocked(toolCache.find).mockReturnValue('pathToCachedTool')
|
||||
vi.mocked(os.type).mockReturnValue('Windows_NT')
|
||||
vi.mocked(fs.chmodSync).mockImplementation(() => {})
|
||||
expect(await run.downloadKubectl('v1.15.0')).toBe(
|
||||
path.join('pathToCachedTool', 'kubectl.exe')
|
||||
)
|
||||
expect(toolCache.find).toHaveBeenCalledWith('kubectl', 'v1.15.0')
|
||||
expect(os.type).toBeCalled()
|
||||
expect(os.type).toHaveBeenCalled()
|
||||
expect(fs.chmodSync).toHaveBeenCalledWith(
|
||||
path.join('pathToCachedTool', 'kubectl.exe'),
|
||||
'775'
|
||||
)
|
||||
expect(toolCache.downloadTool).not.toBeCalled()
|
||||
expect(toolCache.downloadTool).not.toHaveBeenCalled()
|
||||
})
|
||||
test('getLatestPatchVersion() - download and return latest patch version', async () => {
|
||||
vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('v1.27.15')
|
||||
|
||||
const result = await getLatestPatchVersion('1', '27')
|
||||
|
||||
expect(result).toBe('v1.27.15')
|
||||
expect(toolCache.downloadTool).toHaveBeenCalledWith(
|
||||
'https://dl.k8s.io/release/stable-1.27.txt'
|
||||
)
|
||||
})
|
||||
|
||||
test('getLatestPatchVersion() - throw error when patch version is empty', async () => {
|
||||
vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('')
|
||||
|
||||
await expect(getLatestPatchVersion('1', '27')).rejects.toThrow(
|
||||
'Failed to get latest patch version for 1.27'
|
||||
)
|
||||
})
|
||||
|
||||
test('getLatestPatchVersion() - throw error when download fails', async () => {
|
||||
vi.mocked(toolCache.downloadTool).mockRejectedValue(
|
||||
new Error('Network error')
|
||||
)
|
||||
|
||||
await expect(getLatestPatchVersion('1', '27')).rejects.toThrow(
|
||||
'Failed to get latest patch version for 1.27'
|
||||
)
|
||||
})
|
||||
test('resolveKubectlVersion() - expands major.minor to latest patch', async () => {
|
||||
vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('v1.27.15')
|
||||
|
||||
const result = await run.resolveKubectlVersion('1.27')
|
||||
expect(result).toBe('v1.27.15')
|
||||
})
|
||||
|
||||
test('resolveKubectlVersion() - returns full version unchanged', async () => {
|
||||
const result = await run.resolveKubectlVersion('v1.27.15')
|
||||
expect(result).toBe('v1.27.15')
|
||||
})
|
||||
test('resolveKubectlVersion() - adds v prefix to full version', async () => {
|
||||
const result = await run.resolveKubectlVersion('1.27.15')
|
||||
expect(result).toBe('v1.27.15')
|
||||
})
|
||||
test('resolveKubectlVersion() - expands v-prefixed major.minor to latest patch', async () => {
|
||||
vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('v1.27.15')
|
||||
|
||||
const result = await run.resolveKubectlVersion('v1.27')
|
||||
expect(result).toBe('v1.27.15')
|
||||
})
|
||||
test('run() - download specified version and set output', async () => {
|
||||
jest.spyOn(core, 'getInput').mockReturnValue('v1.15.5')
|
||||
jest.spyOn(toolCache, 'find').mockReturnValue('pathToCachedTool')
|
||||
jest.spyOn(os, 'type').mockReturnValue('Windows_NT')
|
||||
jest.spyOn(fs, 'chmodSync').mockImplementation()
|
||||
jest.spyOn(core, 'addPath').mockImplementation()
|
||||
jest.spyOn(console, 'log').mockImplementation()
|
||||
jest.spyOn(core, 'setOutput').mockImplementation()
|
||||
vi.mocked(core.getInput).mockReturnValue('v1.15.5')
|
||||
vi.mocked(toolCache.find).mockReturnValue('pathToCachedTool')
|
||||
vi.mocked(os.type).mockReturnValue('Windows_NT')
|
||||
vi.mocked(fs.chmodSync).mockImplementation()
|
||||
vi.mocked(core.addPath).mockImplementation()
|
||||
vi.spyOn(console, 'log').mockImplementation()
|
||||
vi.mocked(core.setOutput).mockImplementation()
|
||||
expect(await run.run()).toBeUndefined()
|
||||
expect(core.getInput).toHaveBeenCalledWith('version', {required: true})
|
||||
expect(core.addPath).toHaveBeenCalledWith('pathToCachedTool')
|
||||
@ -181,20 +242,18 @@ describe('Testing all functions in run file.', () => {
|
||||
)
|
||||
})
|
||||
test('run() - get latest version, download it and set output', async () => {
|
||||
jest.spyOn(core, 'getInput').mockReturnValue('latest')
|
||||
jest
|
||||
.spyOn(toolCache, 'downloadTool')
|
||||
.mockReturnValue(Promise.resolve('pathToTool'))
|
||||
jest.spyOn(fs, 'readFileSync').mockReturnValue('v1.20.4')
|
||||
jest.spyOn(toolCache, 'find').mockReturnValue('pathToCachedTool')
|
||||
jest.spyOn(os, 'type').mockReturnValue('Windows_NT')
|
||||
jest.spyOn(fs, 'chmodSync').mockImplementation()
|
||||
jest.spyOn(core, 'addPath').mockImplementation()
|
||||
jest.spyOn(console, 'log').mockImplementation()
|
||||
jest.spyOn(core, 'setOutput').mockImplementation()
|
||||
vi.mocked(core.getInput).mockReturnValue('latest')
|
||||
vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
|
||||
vi.mocked(fs.readFileSync).mockReturnValue('v1.20.4')
|
||||
vi.mocked(toolCache.find).mockReturnValue('pathToCachedTool')
|
||||
vi.mocked(os.type).mockReturnValue('Windows_NT')
|
||||
vi.mocked(fs.chmodSync).mockImplementation()
|
||||
vi.mocked(core.addPath).mockImplementation()
|
||||
vi.spyOn(console, 'log').mockImplementation()
|
||||
vi.mocked(core.setOutput).mockImplementation()
|
||||
expect(await run.run()).toBeUndefined()
|
||||
expect(toolCache.downloadTool).toHaveBeenCalledWith(
|
||||
'https://storage.googleapis.com/kubernetes-release/release/stable.txt'
|
||||
'https://dl.k8s.io/release/stable.txt'
|
||||
)
|
||||
expect(core.getInput).toHaveBeenCalledWith('version', {required: true})
|
||||
expect(core.addPath).toHaveBeenCalledWith('pathToCachedTool')
|
||||
|
||||
37
src/run.ts
37
src/run.ts
@ -1,25 +1,25 @@
|
||||
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 {
|
||||
getkubectlDownloadURL,
|
||||
getKubectlArch,
|
||||
getExecutableExtension
|
||||
} from './helpers'
|
||||
getExecutableExtension,
|
||||
getLatestPatchVersion
|
||||
} from './helpers.js'
|
||||
|
||||
const kubectlToolName = 'kubectl'
|
||||
const stableKubectlVersion = 'v1.15.0'
|
||||
const stableVersionUrl =
|
||||
'https://storage.googleapis.com/kubernetes-release/release/stable.txt'
|
||||
const stableVersionUrl = 'https://dl.k8s.io/release/stable.txt'
|
||||
|
||||
export async function run() {
|
||||
let version = core.getInput('version', {required: true})
|
||||
if (version.toLocaleLowerCase() === 'latest') {
|
||||
version = await getStableKubectlVersion()
|
||||
} else {
|
||||
version = await resolveKubectlVersion(version)
|
||||
}
|
||||
const cachedPath = await downloadKubectl(version)
|
||||
|
||||
@ -89,3 +89,28 @@ export async function downloadKubectl(version: string): Promise<string> {
|
||||
fs.chmodSync(kubectlPath, '775')
|
||||
return kubectlPath
|
||||
}
|
||||
|
||||
export async function resolveKubectlVersion(version: string): Promise<string> {
|
||||
const cleanedVersion = version.trim()
|
||||
const versionMatch = cleanedVersion.match(
|
||||
/^v?(?<major>\d+)\.(?<minor>\d+)(?:\.(?<patch>\d+))?$/
|
||||
)
|
||||
|
||||
if (!versionMatch?.groups) {
|
||||
throw new Error(
|
||||
`Invalid version format: "${version}". Version must be in "major.minor" or "major.minor.patch" format (e.g., "1.27" or "v1.27.15").`
|
||||
)
|
||||
}
|
||||
|
||||
const {major, minor, patch} = versionMatch.groups
|
||||
|
||||
if (patch) {
|
||||
// Full version was provided, just ensure it has a 'v' prefix
|
||||
return cleanedVersion.startsWith('v')
|
||||
? cleanedVersion
|
||||
: `v${cleanedVersion}`
|
||||
}
|
||||
|
||||
// Patch version is missing, fetch the latest
|
||||
return await getLatestPatchVersion(major, minor)
|
||||
}
|
||||
|
||||
@ -10,7 +10,7 @@ def get_latest_version():
|
||||
time_to_sleep = 2
|
||||
for _ in range(10):
|
||||
response = requests.get(
|
||||
'https://storage.googleapis.com/kubernetes-release/release/stable.txt')
|
||||
'https://dl.k8s.io/release/stable.txt')
|
||||
if response.status_code == 200:
|
||||
break
|
||||
print('Failed to obtain latest version info, retrying.')
|
||||
|
||||
@ -1,7 +1,12 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES6",
|
||||
"module": "commonjs"
|
||||
"target": "ES2020",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"rootDir": "./src",
|
||||
"outDir": "./lib",
|
||||
"skipLibCheck": true,
|
||||
"noEmit": true
|
||||
},
|
||||
"exclude": ["node_modules", "test"]
|
||||
"exclude": ["node_modules", "**/*.test.ts", "vitest.config.ts"]
|
||||
}
|
||||
|
||||
10
vitest.config.ts
Normal file
10
vitest.config.ts
Normal file
@ -0,0 +1,10 @@
|
||||
import {defineConfig} from 'vitest/config'
|
||||
|
||||
export default defineConfig({
|
||||
test: {
|
||||
globals: true,
|
||||
environment: 'node',
|
||||
include: ['**/*.test.ts'],
|
||||
clearMocks: true
|
||||
}
|
||||
})
|
||||
Loading…
x
Reference in New Issue
Block a user