mirror of
https://github.com/kuhyx/wake-alarm.git
synced 2026-11-11 13:47:31 +01:00
Krzysztof kuhy Rudnicki
97d32c803d
scripts/vmbox/harness.sh provisions a disposable Arch guest, runs the REAL
install.sh in it, and adjudicates 8 cases on a host-side exit code. Plus
DOCS-vmbox.md, which states what a pass does and does not mean.
Covered: system-python imports, timer enabled, wake-alarm.service still
`static` (an [Install] there fires the alarm at *login*), the shutdown wrapper
shadowing /usr/bin/shutdown, the alarm-cache shape jq expects, a trigger tick,
the inhibitor, and the re-fire path. With --window it also opens the real
fullscreen Tk window and screenshots it from the host -- confirmed showing
"WAKE UP!", round 1/4 and a live flash challenge.
Not covered, and said plainly in the doc rather than implied away: audio (the
guest has no pactl/paplay), the phone, GPU and real outputs, and anything
bootloader-related (guest is BIOS, this machine is UEFI).
**The VM earned its place immediately by finding two live bugs that the host
could not reach and the unit suite passed straight through.**
1. The inhibitor claimed a block it did not have. Popen succeeding only means
the binary launched; logind can still refuse -- the guest's polkit denies a
non-interactive session outright ("Failed to inhibit: Access denied", exit
1) while the alarm cheerfully logged the power key as blocked.
take_power_key_inhibitor() now waits INHIBIT_CONFIRM_SECONDS and confirms
the child survived, returning None and logging the refusal otherwise.
2. An unsigned session record was written and then rejected on read. With no
HMAC key on the machine (/etc/gatelock absent, as in the guest),
verify_entry_hmac returns False for a *missing* key exactly as it does for
a forgery -- so every session record was unreadable and item 2's power-off
defence silently did not exist. An entry with no "hmac" field is now
honoured with a loud warning; a present-but-wrong signature is still
rejected, since that one really is tampering.
Two harness traps worth recording, both hit while building it:
- `vm run` reports the *VM's* verdict, not the guest command's exit code, so a
guest script exiting 1 still gives rc=0. A gate built on that fails OPEN.
guest_cases.sh prints ALL-CASES-PASSED only when every case passed and the
harness greps for it; verified by breaking a case on purpose and watching
the gate go red.
- `vm share`/`vm repo` key off the path basename, so REPO_DIR must be absolute
and symlink-resolved. A relative "scripts/vmbox/../.." makes rsync write
into /home and fail with permissions errors that look like a guest fault.
Guest checks live in real .py files beside the shell, not heredocs, so they
get linted like everything else -- ruff's autofix gutted an early heredoc
version (stripped the assignments AND the print) exactly as TODO-hardening
warned, and only running it showed the file had stopped producing output.
Also drops three stale fan references the guest install run surfaced:
install.sh still announced "Fans will ramp to 100%" and README.md still
described the fan ramp, three commits after item 14 deleted the feature.
Splits carried: test_inhibit.py -> + test_inhibit_cleanup.py,
test_alarm_session.py -> + test_alarm_session_refire.py.
455 tests pass, 100% branch coverage. Harness: 8/8 cases, exit 0.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EckWmyfetYq3Mi8MAnUudh
53 lines
2.1 KiB
Markdown
53 lines
2.1 KiB
Markdown
# wake_alarm
|
|
|
|
A phone-driven wake alarm for an always-on PC. The alarm time is whatever the
|
|
companion phone app last synced (via the shared `crdt_sync` transport over a
|
|
private GitHub repo); a per-minute systemd user timer fires at exactly that
|
|
time, showing a fullscreen, challenge-dismissed alarm with escalating audio
|
|
and optional TP-Link Tapo P110 smart-plug control.
|
|
|
|
Change the alarm on the phone at any hour and the PC follows within ~5
|
|
minutes. If the PC does happen to be powered down, a `shutdown` wrapper
|
|
hibernates with `rtcwake` set to the same synced time, as a fallback.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
bash install.sh
|
|
```
|
|
|
|
This installs the package + dependencies into system Python's user
|
|
site-packages (the systemd units run `/usr/bin/python` directly, not a venv —
|
|
see `CLAUDE.md`), installs and enables the per-minute trigger timer, the
|
|
systemd-sleep resume hook, the `shutdown` wrapper that hibernates with
|
|
`rtcwake` as a fallback, and (optionally) `python-kasa` for smart-plug
|
|
control.
|
|
|
|
Reading the phone's alarm needs a GitHub token with `repo` scope, at
|
|
`~/.config/wake_alarm/sync.json` as `{"token": "..."}`. If that file is
|
|
absent, a sibling app's `~/.config/{diet_guard,screen_locker}/sync_token` is
|
|
used instead, so one token covers every app syncing through `kuhyx/syncs`.
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
python -m wake_alarm._alarm --demo # test the alarm window (safe, closeable)
|
|
python -m wake_alarm._sync --show # what alarm time the PC resolves
|
|
python -m wake_alarm._trigger --dry-run # what the next tick would do
|
|
journalctl --user -fu wake-alarm-trigger.service # watch it live
|
|
```
|
|
|
|
The alarm fires automatically once installed; no manual invocation is needed
|
|
in normal operation.
|
|
|
|
## Development
|
|
|
|
```bash
|
|
python -m venv .venv && .venv/bin/pip install -r requirements.txt
|
|
.venv/bin/pre-commit install && .venv/bin/pre-commit install --hook-type pre-push
|
|
.venv/bin/python -m pytest wake_alarm/tests/ --cov=wake_alarm --cov-branch --cov-fail-under=100
|
|
```
|
|
|
|
See `CLAUDE.md` for scheduling details, the hibernate/`rtcwake` mechanism,
|
|
the cross-repo `workout_log.json` read, and production deployment gotchas.
|