feat: run command at the end

Author: jkroepke

.editorconfig

@@ -3,11 +3,8 @@ root = true
 [*]
 charset = utf-8
 indent_style = space
-indent_size = 4
+indent_size = 2
 insert_final_newline = true
 trim_trailing_whitespace = true
 end_of_line = lf
 max_line_length = 160
-
-[*.{yaml,yml,json}]
-indent_size = 2

.env

@@ -9,14 +9,14 @@ ACTIONS_STEP_DEBUG=true
 
 # GitHub Actions inputs should follow `INPUT_<name>` format (case-sensitive).
 # Hyphens should not be converted to underscores!
-INPUT_MILLISECONDS=2400
+INPUT_VERSION=stable
 
 # GitHub Actions default environment variables. These are set for every run of a
 # workflow and can be used in your actions. Setting the value here will override
 # any value set by the local-action tool.
 # https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
 
-# CI="true"
+CI=true
 # GITHUB_ACTION=""
 # GITHUB_ACTION_PATH=""
 # GITHUB_ACTION_REPOSITORY=""
@@ -53,9 +53,9 @@ INPUT_MILLISECONDS=2400
 # GITHUB_WORKFLOW_REF=""
 # GITHUB_WORKFLOW_SHA=""
 # GITHUB_WORKSPACE=""
-# RUNNER_ARCH=""
+RUNNER_ARCH=X64
 # RUNNER_DEBUG=""
 # RUNNER_NAME=""
-# RUNNER_OS=""
+RUNNER_OS=Linux
 RUNNER_TEMP=.local/tmp
 RUNNER_TOOL_CACHE=.local/cache

.github/workflows/ci.yml

@@ -1,6 +1,3 @@
-env:
-  RUNNER_DEBUG: 1
-
 name: 'CI'
 on: # rebuild any PRs and main branch changes
   pull_request:
@@ -19,7 +16,7 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
-          node-version: '22'
+          node-version-file: package.json
       - run: |
           npm install
           npm run all
@@ -32,9 +29,13 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
+    env:
+      RUNNER_DEBUG: 1
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - uses: ./
+        with:
+          version: 'latest'
       - name: Get the version
         run: stackit --version
       - uses: ./

__fixtures__/core.ts

@@ -1,6 +1,7 @@
 import type * as core from '@actions/core'
 import { jest } from '@jest/globals'
 
+export const addPath = jest.fn<typeof core.addPath>()
 export const debug = jest.fn<typeof core.debug>()
 export const error = jest.fn<typeof core.error>()
 export const info = jest.fn<typeof core.info>()

__tests__/main.test.ts

@@ -5,9 +5,16 @@
  * functions and objects. For example, the core module is mocked in this test,
  * so that the actual '@actions/core' module is not imported.
  */
+
+import fs from 'fs/promises'
+import os from 'os'
+import path from 'path'
+
 import { jest } from '@jest/globals'
 import * as core from '../__fixtures__/core.js'
 
+import { toolName, defaultVersion } from '../src/tool.js'
+
 // Mocks should be declared before the module being tested is imported.
 jest.unstable_mockModule('@actions/core', () => core)
 
@@ -16,26 +23,70 @@ jest.unstable_mockModule('@actions/core', () => core)
 const { run } = await import('../src/main.js')
 
 describe('main.ts', () => {
-  beforeEach(() => {
+  const OLD_ENV = process.env
+
+  beforeEach(async () => {
     // Set the action's inputs as return values from core.getInput().
-    core.getInput.mockImplementation(() => '500')
+    core.getInput.mockImplementation(() => defaultVersion.replaceAll('v', ''))
+    process.env = { ...OLD_ENV } // Make a copy
+
+    switch (os.type()) {
+      case 'Linux':
+        process.env.RUNNER_OS = 'Linux'
+        break
+      case 'Darwin':
+        process.env.RUNNER_OS = 'macOS'
+        break
+      case 'Windows_NT':
+        process.env.RUNNER_OS = 'Windows'
+        break
+      default:
+        throw new Error(`Unsupported OS: ${os.type()}`)
+    }
+
+    process.env.RUNNER_ARCH = 'X86_64'
+
+    process.env.RUNNER_TEMP = await fs.mkdtemp(
+      path.join(os.tmpdir(), `${toolName}-runner-temp-`)
+    )
+
+    process.env.RUNNER_TOOL_CACHE = await fs.mkdtemp(
+      path.join(os.tmpdir(), `${toolName}-tool-cache-`)
+    )
   })
 
-  afterEach(() => {
+  afterEach(async () => {
+    if (process.env.RUNNER_TOOL_CACHE) {
+      await fs.rm(process.env.RUNNER_TOOL_CACHE, {
+        recursive: true,
+        force: true
+      })
+    }
+
+    if (process.env.RUNNER_TEMP) {
+      await fs.rm(process.env.RUNNER_TEMP, {
+        recursive: true,
+        force: true
+      })
+    }
+
     jest.resetAllMocks()
+    process.env = OLD_ENV // Restore old environment
   })
 
   it('Run main', async () => {
     await run()
 
-    /*
+    // Verify that no errors were thrown.
+    expect(core.setFailed).not.toHaveBeenCalled()
+
     // Verify the time output was set.
     expect(core.setOutput).toHaveBeenNthCalledWith(
       1,
-      'sops-path',
-      // Simple regex to match a time string in the format HH:MM:SS.
-      expect.stringMatching(/^sops/)
+      'path',
+      expect.stringMatching(
+        new RegExp(`${toolName}[/\\\\]${defaultVersion.replaceAll('v', '')}`)
+      )
     )
-    */
   })
 })

jest.config.js

@@ -27,6 +27,7 @@ export default {
   testEnvironment: 'node',
   testMatch: ['**/*.test.ts'],
   testPathIgnorePatterns: ['/dist/', '/node_modules/'],
+  testTimeout: 30000,
   transform: {
     '^.+\\.ts$': [
       'ts-jest',

package-lock.json

@@ -8,24 +8,25 @@
   "license": "MIT",
   "dependencies": {
     "@actions/core": "^1.11.1",
+    "@actions/exec": "^1.1.1",
     "@actions/http-client": "^2.2.1",
     "@actions/tool-cache": "^2.0.2",
     "semver": "^7.7.1"
   },
   "engines": {
-    "node": ">=20"
+    "node": "^20 || ^22"
   },
   "scripts": {
     "bundle": "npm run format:write && npm run package",
-    "ci-test": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 npx jest",
+    "ci-test": "cross-env NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 npx jest",
     "coverage": "npx make-coverage-badge --output-path ./badges/coverage.svg",
     "format:write": "npx prettier --write .",
     "format:check": "npx prettier --check .",
     "lint": "npx eslint .",
     "local-action": "npx @github/local-action . src/main.ts .env",
     "package": "npx rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",
     "package:watch": "npm run package -- --watch",
-    "test": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 npx jest",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 npx jest",
     "all": "npm run format:write && npm run lint && npm run test && npm run coverage && npm run package",
     "prepare": "husky"
   },
@@ -44,6 +45,7 @@
     "@types/semver": "^7.7.0",
     "@typescript-eslint/eslint-plugin": "^8.31.0",
     "@typescript-eslint/parser": "^8.31.0",
+    "cross-env": "^7.0.3",
     "eslint": "^9.25.1",
     "eslint-config-prettier": "^10.1.2",
     "eslint-import-resolver-typescript": "^4.3.4",

package.json

@@ -1,18 +1,18 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
+import fs from 'fs'
 
 import * as core from '@actions/core'
+import { exec } from '@actions/exec'
 import { HttpClient } from '@actions/http-client'
+import * as toolCache from '@actions/tool-cache'
+
 import {
   binaryName,
   githubRepository,
   toolName,
   defaultVersion,
-  extractBinary
+  extractBinary,
+  getVersionArguments,
 } from './tool.js'
-import * as toolCache from '@actions/tool-cache'
-import * as util from 'util'
-import fs from 'fs'
 
 /**
  * Get the executable extension based on the OS.
@@ -108,26 +108,19 @@ async function download(version: string): Promise<string> {
   const runnerOs = getRunnerOS()
   const runnerArch = getRunnerArch()
   const binaryFileName = toolName + getExecutableExtension()
-  const url = util.format(
-    'https://github.com/%s/releases/download/%s/%s',
-    githubRepository,
-    version,
-    binaryName(version, runnerOs, runnerArch)
-  )
+  const url = `https://github.com/${githubRepository}/releases/download/${version}/${binaryName(version, runnerOs, runnerArch)}`
 
   let cachedToolPath = toolCache.find(toolName, version)
-  if (!cachedToolPath) {
+  if (cachedToolPath) {
+    core.info(`Restoring '${version}' from cache`)
+  } else {
+    core.info(`Downloading '${version}' from '${url}'`)
     let downloadPath
     try {
       downloadPath = await toolCache.downloadTool(url)
     } catch (exception) {
       throw new Error(
-        util.format(
-          'Failed to download %s from location %s. Error: %s',
-          toolName,
-          url,
-          exception
-        )
+        `Failed to download ${toolName} from location ${url}. Error: ${exception}`
       )
     }
 
@@ -144,11 +137,7 @@ async function download(version: string): Promise<string> {
     cachedToolPath = toolCache.find(toolName, version)
     if (!cachedToolPath) {
       throw new Error(
-        util.format(
-          '%s executable not found in path %s',
-          binaryFileName,
-          cachedToolPath
-        )
+        `${binaryFileName} executable not found in path ${cachedToolPath}`
       )
     }
   }
@@ -164,7 +153,9 @@ async function download(version: string): Promise<string> {
 export async function run(): Promise<void> {
   try {
     let version = core.getInput('version', { required: true })
-    if (version.toLocaleLowerCase() === 'latest') {
+    if (version.toLocaleLowerCase() === 'stable') {
+      version = defaultVersion
+    } else if (version.toLocaleLowerCase() === 'latest') {
       version = await latestVersion(githubRepository, toolName, defaultVersion)
     } else if (!version.toLocaleLowerCase().startsWith('v')) {
       version = 'v' + version
@@ -177,6 +168,12 @@ export async function run(): Promise<void> {
       `${toolName} version: '${version}' has been cached at ${cachedPath}`
     )
     core.setOutput('path', cachedPath)
+
+    await exec(toolName + getExecutableExtension(), getVersionArguments(), {
+      env: {
+        PATH: `${cachedPath}`
+      }
+    })
   } catch (error) {
     // Fail the workflow run if an error occurs
     if (error instanceof Error) core.setFailed(error.message)

src/main.ts

@@ -1,5 +1,5 @@
 import { clean } from 'semver'
-import { extractTar } from '@actions/tool-cache'
+import { extractTar, extractZip } from '@actions/tool-cache'
 
 export const toolName = 'stackit'
 export const githubRepository = 'stackitcloud/stackit-cli'
@@ -19,7 +19,17 @@ export async function extractBinary(
   os: string,
   _arch: string
 ): Promise<string> {
-  const extractedFolder = await extractTar(path)
+  let extractedFolder
+
+  if (os === 'windows') {
+    extractedFolder = await extractZip(path)
+  } else {
+    extractedFolder = await extractTar(path)
+  }
 
   return `${extractedFolder}/${toolName}${os === 'windows' ? '.exe' : ''}`
 }
+
+export function getVersionArguments(): string[] {
+  return ['--version']
+}