#!/usr/bin/env bash # The onboarding check, run on the release candidate before every stable # release (AGENTS.md; Release's onboarding job). Linux only, like every # golden: the macOS and Windows scenes are the same window drawn from # fixtures, so they render here too. # # 1. Renders every onboarding scene (Setting up Hex with nothing found, a # stopped download, Settings after Continue without a model, the model step with found models, with the # recommended model already present, ours downloading, Back to it, the # demo, permissions, Windows' microphone switch, the paste permission on # GNOME and KDE Wayland, Almost ready, the # practice game, Hex is ready) in both # appearances and compares each with its approved golden in # tests/golden/. Any difference fails and names the changed scenes; an # intentional change refreshes the goldens in the same PR # (HEX_UPDATE_GOLDENS=1 cargo test --bin hex onboarding_goldens). A GPU # adapter is required (Mesa's lavapipe will do), so the check never # passes by skipping. # 2. Checks Skip: it shows only on the optional pages (the demo and the # practice) and lands on the next step setup still needs (permissions, # then Almost ready while the model downloads, else Hex is ready), # never closing onboarding. Then Continue without a model: it shows only # on the download step once the download failed or stalled, finishes # onboarding, and Settings says no model is installed. # 3. Walks a first run through the real onboarding in a clean temporary # data folder (fresh settings, no models, an empty Hugging Face cache, an # English locale): it downloads and verifies the model onboarding picks, # plays the practice game, and reaches Hex is ready. # # scripts/check-onboarding.sh [] (default target/onboarding-check) # # /scenes/ holds every render, for the go/no-go message to Dax; # /summary.md says what passed. set -euo pipefail [ "$(uname -s)" = Linux ] || { echo "The onboarding check renders on Linux only." >&2; exit 1; } root=$(cd "$(dirname "$0")/.." && pwd) out=${1:-$root/target/onboarding-check} mkdir -p "$out" out=$(cd "$out" && pwd) rm -rf "$out/scenes" "$out/summary.md" mkdir -p "$out/scenes" work=$(mktemp -d) trap 'rm -rf "$work"' EXIT mkdir -p "$work/hub" cd "$root" # A golden refresh must never happen here. unset HEX_UPDATE_GOLDENS # run_one [env...]: runs exactly one test; anything but # "1 passed" (a failure, or a filter that matched nothing) fails. run_one() { local log=$1 test=$2 shift 2 env "$@" cargo test --locked --bin hex -- --exact --include-ignored --nocapture "$test" 2>&1 | tee "$log" local result=${PIPESTATUS[0]} [ "$result" = 0 ] && grep -q 'test result: ok. 1 passed' "$log" } scenes=$(awk '/^pub\(super\) const SCENES/,/^\];/' src/rune_ui/tests/onboarding_check.rs | grep -c '^ "') expected=$((scenes * 2)) status=0 goldens=pass skip=pass without_model=pass walkthrough=pass echo "== Onboarding scenes against their goldens" if ! run_one "$work/goldens.log" rune_ui::tests::onboarding_check::onboarding_goldens \ HEX_REQUIRE_GPU=1 HEX_GOLDEN_RENDERS="$out/scenes"; then goldens=fail status=1 fi rendered=$(find "$out/scenes" -name '*.png' | wc -l | tr -d ' ') if [ "$rendered" != "$expected" ]; then echo "Rendered $rendered scenes, expected $expected." >&2 goldens=fail status=1 fi changed=$(grep -oE '^[a-z0-9-]+: [0-9]+ pixels differ|rune-[a-z0-9-]+\.png is missing' "$work/goldens.log" || true) echo "== Skip only on the optional pages" if ! run_one "$work/skip.log" rune_ui::tests::onboarding_check::onboarding_skip; then skip=fail status=1 fi echo "== Continue without a model" if ! run_one "$work/without-model.log" \ rune_ui::tests::onboarding_check::onboarding_continue_without_model; then without_model=fail status=1 fi echo "== First run in a clean data folder" if ! run_one "$work/walkthrough.log" rune_ui::tests::onboarding_check::onboarding_walkthrough \ -u HF_HOME LANG=en_US.UTF-8 LC_ALL=en_US.UTF-8 LANGUAGE=en \ HEX_APPLICATION_SUPPORT_DIR="$work/support" HF_HUB_CACHE="$work/hub"; then walkthrough=fail status=1 fi { echo "### Onboarding check: $([ "$status" = 0 ] && echo pass || echo FAIL)" echo echo "- Commit: $(git rev-parse HEAD)" echo "- Scenes against goldens: $goldens ($rendered of $expected renders)" if [ -n "$changed" ]; then echo "- Changed scenes:" printf '%s\n' "$changed" | sed 's/^/ - /' fi echo "- Skip only on the demo and practice, to the next required step: $skip" echo "- Continue without a model, only after a failed or stalled download: $without_model" echo "- First run in a clean data folder: $walkthrough" grep -h '^onboarding walkthrough:' "$work/walkthrough.log" | sed 's/^/ - /' || true } > "$out/summary.md" cat "$out/summary.md" exit "$status"