Allow specifying custom image url

Signed-off-by: Aisha Tammy <floss@bsd.ac>

.github/workflows/ci.yml

@@ -115,7 +115,6 @@ jobs:
           uname_hardware: ${{ matrix.architecture.uname || matrix.architecture.name }}
           work_directory: ${{ matrix.host.work_directory }}
 
-
   NetBSD:
     name: NetBSD ${{ matrix.architecture.name }} ${{ matrix.version }} on ${{ matrix.host.name }}
     runs-on: ${{ matrix.host.name }}
@@ -214,3 +213,23 @@ jobs:
           version: '13.1'
           hypervisor: qemu
           run: sysctl hw.model
+
+  test-custom-vm-image:
+    timeout-minutes: 5
+    name: Test custom VM image
+    runs-on: macos-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+
+      - name: Test
+        uses: ./
+        with:
+          operating_system: openbsd
+          architecture: x86-64
+          version: '7.3'
+          image_url: https://github.com/cross-platform-actions/test-custom-image-builder/releases/download/v1.0.0/openbsd-7.3-x86-64.qcow2
+          run: test -f /foo

action.yml

@@ -38,6 +38,10 @@ inputs:
   hypervisor:
     required: false
     description: The hypervisor to use when  starting the virtual machine
+  image_url:
+    required: false
+    description: URL for running the action with a custom image.
+    default: ''
 
 runs:
   using: node16

changelog.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Add support for custom image URLs ([#13](https://github.com/cross-platform-actions/action/pull/13))
 
 ## [0.17.0] - 2023-07-25
 ### Changed

readme.md

@@ -126,7 +126,7 @@ This section lists the available inputs for the action.
 | `memory`                | ❌       | `6G` or `13G`     | string  | The amount of memory for the virtual machine. The default value is `6G` for Linux runners and `13G` for macOS runners.                                                                                                   |
 | `cpu_count`             | ❌       | `2` or `3`  cores | integer | The number of CPU cores for the virtual machine. The default value is `2` for Linux runners and `3` for macOS runners.                                                                                                   |
 | `hypervisor`            | ❌       | `xhyve` or `qemu` | string  | The hypervisor to use for running the virtual machine. For Linux runners the only valid value is `qemu`. For macOS runners the default for OpenBSD and FreeBSD is `xhyve` for all other platforms the default is `qemu`. |
-
+| `image_url`             | ❌       | ❌                | string  | URL a custom VM image that should be used in place of the default ones.                                                                                                                                                  |
 
 All inputs are expected to be of the specified type. It's especially important
 that you specify `version` as a string, using single or

src/action/action.ts

@@ -133,12 +133,12 @@ export class Action {
   }
 
   async downloadDiskImage(): Promise<string> {
-    core.info(
-      `Downloading disk image: ${this.operatingSystem.virtualMachineImageUrl}`
-    )
-    const result = await cache.downloadTool(
-      this.operatingSystem.virtualMachineImageUrl
-    )
+    const imageURL =
+      this.input.imageURL !== ''
+        ? this.input.imageURL
+        : this.operatingSystem.virtualMachineImageUrl
+    core.info(`Downloading disk image: ${imageURL}`)
+    const result = await cache.downloadTool(imageURL)
     core.info(`Downloaded file: ${result}`)
 
     return result

src/action/input.ts

@@ -10,6 +10,7 @@ export class Input {
   private run_?: string
   private operatingSystem_?: os.Kind
   private version_?: string
+  private imageURL_?: string
   private shell_?: Shell
   private environmentVariables_?: string
   private architecture_?: architecture.Kind
@@ -28,6 +29,11 @@ export class Input {
     }))
   }
 
+  get imageURL(): string {
+    if (this.imageURL_ !== undefined) return this.imageURL_
+    return (this.imageURL_ = core.getInput('image_url'))
+  }
+
   get operatingSystem(): os.Kind {
     if (this.operatingSystem_ !== undefined) return this.operatingSystem_
     const input = core.getInput('operating_system', {required: true})