aboutsummaryrefslogtreecommitdiff
path: root/scripts/testing/debug-vm.sh
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-05-17 14:38:40 -0500
committerCraig Jennings <c@cjennings.net>2026-05-17 14:38:40 -0500
commit663cec6520a72680609c0d803494fb0bde4ce765 (patch)
tree17ecf5a8493f561e762826db82e93928ca5d5049 /scripts/testing/debug-vm.sh
parent79f027d4fa8a0e5abb32c6cf8c21586b73c77a39 (diff)
downloadarchsetup-663cec6520a72680609c0d803494fb0bde4ce765.tar.gz
archsetup-663cec6520a72680609c0d803494fb0bde4ce765.zip
fix(testing): cleanup traps, arg validation, and two real bugs
Two real bugs and a sweep of hygiene across the harness. `make test` passed cleanly on this branch with the same 52/0/5 profile as the 2026-05-11 run, so the wiring is verified end-to-end. Real bugs: - `lib/vm-utils.sh` `snapshot_exists` was running `qemu-img snapshot -l | grep -q "$snapshot_name"`, which matches the name as a substring anywhere in the output — including inside dates or filenames in other fields. Replaced with an awk field extraction on the TAG column plus `grep -Fxq` for a whole-line literal match. - `run-test-baremetal.sh` was setting `VALIDATION_PASSED=true|false` after validation, but `validation.sh` already uses `VALIDATION_PASSED` as a pass counter. The test report then referenced `$VALIDATION_PASSED_COUNT`, which is defined nowhere. Renamed the boolean to `TEST_PASSED` (matching run-test.sh's pattern) and report the actual counter. Cleanup traps and arg validation: - `run-test.sh` now installs a top-level EXIT trap that, on abort, kills QEMU and restores the clean-install snapshot. A `CLEANUP_DONE=1` sentinel keeps the existing normal-path cleanup from double-firing. This is the recurring pain from 2026-05-11 where two failed runs left orphaned QEMU processes and dirty base disks behind. - `create-base-vm.sh` and `debug-vm.sh` got the same kind of trap, plus `debug-vm.sh` now rejects non-`.qcow2` paths up front instead of letting QEMU fail later. - `run-test.sh`, `run-test-baremetal.sh`, and `cleanup-tests.sh` now validate that options with required values actually receive one (`${var:?msg}` for `--script`/`--snapshot`/`--host`/`--password`, numeric check for `--keep`). - `run-test-baremetal.sh` traps the temp git bundle for cleanup if the script aborts before its explicit `rm`. The ZFS rollback loop now uses `while IFS= read -r ds` and quotes `$ds` inside the ssh_cmd so dataset names with whitespace wouldn't break it. Smaller hygiene: - `vm-utils.sh` `check_ovmf` also checks `OVMF_VARS_TEMPLATE`; `start_qemu` validates disk and ISO paths before building the QEMU command; numeric tests quoted. - `cleanup-tests.sh` find expression for temp disks wrapped in `\( ... -o ... \)`, all `while read` loops use `IFS= read -r`, orphaned QEMU cleanup tries SIGTERM with a 2s sleep before SIGKILL. - `create-base-vm.sh` moved the "Copy an archangel-*.iso" info line before its `fatal` instead of after (unreachable), and added the serial-log path to the final summary. - `lib/logging.sh` `stop_timer` no longer produces `$((end - ))` when the named timer was never started. - `lib/network-diagnostics.sh` `read` → `IFS= read -r`. - `setup-testing-env.sh` now installs all missing pacman packages in one transaction instead of one-at-a-time (avoids half-installed state if package N fails). KVM check also verifies the user has read+write on `/dev/kvm` and prints the `gpasswd -a $(id -un) kvm` fix if not. A few items from the review I deliberately skipped: replacing the codebase-wide unquoted `$SSH_OPTS` string with an array (cosmetic, would need to be done everywhere at once), `set -e` adds where the existing fall-through-on-failure is intentional, and a `--force` gate on `create-base-vm.sh` (would break the expected workflow).
Diffstat (limited to 'scripts/testing/debug-vm.sh')
-rwxr-xr-xscripts/testing/debug-vm.sh18
1 files changed, 17 insertions, 1 deletions
diff --git a/scripts/testing/debug-vm.sh b/scripts/testing/debug-vm.sh
index 5b2b197..32f377c 100755
--- a/scripts/testing/debug-vm.sh
+++ b/scripts/testing/debug-vm.sh
@@ -25,7 +25,13 @@ if [ $# -eq 0 ]; then
elif [ "$1" = "--base" ]; then
USE_BASE=true
elif [ -f "$1" ]; then
- VM_DISK="$1"
+ case "$1" in
+ *.qcow2) VM_DISK="$1" ;;
+ *)
+ echo "Error: disk image must be qcow2 (got: $1)" >&2
+ exit 1
+ ;;
+ esac
else
echo "Usage: $0 [disk-image.qcow2 | --base]"
echo ""
@@ -48,6 +54,16 @@ LOGFILE="/tmp/debug-vm-$TIMESTAMP.log"
init_logging "$LOGFILE"
init_vm_paths "$VM_IMAGES_DIR"
+cleanup_debug() {
+ if declare -f vm_is_running >/dev/null 2>&1 && vm_is_running; then
+ kill_qemu 2>/dev/null || true
+ fi
+ if [ -n "$OVERLAY_DISK" ] && [ -f "$OVERLAY_DISK" ]; then
+ rm -f "$OVERLAY_DISK"
+ fi
+}
+trap cleanup_debug EXIT
+
section "Launching Debug VM"
# Determine which disk to use