mirror of
https://github.com/kuhyx/wake-alarm.git
synced 2026-11-10 19:27:02 +01:00
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
171 lines
6.2 KiB
Python
171 lines
6.2 KiB
Python
"""Tests for _alarm.py — WakeAlarm init, dismiss, run, and beep phases (part 2)."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import tkinter as tk
|
|
from typing import TYPE_CHECKING
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
import pytest
|
|
|
|
if TYPE_CHECKING:
|
|
from collections.abc import Generator
|
|
|
|
from wake_alarm._alarm import (
|
|
WakeAlarm,
|
|
)
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Helpers (duplicated from part 1 so this file is self-contained)
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def _make_mock_tk() -> MagicMock:
|
|
"""Build a MagicMock that stands in for the tkinter module."""
|
|
mock = MagicMock()
|
|
mock_root = MagicMock()
|
|
mock_root.winfo_screenwidth.return_value = 1920
|
|
mock_root.winfo_screenheight.return_value = 1080
|
|
mock.Tk.return_value = mock_root
|
|
mock.Frame.return_value = MagicMock()
|
|
mock.Label.return_value = MagicMock()
|
|
mock.Entry.return_value = MagicMock()
|
|
mock.TclError = tk.TclError
|
|
mock.END = tk.END
|
|
return mock
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def _block_real_tk() -> Generator[MagicMock]:
|
|
"""Prevent any real Tk windows in tests."""
|
|
mock = _make_mock_tk()
|
|
with (
|
|
patch("wake_alarm._alarm.tk", mock),
|
|
patch("wake_alarm._dismiss_view.tk", mock),
|
|
patch("wake_alarm._alarm_view.tk", mock),
|
|
patch(
|
|
"wake_alarm._alarm.GateRoot",
|
|
return_value=mock.Tk.return_value,
|
|
),
|
|
):
|
|
yield mock
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def _block_extra_devices() -> Generator[MagicMock]:
|
|
"""Prevent real subprocess.Popen calls for extra ALSA devices."""
|
|
with (
|
|
patch("wake_alarm._beep_loop._play_on_all_sinks") as mock,
|
|
patch("wake_alarm._startup._set_max_brightness"),
|
|
patch("wake_alarm._startup._wake_display"),
|
|
patch("wake_alarm._alarm._restore_display"),
|
|
patch("wake_alarm._startup._warn_if_no_real_sink"),
|
|
patch("wake_alarm._alarm._activate_all_outputs", return_value=None),
|
|
patch("wake_alarm._alarm._restore_audio_state"),
|
|
patch("wake_alarm._startup.turn_on_plug"),
|
|
patch("wake_alarm._alarm.turn_off_plug"),
|
|
):
|
|
yield mock
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_tk_module() -> Generator[MagicMock]:
|
|
"""Provide explicit access to the mocked tk module."""
|
|
mock = _make_mock_tk()
|
|
with (
|
|
patch("wake_alarm._alarm.tk", mock),
|
|
patch("wake_alarm._dismiss_view.tk", mock),
|
|
patch("wake_alarm._alarm_view.tk", mock),
|
|
patch(
|
|
"wake_alarm._alarm.GateRoot",
|
|
return_value=mock.Tk.return_value,
|
|
),
|
|
):
|
|
yield mock
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Tests
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
class TestWakeAlarmInit:
|
|
"""Tests for WakeAlarm initialization."""
|
|
|
|
def test_demo_mode_sets_smaller_window(
|
|
self,
|
|
mock_tk_module: MagicMock,
|
|
) -> None:
|
|
"""Demo mode still hijacks the full screen — only timers differ."""
|
|
alarm = WakeAlarm(demo_mode=True)
|
|
assert alarm.demo_mode is True
|
|
assert alarm.dismissed is False
|
|
mock_root = mock_tk_module.Tk.return_value
|
|
# Since gatelock v0.2.0 even demo takes overrideredirect: a window
|
|
# manager rewrites a managed window's geometry, so per-output
|
|
# placement is impossible without it. attributes(fullscreen=True)
|
|
# is gone -- explicit per-output geometry replaces it.
|
|
mock_root.overrideredirect.assert_called_with(boolean=True)
|
|
assert alarm._view._views, "a surface must exist per live output"
|
|
alarm._stop_beep.set() # Stop beep thread
|
|
|
|
def test_init_starts_sink_reactivation(
|
|
self,
|
|
mock_tk_module: MagicMock,
|
|
) -> None:
|
|
"""The retry runs, and stops when the alarm does.
|
|
|
|
Without this the HDMI sink stays absent for the whole alarm: its card
|
|
profile is ``off`` at wake time, and only a fresh set-card-profile can
|
|
bring the sink into existence -- re-enumerating sinks never finds it.
|
|
The conftest stub is replaced here so the wiring itself is asserted.
|
|
"""
|
|
assert mock_tk_module is not None
|
|
with patch("wake_alarm._alarm.start_alarm_reactivation") as start:
|
|
alarm = WakeAlarm(demo_mode=True)
|
|
start.assert_called_once_with(alarm._stop_beep)
|
|
# The same event the beep loop watches, so dismissal ends both.
|
|
alarm._stop_beep.set()
|
|
assert start.call_args.args[0].is_set()
|
|
|
|
def test_init_takes_the_power_key_inhibitor(
|
|
self,
|
|
mock_tk_module: MagicMock,
|
|
) -> None:
|
|
"""A short power-button press must not end the alarm in one tap."""
|
|
assert mock_tk_module is not None
|
|
with patch("wake_alarm._alarm.take_power_key_inhibitor") as take:
|
|
alarm = WakeAlarm(demo_mode=True)
|
|
take.assert_called_once_with()
|
|
assert alarm._hardware.inhibitor is take.return_value
|
|
alarm._stop_beep.set()
|
|
|
|
def test_init_opens_a_session_record(
|
|
self,
|
|
mock_tk_module: MagicMock,
|
|
) -> None:
|
|
"""Written while ringing, so a power cut leaves a trace to re-fire on."""
|
|
assert mock_tk_module is not None
|
|
with patch("wake_alarm._alarm.start_session") as start:
|
|
alarm = WakeAlarm(demo_mode=True)
|
|
start.assert_called_once()
|
|
# The correlation id joins this record to the JSONL log with no
|
|
# handshake -- both sides derive it from the same alarm instant.
|
|
assert start.call_args.args[0].startswith("wake-")
|
|
alarm._stop_beep.set()
|
|
|
|
def test_production_mode_fullscreen(
|
|
self,
|
|
mock_tk_module: MagicMock,
|
|
) -> None:
|
|
"""Production mode activates fullscreen."""
|
|
alarm = WakeAlarm(demo_mode=False)
|
|
assert alarm.demo_mode is False
|
|
mock_root = mock_tk_module.Tk.return_value
|
|
mock_root.overrideredirect.assert_called_with(boolean=True)
|
|
# attributes(fullscreen=True) is deliberately gone: it is an EWMH
|
|
# request an override-redirect window is invisible to, and where
|
|
# it applies it snaps to one monitor or the whole bounding box.
|
|
assert alarm._view._views, "a surface must exist per live output"
|
|
alarm._stop_beep.set()
|