wake-alarm/wake_alarm/tests/test_state.py
Krzysztof kuhy Rudnicki e67cef0c54 Retire the PC's waking role; keep the trigger
The PC no longer wakes anyone -- the phone does. This deletes the alarm
window, the audio escalation, the sink/reactivation machinery, the power-key
inhibitor, the escape hatch, the curtains, the smart plug, the brightness and
DDC/CI control, the hibernate path (shutdown wrapper + rtcwake + sleep hook)
and the challenge set: 30 modules, 34 test files, ~5k lines.

What stays is the part that still earns its keep: the per-minute trigger
reads the alarm the phone published and starts morning-routine.service, so
the workout lock still runs at the right time.

THE ONE LOAD-BEARING BEHAVIOUR CHANGE. Deleting _alarm.py orphaned the only
writer of wake_state.json, and _trigger gated on it via
was_alarm_dismissed_today(). With that gone -- and was_workout_logged_today()
already permanently False, since WORKOUT_LOG_FILE does not exist -- both
gates would have been dead and the routine restarted on every tick for the
rest of the 60-minute catch-up window. The unit is Type=simple, so a start
while it runs is a no-op, but the moment the workout lock finished the next
tick would relaunch it on top of the user. So _trigger now writes its own
once-per-day latch (save_trigger_fired / was_trigger_fired_today) and gates
on that. Collapsing the catch-up window instead was rejected: that window is
the entire reason a suspended or just-booted machine still fires. It also
replaces the deleted sleep hook, via Persistent=true.

_trigger also imported should_refire from _alarm_session, which was on the
delete list. Since start_session lived only in _alarm.py, no session record
is ever written again and the branch was unreachable, not merely unused.

WAKE_STATE_FILE is now redirected in tests/conftest.py rather than per-file.
The trigger tests never redirected it, because until this commit nothing on
that path wrote anything -- and a per-file redirect is exactly the kind that
gets forgotten when a new writer appears, with a silent failure: a green
suite that quietly stamped the live state file. Verified by mtime that it
did not.

Cross-repo, same change: morning_routine._orchestrator loses its alarm leg
and its --with-alarm flag. Leaving an orchestrator pointing at a deleted
module caused a month-long silent failure once already.

uninstall.sh is new, and matters more than it looks. /usr/local/bin/shutdown
is root-owned and shadows /usr/bin/shutdown; deleting this repo would leave
it in place, and with the alarm cache gone it falls through to rtcwake +
hibernate -- so "shutdown now" would silently stop being a poweroff, every
day, forever. /etc/sudoers.d/wake-alarm is deliberately NOT removed:
screen-locker's own _wake_alarm.py still needs passwordless rtcwake.

159 tests pass at 100% branch coverage; all 26 pre-commit hooks green.
Verified by running it: _sync --show and _trigger --dry-run both resolve.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PcdngP688mW6rJye3LRkSN
2026-08-30 15:24:02 +02:00

161 lines
4.6 KiB
Python

"""Tests for _state.py — HMAC-signed wake state management."""
from __future__ import annotations
import json
from typing import TYPE_CHECKING
from unittest.mock import patch
import pytest
from wake_alarm._state import (
_today_str,
load_wake_state,
save_trigger_fired,
)
if TYPE_CHECKING:
from pathlib import Path
@pytest.fixture
def wake_state_file(tmp_path: Path) -> Path:
"""Provide a temporary wake state file path."""
return tmp_path / "wake_state.json"
@pytest.fixture(autouse=True)
def _patch_wake_state_file(wake_state_file: Path) -> None:
"""Redirect WAKE_STATE_FILE to tmp_path for all tests."""
with patch(
"wake_alarm._state.WAKE_STATE_FILE",
wake_state_file,
):
yield
class TestTodayStr:
"""Tests for _today_str helper."""
def test_returns_date_string(self) -> None:
"""Return a YYYY-MM-DD string for today."""
result = _today_str()
assert len(result) == 10
assert result[4] == "-"
assert result[7] == "-"
class TestSaveWakeState:
"""Tests for save_trigger_fired."""
def test_saves_with_hmac(self, wake_state_file: Path) -> None:
"""Save state with HMAC signature when key is available."""
with patch(
"wake_alarm._state.compute_entry_hmac",
return_value="fakesig",
):
result = save_trigger_fired(fired_at="2026-04-12T07:04:00+00:00")
assert result is True
data = json.loads(wake_state_file.read_text())
assert data["fired_at"] == "2026-04-12T07:04:00+00:00"
assert data["hmac"] == "fakesig"
assert data["date"] == _today_str()
def test_saves_without_hmac(self, wake_state_file: Path) -> None:
"""Save unsigned state when HMAC key is unavailable."""
with patch(
"wake_alarm._state.compute_entry_hmac",
return_value=None,
):
result = save_trigger_fired(fired_at="07:04")
assert result is True
data = json.loads(wake_state_file.read_text())
assert "hmac" not in data
def test_returns_false_on_write_error(self, wake_state_file: Path) -> None:
"""Return False when file cannot be written."""
with (
patch(
"wake_alarm._state.compute_entry_hmac",
return_value="sig",
),
patch(
"wake_alarm._state.WAKE_STATE_FILE",
wake_state_file / "nonexistent_dir" / "file.json",
),
):
result = save_trigger_fired(fired_at="07:04")
assert result is False
class TestLoadWakeState:
"""Tests for load_wake_state."""
def test_returns_none_when_file_missing(self) -> None:
"""Return None when state file doesn't exist."""
assert load_wake_state() is None
def test_returns_none_for_wrong_date(
self,
wake_state_file: Path,
) -> None:
"""Return None when state is from a different day."""
state = {"date": "1999-01-01", "hmac": "x"}
wake_state_file.write_text(json.dumps(state))
assert load_wake_state() is None
def test_returns_none_for_invalid_json(
self,
wake_state_file: Path,
) -> None:
"""Return None when file contains invalid JSON."""
wake_state_file.write_text("not json {{{")
assert load_wake_state() is None
def test_returns_none_for_non_dict(
self,
wake_state_file: Path,
) -> None:
"""Return None when file contains a non-dict JSON value."""
wake_state_file.write_text(json.dumps([1, 2, 3]))
assert load_wake_state() is None
def test_returns_none_for_bad_hmac(
self,
wake_state_file: Path,
) -> None:
"""Return None when HMAC verification fails."""
state = {
"date": _today_str(),
"fired_at": "07:00",
"hmac": "badsig",
}
wake_state_file.write_text(json.dumps(state))
with patch(
"wake_alarm._state.verify_entry_hmac",
return_value=False,
):
assert load_wake_state() is None
def test_returns_state_for_valid_today(
self,
wake_state_file: Path,
) -> None:
"""Return state dict when file is valid and for today."""
state = {
"date": _today_str(),
"fired_at": "07:04",
"hmac": "validsig",
}
wake_state_file.write_text(json.dumps(state))
with patch(
"wake_alarm._state.verify_entry_hmac",
return_value=True,
):
result = load_wake_state()
assert result is not None