mirror of
https://github.com/kuhyx/wake-alarm.git
synced 2026-11-21 04:42:18 +01:00
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
151 lines
5.6 KiB
Python
151 lines
5.6 KiB
Python
"""Tests for the fire-time session record that survives a hard power-off."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from datetime import datetime
|
|
import json
|
|
from typing import TYPE_CHECKING
|
|
|
|
import pytest
|
|
|
|
from wake_alarm import _alarm_session
|
|
from wake_alarm._alarm_session import (
|
|
STATE_FINISHED,
|
|
STATE_RINGING,
|
|
finish_session,
|
|
load_session,
|
|
should_refire,
|
|
start_session,
|
|
)
|
|
|
|
if TYPE_CHECKING:
|
|
from pathlib import Path
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def session_file(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> Path:
|
|
"""Point the record at a temporary file, never the real one."""
|
|
path = tmp_path / "alarm_session.json"
|
|
monkeypatch.setattr(_alarm_session, "ALARM_SESSION_FILE", path)
|
|
return path
|
|
|
|
|
|
class TestStartSession:
|
|
"""Opening a record the moment the alarm starts ringing."""
|
|
|
|
def test_writes_a_signed_ringing_record(self, session_file: Path) -> None:
|
|
"""The record exists before anything can go wrong."""
|
|
assert start_session("wake-20260827-0700") is True
|
|
entry = json.loads(session_file.read_text())
|
|
assert entry["state"] == STATE_RINGING
|
|
assert entry["correlation"] == "wake-20260827-0700"
|
|
assert "hmac" in entry
|
|
# An aware timestamp: freshness is measured as elapsed time, so the
|
|
# offset has to be carried rather than assumed.
|
|
assert datetime.fromisoformat(str(entry["fired_at"])).tzinfo is not None
|
|
|
|
def test_creates_the_parent_directory(
|
|
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
"""A fresh install has no ~/.config/wake_alarm yet."""
|
|
monkeypatch.setattr(
|
|
_alarm_session, "ALARM_SESSION_FILE", tmp_path / "new" / "s.json"
|
|
)
|
|
assert start_session("wake-20260827-0700") is True
|
|
|
|
def test_unwritable_path_is_survivable(
|
|
self,
|
|
tmp_path: Path,
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
caplog: pytest.LogCaptureFixture,
|
|
) -> None:
|
|
"""A failed write must never stop the alarm from ringing."""
|
|
blocker = tmp_path / "blocker"
|
|
blocker.write_text("not a directory")
|
|
monkeypatch.setattr(_alarm_session, "ALARM_SESSION_FILE", blocker / "s.json")
|
|
with caplog.at_level("WARNING"):
|
|
assert start_session("wake-20260827-0700") is False
|
|
assert "Failed to write" in caplog.text
|
|
|
|
def test_saves_unsigned_when_no_hmac_key(
|
|
self, monkeypatch: pytest.MonkeyPatch, caplog: pytest.LogCaptureFixture
|
|
) -> None:
|
|
"""An unsigned record still beats no record at all."""
|
|
monkeypatch.setattr(_alarm_session, "compute_entry_hmac", lambda _entry: None)
|
|
with caplog.at_level("WARNING"):
|
|
assert start_session("wake-20260827-0700") is True
|
|
assert "unsigned alarm session" in caplog.text
|
|
|
|
|
|
class TestFinishSession:
|
|
"""Closing the record however the alarm actually ended."""
|
|
|
|
def test_marks_the_record_finished(self, session_file: Path) -> None:
|
|
"""Dismissal, escape hatch and SIGTERM all land here."""
|
|
start_session("wake-20260827-0700")
|
|
assert finish_session() is True
|
|
entry = json.loads(session_file.read_text())
|
|
assert entry["state"] == STATE_FINISHED
|
|
# fired_at is preserved: it is the audit trail of when it rang.
|
|
assert entry["fired_at"] is not None
|
|
assert entry["correlation"] == "wake-20260827-0700"
|
|
|
|
def test_no_record_to_finish(self) -> None:
|
|
"""on_close() runs even when no session was ever opened."""
|
|
assert finish_session() is False
|
|
|
|
|
|
class TestLoadSession:
|
|
"""Reading the record back, rejecting anything untrustworthy."""
|
|
|
|
def test_absent_file(self) -> None:
|
|
"""No record is not an error."""
|
|
assert load_session() is None
|
|
|
|
def test_unreadable_json(
|
|
self, session_file: Path, caplog: pytest.LogCaptureFixture
|
|
) -> None:
|
|
"""A truncated write is treated as no record."""
|
|
session_file.write_text("{not json")
|
|
with caplog.at_level("WARNING"):
|
|
assert load_session() is None
|
|
assert "Cannot read" in caplog.text
|
|
|
|
def test_non_dict_payload(self, session_file: Path) -> None:
|
|
"""A JSON list is not a record."""
|
|
session_file.write_text("[1, 2, 3]")
|
|
assert load_session() is None
|
|
|
|
def test_an_unsigned_record_is_honoured(
|
|
self,
|
|
session_file: Path,
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
caplog: pytest.LogCaptureFixture,
|
|
) -> None:
|
|
"""No HMAC key must not silently disable the power-off defence.
|
|
|
|
``verify_entry_hmac`` returns False both for a forgery *and* for a
|
|
machine with no key at all. Treating them alike meant that on such a
|
|
machine every session record was unreadable and the re-fire simply did
|
|
not happen -- found by running the vmbox harness, where /etc/gatelock
|
|
is absent.
|
|
"""
|
|
monkeypatch.setattr(_alarm_session, "compute_entry_hmac", lambda _e: None)
|
|
start_session("wake-20260827-0700")
|
|
assert "hmac" not in json.loads(session_file.read_text())
|
|
with caplog.at_level("WARNING"):
|
|
assert should_refire() is True
|
|
assert "unsigned" in caplog.text
|
|
|
|
def test_tampered_record_is_rejected(
|
|
self, session_file: Path, caplog: pytest.LogCaptureFixture
|
|
) -> None:
|
|
"""Hand-editing state must not be able to fake -- or force -- a ring."""
|
|
start_session("wake-20260827-0700")
|
|
entry = json.loads(session_file.read_text())
|
|
entry["state"] = STATE_FINISHED
|
|
session_file.write_text(json.dumps(entry))
|
|
with caplog.at_level("WARNING"):
|
|
assert load_session() is None
|
|
assert "HMAC verification failed" in caplog.text
|