mirror of
https://github.com/kuhyx/wake-alarm.git
synced 2026-07-04 12:03:01 +02:00
Krzysztof kuhy Rudnicki
407d7cbf8f
Rewrites python_pkg.wake_alarm imports to wake_alarm, vendors the shared configure_logging helper, drops the monorepo PYTHONPATH from install.sh and the systemd unit (package is now pip-installed), and untracks wake_state.json (runtime HMAC state, now gitignored). Scaffolds standalone lint/test config copied from the already-corrected diet_guard scaffold (pylint --fail-under=10 with tests excluded and the use-implicit-booleaness/consider-using-with disables, mypy's actual disabled-error-code set, ruff ALL, bandit, 100% branch coverage), plus the wave.Wave_write generated-members fix this package's _audio.py needs.
474 lines
16 KiB
Python
474 lines
16 KiB
Python
"""Tests for _alarm.py — wake alarm daemon, UI, and beep logic."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import pathlib
|
|
import subprocess
|
|
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 (
|
|
_is_alarm_day,
|
|
_should_run_alarm,
|
|
)
|
|
from wake_alarm._audio import (
|
|
_beep_loud,
|
|
_beep_medium,
|
|
_beep_soft,
|
|
_find_fan_hwmon,
|
|
_max_fans,
|
|
_play_on_extra_devices,
|
|
_restore_fans,
|
|
_speaker_test_path,
|
|
)
|
|
from wake_alarm._challenges import (
|
|
_DISMISS_CHARS,
|
|
_generate_code,
|
|
)
|
|
from wake_alarm._constants import (
|
|
DISMISS_CODE_LENGTH,
|
|
)
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Helpers
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
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._alarm.GateRoot",
|
|
return_value=mock.Tk.return_value,
|
|
),
|
|
):
|
|
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._alarm.GateRoot",
|
|
return_value=mock.Tk.return_value,
|
|
),
|
|
):
|
|
yield mock
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Unit tests for pure functions
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
class TestGenerateCode:
|
|
"""Tests for _generate_code."""
|
|
|
|
def test_correct_length(self) -> None:
|
|
"""Generated code has the configured length."""
|
|
code = _generate_code()
|
|
assert len(code) == DISMISS_CODE_LENGTH
|
|
|
|
def test_all_alphanumeric(self) -> None:
|
|
"""Generated code uses only the unambiguous alphanumeric charset."""
|
|
|
|
code = _generate_code()
|
|
assert all(c in _DISMISS_CHARS for c in code)
|
|
|
|
def test_different_codes(self) -> None:
|
|
"""Two calls produce different codes (probabilistic, but safe)."""
|
|
codes = {_generate_code() for _ in range(50)}
|
|
assert len(codes) > 1
|
|
|
|
|
|
class TestIsAlarmDay:
|
|
"""Tests for _is_alarm_day."""
|
|
|
|
def test_monday_is_alarm_day(self) -> None:
|
|
"""Monday (weekday=0) is an alarm day."""
|
|
from datetime import datetime
|
|
|
|
# Create a date that is Monday
|
|
with patch(
|
|
"wake_alarm._alarm.datetime",
|
|
) as mock_dt:
|
|
mock_now = MagicMock()
|
|
mock_now.weekday.return_value = 0 # Monday
|
|
mock_dt.now.return_value = mock_now
|
|
mock_dt.side_effect = datetime
|
|
assert _is_alarm_day() is True
|
|
|
|
def test_tuesday_is_not_alarm_day(self) -> None:
|
|
"""Tuesday (weekday=1) is NOT an alarm day."""
|
|
with patch(
|
|
"wake_alarm._alarm.datetime",
|
|
) as mock_dt:
|
|
mock_now = MagicMock()
|
|
mock_now.weekday.return_value = 1 # Tuesday
|
|
mock_dt.now.return_value = mock_now
|
|
assert _is_alarm_day() is False
|
|
|
|
def test_friday_is_alarm_day(self) -> None:
|
|
"""Friday (weekday=4) is an alarm day."""
|
|
with patch(
|
|
"wake_alarm._alarm.datetime",
|
|
) as mock_dt:
|
|
mock_now = MagicMock()
|
|
mock_now.weekday.return_value = 4 # Friday
|
|
mock_dt.now.return_value = mock_now
|
|
assert _is_alarm_day() is True
|
|
|
|
def test_saturday_is_alarm_day(self) -> None:
|
|
"""Saturday (weekday=5) is an alarm day."""
|
|
with patch(
|
|
"wake_alarm._alarm.datetime",
|
|
) as mock_dt:
|
|
mock_now = MagicMock()
|
|
mock_now.weekday.return_value = 5
|
|
mock_dt.now.return_value = mock_now
|
|
assert _is_alarm_day() is True
|
|
|
|
def test_sunday_is_alarm_day(self) -> None:
|
|
"""Sunday (weekday=6) is an alarm day."""
|
|
with patch(
|
|
"wake_alarm._alarm.datetime",
|
|
) as mock_dt:
|
|
mock_now = MagicMock()
|
|
mock_now.weekday.return_value = 6
|
|
mock_dt.now.return_value = mock_now
|
|
assert _is_alarm_day() is True
|
|
|
|
def test_wednesday_is_not_alarm_day(self) -> None:
|
|
"""Wednesday (weekday=2) is NOT an alarm day."""
|
|
with patch(
|
|
"wake_alarm._alarm.datetime",
|
|
) as mock_dt:
|
|
mock_now = MagicMock()
|
|
mock_now.weekday.return_value = 2
|
|
mock_dt.now.return_value = mock_now
|
|
assert _is_alarm_day() is False
|
|
|
|
|
|
class TestSpeakerTestPath:
|
|
"""Tests for _speaker_test_path."""
|
|
|
|
def test_returns_path_when_found(self) -> None:
|
|
"""Return full path when speaker-test is available."""
|
|
with patch(
|
|
"wake_alarm._audio.shutil.which",
|
|
return_value="/usr/bin/speaker-test",
|
|
):
|
|
assert _speaker_test_path() == "/usr/bin/speaker-test"
|
|
|
|
def test_raises_when_not_found(self) -> None:
|
|
"""Raise FileNotFoundError when speaker-test is missing."""
|
|
with (
|
|
patch(
|
|
"wake_alarm._audio.shutil.which",
|
|
return_value=None,
|
|
),
|
|
pytest.raises(FileNotFoundError, match="speaker-test not found"),
|
|
):
|
|
_speaker_test_path()
|
|
|
|
|
|
class TestBeepFunctions:
|
|
"""Tests for beep helper functions."""
|
|
|
|
def test_beep_soft_writes_bell(self) -> None:
|
|
"""_beep_soft writes terminal bell character."""
|
|
with patch("wake_alarm._audio.sys") as mock_sys:
|
|
mock_sys.stdout = MagicMock()
|
|
_beep_soft()
|
|
mock_sys.stdout.write.assert_called_once_with("\a")
|
|
mock_sys.stdout.flush.assert_called_once()
|
|
|
|
def test_beep_medium_delegates_to_play_tone(self) -> None:
|
|
"""_beep_medium just delegates to _play_tone."""
|
|
with patch("wake_alarm._audio._play_tone") as mock_play:
|
|
_beep_medium(frequency=800)
|
|
mock_play.assert_called_once_with(800)
|
|
|
|
def test_beep_loud_delegates_to_play_tone(self) -> None:
|
|
"""_beep_loud just delegates to _play_tone."""
|
|
with patch("wake_alarm._audio._play_tone") as mock_play:
|
|
_beep_loud(frequency=1200)
|
|
mock_play.assert_called_once_with(1200)
|
|
|
|
|
|
class TestShouldRunAlarm:
|
|
"""Tests for _should_run_alarm."""
|
|
|
|
def test_returns_false_on_non_alarm_day(self) -> None:
|
|
"""Return False when today is not an alarm day."""
|
|
with patch(
|
|
"wake_alarm._alarm._is_alarm_day",
|
|
return_value=False,
|
|
):
|
|
assert _should_run_alarm() is False
|
|
|
|
def test_returns_false_when_already_dismissed(self) -> None:
|
|
"""Return False when alarm was already dismissed today."""
|
|
with (
|
|
patch(
|
|
"wake_alarm._alarm._is_alarm_day",
|
|
return_value=True,
|
|
),
|
|
patch(
|
|
"wake_alarm._alarm.was_alarm_dismissed_today",
|
|
return_value=True,
|
|
),
|
|
):
|
|
assert _should_run_alarm() is False
|
|
|
|
def test_returns_true_when_alarm_day_and_not_dismissed(self) -> None:
|
|
"""Return True when today is alarm day and not yet dismissed."""
|
|
with (
|
|
patch(
|
|
"wake_alarm._alarm._is_alarm_day",
|
|
return_value=True,
|
|
),
|
|
patch(
|
|
"wake_alarm._alarm.was_alarm_dismissed_today",
|
|
return_value=False,
|
|
),
|
|
patch(
|
|
"wake_alarm._alarm.was_workout_logged_today",
|
|
return_value=False,
|
|
),
|
|
):
|
|
assert _should_run_alarm() is True
|
|
|
|
def test_returns_false_when_workout_already_logged(self) -> None:
|
|
"""Return False when workout was already logged today."""
|
|
with (
|
|
patch(
|
|
"wake_alarm._alarm._is_alarm_day",
|
|
return_value=True,
|
|
),
|
|
patch(
|
|
"wake_alarm._alarm.was_alarm_dismissed_today",
|
|
return_value=False,
|
|
),
|
|
patch(
|
|
"wake_alarm._alarm.was_workout_logged_today",
|
|
return_value=True,
|
|
),
|
|
):
|
|
assert _should_run_alarm() is False
|
|
|
|
|
|
class TestPlayOnExtraDevices:
|
|
"""Tests for _play_on_extra_devices."""
|
|
|
|
def test_popen_called_for_each_device(self) -> None:
|
|
"""_play_on_extra_devices spawns speaker-test with PIPEWIRE_NODE set."""
|
|
with (
|
|
patch(
|
|
"wake_alarm._audio._speaker_test_path",
|
|
return_value="/usr/bin/speaker-test",
|
|
),
|
|
patch("wake_alarm._audio.subprocess.Popen") as mock_popen,
|
|
):
|
|
_play_on_extra_devices(1000)
|
|
mock_popen.assert_called_once()
|
|
args = mock_popen.call_args[0][0]
|
|
env = mock_popen.call_args.kwargs["env"]
|
|
assert "/usr/bin/speaker-test" in args
|
|
assert "-D" not in args
|
|
assert "1000" in args
|
|
assert "PIPEWIRE_NODE" in env
|
|
assert "alsa_output" in env["PIPEWIRE_NODE"]
|
|
|
|
def test_noop_when_speaker_test_missing(self) -> None:
|
|
"""_play_on_extra_devices does nothing when speaker-test is absent."""
|
|
with (
|
|
patch(
|
|
"wake_alarm._audio._speaker_test_path",
|
|
side_effect=FileNotFoundError("not found"),
|
|
),
|
|
patch("wake_alarm._audio.subprocess.Popen") as mock_popen,
|
|
):
|
|
_play_on_extra_devices(1000)
|
|
mock_popen.assert_not_called()
|
|
|
|
def test_ignores_oserror_on_popen(self) -> None:
|
|
"""_play_on_extra_devices silently ignores OSError from Popen."""
|
|
with (
|
|
patch(
|
|
"wake_alarm._audio._speaker_test_path",
|
|
return_value="/usr/bin/speaker-test",
|
|
),
|
|
patch(
|
|
"wake_alarm._audio.subprocess.Popen",
|
|
side_effect=OSError("device busy"),
|
|
),
|
|
):
|
|
_play_on_extra_devices(1000) # must not raise
|
|
|
|
|
|
class TestFindFanHwmon:
|
|
"""Tests for _find_fan_hwmon."""
|
|
|
|
def test_returns_none_when_no_hwmon(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
|
"""No hwmon entries → returns None."""
|
|
monkeypatch.setattr(pathlib.Path, "glob", lambda _s, _p: iter([]))
|
|
assert _find_fan_hwmon() is None
|
|
|
|
def test_returns_none_for_unknown_chip(
|
|
self, tmp_path: pathlib.Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
"""Non-NCT chip name → returns None."""
|
|
name_file = tmp_path / "name"
|
|
name_file.write_text("unknown_chip\n")
|
|
monkeypatch.setattr(pathlib.Path, "glob", lambda _s, _p: iter([name_file]))
|
|
assert _find_fan_hwmon() is None
|
|
|
|
def test_returns_hwmon_dir_for_nct_chip(
|
|
self, tmp_path: pathlib.Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
"""NCT chip name → returns the hwmon directory path."""
|
|
name_file = tmp_path / "name"
|
|
name_file.write_text("nct6799\n")
|
|
monkeypatch.setattr(pathlib.Path, "glob", lambda _s, _p: iter([name_file]))
|
|
result = _find_fan_hwmon()
|
|
assert result == str(tmp_path)
|
|
|
|
def test_skips_unreadable_name_file(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
|
"""OSError on read → skips and returns None."""
|
|
bad_path = MagicMock(spec=pathlib.Path)
|
|
bad_path.read_text.side_effect = OSError("unreadable")
|
|
monkeypatch.setattr(pathlib.Path, "glob", lambda _s, _p: iter([bad_path]))
|
|
assert _find_fan_hwmon() is None
|
|
|
|
|
|
class TestMaxFans:
|
|
"""Tests for _max_fans."""
|
|
|
|
def test_returns_false_when_no_hwmon(self) -> None:
|
|
"""No fan controller → returns False immediately."""
|
|
with patch("wake_alarm._audio._find_fan_hwmon", return_value=None):
|
|
assert _max_fans() is False
|
|
|
|
def test_returns_false_on_script_oserror(self, tmp_path: pathlib.Path) -> None:
|
|
"""OSError running fan script → returns False."""
|
|
with (
|
|
patch(
|
|
"wake_alarm._audio._find_fan_hwmon",
|
|
return_value=str(tmp_path),
|
|
),
|
|
patch(
|
|
"wake_alarm._audio.subprocess.run",
|
|
side_effect=OSError("not found"),
|
|
),
|
|
):
|
|
assert _max_fans() is False
|
|
|
|
def test_returns_false_on_script_timeout(self, tmp_path: pathlib.Path) -> None:
|
|
"""TimeoutExpired running fan script → returns False."""
|
|
with (
|
|
patch(
|
|
"wake_alarm._audio._find_fan_hwmon",
|
|
return_value=str(tmp_path),
|
|
),
|
|
patch(
|
|
"wake_alarm._audio.subprocess.run",
|
|
side_effect=subprocess.TimeoutExpired("fan", 5),
|
|
),
|
|
):
|
|
assert _max_fans() is False
|
|
|
|
def test_returns_false_on_nonzero_returncode(self, tmp_path: pathlib.Path) -> None:
|
|
"""Fan script exits non-zero → returns False."""
|
|
mock_result = MagicMock()
|
|
mock_result.returncode = 1
|
|
with (
|
|
patch(
|
|
"wake_alarm._audio._find_fan_hwmon",
|
|
return_value=str(tmp_path),
|
|
),
|
|
patch(
|
|
"wake_alarm._audio.subprocess.run",
|
|
return_value=mock_result,
|
|
),
|
|
):
|
|
assert _max_fans() is False
|
|
|
|
def test_returns_true_on_success(self, tmp_path: pathlib.Path) -> None:
|
|
"""Successful run → returns True (state is saved by the helper)."""
|
|
mock_result = MagicMock()
|
|
mock_result.returncode = 0
|
|
with (
|
|
patch(
|
|
"wake_alarm._audio._find_fan_hwmon",
|
|
return_value=str(tmp_path),
|
|
),
|
|
patch(
|
|
"wake_alarm._audio.subprocess.run",
|
|
return_value=mock_result,
|
|
),
|
|
):
|
|
assert _max_fans() is True
|
|
|
|
|
|
class TestRestoreFans:
|
|
"""Tests for _restore_fans."""
|
|
|
|
def test_noop_when_inactive(self) -> None:
|
|
"""False state → subprocess.run is never called."""
|
|
with patch("wake_alarm._audio.subprocess.run") as mock_run:
|
|
_restore_fans(active=False)
|
|
mock_run.assert_not_called()
|
|
|
|
def test_calls_fan_script_restore(self) -> None:
|
|
"""Active state → fan script called with restore (no args)."""
|
|
with patch("wake_alarm._audio.subprocess.run") as mock_run:
|
|
mock_run.return_value.returncode = 0
|
|
_restore_fans(active=True)
|
|
mock_run.assert_called_once()
|
|
args = mock_run.call_args[0][0]
|
|
assert "restore" in args
|
|
|
|
def test_ignores_oserror_on_restore(self) -> None:
|
|
"""OSError from fan script is silently suppressed."""
|
|
with patch(
|
|
"wake_alarm._audio.subprocess.run",
|
|
side_effect=OSError("no script"),
|
|
):
|
|
_restore_fans(active=True) # must not raise
|
|
|
|
def test_ignores_timeout_on_restore(self) -> None:
|
|
"""TimeoutExpired from fan script is silently suppressed."""
|
|
with patch(
|
|
"wake_alarm._audio.subprocess.run",
|
|
side_effect=subprocess.TimeoutExpired("fan", 5),
|
|
):
|
|
_restore_fans(active=True) # must not raise
|