steam-backlog-enforcer/steam_backlog_enforcer/tests/_main_helpers.py
Krzysztof kuhy Rudnicki 45ff4eb7c2 Split main.py (1076 lines) into a main/ package
main.py became main/ with __main__.py, so the invocation string baked into
run.sh and the systemd unit (`python -m steam_backlog_enforcer.main`) stays
byte-identical and nothing needs redeploying. Commands are grouped into
sibling modules (status, install, picks, abandon, misc), with _shared.py as
a leaf holding the lock helpers and constants both need, and _registry.py
holding the command tables. main/__init__.py keeps every public and private
name importable, so `from steam_backlog_enforcer.main import X` is unchanged.

The subtle part is patch targets. The test suite builds them as
f"{PKG}.{name}", so a grep for the literal module path found nothing -- but
once a command moves to a submodule it resolves its dependencies from that
module's globals, and patching the main package's re-export silently stops
biting. Measured which of the 36 patched symbols moved: 8 could have passed
vacuously. Rather than repair PKG per class, the five test_main*.py files
(all cap violators anyway) were regrouped to mirror the production modules,
so each file has exactly one correct PKG. Verified by mutation: breaking a
line in status/misc/picks/_shared each makes the corresponding tests fail.

test_web_server.py patched main_mod.serve, which no longer intercepts
cmd_serve; repointed at main.misc and confirmed it fails when the call is
removed. Added tests for the __main__ shim, which coverage would otherwise
report at 0% under fail_under = 100.

Shared test builders live in tests/_main_helpers.py, reachable because the
Phase 0 name-tests-test exclude allows tests/_*.py.

1290 tests pass; every main/ module reports 100% coverage; `main`, `status`,
`bogus` and `--status` produce byte-identical output and exit codes to
pre-refactor. 55 -> 49 files over the cap.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PPpmMpTSkp8UziRc5u8B7P
2026-08-23 19:56:34 +02:00

149 lines
4.1 KiB
Python

"""Shared fixtures and builders for the ``main`` CLI test modules.
Lives outside a ``test_*.py`` name on purpose: these are constructors, not
tests. ``name-tests-test`` exempts ``tests/_*.py`` for exactly this.
"""
from __future__ import annotations
from datetime import datetime, timedelta, timezone
from typing import Any
from steam_backlog_enforcer._actions import MANUAL_GRACE_DAYS
from steam_backlog_enforcer._allowed_games import MANUAL_LOCK_DAYS
from steam_backlog_enforcer._total_block import TotalBlockStatus
from steam_backlog_enforcer.config import State
STARTED_AT = (datetime.now(timezone.utc) - timedelta(days=1)).isoformat()
# A start timestamp that is always past the 14-day deadline.
EXPIRED_AT = (
datetime.now(timezone.utc) - timedelta(days=MANUAL_LOCK_DAYS + 1)
).isoformat()
ACTIVE_STATUS = TotalBlockStatus(
active=True,
started_at=datetime.now(timezone.utc) - timedelta(hours=1),
until=datetime.now(timezone.utc) + timedelta(hours=23),
days=1,
days_remaining=0.96,
)
INACTIVE_STATUS = TotalBlockStatus(
active=False, started_at=None, until=None, days=0, days_remaining=0.0
)
def snap(
app_id: int = 1,
name: str = "G",
total: int = 10,
unlocked: int = 0,
hours: float = -1,
) -> dict[str, Any]:
"""Build one snapshot entry.
Args:
app_id: Steam application id.
name: Game name.
total: Total achievement count.
unlocked: Unlocked achievement count.
hours: Completionist hours (-1 when unknown).
Returns:
A snapshot dict shaped like the on-disk format.
"""
return {
"app_id": app_id,
"name": name,
"total_achievements": total,
"unlocked_achievements": unlocked,
"playtime_minutes": 60,
"completionist_hours": hours,
}
def snap_with_achievements(
app_id: int = 1,
name: str = "G",
total: int = 10,
unlocked: int = 0,
hours: float = -1,
) -> dict[str, Any]:
"""Build a snapshot entry carrying an empty ``achievements`` list.
Args:
app_id: Steam application id.
name: Game name.
total: Total achievement count.
unlocked: Unlocked achievement count.
hours: Completionist hours (-1 when unknown).
Returns:
A snapshot dict with ``achievements`` and zero playtime.
"""
entry = snap(app_id, name, total, unlocked, hours)
entry["playtime_minutes"] = 0
entry["achievements"] = []
return entry
def locked_state(
app_id: int = 100,
name: str = "TestGame",
started_at: str = STARTED_AT,
) -> State:
"""Build a State carrying one active manual pick.
Args:
app_id: Picked application id.
name: Picked game name.
started_at: ISO timestamp the pick started at.
Returns:
A State with a single manual pick.
"""
return State(
manual_picks=[{"app_id": app_id, "game_name": name, "started_at": started_at}],
)
IN_GRACE = (datetime.now(timezone.utc) - timedelta(days=1)).isoformat()
PAST_GRACE = (
datetime.now(timezone.utc) - timedelta(days=MANUAL_GRACE_DAYS + 1)
).isoformat()
VALID_REASON = "I need this game installed for a work presentation this week."
def abandonable_state(app_id: int = 100, started_at: str = IN_GRACE) -> State:
"""Build a State whose single manual pick is still abandonable.
Args:
app_id: Picked application id.
started_at: ISO timestamp the pick started at.
Returns:
A State with the pick also set as the current assignment.
"""
state = locked_state(app_id=app_id, started_at=started_at)
state.current_app_id = app_id
state.current_game_name = state.manual_pick_game_name
return state
def two_pick_state() -> State:
"""Build a State carrying two active manual picks.
Returns:
A State whose current assignment is the second pick.
"""
state = State(
manual_picks=[
{"app_id": 100, "game_name": "TestGame", "started_at": IN_GRACE},
{"app_id": 200, "game_name": "SecondGame", "started_at": IN_GRACE},
],
)
state.current_app_id = 200
state.current_game_name = "SecondGame"
return state