vmspawn: add integration test for machinectl VM control verbs
Add TEST-87-AUX-UTILS-VM.vmspawn.sh that validates the QMP-varlink bridge end-to-end using a real QEMU instance: - Launches vmspawn with --directory and --linux for direct kernel boot (no UEFI firmware or bootable image needed) - Waits for machine registration with machined - Verifies varlinkAddress is exposed in Machine.List - Tests machinectl pause, resume, poweroff - Exercises MachineInstance varlink interface directly via varlinkctl: QueryStatus state verification across pause/resume, Pause, Resume Skipped automatically if vmspawn, QEMU, or a bootable kernel is not available. Runs as part of TEST-87-AUX-UTILS-VM in the mkosi integration test suite. Signed-off-by: Christian Brauner (Amutable) <brauner@kernel.org>
This commit is contained in:
Christian Brauner
Executable
+319
@@ -0,0 +1,319 @@
|
||||
#!/usr/bin/env bash
|
||||
# SPDX-License-Identifier: LGPL-2.1-or-later
|
||||
# Test vmspawn QMP-varlink bridge and machinectl VM control verbs.
|
||||
set -eux
|
||||
set -o pipefail
|
||||
|
||||
# shellcheck source=test/units/util.sh
|
||||
. "$(dirname "$0")"/util.sh
|
||||
|
||||
if [[ -v ASAN_OPTIONS ]]; then
|
||||
echo "vmspawn launches QEMU which doesn't work under ASan, skipping"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
if ! command -v systemd-vmspawn >/dev/null 2>&1; then
|
||||
echo "systemd-vmspawn not found, skipping"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
if ! find_qemu_binary; then
|
||||
echo "QEMU not found, skipping"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# --directory= needs virtiofsd (on Fedora it lives in /usr/libexec, not in PATH)
|
||||
if ! command -v virtiofsd >/dev/null 2>&1 &&
|
||||
! test -x /usr/libexec/virtiofsd &&
|
||||
! test -x /usr/lib/virtiofsd; then
|
||||
echo "virtiofsd not found, skipping"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Find a kernel for direct boot
|
||||
KERNEL=""
|
||||
for k in /usr/lib/modules/"$(uname -r)"/vmlinuz /boot/vmlinuz-"$(uname -r)" /boot/vmlinuz; do
|
||||
if [[ -f "$k" ]]; then
|
||||
KERNEL="$k"
|
||||
break
|
||||
fi
|
||||
done
|
||||
|
||||
if [[ -z "$KERNEL" ]]; then
|
||||
echo "No kernel found for direct VM boot, skipping"
|
||||
exit 0
|
||||
fi
|
||||
echo "Using kernel: $KERNEL"
|
||||
|
||||
MACHINE="test-vmspawn-qmp-$$"
|
||||
WORKDIR="$(mktemp -d)"
|
||||
|
||||
at_exit() {
|
||||
set +e
|
||||
|
||||
for m in "$MACHINE" "${MACHINE2:-}" "${STRESS_MACHINE:-}"; do
|
||||
[[ -n "$m" ]] || continue
|
||||
if machinectl status "$m" &>/dev/null; then
|
||||
machinectl terminate "$m" 2>/dev/null
|
||||
timeout 10 bash -c "while machinectl status '$m' &>/dev/null; do sleep .5; done" 2>/dev/null
|
||||
fi
|
||||
done
|
||||
|
||||
[[ -n "${SUBSCRIBE_ALL_PID:-}" ]] && kill "$SUBSCRIBE_ALL_PID" 2>/dev/null && wait "$SUBSCRIBE_ALL_PID" 2>/dev/null
|
||||
[[ -n "${SUBSCRIBE_FILTER_PID:-}" ]] && kill "$SUBSCRIBE_FILTER_PID" 2>/dev/null && wait "$SUBSCRIBE_FILTER_PID" 2>/dev/null
|
||||
[[ -n "${STRESS_PID:-}" ]] && kill "$STRESS_PID" 2>/dev/null && wait "$STRESS_PID" 2>/dev/null
|
||||
[[ -n "${VMSPAWN_PID:-}" ]] && kill "$VMSPAWN_PID" 2>/dev/null && wait "$VMSPAWN_PID" 2>/dev/null
|
||||
[[ -n "${VMSPAWN2_PID:-}" ]] && kill "$VMSPAWN2_PID" 2>/dev/null && wait "$VMSPAWN2_PID" 2>/dev/null
|
||||
rm -rf "$WORKDIR"
|
||||
}
|
||||
trap at_exit EXIT
|
||||
|
||||
# Create a minimal root filesystem. The guest does not need to fully boot -- we only need QEMU running
|
||||
# with QMP. A trivial init that sleeps is sufficient.
|
||||
mkdir -p "$WORKDIR/root/sbin"
|
||||
cat >"$WORKDIR/root/sbin/init" <<'EOF'
|
||||
#!/bin/sh
|
||||
exec sleep infinity
|
||||
EOF
|
||||
chmod +x "$WORKDIR/root/sbin/init"
|
||||
|
||||
# Wait for a vmspawn machine to register with machined.
|
||||
# Skips the test gracefully if vmspawn fails due to missing vhost-user-fs support (nested VM).
|
||||
wait_for_machine() {
|
||||
local machine="$1" pid="$2" log="$3"
|
||||
timeout 30 bash -c "
|
||||
while ! machinectl list --no-legend 2>/dev/null | grep >/dev/null '$machine'; do
|
||||
if ! kill -0 $pid 2>/dev/null; then
|
||||
if grep >/dev/null 'virtiofs.*QMP\|vhost-user-fs-pci' '$log'; then
|
||||
echo 'vhost-user-fs not supported (nested VM?), skipping'
|
||||
exit 77
|
||||
fi
|
||||
echo 'vmspawn exited before registering'
|
||||
cat '$log'
|
||||
exit 1
|
||||
fi
|
||||
sleep .5
|
||||
done
|
||||
" || {
|
||||
local rc=$?
|
||||
if [[ $rc -eq 77 ]]; then exit 0; fi
|
||||
exit "$rc"
|
||||
}
|
||||
}
|
||||
|
||||
# Launch vmspawn in the background with direct kernel boot and headless console.
|
||||
systemd-vmspawn \
|
||||
--machine="$MACHINE" \
|
||||
--ram=256M \
|
||||
--directory="$WORKDIR/root" \
|
||||
--linux="$KERNEL" \
|
||||
--tpm=no \
|
||||
--console=headless \
|
||||
&>"$WORKDIR/vmspawn.log" &
|
||||
VMSPAWN_PID=$!
|
||||
|
||||
wait_for_machine "$MACHINE" "$VMSPAWN_PID" "$WORKDIR/vmspawn.log"
|
||||
echo "Machine '$MACHINE' registered with machined"
|
||||
|
||||
# Verify that controlAddress is present in Machine.List output
|
||||
varlinkctl call /run/systemd/machine/io.systemd.Machine io.systemd.Machine.List "{\"name\":\"$MACHINE\"}" | grep >/dev/null controlAddress
|
||||
echo "controlAddress exposed in Machine.List"
|
||||
|
||||
# Exercise the MachineInstance varlink interface directly via varlinkctl.
|
||||
# Look up the varlink address from machined. Do this BEFORE machinectl poweroff since poweroff
|
||||
# is destructive (either kills the machine via signal or sends ACPI shutdown).
|
||||
VARLINK_ADDR=$(varlinkctl call /run/systemd/machine/io.systemd.Machine io.systemd.Machine.List "{\"name\":\"$MACHINE\"}" | jq -r '.controlAddress')
|
||||
assert_neq "$VARLINK_ADDR" "null"
|
||||
|
||||
# Describe should reflect a running VM
|
||||
STATUS=$(varlinkctl call "$VARLINK_ADDR" io.systemd.MachineInstance.Describe '{}')
|
||||
echo "$STATUS" | jq -e '.running == true'
|
||||
echo "$STATUS" | jq -e '.status == "running"'
|
||||
echo "Describe returned running state"
|
||||
|
||||
# Pause, verify, resume via varlinkctl
|
||||
varlinkctl call "$VARLINK_ADDR" io.systemd.MachineInstance.Pause '{}'
|
||||
STATUS=$(varlinkctl call "$VARLINK_ADDR" io.systemd.MachineInstance.Describe '{}')
|
||||
echo "$STATUS" | jq -e '.running == false'
|
||||
echo "Verified paused state via Describe"
|
||||
|
||||
varlinkctl call "$VARLINK_ADDR" io.systemd.MachineInstance.Resume '{}'
|
||||
STATUS=$(varlinkctl call "$VARLINK_ADDR" io.systemd.MachineInstance.Describe '{}')
|
||||
echo "$STATUS" | jq -e '.running == true'
|
||||
echo "Verified resumed state via Describe"
|
||||
|
||||
# --- SubscribeEvents tests ---
|
||||
# Subscribe to all events in the background, collect output
|
||||
varlinkctl call --more --timeout=10 "$VARLINK_ADDR" io.systemd.MachineInstance.SubscribeEvents '{}' \
|
||||
>"$WORKDIR/events-all.json" 2>&1 &
|
||||
SUBSCRIBE_ALL_PID=$!
|
||||
sleep 0.5
|
||||
|
||||
# Trigger STOP + RESUME events via pause/resume
|
||||
varlinkctl call "$VARLINK_ADDR" io.systemd.MachineInstance.Pause '{}'
|
||||
sleep 0.2
|
||||
varlinkctl call "$VARLINK_ADDR" io.systemd.MachineInstance.Resume '{}'
|
||||
sleep 0.5
|
||||
|
||||
# Kill the subscriber and check output
|
||||
kill "$SUBSCRIBE_ALL_PID" 2>/dev/null; wait "$SUBSCRIBE_ALL_PID" 2>/dev/null || true
|
||||
cat "$WORKDIR/events-all.json"
|
||||
|
||||
# Verify initial READY event
|
||||
grep >/dev/null '"READY"' "$WORKDIR/events-all.json"
|
||||
echo "SubscribeEvents sent READY event"
|
||||
|
||||
# Verify we got both STOP and RESUME events
|
||||
grep >/dev/null '"STOP"' "$WORKDIR/events-all.json"
|
||||
grep >/dev/null '"RESUME"' "$WORKDIR/events-all.json"
|
||||
echo "SubscribeEvents received STOP and RESUME events"
|
||||
|
||||
# Test filtered subscription: only STOP events
|
||||
varlinkctl call --more --timeout=10 "$VARLINK_ADDR" io.systemd.MachineInstance.SubscribeEvents '{"filter":["STOP"]}' \
|
||||
>"$WORKDIR/events-filtered.json" 2>&1 &
|
||||
SUBSCRIBE_FILTER_PID=$!
|
||||
sleep 0.5
|
||||
|
||||
# Trigger both events again
|
||||
varlinkctl call "$VARLINK_ADDR" io.systemd.MachineInstance.Pause '{}'
|
||||
sleep 0.2
|
||||
varlinkctl call "$VARLINK_ADDR" io.systemd.MachineInstance.Resume '{}'
|
||||
sleep 0.5
|
||||
|
||||
kill "$SUBSCRIBE_FILTER_PID" 2>/dev/null; wait "$SUBSCRIBE_FILTER_PID" 2>/dev/null || true
|
||||
cat "$WORKDIR/events-filtered.json"
|
||||
|
||||
# Should have STOP but not RESUME
|
||||
grep >/dev/null '"STOP"' "$WORKDIR/events-filtered.json"
|
||||
(! grep >/dev/null '"RESUME"' "$WORKDIR/events-filtered.json")
|
||||
echo "Filtered subscription correctly received only STOP events"
|
||||
|
||||
# Test machinectl pause/resume
|
||||
machinectl pause "$MACHINE"
|
||||
echo "machinectl pause succeeded"
|
||||
|
||||
machinectl resume "$MACHINE"
|
||||
echo "machinectl resume succeeded"
|
||||
|
||||
# Test machinectl poweroff -- sends ACPI powerdown via QMP (system_powerdown).
|
||||
# The guest won't handle it (our init is just 'sleep infinity'), but the QMP command should succeed.
|
||||
machinectl poweroff "$MACHINE"
|
||||
echo "machinectl poweroff succeeded"
|
||||
|
||||
# --- Stress test: repeated start/pause/resume/terminate cycles ---
|
||||
# Exercises the varlink disconnect path, QMP reconnection, and ref counting under repeated use.
|
||||
# This catches use-after-free and double-close bugs that only manifest after multiple cycles.
|
||||
machinectl terminate "$MACHINE" 2>/dev/null
|
||||
timeout 10 bash -c "while machinectl status '$MACHINE' &>/dev/null; do sleep .5; done" 2>/dev/null
|
||||
timeout 10 bash -c "while kill -0 '$VMSPAWN_PID' 2>/dev/null; do sleep .5; done" 2>/dev/null
|
||||
|
||||
for i in $(seq 1 5); do
|
||||
echo "Stress cycle $i/5"
|
||||
|
||||
STRESS_MACHINE="test-vmspawn-stress-$i-$$"
|
||||
systemd-vmspawn \
|
||||
--machine="$STRESS_MACHINE" \
|
||||
--ram=256M \
|
||||
--directory="$WORKDIR/root" \
|
||||
--linux="$KERNEL" \
|
||||
--tpm=no \
|
||||
--console=headless \
|
||||
&>"$WORKDIR/vmspawn-stress.log" &
|
||||
STRESS_PID=$!
|
||||
|
||||
wait_for_machine "$STRESS_MACHINE" "$STRESS_PID" "$WORKDIR/vmspawn-stress.log"
|
||||
|
||||
STRESS_ADDR=$(varlinkctl call /run/systemd/machine/io.systemd.Machine \
|
||||
io.systemd.Machine.List "{\"name\":\"$STRESS_MACHINE\"}" | jq -r '.controlAddress')
|
||||
assert_neq "$STRESS_ADDR" "null"
|
||||
|
||||
# Rapid pause/resume/describe cycles
|
||||
for _ in $(seq 1 3); do
|
||||
machinectl pause "$STRESS_MACHINE"
|
||||
varlinkctl call "$STRESS_ADDR" io.systemd.MachineInstance.Describe '{}' | jq -e '.running == false' >/dev/null
|
||||
machinectl resume "$STRESS_MACHINE"
|
||||
varlinkctl call "$STRESS_ADDR" io.systemd.MachineInstance.Describe '{}' | jq -e '.running == true' >/dev/null
|
||||
done
|
||||
|
||||
machinectl terminate "$STRESS_MACHINE"
|
||||
timeout 10 bash -c "while machinectl status '$STRESS_MACHINE' &>/dev/null; do sleep .5; done"
|
||||
timeout 10 bash -c "while kill -0 '$STRESS_PID' 2>/dev/null; do sleep .5; done"
|
||||
echo "Stress cycle $i/5 passed"
|
||||
done
|
||||
echo "All stress cycles passed"
|
||||
|
||||
# Restart a fresh VM for the remaining tests
|
||||
systemd-vmspawn \
|
||||
--machine="$MACHINE" \
|
||||
--ram=256M \
|
||||
--directory="$WORKDIR/root" \
|
||||
--linux="$KERNEL" \
|
||||
--tpm=no \
|
||||
--console=headless \
|
||||
&>"$WORKDIR/vmspawn.log" &
|
||||
VMSPAWN_PID=$!
|
||||
|
||||
wait_for_machine "$MACHINE" "$VMSPAWN_PID" "$WORKDIR/vmspawn.log"
|
||||
VARLINK_ADDR=$(varlinkctl call /run/systemd/machine/io.systemd.Machine \
|
||||
io.systemd.Machine.List "{\"name\":\"$MACHINE\"}" | jq -r '.controlAddress')
|
||||
assert_neq "$VARLINK_ADDR" "null"
|
||||
|
||||
# --- Parallel multi-machine dispatch tests ---
|
||||
# Launch a second VM to test machinectl operating on multiple machines simultaneously.
|
||||
# Use a separate rootfs so each VM gets independent sidecar state (TPM, EFI NVRAM).
|
||||
MACHINE2="test-vmspawn-qmp2-$$"
|
||||
|
||||
mkdir -p "$WORKDIR/root2/sbin"
|
||||
cp "$WORKDIR/root/sbin/init" "$WORKDIR/root2/sbin/init"
|
||||
|
||||
systemd-vmspawn \
|
||||
--machine="$MACHINE2" \
|
||||
--ram=256M \
|
||||
--directory="$WORKDIR/root2" \
|
||||
--linux="$KERNEL" \
|
||||
--tpm=no \
|
||||
--console=headless \
|
||||
&>"$WORKDIR/vmspawn2.log" &
|
||||
VMSPAWN2_PID=$!
|
||||
|
||||
wait_for_machine "$MACHINE2" "$VMSPAWN2_PID" "$WORKDIR/vmspawn2.log"
|
||||
echo "Second machine '$MACHINE2' registered"
|
||||
|
||||
VARLINK_ADDR2=$(varlinkctl call /run/systemd/machine/io.systemd.Machine \
|
||||
io.systemd.Machine.List "{\"name\":\"$MACHINE2\"}" | jq -r '.controlAddress')
|
||||
assert_neq "$VARLINK_ADDR2" "null"
|
||||
|
||||
# Parallel pause: both machines at once
|
||||
machinectl pause "$MACHINE" "$MACHINE2"
|
||||
echo "Parallel pause of two machines succeeded"
|
||||
|
||||
# Verify both are paused
|
||||
varlinkctl call "$VARLINK_ADDR" io.systemd.MachineInstance.Describe '{}' | jq -e '.running == false'
|
||||
varlinkctl call "$VARLINK_ADDR2" io.systemd.MachineInstance.Describe '{}' | jq -e '.running == false'
|
||||
echo "Both machines verified paused"
|
||||
|
||||
# Parallel resume
|
||||
machinectl resume "$MACHINE" "$MACHINE2"
|
||||
echo "Parallel resume of two machines succeeded"
|
||||
|
||||
# Verify both resumed
|
||||
varlinkctl call "$VARLINK_ADDR" io.systemd.MachineInstance.Describe '{}' | jq -e '.running == true'
|
||||
varlinkctl call "$VARLINK_ADDR2" io.systemd.MachineInstance.Describe '{}' | jq -e '.running == true'
|
||||
echo "Both machines verified running"
|
||||
|
||||
# --- Terminate and verify cleanup ---
|
||||
# Parallel terminate: both machines at once (QMP quit)
|
||||
machinectl terminate "$MACHINE" "$MACHINE2"
|
||||
timeout 10 bash -c "
|
||||
while machinectl status '$MACHINE' &>/dev/null || machinectl status '$MACHINE2' &>/dev/null; do
|
||||
sleep .5
|
||||
done
|
||||
"
|
||||
echo "Parallel terminate succeeded, both VMs gone"
|
||||
|
||||
# Both vmspawn processes should have exited
|
||||
timeout 10 bash -c "while kill -0 '$VMSPAWN_PID' 2>/dev/null; do sleep .5; done"
|
||||
timeout 10 bash -c "while kill -0 '$VMSPAWN2_PID' 2>/dev/null; do sleep .5; done"
|
||||
echo "Both vmspawn processes exited"
|
||||
|
||||
echo "All vmspawn QMP-varlink bridge tests passed"
|
||||
@@ -525,3 +525,36 @@ check_nss_module() (
|
||||
|
||||
return 0
|
||||
)
|
||||
|
||||
find_qemu_binary() {
|
||||
# Mirrors find_qemu_binary() from src/vmspawn/vmspawn-util.c.
|
||||
# Returns 0 if a usable QEMU binary exists, 1 otherwise.
|
||||
for binary in qemu qemu-kvm; do
|
||||
if command -v "$binary" >/dev/null 2>&1; then
|
||||
return 0
|
||||
fi
|
||||
done
|
||||
|
||||
if test -x /usr/libexec/qemu-kvm; then
|
||||
return 0
|
||||
fi
|
||||
|
||||
local arch
|
||||
case "$(uname -m)" in
|
||||
x86_64) arch=x86_64 ;;
|
||||
i?86) arch=i386 ;;
|
||||
aarch64) arch=aarch64 ;;
|
||||
armv*l|arm*) arch=arm ;;
|
||||
alpha) arch=alpha ;;
|
||||
loongarch64) arch=loongarch64 ;;
|
||||
mips*) arch=mips ;;
|
||||
parisc*) arch=hppa ;;
|
||||
ppc64*|ppc*) arch=ppc ;;
|
||||
riscv32) arch=riscv32 ;;
|
||||
riscv64) arch=riscv64 ;;
|
||||
s390x) arch=s390x ;;
|
||||
*) return 1 ;;
|
||||
esac
|
||||
|
||||
command -v "qemu-system-$arch" >/dev/null 2>&1
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user