mirror of
https://github.com/kuhyx/screen-locker.git
synced 2026-11-11 19:33:56 +01:00
Krzysztof kuhy Rudnicki
aa3e290391
Real one-line docstrings stating what each test pins down. Files that would pass 250 lines moved whole classes into _part2 siblings (sick_panel, earned, poke_server, shutdown_reading, manual_workout_dialog). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WzxdWYdwRAtMg7ki6TKxuU
245 lines
10 KiB
Python
245 lines
10 KiB
Python
"""Tests for ``_rest_day`` and its CLI: declared ahead, two a week, signed."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from datetime import date, datetime, time
|
|
import json
|
|
import logging
|
|
from typing import TYPE_CHECKING
|
|
from unittest.mock import patch
|
|
|
|
import earned_time
|
|
import pytest
|
|
|
|
from screen_locker import _earned, _rest_day
|
|
from screen_locker._rest_day import declare, is_rest_day, rest_day_declarations
|
|
from screen_locker._rest_day_cli import run_declare_rest_day
|
|
from screen_locker._workout_ledger import ledger_path
|
|
from screen_locker.tests._earned_fixtures import KEY, signing_key
|
|
|
|
if TYPE_CHECKING:
|
|
from collections.abc import Iterator
|
|
from pathlib import Path
|
|
|
|
_EVE = datetime.combine(date(2026, 10, 9), time(18, 55)).astimezone()
|
|
_SAT, _SUN, _MON = date(2026, 10, 10), date(2026, 10, 11), date(2026, 10, 12)
|
|
|
|
|
|
@pytest.fixture
|
|
def key(tmp_path: Path) -> Iterator[Path]:
|
|
"""Provide a signing key in a temp dir for the duration of the test."""
|
|
with signing_key(tmp_path) as path:
|
|
yield path
|
|
|
|
|
|
def rows() -> list[dict[str, object]]:
|
|
"""Read back the stored rest-day rows."""
|
|
return json.loads(_rest_day.REST_DAY_FILE.read_text())["entries"]
|
|
|
|
|
|
def write(entries: object) -> None:
|
|
"""Overwrite the rest-day file with the given entries."""
|
|
_rest_day.REST_DAY_FILE.write_text(json.dumps({"entries": entries}))
|
|
|
|
|
|
@pytest.mark.usefixtures("key")
|
|
class TestDeclare:
|
|
"""declare signs a future rest day, mirrors it to the ledger and enforces the weekly cap."""
|
|
|
|
def test_a_future_day_is_signed_and_mirrored_to_the_ledger(self) -> None:
|
|
"""A future day is signed, stored and mirrored into the earned-time ledger."""
|
|
result = declare(_SAT, now=_EVE)
|
|
assert result.ok
|
|
assert result.reason == "2026-10-10 is a rest day (1 left in ISO week 41)"
|
|
(row,) = rows()
|
|
assert earned_time.verified(row, KEY)
|
|
assert row["declared_on"] == "2026-10-09"
|
|
(credit,) = json.loads(ledger_path().read_text())["entries"]
|
|
assert credit["entry_id"] == "rest:2026-10-10"
|
|
assert credit["detail"]["source"] == "rest_day"
|
|
assert float(credit["detail"]["declared_at"]) == _EVE.timestamp()
|
|
midnight = datetime.combine(_SAT, time.min).astimezone().timestamp()
|
|
assert float(credit["detail"]["completed_at"]) == midnight
|
|
assert is_rest_day(_SAT)
|
|
|
|
@pytest.mark.parametrize("day", [date(2026, 10, 9), date(2026, 10, 1)])
|
|
def test_today_and_the_past_are_refused(self, day: date) -> None:
|
|
"""Today and past days are refused and nothing is written."""
|
|
result = declare(day, now=_EVE)
|
|
assert not result.ok
|
|
assert "not in the future" in result.reason
|
|
assert not _rest_day.REST_DAY_FILE.exists()
|
|
|
|
def test_two_per_iso_week_then_refused(self) -> None:
|
|
"""Only two rest days fit in one ISO week; the next week gets its own two."""
|
|
assert declare(_SAT, now=_EVE).ok
|
|
assert declare(_SUN, now=_EVE).reason.endswith("(0 left in ISO week 41)")
|
|
assert declare(_SUN, now=_EVE).reason == "2026-10-11 is already a rest day"
|
|
third = declare(date(2026, 10, 8 + 1), now=datetime(2026, 10, 8).astimezone())
|
|
assert not third.ok
|
|
assert third.reason == "ISO week 41 already has 2 rest days"
|
|
assert declare(_MON, now=_EVE).ok # the next week has its own two
|
|
|
|
def test_an_unreadable_file_refuses(self, caplog: pytest.LogCaptureFixture) -> None:
|
|
"""An unreadable rest-day file refuses the declaration with a logged warning."""
|
|
_rest_day.REST_DAY_FILE.write_text("{not json")
|
|
with caplog.at_level(logging.WARNING):
|
|
result = declare(_SAT, now=_EVE)
|
|
assert not result.ok
|
|
assert result.reason == "rest-day file or signing key unreadable"
|
|
assert "unreadable" in caplog.text
|
|
|
|
def test_a_failed_write_says_so(self, caplog: pytest.LogCaptureFixture) -> None:
|
|
"""A failed file write is reported in the refusal reason."""
|
|
with (
|
|
patch.object(
|
|
type(_rest_day.REST_DAY_FILE), "write_text", side_effect=OSError("ro")
|
|
),
|
|
caplog.at_level(logging.WARNING),
|
|
):
|
|
result = declare(_SAT, now=_EVE)
|
|
assert not result.ok
|
|
assert "could not write" in result.reason
|
|
|
|
|
|
class TestReading:
|
|
"""rest_day_declarations only trusts signed, well-formed rows."""
|
|
|
|
def test_no_key_counts_nothing(
|
|
self, tmp_path: Path, caplog: pytest.LogCaptureFixture
|
|
) -> None:
|
|
"""Without a usable signing key no declaration counts and the cause is logged."""
|
|
with caplog.at_level(logging.WARNING):
|
|
assert not rest_day_declarations()
|
|
assert "signing key" in caplog.text
|
|
with signing_key(tmp_path, b" "):
|
|
assert not rest_day_declarations()
|
|
|
|
@pytest.mark.usefixtures("key")
|
|
def test_a_hand_edited_row_is_ignored(
|
|
self, caplog: pytest.LogCaptureFixture
|
|
) -> None:
|
|
"""A row edited after signing fails its signature and is ignored."""
|
|
declare(_SAT, now=_EVE)
|
|
edited = rows()
|
|
edited[0]["day"] = "2026-10-14"
|
|
write(edited)
|
|
with caplog.at_level(logging.WARNING):
|
|
assert not rest_day_declarations()
|
|
assert "fails its signature" in caplog.text
|
|
|
|
@pytest.mark.usefixtures("key")
|
|
def test_a_signed_same_day_row_is_not_ahead(self) -> None:
|
|
"""A row from any other route still has to be declared ahead."""
|
|
body = {
|
|
"kind": "rest_day",
|
|
"day": "2026-10-10",
|
|
"declared_on": "2026-10-10",
|
|
"declared_at": 1.0,
|
|
}
|
|
write([{**body, "hmac": earned_time.entry_signature(body, KEY)}])
|
|
assert not rest_day_declarations()
|
|
|
|
@pytest.mark.usefixtures("key")
|
|
def test_malformed_and_foreign_rows_are_ignored(
|
|
self, caplog: pytest.LogCaptureFixture
|
|
) -> None:
|
|
"""Malformed and foreign rows are skipped with a warning."""
|
|
body = {
|
|
"kind": "rest_day",
|
|
"day": "soon",
|
|
"declared_on": "2026-10-09",
|
|
"declared_at": 1.0,
|
|
}
|
|
write(
|
|
[
|
|
"x",
|
|
{"kind": "other"},
|
|
{**body, "hmac": earned_time.entry_signature(body, KEY)},
|
|
]
|
|
)
|
|
with caplog.at_level(logging.WARNING):
|
|
assert not rest_day_declarations()
|
|
assert "malformed" in caplog.text
|
|
|
|
@pytest.mark.usefixtures("key")
|
|
def test_a_file_without_entries_counts_nothing(
|
|
self, caplog: pytest.LogCaptureFixture
|
|
) -> None:
|
|
"""A rest-day file that is not an entries object counts nothing and warns."""
|
|
_rest_day.REST_DAY_FILE.write_text("[]")
|
|
with caplog.at_level(logging.WARNING):
|
|
assert not rest_day_declarations()
|
|
assert "no entries array" in caplog.text
|
|
|
|
@pytest.mark.usefixtures("key")
|
|
def test_the_cap_holds_on_read(self) -> None:
|
|
"""Three signed rows in a week: the two declared first count."""
|
|
|
|
def row(day: str, at: float) -> dict[str, object]:
|
|
body = {
|
|
"kind": "rest_day",
|
|
"day": day,
|
|
"declared_on": "2026-10-01",
|
|
"declared_at": at,
|
|
}
|
|
return {**body, "hmac": earned_time.entry_signature(body, KEY)}
|
|
|
|
write([row("2026-10-07", 3.0), row("2026-10-05", 1.0), row("2026-10-06", 2.0)])
|
|
assert set(rest_day_declarations()) == {date(2026, 10, 5), date(2026, 10, 6)}
|
|
|
|
|
|
@pytest.mark.usefixtures("key")
|
|
class TestCli:
|
|
"""The declare-rest-day CLI maps outcomes to output text and exit codes."""
|
|
|
|
def _run(self, *argv: str, offset: float | None = 0.0) -> int:
|
|
with (
|
|
patch("screen_locker._rest_day_cli._query_ntp_offset", return_value=offset),
|
|
patch("screen_locker._rest_day_cli.today_str", return_value="2026-10-09"),
|
|
patch("screen_locker._rest_day.datetime") as clock,
|
|
):
|
|
clock.now.return_value = _EVE
|
|
return run_declare_rest_day(list(argv))
|
|
|
|
def test_declare_tomorrow(self, capsys: pytest.CaptureFixture[str]) -> None:
|
|
"""Declaring tomorrow succeeds and prints the rest day."""
|
|
assert not self._run("tomorrow")
|
|
assert "2026-10-10 is a rest day" in capsys.readouterr().out
|
|
|
|
def test_a_date_and_then_the_list(self, capsys: pytest.CaptureFixture[str]) -> None:
|
|
"""A date argument declares that day and --list prints it."""
|
|
assert not self._run("2026-10-11")
|
|
assert not self._run("--list")
|
|
assert capsys.readouterr().out.splitlines()[-1] == "2026-10-11"
|
|
|
|
def test_an_empty_list(self, capsys: pytest.CaptureFixture[str]) -> None:
|
|
"""Listing with no declarations says so."""
|
|
assert not self._run()
|
|
assert capsys.readouterr().out.strip() == "no rest days declared"
|
|
|
|
def test_a_bad_date(self, capsys: pytest.CaptureFixture[str]) -> None:
|
|
"""An unparsable date exits with code 2 and an error message."""
|
|
assert self._run("someday") == 2
|
|
assert capsys.readouterr().out.startswith("error:")
|
|
|
|
def test_no_ntp_refuses(self, capsys: pytest.CaptureFixture[str]) -> None:
|
|
"""Without a confirmed NTP offset the declaration is refused."""
|
|
assert self._run("tomorrow", offset=None) == 1
|
|
assert "cannot be confirmed" in capsys.readouterr().out
|
|
|
|
def test_a_skewed_clock_refuses(self, capsys: pytest.CaptureFixture[str]) -> None:
|
|
"""A clock skewed from NTP refuses the declaration and names the skew."""
|
|
assert self._run("tomorrow", offset=86400.0) == 1
|
|
assert "off by 86400s" in capsys.readouterr().out
|
|
|
|
def test_today_is_refused(self, capsys: pytest.CaptureFixture[str]) -> None:
|
|
"""Declaring today is refused as not in the future."""
|
|
assert self._run("2026-10-09") == 1
|
|
assert "refused: 2026-10-09 is not in the future" in capsys.readouterr().out
|
|
|
|
|
|
def test_the_key_binding_is_the_one_earned_reads() -> None:
|
|
"""The suite redirects ``_earned.HMAC_KEY_FILE``; rest days must follow it."""
|
|
assert not _earned.HMAC_KEY_FILE.exists()
|