CI and build scripts for the eMoflon::IBeX VM based on Ubuntu.
Go to file
Maximilian Kratz f7bbcb52c2
Merge pull request #50 from eMoflon/feature/fix-runner-setup-script
Runner setup script: Adds `curl` + fixes `vboxusers` group + fixes/updates `vagrant` version
2024-05-19 15:24:14 +02:00
.github/workflows Updates the base (X)Ubuntu image to 24.04 2024-05-12 13:09:35 +02:00
.gitignore Adds URLs/website links to the desktop 2022-11-07 14:21:42 +01:00
LICENSE Add LICENSE 2022-08-04 15:17:22 +02:00
prov.sh Adds an installation task for additional CLI tools 2024-05-16 16:12:49 +02:00
README.md Updates the base (X)Ubuntu image to 24.04 2024-05-12 13:09:35 +02:00
runner-setup.sh Runner setup script: adds curl + fixes vbox grp + fixes vagrant version 2024-05-19 15:22:28 +02:00
Vagrantfile Updates the base (X)Ubuntu image to 24.04 2024-05-12 13:09:35 +02:00

eMoflon::IBeX VM

Build eMoflon::IBeX VM

This repository is used to automatically build an eMoflon virtual machine (VM).

Packages/Configuration

Usage/Installation

  • Download the latest version from the release page.
  • Install VirtualBox (or another Hypervisor compatible to OVA files).
  • Import the OVA file as new VM in VirtualBox. (More detailed description can be found here.)
  • Use the credentials vagrant:vagrant to login.
  • Use the Eclipse icon on the desktop to start eMoflon.

Please notice:

  • The default configuration for this VM image consists 8GB of RAM and 2 vCPU cores. You need at least 8GB to run the full eMoflon::IBeX test suite. If your PC only has 8GB of RAM available, reduce the RAM capacity of the VM within VirtualBox
  • It is recommend to change the settings to at least 4 vCPU cores.

Runner requirements

There are two ways to provide this project with runners.

GitHub-hosted macOS-based runners

Unfortunately, only the macOS-based GitHub-hosted action runners do support nested virtualization: https://github.com/actions/runner-images/issues/433

Therefore, we've adapted the CI-configuration to provision the eMoflon-IBeX-VM on a macOS-based runner until nested virtualization support gets added to the Linux-based runners.

Unfortunately, these workflows did break very often lately so we switched back to self-hosted Linux-based runners.

Self-hosted Linux-based runners

Currently, all actions must be run by a self-hosted GitHub runner, because GitHub-hosted runners do not provide the VT-x flag:

[...]
==> ubuntu: Booting VM...
There was an error while executing `VBoxManage`, a CLI used by Vagrant
for controlling VirtualBox. The command and stderr is shown below.

Command: ["startvm", "594c50ca-4ec6-4ff6-b785-2c6ba627bffd", "--type", "headless"]

Stderr: VBoxManage: error: VT-x is not available (VERR_VMX_NO_VMX)
VBoxManage: error: Details: code NS_ERROR_FAILURE (0x80004005), component ConsoleWrap, interface IConsole
Error: Process completed with exit code 1.

In order to run the "GitHub Actions" pipeline on a self-hosted runner, you must ensure that you have at least one properly configured Linux-based runner added to this GitHub project.

Required packages (at least):

  • curl
  • wget
  • grep
  • VirtualBox
  • vagrant

Please keep in mind that your runner (VM) needs the virtualization flag enabled and at least 10 GB of RAM!