Fix #73: OpenBSD VM fails during "Initializing VM" with QEMU on macOS

The `Xhyve` hypervisor class was selected instead of `QemuEfi`

.github/workflows/ci.yml

@@ -396,3 +396,25 @@ jobs:
           hypervisor: qemu
           shutdown_vm: true
           run: test -f foo.txt
+
+  openbsd-qemu-macos:
+    timeout-minutes: 5
+    name: Test OpenBSD with QEMU on macOS runner
+    runs-on: macos-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Test
+        uses: ./
+        with:
+          operating_system: openbsd
+          architecture: x86-64
+          version: '7.4'
+          hypervisor: qemu
+          sync_files: false
+          shutdown_vm: false
+          run: true

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]
+### Fixed
+- OpenBSD VM fails during "Initializing VM" with QEMU on macOS ([#73](https://github.com/cross-platform-actions/action/issues/73))
 
 ### Changed
 - Update qemu to 8.2.0 for CVTPS2PD fix ([#78](https://github.com/cross-platform-actions/action/issues/78))

spec/architecture.spec.ts

@@ -1,4 +1,65 @@
 import * as architecture from '../src/architecture'
+import {Architecture} from '../src/architecture'
+import {Host} from '../src/host'
+import * as os from '../src/operating_systems/kind'
+import {Qemu, QemuEfi, Xhyve} from '../src/hypervisor'
+
+let context = describe
+
+describe('Architecture', () => {
+  describe('efiHypervisor', () => {
+    context('x86_64', () => {
+      let kind = architecture.Kind.x86_64
+
+      context('macOS host', () => {
+        let host = Host.create('darwin')
+
+        context('QEMU hypervisor', () => {
+          let selectedHypervisor = new Qemu()
+
+          context('OpenBSD', () => {
+            let osKind = os.Kind.for('openbsd')
+            let arch = Architecture.for(kind, host, osKind, selectedHypervisor)
+
+            it('returns the QEMU EFI hypervisor', () => {
+              expect(arch.efiHypervisor).toBeInstanceOf(QemuEfi)
+            })
+          })
+        })
+
+        context('Xhyve hypervisor', () => {
+          let selectedHypervisor = new Xhyve()
+
+          context('OpenBSD', () => {
+            let osKind = os.Kind.for('openbsd')
+            let arch = Architecture.for(kind, host, osKind, selectedHypervisor)
+
+            it('returns the Xhyve hypervisor', () => {
+              expect(arch.efiHypervisor).toBeInstanceOf(Xhyve)
+            })
+          })
+        })
+      })
+
+      context('Linux host', () => {
+        let host = Host.create('linux')
+
+        context('QEMU hypervisor', () => {
+          let selectedHypervisor = new Qemu()
+
+          context('OpenBSD', () => {
+            let osKind = os.Kind.for('openbsd')
+            let arch = Architecture.for(kind, host, osKind, selectedHypervisor)
+
+            it('returns the QEMU EFI hypervisor', () => {
+              expect(arch.efiHypervisor).toBeInstanceOf(QemuEfi)
+            })
+          })
+        })
+      })
+    })
+  })
+})
 
 describe('toKind', () => {
   describe('arm64', () => {

src/action/action.ts

@@ -95,7 +95,7 @@ export class Action {
     try {
       await implementation.run()
       implementation.configSSH(vm.ipAddress)
-      await implementation.wait(120)
+      await implementation.wait(240)
       await implementation.setupWorkDirectory(
         this.homeDirectory,
         this.workDirectory

src/architecture.ts

@@ -156,7 +156,7 @@ export abstract class Architecture {
     }
 
     override get efiHypervisor(): hypervisor.Hypervisor {
-      return this.host.efiHypervisor
+      return this.selectedHypervisor.efi
     }
   }
 

src/hypervisor.ts

@@ -23,6 +23,7 @@ export abstract class Hypervisor {
   abstract get sshPort(): number
   abstract get firmwareFile(): string
   abstract get vmModule(): typeof QemuVm | typeof XhyveVm
+  abstract get efi(): Hypervisor
   abstract getResourceUrl(architecture: Architecture): string
   abstract resolve<T>(implementation: Record<string, T>): T
 }
@@ -44,6 +45,10 @@ export class Xhyve extends Hypervisor {
     return XhyveVm
   }
 
+  override get efi(): Hypervisor {
+    return this
+  }
+
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   override getResourceUrl(_architecture: Architecture): string {
     return `${ResourceUrls.create().resourceBaseUrl}/xhyve-macos.tar`
@@ -73,6 +78,10 @@ export class Qemu extends Hypervisor {
     return QemuVm
   }
 
+  override get efi(): Hypervisor {
+    return new QemuEfi()
+  }
+
   override getResourceUrl(architecture: Architecture): string {
     return architecture.resourceUrl
   }

src/operating_systems/openbsd/openbsd.ts

@@ -6,7 +6,6 @@ import * as core from '@actions/core'
 import * as architecture from '../../architecture'
 import {operatingSystem} from '../factory'
 import * as vmModule from '../../vm'
-import {host} from '../../host'
 import {QemuVm} from './qemu_vm'
 import * as os from '../../operating_system'
 import versions from '../../version'
@@ -66,7 +65,7 @@ export default class OpenBsd extends os.OperatingSystem {
       uuid: this.uuid
     }
 
-    const cls = host.hypervisor.resolve({qemu: QemuVm, xhyve: XhyveVm})
+    const cls = this.hypervisor.resolve({qemu: QemuVm, xhyve: XhyveVm})
     return new cls(
       hypervisorDirectory,
       resourcesDirectory,

src/qemu_vm.ts

@@ -36,7 +36,8 @@ export abstract class Vm extends vm.Vm {
       this.hypervisorPath.toString(),
       '-daemonize',
       '-machine', `type=${this.configuration.machineType},accel=${accel}`,
-      '-cpu', this.configuration.cpu,
+      // "-pdpe1gb" == disable huge pages, otherwise OpenBSD will not boot: https://gitlab.com/qemu-project/qemu/-/issues/1091
+      '-cpu', `${this.configuration.cpu},-pdpe1gb`,
       '-smp', this.configuration.cpuCount.toString(),
       '-m', this.configuration.memory,
 
@@ -49,8 +50,9 @@ export abstract class Vm extends vm.Vm {
 
       '-boot', 'strict=off',
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      '-bios', this.configuration.firmware!.toString()
-    ].concat(this.hardDriverFlags)
+     '-bios', this.configuration.firmware!.toString(),
+      ...this.hardDriverFlags
+    ]
   }
 
   protected abstract get hardDriverFlags(): string[]