Migrate to ESM with esbuild and vitest (#243)

* Migrate to ESM with esbuild, vitest and upgrade @actions/* to ESM-only versions

* fix: update lockfile for npm ci compatibility

---------

Co-authored-by: Suneha Bose <suneha.bose@gmail.com>

.github/workflows/codeql.yml

@@ -59,7 +59,7 @@ jobs:
 
          # Initializes the CodeQL tools for scanning.
          - name: Initialize CodeQL
-           uses: github/codeql-action/init@b1bff81932f5cdfc8695c7752dcee935dcd061c8 # v3.29.5
+           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@b1bff81932f5cdfc8695c7752dcee935dcd061c8 # v3.29.5
+           uses: github/codeql-action/analyze@c10b8064de6f491fea524254123dbe5e09572f13 # v4.35.1
            with:
               category: '/language:${{matrix.language}}'

jest.config.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
-      }
-   }
-}

package.json

@@ -3,10 +3,12 @@
    "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",
+      "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);\"",
-      "test": "jest",
+      "typecheck": "tsc --noEmit",
-      "test-coverage": "jest --coverage",
+      "test": "vitest run",
+      "test-coverage": "vitest run --coverage",
       "format": "prettier --write .",
       "format-check": "prettier --check .",
       "prepare": "husky"
@@ -19,18 +21,16 @@
    "author": "GitHub",
    "license": "MIT",
    "dependencies": {
-      "@actions/core": "^2.0.2",
+      "@actions/core": "^3.0.0",
-      "@actions/exec": "^2.0.0",
+      "@actions/exec": "^3.0.0",
-      "@actions/tool-cache": "^3.0.0"
+      "@actions/tool-cache": "^4.0.0"
    },
    "devDependencies": {
-      "@types/jest": "^30.0.0",
       "@types/node": "^25.0.9",
-      "@vercel/ncc": "^0.38.4",
+      "esbuild": "^0.27.4",
       "husky": "^9.1.7",
-      "jest": "^30.2.0",
       "prettier": "3.8.0",
-      "ts-jest": "^29.4.6",
+      "typescript": "5.9.3",
-      "typescript": "5.9.3"
+      "vitest": "^4.0.18"
    }
 }

src/helpers.ts

@@ -42,7 +42,7 @@ export async function getLatestPatchVersion(
       }
       return latestPatch
    } catch (error) {
-      core.debug(error)
+      core.debug(String(error))
       core.warning('GetLatestPatchVersionFailed')
       throw new Error(`Failed to get latest patch version for ${version}`)
    }

src/index.ts

@@ -1,4 +1,4 @@
-import {run} from './run'
+import {run} from './run.js'
 import * as core from '@actions/core'
 
 run().catch(core.setFailed)

src/run.test.ts

@@ -1,28 +1,43 @@
-import * as run from './run'
+import {vi, describe, test, expect, beforeEach} from 'vitest'
-import {
+import * as path from 'path'
+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
-} from './helpers'
+} = await import('./helpers.js')
-import * as os from 'os'
-import * as toolCache from '@actions/tool-cache'
-import * as fs from 'fs'
-import * as path from 'path'
-import * as core from '@actions/core'
-import * as util from 'util'
 
 describe('Testing all functions in run file.', () => {
    beforeEach(() => {
-      jest.clearAllMocks()
+      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).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).toHaveBeenCalled()
    })
@@ -33,7 +48,7 @@ describe('Testing all functions in run file.', () => {
    ])(
       'getKubectlArch() - return on %s os arch %s kubectl arch',
       (osArch, kubectlArch) => {
-         jest.spyOn(os, 'arch').mockReturnValue(osArch as NodeJS.Architecture)
+         vi.mocked(os.arch).mockReturnValue(osArch as NodeJS.Architecture)
          expect(getKubectlArch()).toBe(kubectlArch)
          expect(os.arch).toHaveBeenCalled()
       }
@@ -41,7 +56,7 @@ describe('Testing all functions in run file.', () => {
    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
@@ -53,7 +68,7 @@ describe('Testing all functions in run file.', () => {
    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
@@ -65,7 +80,7 @@ describe('Testing all functions in run file.', () => {
    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
@@ -75,40 +90,30 @@ describe('Testing all functions in run file.', () => {
       }
    )
    test('getStableKubectlVersion() - download stable version file, read version and return it', async () => {
-      jest
+      vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
-         .spyOn(toolCache, 'downloadTool')
+      vi.mocked(fs.readFileSync).mockReturnValue('v1.20.4')
-         .mockReturnValue(Promise.resolve('pathToTool'))
-      jest.spyOn(fs, 'readFileSync').mockReturnValue('v1.20.4')
       expect(await run.getStableKubectlVersion()).toBe('v1.20.4')
       expect(toolCache.downloadTool).toHaveBeenCalled()
       expect(fs.readFileSync).toHaveBeenCalledWith('pathToTool', 'utf8')
    })
    test('getStableKubectlVersion() - return default v1.15.0 if version read is empty', async () => {
-      jest
+      vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
-         .spyOn(toolCache, 'downloadTool')
+      vi.mocked(fs.readFileSync).mockReturnValue('')
-         .mockReturnValue(Promise.resolve('pathToTool'))
-      jest.spyOn(fs, 'readFileSync').mockReturnValue('')
       expect(await run.getStableKubectlVersion()).toBe('v1.15.0')
       expect(toolCache.downloadTool).toHaveBeenCalled()
       expect(fs.readFileSync).toHaveBeenCalledWith('pathToTool', 'utf8')
    })
    test('getStableKubectlVersion() - return default v1.15.0 if unable to download file', async () => {
-      jest
+      vi.mocked(toolCache.downloadTool).mockRejectedValue('Unable to download.')
-         .spyOn(toolCache, 'downloadTool')
-         .mockRejectedValue('Unable to download.')
       expect(await run.getStableKubectlVersion()).toBe('v1.15.0')
       expect(toolCache.downloadTool).toHaveBeenCalled()
    })
    test('downloadKubectl() - download kubectl, add it to toolCache and return path to it', async () => {
-      jest.spyOn(toolCache, 'find').mockReturnValue('')
+      vi.mocked(toolCache.find).mockReturnValue('')
-      jest
+      vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
-         .spyOn(toolCache, 'downloadTool')
+      vi.mocked(toolCache.cacheFile).mockResolvedValue('pathToCachedTool')
-         .mockReturnValue(Promise.resolve('pathToTool'))
+      vi.mocked(os.type).mockReturnValue('Windows_NT')
-      jest
+      vi.mocked(fs.chmodSync).mockImplementation(() => {})
-         .spyOn(toolCache, 'cacheFile')
-         .mockReturnValue(Promise.resolve('pathToCachedTool'))
-      jest.spyOn(os, 'type').mockReturnValue('Windows_NT')
-      jest.spyOn(fs, 'chmodSync').mockImplementation(() => {})
       expect(await run.downloadKubectl('v1.15.0')).toBe(
          path.join('pathToCachedTool', 'kubectl.exe')
       )
@@ -122,10 +127,10 @@ describe('Testing all functions in run file.', () => {
       )
    })
    test('downloadKubectl() - throw DownloadKubectlFailed error when unable to download kubectl', async () => {
-      jest.spyOn(toolCache, 'find').mockReturnValue('')
+      vi.mocked(toolCache.find).mockReturnValue('')
-      jest
+      vi.mocked(toolCache.downloadTool).mockRejectedValue(
-         .spyOn(toolCache, 'downloadTool')
+         'Unable to download kubectl.'
-         .mockRejectedValue('Unable to download kubectl.')
+      )
       await expect(run.downloadKubectl('v1.15.0')).rejects.toThrow(
          'DownloadKubectlFailed'
       )
@@ -135,9 +140,9 @@ describe('Testing all functions in run file.', () => {
    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 as any)
+      vi.mocked(os.arch).mockReturnValue(arch as NodeJS.Architecture)
-      jest.spyOn(toolCache, 'find').mockReturnValue('')
+      vi.mocked(toolCache.find).mockReturnValue('')
-      jest.spyOn(toolCache, 'downloadTool').mockImplementation((_) => {
+      vi.mocked(toolCache.downloadTool).mockImplementation((_) => {
          throw new toolCache.HTTPError(404)
       })
       await expect(run.downloadKubectl(kubectlVersion)).rejects.toThrow(
@@ -152,11 +157,10 @@ describe('Testing all functions in run file.', () => {
       expect(toolCache.downloadTool).toHaveBeenCalled()
    })
    test('downloadKubectl() - return path to existing cache of kubectl', async () => {
-      jest.spyOn(core, 'getInput').mockImplementation(() => 'v1.15.5')
+      vi.mocked(core.getInput).mockImplementation(() => 'v1.15.5')
-      jest.spyOn(toolCache, 'find').mockReturnValue('pathToCachedTool')
+      vi.mocked(toolCache.find).mockReturnValue('pathToCachedTool')
-      jest.spyOn(os, 'type').mockReturnValue('Windows_NT')
+      vi.mocked(os.type).mockReturnValue('Windows_NT')
-      jest.spyOn(fs, 'chmodSync').mockImplementation(() => {})
+      vi.mocked(fs.chmodSync).mockImplementation(() => {})
-      jest.spyOn(toolCache, 'downloadTool')
       expect(await run.downloadKubectl('v1.15.0')).toBe(
          path.join('pathToCachedTool', 'kubectl.exe')
       )
@@ -169,8 +173,8 @@ describe('Testing all functions in run file.', () => {
       expect(toolCache.downloadTool).not.toHaveBeenCalled()
    })
    test('getLatestPatchVersion() - download and return latest patch version', async () => {
-      jest.spyOn(toolCache, 'downloadTool').mockResolvedValue('pathToTool')
+      vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
-      jest.spyOn(fs, 'readFileSync').mockReturnValue('v1.27.15')
+      vi.mocked(fs.readFileSync).mockReturnValue('v1.27.15')
 
       const result = await getLatestPatchVersion('1', '27')
 
@@ -181,8 +185,8 @@ describe('Testing all functions in run file.', () => {
    })
 
    test('getLatestPatchVersion() - throw error when patch version is empty', async () => {
-      jest.spyOn(toolCache, 'downloadTool').mockResolvedValue('pathToTool')
+      vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
-      jest.spyOn(fs, 'readFileSync').mockReturnValue('')
+      vi.mocked(fs.readFileSync).mockReturnValue('')
 
       await expect(getLatestPatchVersion('1', '27')).rejects.toThrow(
          'Failed to get latest patch version for 1.27'
@@ -190,17 +194,17 @@ describe('Testing all functions in run file.', () => {
    })
 
    test('getLatestPatchVersion() - throw error when download fails', async () => {
-      jest
+      vi.mocked(toolCache.downloadTool).mockRejectedValue(
-         .spyOn(toolCache, 'downloadTool')
+         new Error('Network error')
-         .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 () => {
-      jest.spyOn(toolCache, 'downloadTool').mockResolvedValue('pathToTool')
+      vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
-      jest.spyOn(fs, 'readFileSync').mockReturnValue('v1.27.15')
+      vi.mocked(fs.readFileSync).mockReturnValue('v1.27.15')
 
       const result = await run.resolveKubectlVersion('1.27')
       expect(result).toBe('v1.27.15')
@@ -215,20 +219,20 @@ describe('Testing all functions in run file.', () => {
       expect(result).toBe('v1.27.15')
    })
    test('resolveKubectlVersion() - expands v-prefixed major.minor to latest patch', async () => {
-      jest.spyOn(toolCache, 'downloadTool').mockResolvedValue('pathToTool')
+      vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
-      jest.spyOn(fs, 'readFileSync').mockReturnValue('v1.27.15')
+      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')
+      vi.mocked(core.getInput).mockReturnValue('v1.15.5')
-      jest.spyOn(toolCache, 'find').mockReturnValue('pathToCachedTool')
+      vi.mocked(toolCache.find).mockReturnValue('pathToCachedTool')
-      jest.spyOn(os, 'type').mockReturnValue('Windows_NT')
+      vi.mocked(os.type).mockReturnValue('Windows_NT')
-      jest.spyOn(fs, 'chmodSync').mockImplementation()
+      vi.mocked(fs.chmodSync).mockImplementation()
-      jest.spyOn(core, 'addPath').mockImplementation()
+      vi.mocked(core.addPath).mockImplementation()
-      jest.spyOn(console, 'log').mockImplementation()
+      vi.spyOn(console, 'log').mockImplementation()
-      jest.spyOn(core, 'setOutput').mockImplementation()
+      vi.mocked(core.setOutput).mockImplementation()
       expect(await run.run()).toBeUndefined()
       expect(core.getInput).toHaveBeenCalledWith('version', {required: true})
       expect(core.addPath).toHaveBeenCalledWith('pathToCachedTool')
@@ -238,17 +242,15 @@ describe('Testing all functions in run file.', () => {
       )
    })
    test('run() - get latest version, download it and set output', async () => {
-      jest.spyOn(core, 'getInput').mockReturnValue('latest')
+      vi.mocked(core.getInput).mockReturnValue('latest')
-      jest
+      vi.mocked(toolCache.downloadTool).mockResolvedValue('pathToTool')
-         .spyOn(toolCache, 'downloadTool')
+      vi.mocked(fs.readFileSync).mockReturnValue('v1.20.4')
-         .mockReturnValue(Promise.resolve('pathToTool'))
+      vi.mocked(toolCache.find).mockReturnValue('pathToCachedTool')
-      jest.spyOn(fs, 'readFileSync').mockReturnValue('v1.20.4')
+      vi.mocked(os.type).mockReturnValue('Windows_NT')
-      jest.spyOn(toolCache, 'find').mockReturnValue('pathToCachedTool')
+      vi.mocked(fs.chmodSync).mockImplementation()
-      jest.spyOn(os, 'type').mockReturnValue('Windows_NT')
+      vi.mocked(core.addPath).mockImplementation()
-      jest.spyOn(fs, 'chmodSync').mockImplementation()
+      vi.spyOn(console, 'log').mockImplementation()
-      jest.spyOn(core, 'addPath').mockImplementation()
+      vi.mocked(core.setOutput).mockImplementation()
-      jest.spyOn(console, 'log').mockImplementation()
-      jest.spyOn(core, 'setOutput').mockImplementation()
       expect(await run.run()).toBeUndefined()
       expect(toolCache.downloadTool).toHaveBeenCalledWith(
          'https://dl.k8s.io/release/stable.txt'

src/run.ts

@@ -8,7 +8,7 @@ import {
    getKubectlArch,
    getExecutableExtension,
    getLatestPatchVersion
-} from './helpers'
+} from './helpers.js'
 
 const kubectlToolName = 'kubectl'
 const stableKubectlVersion = 'v1.15.0'

tsconfig.json

@@ -1,8 +1,12 @@
 {
    "compilerOptions": {
       "target": "ES2020",
-      "module": "commonjs",
+      "module": "NodeNext",
-      "lib": ["ES2020", "DOM"]
+      "moduleResolution": "NodeNext",
+      "rootDir": "./src",
+      "outDir": "./lib",
+      "skipLibCheck": true,
+      "noEmit": true
    },
-   "exclude": ["node_modules", "test"]
+   "exclude": ["node_modules", "**/*.test.ts", "vitest.config.ts"]
 }

vitest.config.ts

@@ -0,0 +1,10 @@
+import {defineConfig} from 'vitest/config'
+
+export default defineConfig({
+   test: {
+      globals: true,
+      environment: 'node',
+      include: ['**/*.test.ts'],
+      clearMocks: true
+   }
+})