Spencer Bull
5345673988
OpenClaw's desktop experience on Linux is its Control UI, served by the gateway the openclaw package runs, so the Install > AI entry installs the package and a web app launcher that routes through the new omarchy-launch-openclaw: first launch hands off to OpenClaw's own onboarding wizard, later launches start the gateway when needed and open the dashboard's single-use browser handoff URL as an app window. Remove > AI tears the gateway service down through OpenClaw's own gateway uninstall (falling back to systemctl by hand), aborts rather than dropping the package under a gateway that will not stop, and keeps the user's agent in ~/.openclaw. OpenClaw also joins Setup > Defaults > Agent through the same agent_installer seam Hermes carries: its CLI is the pacman package rather than a mise tool, so omarchy-install-openclaw-cli answers --check/--now with pacman, and omarchy-agent runs `openclaw chat`, seeding prompts through --message. The menu mark is a new U+E90C glyph traced from the package's lobster favicon; E90B stays free for the Perplexity mark still in flight on its own branch. The launcher recovers the gateway through `openclaw gateway install --force` (unit not enabled: missing, or an install that died after writing it) or `openclaw gateway start` (enabled but stopped), never `openclaw dashboard --yes`: as of OpenClaw 2026.9.1 that defers to "the owning supervisor" in both cases, and once the gateway is up it copies a one-time browser pairing URL into the clipboard. The dashboard probe is bounded so an app-grid launch cannot hang without a terminal to interrupt it. Removal treats only systemd's own "inactive"/"failed" as a stopped gateway, so an unreachable user manager aborts instead of dropping the package under a live process. All of it verified against a real 2026.9.1 install. Removal also takes down the node-host unit if OpenClaw ever installed one, and asks (default no, only on a terminal) whether ~/.openclaw should go too, with its size: the chats and credentials live there next to hundreds of megabytes of plugin runtimes and cache OpenClaw downloads for itself. Onboarding goes through omarchy-openclaw-onboard rather than bare `openclaw onboard`: as of 2026.9.1 the bare command is the guided flow, which ends by running a foreground gateway and handing off to a browser tab without returning, so the install script never reached the app launch and no service was installed. The helper runs the classic wizard (--flow quickstart --install-daemon --skip-ui) as a background job that keeps the terminal as its stdin, so its prompts render and take input as upstream draws them, and stops it once the gateway answers: upstream leaves the wizard running after its outro (only the TUI branch exits, and the model sign-in holds a socket open). Every quickstart prompt precedes the service install, so that point is safe. A gateway that never comes up after this run applies setup ends the wait as a failure instead of hanging, an already-running OpenClaw is left alone rather than mistaken for this run's success, a gateway answering on the port is only this run's once its process is the unit's own MainPID (an orphan from an earlier run) is not mistaken for the service this run installs, and a signal at the helper takes the wizard down with it.
289 lines
12 KiB
Bash
Executable File
289 lines
12 KiB
Bash
Executable File
#!/bin/bash
|
|
|
|
set -euo pipefail
|
|
|
|
source "$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)/base-test.sh"
|
|
|
|
tmp_dir="$(mktemp -d)"
|
|
trap 'rm -rf "$tmp_dir"' EXIT
|
|
|
|
mkdir -p "$tmp_dir/bin" "$tmp_dir/home"
|
|
export TEST_LOG="$tmp_dir/log"
|
|
export PATH="$tmp_dir/bin:$PATH"
|
|
export HOME="$tmp_dir/home"
|
|
export OMARCHY_OPENCLAW_ONBOARD_SETTLE_SECONDS=0
|
|
unit="$HOME/.config/systemd/user/openclaw-gateway.service"
|
|
export unit
|
|
|
|
# systemd and ss stand in for themselves. Once the wizard has written the unit
|
|
# it is running as pid 4242, and that same process holds the gateway port
|
|
# unless a test plants a different listener (an orphan) in $listener_file.
|
|
listener_file="$tmp_dir/listener"
|
|
export listener_file
|
|
cat >"$tmp_dir/bin/systemctl" <<'SCRIPT'
|
|
#!/bin/bash
|
|
printf 'systemctl:%s\n' "$*" >>"$TEST_LOG"
|
|
if [[ $* == *MainPID* ]]; then
|
|
[[ -f $unit ]] && echo 4242 || echo 0
|
|
exit 0
|
|
fi
|
|
[[ $* == *is-active* ]] && [[ -f $unit ]]
|
|
SCRIPT
|
|
chmod +x "$tmp_dir/bin/systemctl"
|
|
cat >"$tmp_dir/bin/ss" <<'SCRIPT'
|
|
#!/bin/bash
|
|
pid=
|
|
[[ -f $listener_file ]] && pid=$(cat "$listener_file")
|
|
[[ -z $pid && -f $unit ]] && pid=4242
|
|
[[ -n $pid ]] && echo "LISTEN 0 511 127.0.0.1:18789 0.0.0.0:* users:((\"node\",pid=$pid,fd=3))"
|
|
exit 0
|
|
SCRIPT
|
|
chmod +x "$tmp_dir/bin/ss"
|
|
export OMARCHY_OPENCLAW_ONBOARD_GATEWAY_TIMEOUT=1
|
|
|
|
# A wizard that configures OpenClaw, prints its outro, and then lingers forever
|
|
# on an open handle: the 2026.9.1 --skip-ui behaviour. It "installs the
|
|
# gateway" by writing the config a moment in, so the gateway only starts
|
|
# answering partway through, never at once.
|
|
cat >"$tmp_dir/bin/openclaw" <<'SCRIPT'
|
|
#!/bin/bash
|
|
printf 'openclaw:%s\n' "$*" >>"$TEST_LOG"
|
|
case $1 in
|
|
onboard)
|
|
( sleep 1; mkdir -p "$HOME/.openclaw" "${unit%/*}"; touch "$HOME/.openclaw/openclaw.json" "$unit" ) &
|
|
trap 'echo terminated >>"$TEST_LOG"; exit 143' TERM
|
|
while :; do sleep 0.2; done
|
|
;;
|
|
dashboard)
|
|
[[ -f $HOME/.openclaw/openclaw.json ]] && echo '{"ok":true,"port":18789}' || { echo '{"ok":false}'; exit 1; }
|
|
;;
|
|
esac
|
|
SCRIPT
|
|
chmod +x "$tmp_dir/bin/openclaw"
|
|
|
|
start=$SECONDS
|
|
rc=0
|
|
"$ROOT/bin/omarchy-openclaw-onboard" </dev/null >/dev/null 2>&1 || rc=$?
|
|
elapsed=$((SECONDS - start))
|
|
|
|
grep -q '^openclaw:onboard --flow quickstart --install-daemon --skip-ui$' "$TEST_LOG" ||
|
|
fail "onboarding runs the classic quickstart wizard with the service install" "$(grep '^openclaw:onboard' "$TEST_LOG" || true)"
|
|
pass "onboarding runs the classic quickstart wizard with the service install"
|
|
|
|
[[ $rc == 0 ]] || fail "a wizard that lingers after the gateway is up is stopped and counts as success" "rc=$rc"
|
|
grep -q '^terminated$' "$TEST_LOG" ||
|
|
fail "a wizard that lingers after the gateway is up is stopped and counts as success" "wizard was never signalled"
|
|
(( elapsed < 30 )) || fail "a wizard that lingers after the gateway is up is stopped and counts as success" "took ${elapsed}s"
|
|
pass "a wizard that lingers after the gateway is up is stopped and counts as success"
|
|
|
|
# The wizard only starts being stopped once the gateway actually answers: a
|
|
# stub that never writes the config is left alone and must be ended by its own
|
|
# exit, not the watcher.
|
|
: >"$TEST_LOG"
|
|
rm -rf "$HOME/.openclaw" "$unit" "$listener_file"
|
|
cat >"$tmp_dir/bin/openclaw" <<'SCRIPT'
|
|
#!/bin/bash
|
|
printf 'openclaw:%s\n' "$*" >>"$TEST_LOG"
|
|
[[ $1 == onboard ]] && { echo "Skipped for now."; exit 3; }
|
|
echo '{"ok":false}'; exit 1
|
|
SCRIPT
|
|
chmod +x "$tmp_dir/bin/openclaw"
|
|
rc=0
|
|
"$ROOT/bin/omarchy-openclaw-onboard" </dev/null >/dev/null 2>&1 || rc=$?
|
|
[[ $rc == 3 ]] || fail "an abandoned wizard passes its exit code through" "rc=$rc"
|
|
[[ ! -f $HOME/.openclaw/openclaw.json ]] || fail "an abandoned wizard passes its exit code through" "config appeared"
|
|
! grep -q '^terminated$' "$TEST_LOG" || fail "an abandoned wizard passes its exit code through" "watcher signalled it anyway"
|
|
pass "an abandoned wizard passes its exit code through"
|
|
|
|
# A wizard that finishes and exits on its own is simply waited for.
|
|
: >"$TEST_LOG"
|
|
cat >"$tmp_dir/bin/openclaw" <<'SCRIPT'
|
|
#!/bin/bash
|
|
printf 'openclaw:%s\n' "$*" >>"$TEST_LOG"
|
|
[[ $1 == onboard ]] && { mkdir -p "$HOME/.openclaw"; touch "$HOME/.openclaw/openclaw.json"; exit 0; }
|
|
echo '{"ok":true,"port":18789}'
|
|
SCRIPT
|
|
chmod +x "$tmp_dir/bin/openclaw"
|
|
rc=0
|
|
"$ROOT/bin/omarchy-openclaw-onboard" </dev/null >/dev/null 2>&1 || rc=$?
|
|
[[ $rc == 0 ]] || fail "a wizard that exits cleanly is waited for" "rc=$rc"
|
|
pass "a wizard that exits cleanly is waited for"
|
|
|
|
# Input reaches the wizard: it runs in the foreground, not backgrounded (which
|
|
# would stop it on SIGTTIN the moment it read stdin).
|
|
: >"$TEST_LOG"
|
|
rm -rf "$HOME/.openclaw" "$unit" "$listener_file"
|
|
cat >"$tmp_dir/bin/openclaw" <<'SCRIPT'
|
|
#!/bin/bash
|
|
printf 'openclaw:%s\n' "$*" >>"$TEST_LOG"
|
|
case $1 in
|
|
onboard)
|
|
read -r answer
|
|
printf 'answer:%s\n' "$answer" >>"$TEST_LOG"
|
|
mkdir -p "$HOME/.openclaw"; touch "$HOME/.openclaw/openclaw.json"
|
|
exit 0
|
|
;;
|
|
dashboard) echo '{"ok":true,"port":18789}' ;;
|
|
esac
|
|
SCRIPT
|
|
chmod +x "$tmp_dir/bin/openclaw"
|
|
printf 'gpt-5\n' | "$ROOT/bin/omarchy-openclaw-onboard" >/dev/null 2>&1
|
|
grep -q '^answer:gpt-5$' "$TEST_LOG" ||
|
|
fail "the wizard reads terminal input" "$(grep '^answer' "$TEST_LOG" || echo 'no input reached it')"
|
|
pass "the wizard reads terminal input"
|
|
|
|
# An already-configured machine whose gateway answers is not onboarded again:
|
|
# the wizard's repair pass would otherwise be stopped mid-prompt the moment
|
|
# the watcher saw the pre-existing gateway.
|
|
: >"$TEST_LOG"
|
|
mkdir -p "$HOME/.openclaw" && touch "$HOME/.openclaw/openclaw.json"
|
|
cat >"$tmp_dir/bin/openclaw" <<'SCRIPT'
|
|
#!/bin/bash
|
|
printf 'openclaw:%s\n' "$*" >>"$TEST_LOG"
|
|
[[ $1 == onboard ]] && { echo wizard-ran >>"$TEST_LOG"; exit 0; }
|
|
echo '{"ok":true,"port":18789}'
|
|
SCRIPT
|
|
chmod +x "$tmp_dir/bin/openclaw"
|
|
rc=0
|
|
"$ROOT/bin/omarchy-openclaw-onboard" </dev/null >/dev/null 2>&1 || rc=$?
|
|
[[ $rc == 0 ]] || fail "an already-running OpenClaw is left alone" "rc=$rc"
|
|
! grep -q '^wizard-ran$' "$TEST_LOG" || fail "an already-running OpenClaw is left alone" "wizard ran anyway"
|
|
pass "an already-running OpenClaw is left alone"
|
|
|
|
# Setup applied but the gateway never answers: the wizard would linger
|
|
# forever, so it is stopped after the deadline and that is reported as failure.
|
|
: >"$TEST_LOG"
|
|
rm -rf "$HOME/.openclaw" "$unit" "$listener_file"
|
|
cat >"$tmp_dir/bin/openclaw" <<'SCRIPT'
|
|
#!/bin/bash
|
|
printf 'openclaw:%s\n' "$*" >>"$TEST_LOG"
|
|
case $1 in
|
|
onboard)
|
|
mkdir -p "$HOME/.openclaw"; touch "$HOME/.openclaw/openclaw.json"
|
|
trap 'echo terminated >>"$TEST_LOG"; exit 143' TERM
|
|
while :; do sleep 0.2; done
|
|
;;
|
|
dashboard) echo '{"ok":false}'; exit 1 ;;
|
|
esac
|
|
SCRIPT
|
|
chmod +x "$tmp_dir/bin/openclaw"
|
|
start=$SECONDS
|
|
rc=0
|
|
err=$("$ROOT/bin/omarchy-openclaw-onboard" </dev/null 2>&1 >/dev/null) || rc=$?
|
|
elapsed=$((SECONDS - start))
|
|
[[ $rc == 1 ]] || fail "a gateway that never comes up ends the wait with a failure" "rc=$rc"
|
|
grep -q '^terminated$' "$TEST_LOG" || fail "a gateway that never comes up ends the wait with a failure" "wizard left running"
|
|
[[ $err == *"gateway status"* ]] || fail "a gateway that never comes up ends the wait with a failure" "no diagnostic: $err"
|
|
(( elapsed < 30 )) || fail "a gateway that never comes up ends the wait with a failure" "took ${elapsed}s"
|
|
pass "a gateway that never comes up ends the wait with a failure"
|
|
|
|
# A signal at this script alone takes the wizard down with it.
|
|
: >"$TEST_LOG"
|
|
rm -rf "$HOME/.openclaw" "$unit" "$listener_file"
|
|
cat >"$tmp_dir/bin/openclaw" <<'SCRIPT'
|
|
#!/bin/bash
|
|
printf 'openclaw:%s\n' "$*" >>"$TEST_LOG"
|
|
case $1 in
|
|
onboard) trap 'echo terminated >>"$TEST_LOG"; exit 143' TERM; while :; do sleep 0.2; done ;;
|
|
dashboard) echo '{"ok":false}'; exit 1 ;;
|
|
esac
|
|
SCRIPT
|
|
chmod +x "$tmp_dir/bin/openclaw"
|
|
"$ROOT/bin/omarchy-openclaw-onboard" </dev/null >/dev/null 2>&1 &
|
|
wrapper=$!
|
|
sleep 1
|
|
kill -TERM "$wrapper"
|
|
wait "$wrapper" 2>/dev/null || true
|
|
sleep 1
|
|
grep -q '^terminated$' "$TEST_LOG" || fail "stopping the wrapper stops the wizard" "wizard survived"
|
|
! pgrep -f "$tmp_dir/bin/openclaw onboard" >/dev/null || fail "stopping the wrapper stops the wizard" "wizard process still alive"
|
|
pass "stopping the wrapper stops the wizard"
|
|
|
|
# A config left by an earlier, incomplete setup does not start the gateway
|
|
# deadline: only this run applying setup does. The wizard here takes longer
|
|
# than the deadline at its prompts, never touches the old config, and must be
|
|
# left to finish on its own.
|
|
: >"$TEST_LOG"
|
|
mkdir -p "$HOME/.openclaw" && touch "$HOME/.openclaw/openclaw.json"
|
|
sleep 1
|
|
cat >"$tmp_dir/bin/openclaw" <<'SCRIPT'
|
|
#!/bin/bash
|
|
printf 'openclaw:%s\n' "$*" >>"$TEST_LOG"
|
|
case $1 in
|
|
onboard) trap 'echo terminated >>"$TEST_LOG"; exit 143' TERM; sleep 4; echo finished >>"$TEST_LOG"; exit 0 ;;
|
|
dashboard) echo '{"ok":false}'; exit 1 ;;
|
|
esac
|
|
SCRIPT
|
|
chmod +x "$tmp_dir/bin/openclaw"
|
|
rc=0
|
|
"$ROOT/bin/omarchy-openclaw-onboard" </dev/null >/dev/null 2>&1 || rc=$?
|
|
[[ $rc == 0 ]] || fail "a stale config does not start the gateway deadline" "rc=$rc"
|
|
grep -q '^finished$' "$TEST_LOG" || fail "a stale config does not start the gateway deadline" "wizard was cut short"
|
|
! grep -q '^terminated$' "$TEST_LOG" || fail "a stale config does not start the gateway deadline" "wizard was signalled"
|
|
pass "a stale config does not start the gateway deadline"
|
|
|
|
# ...while the same stale config being rewritten by this run does arm it.
|
|
: >"$TEST_LOG"
|
|
cat >"$tmp_dir/bin/openclaw" <<'SCRIPT'
|
|
#!/bin/bash
|
|
printf 'openclaw:%s\n' "$*" >>"$TEST_LOG"
|
|
case $1 in
|
|
onboard) touch "$HOME/.openclaw/openclaw.json"; trap 'echo terminated >>"$TEST_LOG"; exit 143' TERM; while :; do sleep 0.2; done ;;
|
|
dashboard) echo '{"ok":false}'; exit 1 ;;
|
|
esac
|
|
SCRIPT
|
|
chmod +x "$tmp_dir/bin/openclaw"
|
|
rc=0
|
|
"$ROOT/bin/omarchy-openclaw-onboard" </dev/null >/dev/null 2>&1 || rc=$?
|
|
[[ $rc == 1 ]] || fail "a config rewritten by this run arms the gateway deadline" "rc=$rc"
|
|
grep -q '^terminated$' "$TEST_LOG" || fail "a config rewritten by this run arms the gateway deadline" "wizard left running"
|
|
pass "a config rewritten by this run arms the gateway deadline"
|
|
|
|
# A gateway that answers while no config exists is not this run's: with no
|
|
# config `openclaw dashboard --json` still probes the default port, so a
|
|
# process left behind by something else (an earlier guided onboarding's
|
|
# foreground gateway) would otherwise end a wizard still at its first prompt.
|
|
: >"$TEST_LOG"
|
|
rm -rf "$HOME/.openclaw" "$unit" "$listener_file"
|
|
cat >"$tmp_dir/bin/openclaw" <<'SCRIPT'
|
|
#!/bin/bash
|
|
printf 'openclaw:%s\n' "$*" >>"$TEST_LOG"
|
|
case $1 in
|
|
onboard) trap 'echo terminated >>"$TEST_LOG"; exit 143' TERM; sleep 4; echo finished >>"$TEST_LOG"; exit 0 ;;
|
|
dashboard) echo '{"ok":true,"port":18789}' ;;
|
|
esac
|
|
SCRIPT
|
|
chmod +x "$tmp_dir/bin/openclaw"
|
|
rc=0
|
|
"$ROOT/bin/omarchy-openclaw-onboard" </dev/null >/dev/null 2>&1 || rc=$?
|
|
[[ $rc == 0 ]] || fail "an orphaned gateway answering with no config does not end the wizard" "rc=$rc"
|
|
grep -q '^finished$' "$TEST_LOG" || fail "an orphaned gateway answering with no config does not end the wizard" "wizard was cut short"
|
|
! grep -q '^terminated$' "$TEST_LOG" || fail "an orphaned gateway answering with no config does not end the wizard" "wizard was signalled"
|
|
pass "an orphaned gateway answering with no config does not end the wizard"
|
|
|
|
# And after setup, an orphan still bound to the port is not success even
|
|
# while the unit reports active: Type=simple counts it active from the fork,
|
|
# before it has discovered the port is taken. The port's owner has to be the
|
|
# unit's own main process. Here it never is, so the deadline ends the wait as
|
|
# a failure rather than opening the app on the orphan.
|
|
: >"$TEST_LOG"
|
|
rm -rf "$HOME/.openclaw" "$unit" "$listener_file"
|
|
echo 999 >"$listener_file"
|
|
cat >"$tmp_dir/bin/openclaw" <<'SCRIPT'
|
|
#!/bin/bash
|
|
printf 'openclaw:%s\n' "$*" >>"$TEST_LOG"
|
|
case $1 in
|
|
onboard) mkdir -p "$HOME/.openclaw" "${unit%/*}"; touch "$HOME/.openclaw/openclaw.json" "$unit"; trap 'echo terminated >>"$TEST_LOG"; exit 143' TERM; while :; do sleep 0.2; done ;;
|
|
dashboard) echo '{"ok":true,"port":18789}' ;;
|
|
esac
|
|
SCRIPT
|
|
chmod +x "$tmp_dir/bin/openclaw"
|
|
rc=0
|
|
"$ROOT/bin/omarchy-openclaw-onboard" </dev/null >/dev/null 2>&1 || rc=$?
|
|
[[ $rc == 1 ]] || fail "an orphan holding the port is not mistaken for the active unit" "rc=$rc"
|
|
grep -q '^terminated$' "$TEST_LOG" || fail "an orphan holding the port is not mistaken for the active unit" "wizard left running"
|
|
grep -q '^systemctl:--user show -p MainPID --value openclaw-gateway.service$' "$TEST_LOG" ||
|
|
fail "an orphan holding the port is not mistaken for the active unit" "unit ownership never checked"
|
|
pass "an orphan holding the port is not mistaken for the active unit"
|
|
rm -f "$listener_file"
|