wake-alarm/wake_alarm/tests/test_correlation.py
Krzysztof kuhy Rudnicki e8f50828e6 Phase 5: the power button no longer ends the alarm (item 2)
Two defences, because one press and one held press are different problems.

**Prevention — _inhibit.py.** A logind block-mode inhibitor on
handle-power-key:shutdown:idle, taken while the alarm is audible and released
in on_close(). Confirmed on the host before writing it that
PowerKeyIgnoreInhibited=no is in force, so no logind.conf drop-in is needed --
and none is added: a drop-in changes the machine permanently, an inhibitor is
scoped to the alarm.

Verified live: the inhibitor appears in `systemd-inhibit --list` as
`wake-alarm ... shutdown:idle:handle-power-key ... block` and disappears on
release.

The child runs `sleep 7200`, never `sleep infinity`. An orphaned block-mode
inhibitor would hold the power button down until reboot -- worse than the bug
being fixed -- so it self-terminates, and a stale one is cleared at startup.

That cleanup was wrong on the first attempt and the host run caught it:
`pkill -f "--who=wake-alarm"` matched the *shell that had just typed the
pattern* and killed it, leaving the real inhibitor alive (`killed 0`, one
inhibitor still listed). Substring matching is inherently self-matching. Now
it lists `pgrep -x systemd-inhibit` and confirms each pid via
/proc/<pid>/cmdline. Re-verified: orphan reaped, exactly one live inhibitor,
zero remaining after release.

**Consequence — _alarm_session.py.** The real gap was that nothing on disk
ever said "ringing, not yet dismissed": wake_state.json is written only on
dismissal, so a hard power-off left no trace and the catch-up window closed
while the machine was down. A signed record is now written at fire time, and
_trigger re-fires on one still marked ringing, ignoring the window.

Deliberately no date field. _state.py keys by UTC and
screen_locker/_wake_state.py mirrors that helper to read the very same file
from another repo, so the UTC basis there is load-bearing. The plan's
_today_str() flip is therefore NOT done -- it would have made any dismissal
between 00:00-02:00 local read as yesterday's in screen-locker and silently
lose an earned workout skip. This record carries only an aware fired_at and
compares elapsed time, so the midnight question never arises.

Age-bounded at 5400 s: an alarm that dies before dismissal leaves a record
nothing ever clears, and unbounded this would restart the alarm every minute
forever.

Two bugs the unit tests could not see, both found by running it:

- A future-stamped record returned None, i.e. "not ringing". But a backward
  clock jump is routine on a machine that hibernates nightly (NTP correcting
  after resume), so that failed *open* on exactly the escape it closes: ring
  on a fast clock, clock corrects, power-off works again. Now clamped to zero
  within a 900 s tolerance and logged.
- _alarm.py derived the correlation id from the alarm's *start* instant. On a
  catch-up or re-fire the PC would write wake-...-0735 while the phone wrote
  wake-...-0700 and the two log streams stop joining. Now
  correlation_id_for_today() derives it from the resolved alarm time, which is
  what _correlation.py always specified.

Every trigger test patched should_refire, so _decide against a real record was
untested -- which is why only the manual run found the first one. There is now
an end-to-end test that writes a real session and asserts the decision.

Splits carried: test_trigger.py 294 -> 197 + test_trigger_main.py,
test_alarm_part2.py 266 -> 170 + test_alarm_timers_flash.py. The inhibitor
handle moved into _AlarmHardware, which also settles pylint's attribute count
and puts it beside the other thing on_close() gives back.

No new suppressions: the one inline pylint disable was redundant, since
consider-using-with is already disabled repo-wide in pyproject.toml.

452 tests pass, 100% branch coverage.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EckWmyfetYq3Mi8MAnUudh
2026-08-27 20:26:37 +02:00

70 lines
2.5 KiB
Python

"""Tests for the derived correlation id."""
from __future__ import annotations
from datetime import datetime
from typing import TYPE_CHECKING
from wake_alarm import _correlation
from wake_alarm._correlation import correlation_id, correlation_id_for
from wake_alarm._sync import Alarm
if TYPE_CHECKING:
import pytest
def _local(year: int, month: int, day: int, hour: int, minute: int) -> datetime:
"""Build an aware local datetime, matching the idiom in test_trigger.py."""
return datetime(year, month, day, hour, minute, tzinfo=None).astimezone()
def test_correlation_id_formats_local_instant() -> None:
"""The id encodes the local date and the alarm's wall-clock time."""
assert correlation_id(_local(2026, 8, 26, 7, 0)) == "wake-20260826-0700"
def test_correlation_id_pads_single_digits() -> None:
"""Single-digit months, days, hours and minutes are zero padded."""
assert correlation_id(_local(2026, 1, 2, 3, 4)) == "wake-20260102-0304"
def test_correlation_id_is_stable_for_the_same_instant() -> None:
"""Two independent computations agree, which is the whole point."""
moment = _local(2026, 12, 31, 23, 59)
assert correlation_id(moment) == correlation_id(moment)
def test_correlation_id_for_uses_the_date_of_now() -> None:
"""The (hour, minute) form takes its date from the supplied instant."""
assert (
correlation_id_for(7, 30, now=_local(2026, 8, 26, 22, 15))
== "wake-20260826-0730"
)
def test_correlation_id_for_ignores_the_time_of_now() -> None:
"""Only *now*'s date matters; its own time is replaced."""
early = correlation_id_for(6, 0, now=_local(2026, 8, 26, 1, 2))
late = correlation_id_for(6, 0, now=_local(2026, 8, 26, 23, 58))
assert early == late == "wake-20260826-0600"
def test_today_id_comes_from_the_alarm_not_the_start_instant(
monkeypatch: pytest.MonkeyPatch,
) -> None:
"""A late start must not shift the id away from the phone's.
The alarm can begin a full catch-up window late, or hours late on a
re-fire. Both halves derive the id independently with no handshake, so
deriving the PC's from *now* rather than from the resolved alarm time
would silently stop the two log streams joining.
"""
monkeypatch.setattr(_correlation, "get_alarm", lambda: Alarm(6, 45, "remote"))
today = datetime.now().astimezone()
# Started at 07:35 -- 50 minutes into the catch-up window.
assert _correlation.correlation_id_for_today() == correlation_id_for(
6, 45, now=today
)
assert _correlation.correlation_id_for_today().endswith("-0645")