vmtest-action

This action wraps vmtest with a standard Github Actions interface to make it easy to plug vmtest into your CI.

This action is designed to easily "drop in" to your existing CI workflows by leveraging vmtest's ability to map the host userspace into the guest VM. In other words, any dependency wrangling or setup you do on the root host can be used inside the VM without additional configuration.

Please be aware that vmtest-action performance may be degraded unless your job is running on a large or self-hosted GHA runner. See vmtest's FAQ for more details.

Usage

See action.yml for full manifest.

Inputs

The following input parameters map 1:1 with vmtest target fields. Please see the link for full documentation. But for reference, here are the available inputs again:

name
image
uefi
kernel
kernel_args
command

In contrast to the above, the below input parameters only exist in vmtest-action and are for convenience:

image_url
- Virtual machine image to download and use.
- Cannot be used in conjunction with image parameter.
kernel_url
- Kernel to download and use.
- Cannot be used in conjunction with kernel parameter.

Example project

This repository shows off a simple but powerful example: https://github.com/danobi/vmtest-action-demo

Example usage

steps:
- uses: actions/checkout@v3
- uses: danobi/vmtest-action@master
  with:
    kernel: './kernels/bzImage-5.15.0-1022-aws'
    command: "/bin/bash -c 'uname -r | grep -e aws$'"

Example workflow

name: vmtest

on:
  push:
    branches: [ "master" ]
  pull_request:
    branches: [ "master" ]

jobs:
  build-test:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3

    - name: Run main.sh on "default" kernel
      run: |
        ./main.sh

    - name: Run main.sh in specified kernel but with same userspace
      uses: danobi/vmtest-action@master
      with:
        kernel_url: https://github.com/danobi/vmtest/releases/download/test_assets/bzImage-v6.2-empty
        command: ${{ github.workspace }}./main.sh

danobi / vmtest-action