Merge pull request #2 from balena-io-experimental/kyle/outputs

Populate action outputs for path and version

Author: klutchell

.github/actions/test/action.yml

@@ -9,8 +9,7 @@ runs:
       id: setup-oras-cli
     - name: Print outputs
       shell: bash
-      run: |
-        echo "Installed version: ${{ steps.setup-oras-cli.outputs.version }}"
+      run: echo "${{ toJSON(steps.setup-oras-cli.outputs) }}"
     - name: Test CLI
       shell: bash
       run: oras version

.github/workflows/flowzone.yml

@@ -25,3 +25,11 @@ jobs:
     secrets: inherit
     with:
       restrict_custom_actions: false
+      custom_test_matrix: >
+        {
+          "os": [
+            ["ubuntu-latest"],
+            ["macos-latest"],
+            ["windows-latest"]
+          ],
+        }

.prettierignore

@@ -1,3 +1,5 @@
 dist/
 node_modules/
-coverage/
+coverage/
+CHANGELOG.md
+.versionbot/

README.md

@@ -21,6 +21,7 @@ To use this action in your workflow, add the following step:
 
 ### Outputs
 
+- `path`: The path where the ORAS CLI was installed.
 - `version`: The ORAS CLI release that was installed.
 
 ## Contributing

__tests__/main.test.js

@@ -93,6 +93,40 @@ describe('ORAS setup action', () => {
         'https://github.com/oras-project/oras/releases/download/v1.2.3/oras_1.2.3_linux_amd64.tar.gz'
       )
     })
+    it('constructs correct download URL for windows', () => {
+      const url = main.getDownloadURL('1.2.3', 'windows', 'amd64')
+      expect(url).toBe(
+        'https://github.com/oras-project/oras/releases/download/v1.2.3/oras_1.2.3_windows_amd64.zip'
+      )
+    })
+  })
+
+  describe('execVersion', () => {
+    it('executes version command', async () => {
+      const exec = require('@actions/exec')
+      exec.getExecOutput = jest.fn().mockResolvedValue({
+        exitCode: 0,
+        stdout: 'Version: 1.2.3',
+        stderr: ''
+      })
+
+      await main.execVersion()
+
+      expect(exec.getExecOutput).toHaveBeenCalledWith('oras', ['version'])
+    })
+
+    it('handles version command failure', async () => {
+      const exec = require('@actions/exec')
+      // exec.getExecOutput.mockRejectedValue(new Error('Version command failed'))
+
+      exec.getExecOutput = jest.fn().mockResolvedValue({
+        exitCode: 1,
+        stdout: '',
+        stderr: 'Version command failed'
+      })
+
+      await expect(main.execVersion()).rejects.toThrow('Version command failed')
+    })
   })
 
   describe('setup', () => {
@@ -101,6 +135,12 @@ describe('ORAS setup action', () => {
       tc.downloadTool.mockResolvedValue('/path/to/download')
       tc.extractTar.mockResolvedValue('/path/to/cli')
       core.getInput.mockReturnValue('1.2.3')
+      const exec = require('@actions/exec')
+      exec.getExecOutput = jest.fn().mockResolvedValue({
+        exitCode: 0,
+        stdout: 'Version: 1.2.3',
+        stderr: ''
+      })
     })
 
     it('downloads and extracts CLI successfully', async () => {
@@ -111,6 +151,12 @@ describe('ORAS setup action', () => {
 
       // Verify PATH addition
       expect(core.addPath).toHaveBeenCalledWith('/path/to/cli')
+
+      // Verify path output is set
+      expect(core.setOutput).toHaveBeenCalledWith('path', '/path/to/cli')
+
+      // Verify version output is set
+      expect(core.setOutput).toHaveBeenCalledWith('version', '1.2.3')
     })
 
     it('handles download failure', async () => {

action.yml

@@ -6,9 +6,11 @@ inputs:
   version:
     description: 'The ORAS CLI release to install'
     required: false
-    default: ' 1.2.0'
+    default: '1.2.0'
 
 outputs:
+  path:
+    description: 'The path where the ORAS CLI was installed'
   version:
     description: 'The ORAS CLI release that was installed'
 

dist/index.js

@@ -3,8 +3,11 @@ const tc = require('@actions/tool-cache')
 
 function getDownloadURL(version, platform, arch) {
   // Construct the download URL
+  // See: https://github.com/oras-project/oras/releases/tag/v1.2.0
   // e.g. https://github.com/oras-project/oras/releases/download/v1.2.0/oras_1.2.0_linux_arm64.tar.gz
-  return `https://github.com/oras-project/oras/releases/download/v${version}/oras_${version}_${platform}_${arch}.tar.gz`
+  // e.g. https://github.com/oras-project/oras/releases/download/v1.2.0/oras_1.2.0_windows_amd64.zip
+  const extension = platform === 'windows' ? 'zip' : 'tar.gz'
+  return `https://github.com/oras-project/oras/releases/download/v${version}/oras_${version}_${platform}_${arch}.${extension}`
 }
 
 function getVersion() {
@@ -50,6 +53,18 @@ function getPlatform() {
   }
 }
 
+// Call the tool to print the version
+async function execVersion() {
+  const exec = require('@actions/exec')
+  const { exitCode, stdout, stderr } = await exec.getExecOutput('oras', [
+    'version'
+  ])
+  if (exitCode !== 0) {
+    throw new Error(stderr)
+  }
+  return stdout.match(/Version:\s*([\d.]+)/)[1]
+}
+
 async function setup() {
   const version = getVersion()
   const platform = getPlatform()
@@ -65,12 +80,18 @@ async function setup() {
 
   // Expose the tool by adding it to the PATH
   core.addPath(pathToCLI)
+
+  const versionOutput = await execVersion()
+
+  core.setOutput('path', pathToCLI)
+  core.setOutput('version', versionOutput.trim())
 }
 
 module.exports = {
   setup,
   getVersion,
   getPlatform,
   getArch,
-  getDownloadURL
+  getDownloadURL,
+  execVersion
 }