steam-backlog-enforcer/steam_backlog_enforcer/tests/test_game_names.py
Krzysztof kuhy Rudnicki 21fe2f7742 Stop the enforcer launching Steam and notifications as root
The enforce service runs as root (no User=) but sets DISPLAY=:0, so any GUI
it starts lands on the desktop session. Two resolvers disagreed about who to
drop privileges to:

  library_hider._resolve_desktop_user()  read STEAM_ENFORCER_DESKTOP_USER
  game_install._get_real_user()          read only SUDO_USER or USER

systemd sets neither of the latter, so _get_real_user() returned None under
the service and every `geteuid() == 0 and real_user and ...` guard fell
through to running as root. Steam answered with a zenity modal ("Cannot run
as root user", /usr/lib/steam/steam:261) on screen.

Confirmed from the live process tree: root `bash /usr/lib/steam/steam
-cef-disable-gpu ... steam://install/618510` with a root zenity child. It
never reached the journal, because that text goes to zenity and _run_as_user
sends child output to DEVNULL.

- _desktop_env: add resolve_desktop_user/desktop_uid/desktop_user_cmd. Only
  the argv builder is shared, never the spawn call: tests/_no_subprocess.py
  patches subprocess per module by name, so a spawn site in an unpatched
  module could fire a real `sudo -u kuhy steam`.
- game_install._get_real_user: delegate to the shared resolver. This alone
  also fixes the root `steam -silent` in _ensure_steam_running and the
  no-op os.chown on new appmanifests.
- _trigger_steam_install / enforcer.send_notification: drop privileges.
  send_notification had no DBUS_SESSION_BUS_ADDRESS, so it silently reached
  nobody for all six of its callers.
- _run_as_user: fail closed. Running unchanged as root when no desktop user
  resolves is what put the modal on screen; refuse and log instead.

Also stop the retry storm behind it. steamapps does not exist (Steam has
never completed sign-in), so is_game_installed() was always False and the
loop re-triggered every allowed game every pass: 1656 attempts in 30
minutes, service RSS 1.5 GB (peak 4.3 GB), a FileNotFoundError traceback
each time. Guard install_game and _reinstall_missing_allowed on
steam_library_ready() -- a missing library means no install can succeed by
any route, so this is a correctness check rather than a tuned retry limit.

The module splits here are forced by the pre-commit 250-line gate, which
blocks any commit touching an over-cap file: game_install, library_hider and
_enforce_loop were already over before this change. They are split by
responsibility (_cdp transport, _steam_launch lifecycle, _steam_process
spawning, _steam_errors, _steam_client, _game_names, game_uninstall,
_enforce_steps, _owned_apps_cache, _echo, _protected_apps). game_install and
library_hider re-export their old public names, so the 15 modules that
import from them are untouched by this commit.

Verified as real root under the unit's environment: argv is now
`sudo -u kuhy env DISPLAY=:0 ... xdg-open steam://install/...` for both the
installer and notify-send; three enforce passes spawn no process and log
once; _run_as_user refuses with no desktop user. After restart: 0 retries,
0 tracebacks, 0 root-owned files under ~/.local/share/Steam, RSS 342 MB.

1311 tests pass. _desktop_env and _steam_state at 100% branch coverage.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016A1EYiv7e7HGhET84oa9M3
2026-08-24 13:55:44 +02:00

120 lines
4.0 KiB
Python

"""Tests for game-name normalisation and the protected-name safety net.
Split to keep every test file under the 250-line cap.
"""
from __future__ import annotations
from typing import TYPE_CHECKING
from unittest.mock import MagicMock, patch
from steam_backlog_enforcer._game_names import (
_is_protected_name,
_normalize_game_name,
_protected_name_stems,
)
from steam_backlog_enforcer.game_uninstall import (
_remove_game_dirs,
)
if TYPE_CHECKING:
from pathlib import Path
PKG = "steam_backlog_enforcer.game_install"
GAME_NAMES_PKG = "steam_backlog_enforcer._game_names"
GAME_UNINSTALL_PKG = "steam_backlog_enforcer.game_uninstall"
class TestNormalizeGameName:
"""Tests for _normalize_game_name."""
def test_lowercases_and_strips_punctuation(self) -> None:
assert (
_normalize_game_name("Kingdom Come: Deliverance II")
== "kingdomcomedeliverance2"
)
def test_matches_no_space_variant(self) -> None:
assert _normalize_game_name("KingdomComeDeliverance2") == _normalize_game_name(
"Kingdom Come: Deliverance II"
)
def test_spelled_out_number_matches_digit(self) -> None:
assert _normalize_game_name("Portal Two") == _normalize_game_name("Portal 2")
class TestProtectedNameStems:
"""Tests for _protected_name_stems."""
def test_returns_allowed_game_names(self) -> None:
with (
patch("steam_backlog_enforcer.config.State.load", return_value=MagicMock()),
patch(
"steam_backlog_enforcer._game_names.allowed_games",
return_value=[(1771300, "Kingdom Come: Deliverance II"), (440, "")],
),
):
stems = _protected_name_stems()
assert stems == ["Kingdom Come: Deliverance II"]
def test_returns_empty_list_when_state_cannot_load(self) -> None:
with patch(
"steam_backlog_enforcer.config.State.load", side_effect=RuntimeError("boom")
):
stems = _protected_name_stems()
assert stems == []
class TestIsProtectedName:
"""Tests for _is_protected_name."""
def test_blank_candidate_is_not_protected(self) -> None:
assert _is_protected_name(" ") is False
def test_matches_exact_normalized_name(self) -> None:
with patch(
f"{GAME_NAMES_PKG}._protected_name_stems",
return_value=["Kingdom Come: Deliverance II"],
):
assert _is_protected_name("KingdomComeDeliverance2") is True
def test_matches_typo_via_fuzzy_ratio(self) -> None:
with patch(
f"{GAME_NAMES_PKG}._protected_name_stems",
return_value=["Kingdom Come: Deliverance II"],
):
assert _is_protected_name("Kingdom Come Delievarnce 2") is True
def test_no_match_for_unrelated_name(self) -> None:
with patch(
f"{GAME_NAMES_PKG}._protected_name_stems",
return_value=["Kingdom Come: Deliverance II"],
):
assert _is_protected_name("Cogmind") is False
def test_skips_blank_protected_name(self) -> None:
with patch(
f"{GAME_NAMES_PKG}._protected_name_stems", return_value=["", "Cogmind"]
):
assert _is_protected_name("Cogmind") is True
class TestRemoveGameDirsProtectedName:
"""Tests for the _is_protected_name safety net inside _remove_game_dirs."""
def test_refuses_to_remove_protected_name(self, tmp_path: Path) -> None:
install_dir = tmp_path / "common" / "Kingdom Come: Deliverance II"
install_dir.mkdir(parents=True)
(install_dir / "game.exe").touch()
with (
patch("steam_backlog_enforcer.game_uninstall.STEAMAPPS_PATH", tmp_path),
patch(
"steam_backlog_enforcer.game_uninstall._is_protected_name",
return_value=True,
),
):
result = _remove_game_dirs(install_dir, 1771300)
assert result is False
assert install_dir.exists()
assert (install_dir / "game.exe").exists()