phoebus_os/scripts/doctor.sh
2026-09-24 11:42:16 -07:00

106 lines
4.3 KiB
Bash
Executable file

#!/usr/bin/env bash
# Check that this machine can build, test and VM-test Phoebus.
#
# Exit status is advisory: 0 if the essentials are present, 1 otherwise.
set -uo pipefail
ok=0; warn=0; fail=0
result() { # result STATUS name detail
case "$1" in
OK) printf ' [ok] %-28s %s\n' "$2" "$3"; ok=$((ok+1)) ;;
WARN) printf ' [warn] %-28s %s\n' "$2" "$3"; warn=$((warn+1)) ;;
FAIL) printf ' [FAIL] %-28s %s\n' "$2" "$3"; fail=$((fail+1)) ;;
esac
}
have() { command -v "$1" >/dev/null 2>&1; }
echo "Phoebus host doctor"
echo "==================="
# Essentials for any work.
for c in git bash make; do
if have "$c"; then result OK "$c" "$(command -v "$c")"; else result FAIL "$c" "not found"; fi
done
# Bash reference tooling.
if have shellcheck; then result OK shellcheck "$(shellcheck --version | awk '/version:/{print $2}')"; else result WARN shellcheck "install for lint"; fi
if have dialog; then result OK dialog present; else result WARN dialog "only whiptail available"; fi
# Rust workspace.
if have cargo; then
result OK cargo "$(cargo --version | awk '{print $2}')"
if cargo fmt --version >/dev/null 2>&1; then result OK rustfmt present; else result FAIL rustfmt "cargo fmt unavailable"; fi
if cargo clippy --version >/dev/null 2>&1; then result OK clippy present; else result FAIL clippy "cargo clippy unavailable"; fi
else
result FAIL cargo "not found"
fi
# VM tooling.
for c in qemu-system-x86_64 qemu-img; do
if have "$c"; then result OK "$c" present; else result FAIL "$c" "install qemu for VM tests"; fi
done
ovmf=""
for f in /usr/share/OVMF/OVMF_CODE_4M.fd /usr/share/OVMF/OVMF_CODE.fd /usr/share/edk2/x64/OVMF_CODE.fd; do
[[ -r "$f" ]] && { ovmf="$f"; break; }
done
if [[ -n "$ovmf" ]]; then result OK OVMF "$ovmf"; else result FAIL OVMF "install ovmf-generic"; fi
if [[ -r /dev/kvm ]]; then result OK /dev/kvm "hardware acceleration"; else result WARN /dev/kvm "KVM unavailable; VM will be slow"; fi
# ISO / image tooling.
for c in xorriso 7z unsquashfs cpio zstd; do
if have "$c"; then result OK "$c" present; else result WARN "$c" "optional"; fi
done
# Python VM driver.
if have python3 && python3 -c 'import pexpect' >/dev/null 2>&1; then
result OK pexpect "python3 pexpect available"
else
result FAIL pexpect "install python3-pexpect"
fi
# Reference ISO (not required for unit tests).
iso="$(find "$(git rev-parse --show-toplevel)" -maxdepth 1 -name 'livegui-*.iso' -print -quit 2>/dev/null || true)"
if [[ -n "$iso" ]]; then result OK reference-iso "$(basename "$iso")"; else result WARN reference-iso "not found in repo root"; fi
# Disk space for build and VM targets.
vm_dir="${PHOEBUS_VM_STATE:-/var/tmp/phoebus-vm}"
build_dir="${WORKDIR:-/var/tmp/phoebus-live/build}"
mkdir -p "$vm_dir" "$build_dir" 2>/dev/null || true
vm_fs="$(df -Pk "$vm_dir" 2>/dev/null | awk 'NR==2{print $6}')"
vm_avail="$(df -Pk "$vm_dir" 2>/dev/null | awk 'NR==2{print $4}')"
build_fs="$(df -Pk "$build_dir" 2>/dev/null | awk 'NR==2{print $6}')"
build_avail="$(df -Pk "$build_dir" 2>/dev/null | awk 'NR==2{print $4}')"
if [[ -n "$vm_fs" && "$vm_fs" == "$build_fs" ]]; then
avail_gib=$(( vm_avail / 1024 / 1024 ))
if (( vm_avail >= 31457280 )); then
result OK disk-space "${avail_gib} GiB free on ${vm_fs} (shared by build & VM; want >=30 GiB for both)"
elif (( vm_avail >= 20971520 )); then
result WARN disk-space "${avail_gib} GiB free on ${vm_fs} (sufficient for VM >=20 GiB, tight for simultaneous build)"
else
result FAIL disk-space "${avail_gib} GiB free on ${vm_fs} (want >=20 GiB for VM)"
fi
else
if [[ -n "$vm_avail" ]]; then
avail_gib=$(( vm_avail / 1024 / 1024 ))
if (( vm_avail >= 20971520 )); then
result OK disk-vm "${avail_gib} GiB free on ${vm_fs} (${vm_dir})"
else
result FAIL disk-vm "${avail_gib} GiB free on ${vm_fs} (want >=20 GiB)"
fi
fi
if [[ -n "$build_avail" ]]; then
b_avail_gib=$(( build_avail / 1024 / 1024 ))
if (( build_avail >= 10485760 )); then
result OK disk-build "${b_avail_gib} GiB free on ${build_fs} (${build_dir})"
else
result WARN disk-build "${b_avail_gib} GiB free on ${build_fs} (want >=10 GiB)"
fi
fi
fi
echo
printf 'summary: %d ok, %d warnings, %d failures\n' "$ok" "$warn" "$fail"
(( fail == 0 ))