Files
omarchycn/test/shell.d/compositor-guard-test.sh
b97a1480dc Treat the guard test's socket fixture as optional (#6755)
Standing in for an abandoned compositor means binding a Unix socket, and the
sandboxes this guard exists for are the ones that deny it: the fixture raised
PermissionError and took the whole file down with set -e, adding a failure in
the environment the guard was written to keep clean. Run the cases that need no
socket first and skip the rest when one cannot be bound.

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-12 16:58:46 +02:00

114 lines
4.3 KiB
Bash

#!/bin/bash
set -euo pipefail
source "$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)/base-test.sh"
test_dir=$(mktemp -d)
trap 'rm -rf "$test_dir"' EXIT
runtime_dir="$test_dir/run"
stub_bin="$test_dir/bin"
mkdir -p "$runtime_dir" "$stub_bin"
# A bound AF_UNIX socket outlives the process that bound it, which is exactly the
# corpse a dead compositor leaves behind. Binding one is the only way to get a
# file that passes -S, and the sandboxes this guard exists for are the ones that
# deny it, so treat the fixture as optional rather than fail there.
socket_bound=1
if command -v python3 >/dev/null; then
python3 -c 'import socket, sys; socket.socket(socket.AF_UNIX).bind(sys.argv[1])' \
"$runtime_dir/wayland-1" 2>/dev/null || socket_bound=0
else
socket_bound=0
fi
attempts_log="$test_dir/hyprctl-attempts"
stub_hyprctl() {
: >"$attempts_log"
cat >"$stub_bin/hyprctl" <<STUB
#!/bin/bash
echo asked >>"$attempts_log"
exit $1
STUB
chmod +x "$stub_bin/hyprctl"
}
# Answers only from the second query on, the way Hyprland behaves while it is
# busy reconfiguring outputs.
stub_flaky_hyprctl() {
: >"$attempts_log"
cat >"$stub_bin/hyprctl" <<STUB
#!/bin/bash
echo asked >>"$attempts_log"
(( \$(grep -c asked "$attempts_log") > 1 ))
STUB
chmod +x "$stub_bin/hyprctl"
}
attempts() {
grep -c asked "$attempts_log" || true
}
# The guard exits the shell it runs in, so run it in a child and report back what
# it did: the skip line, or the core limit it left behind for Quickshell.
run_guard() {
env "$@" PATH="$stub_bin:$PATH" bash -c '
source "$1/base-test.sh"
ulimit -c unlimited 2>/dev/null || true
require_compositor "sample runtime test"
printf "launched with core limit %s\n" "$(ulimit -c)"
' bash "$SHELL_TEST_DIR" 2>&1 || printf 'guard exited %s\n' "$?"
}
skipped="ok - no Wayland compositor; skipping sample runtime test"
output=$(run_guard -u WAYLAND_DISPLAY XDG_RUNTIME_DIR="$runtime_dir")
[[ $output == "$skipped" ]] || fail "guard skips without a display" "$output"
pass "guard skips without a display"
# The sandbox shape from the bug report: the variable comes through, the runtime
# directory does not.
output=$(run_guard WAYLAND_DISPLAY=wayland-1 XDG_RUNTIME_DIR="$test_dir/blocked")
[[ $output == "$skipped" ]] || fail "guard skips when the socket is unreachable" "$output"
pass "guard skips when the socket is unreachable"
# Everything below needs a socket to stand in for a live or abandoned compositor.
if (( ! socket_bound )); then
pass "cannot bind a Unix socket here; skipping the cases that need one"
exit 0
fi
# Hyprland can miss a single query mid-reconfigure, so only a compositor that
# stays silent counts as gone.
stub_hyprctl 1
output=$(run_guard WAYLAND_DISPLAY=wayland-1 XDG_RUNTIME_DIR="$runtime_dir" HYPRLAND_INSTANCE_SIGNATURE=test)
[[ $output == "$skipped" ]] || fail "guard skips when the compositor stopped answering" "$output"
pass "guard skips when the compositor stopped answering"
[[ $(attempts) == 3 ]] || fail "guard retries a silent compositor before giving up" "asked $(attempts) times"
pass "guard retries a silent compositor before giving up"
stub_flaky_hyprctl
output=$(run_guard WAYLAND_DISPLAY=wayland-1 XDG_RUNTIME_DIR="$runtime_dir" HYPRLAND_INSTANCE_SIGNATURE=test)
[[ $output == "launched with core limit 0" ]] || fail "guard rides out a missed query" "$output"
pass "guard rides out a missed query"
# Without a signature there is nothing to ask, and a live socket is all the
# evidence there is: run rather than skip real coverage.
stub_hyprctl 1
output=$(run_guard -u HYPRLAND_INSTANCE_SIGNATURE WAYLAND_DISPLAY=wayland-1 XDG_RUNTIME_DIR="$runtime_dir")
[[ $output == "launched with core limit 0" ]] || fail "guard runs when hyprctl cannot be asked" "$output"
pass "guard runs when hyprctl cannot be asked"
[[ $(attempts) == 0 ]] || fail "guard leaves hyprctl alone without a signature" "asked $(attempts) times"
pass "guard leaves hyprctl alone without a signature"
# Quickshell aborts if the compositor disappears mid-run, so the tests it is
# about to launch must not be able to dump core.
stub_hyprctl 0
output=$(run_guard WAYLAND_DISPLAY=wayland-1 XDG_RUNTIME_DIR="$runtime_dir" HYPRLAND_INSTANCE_SIGNATURE=test)
[[ $output == "launched with core limit 0" ]] || fail "guard runs with core dumps disabled" "$output"
pass "guard runs with core dumps disabled"