repositories / dotfiles

dotfiles

bugabingas dorkfiles

owned by bugabinga

test(quickshell): audit smoke runner contract

633769ec28d73da66f05a583ee38845a1998d18a

Oliver Jan Krylow <oliver@bugabinga.net> ·

unsigned

Browse filesCompare with HEAD

Changed files (2)

docs/super/inventory/2026-06-17-quickshell-self-contained-audit.md

Modified
15 15 - required named-config files are present: `shell.qml`, `Theme.qml`, `nugu.json`, `README.md`, `COMPONENTS.md`, `IPC.md`, `EXTERNALS.md`, `SERVICE.md`, `PARITY.md`, `audit.sh`, `smoke.sh`, `live-check.sh`.
16 16 - `README.md` links the required inventories, service/parity contracts, smoke/audit/live-check gates, named config command, and IPC command form.
17 17 - `live-check.sh` is executable and audited read-only: it must not link, start, stop, enable, disable, restart, or launch `qs -c nugu`.
18 +- `smoke.sh` is executable and audited for self-contained temp `HOME`/`XDG_CONFIG_HOME`, named config launch, cleanup trap, and no live link/service mutation.
18 19 - every QML component is listed in `COMPONENTS.md` with purpose and rollout status.
19 20 - every `nugu` IPC method from `shell.qml` is listed in `IPC.md` with purpose and rollout status.
20 21 - component, IPC, and external inventory rows reject duplicates, malformed names, thin text, and placeholder wording.
65 66 docs_index=ok
66 67 live_check=ok
67 68 live_check_readonly=ok
69 +smoke_contract=ok
68 70 inventory_tables=ok
69 71 service_contract=ok
70 72 parity_matrix=ok
88 90 docs_index=ok
89 91 live_check=ok
90 92 live_check_readonly=ok
93 +smoke_contract=ok
91 94 inventory_tables=ok
92 95 service_contract=ok
93 96 parity_matrix=ok

quickshell/nugu/audit.sh

Modified
27 27 if not (config_dir / name).exists():
28 28 errors.append(f"missing required self-contained config file {name}")
30 +smoke_path = config_dir / "smoke.sh"
31 +if smoke_path.exists():
32 + if not os.access(smoke_path, os.X_OK):
33 + errors.append("smoke.sh must be executable")
34 + smoke_source = smoke_path.read_text()
35 + smoke_code = "\n".join(line.split("#", 1)[0] for line in smoke_source.splitlines())
36 + required_smoke_markers = (
37 + "dbus-run-session",
38 + "NUGU_QS_INSIDE_SMOKE",
39 + "HOME=\"$home_tmp\" XDG_CONFIG_HOME=\"$tmp\"",
40 + "ln -s \"$config_dir\" \"$tmp/quickshell/nugu\"",
41 + "qs -c nugu",
42 + "qs ipc -c nugu call nugu",
43 + "hideAll",
44 + "trap cleanup EXIT INT TERM",
45 + "kill \"$qs_pid\"",
46 + )
47 + for marker in required_smoke_markers:
48 + if marker not in smoke_source:
49 + errors.append(f"smoke.sh missing self-contained smoke marker {marker!r}")
50 + forbidden_smoke_patterns = (
51 + r"\bsystemctl\s+--user\s+(start|stop|restart|try-restart|reload|enable|disable|mask|unmask|daemon-reload)\b",
52 + r"\bjust\s+(link|setup|services|unlink)\b",
53 + r"\bjava\s+bootstripper\.java\s+(clean|setup|link)\b",
54 + r"\$HOME/\.config/quickshell",
55 + )
56 + for pattern in forbidden_smoke_patterns:
57 + if re.search(pattern, smoke_code):
58 + errors.append(f"smoke.sh contains live-mutating or live-config command matching {pattern!r}")
30 60 live_check_path = config_dir / "live-check.sh"
31 61 if live_check_path.exists():
32 62 if not os.access(live_check_path, os.X_OK):
371 401 print("docs_index=ok")
372 402 print("live_check=ok")
373 403 print("live_check_readonly=ok")
404 +print("smoke_contract=ok")
374 405 print("inventory_tables=ok")
375 406 print("service_contract=ok")
376 407 print("parity_matrix=ok")