steam-backlog-enforcer/_installer_import/tests/test_steamctl.py
Krzysztof kuhy Rudnicki 15f647f639 Install any game from an appid, a URL or a name; adopt Steam's partial downloads
`./run.sh <anything>` is now the entry point. It installs its own dependencies
(steamcmd via yay, DepotDownloader from the SteamRE release, a local .venv) and
works out what the argument is: an appid, a Steam URL, an exact title, or part
of a title. Every route is confirmed through steamcmd's own app_info before
anything acts on it.

Name search moves to steamcommunity.com/actions/SearchApps, which works, with
the storefront API kept as a fallback -- it TLS-rejects scripted clients here,
so search had been effectively dead. DNS on this box fails transiently about one
lookup in three, so each backend is retried before giving up. An exact title now
wins over Steam's own ranking, which puts "Portal 2" above "Portal"; an
ambiguous name shows a picker, or exits 2 rather than guessing.

Two problems found while building this, both now handled:

Anonymous steamcmd has no licence for a paid app and does not say so. It
transfers nothing, prints "Success! App '284160' fully installed.", exits 0, and
writes StateFlags=4 with SizeOnDisk=0 and no depots. A running Steam client then
reads that, decides the app is installed but stale, and downloads the whole game
by itself. `ghost.py` detects that state -- validated read-only against all ten
manifests in a real library, where the nine genuine installs are untouched and
only the fabricated one matches -- and `--repair-ghosts` clears it away. Repair
uses rmdir, never rmtree, so a non-empty directory survives a wrong diagnosis.

And Steam's own in-progress downloads are no longer wasted. `takeover.py`
hardlinks `steamapps/downloading/<appid>/` into the install directory before
depotdownloader runs; depotdownloader hash-checks what is already on disk
(ContentDownloader.cs skips a file when neededChunks is empty) and fetches only
the remainder. Nothing is deleted up front -- the staging tree is cleared only
after the install is verified -- so a failed run still leaves Steam able to
resume. The trees share inodes, so an in-place chunk patch corrects both.

cli.py drops from 311 to 244 lines, back under the repo's 250-line cap, by
moving the install flow to flow.py and the manifest finish to finalize.py.

install.sh had a latent bug: `pip install -e .[dev]` only warns about a missing
extra and exits 0, so the `|| fallback` that installed pytest and coverage never
ran. A fresh venv had no test tools at all; the existing one only worked because
they had been installed by hand earlier. Now named outright and asserted.

246 tests, 100% statement and branch coverage. Verified live: all four input
forms resolve to 284160, an exact "Portal" resolves to 400 and not 620, an
ambiguous name exits 2, ghost detection flags nothing on nine real installs, and
a from-scratch venv bootstraps and runs.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Sgkb3wH6MU9fYquX328ovT
2026-09-11 21:38:16 +02:00

59 lines
1.7 KiB
Python

"""Closing and reopening the Steam client.
Steam is only ever asked to leave politely. A hung client is a reason to stop
and say so, never to escalate to a signal: SIGKILL mid-write is how a manifest
ends up truncated.
"""
import logging
import pytest
from steam_installer import recognize, steamctl
LOGGER = logging.getLogger("test-steamctl")
def test_stop_is_a_no_op_when_steam_is_not_running(monkeypatch):
monkeypatch.setattr(recognize, "steam_client_pids", list)
called = []
monkeypatch.setattr(steamctl.subprocess, "run", lambda *a, **k: called.append(a))
assert steamctl.stop(LOGGER) is False
assert called == []
def test_stop_asks_steam_to_shut_down_and_waits_for_it(monkeypatch):
pids = iter([[42], [42], [], []])
monkeypatch.setattr(recognize, "steam_client_pids", lambda: next(pids))
seen = {}
monkeypatch.setattr(
steamctl.subprocess, "run", lambda cmd, **k: seen.setdefault("cmd", cmd)
)
assert steamctl.stop(LOGGER, sleep=lambda _: None) is True
assert seen["cmd"] == ["steam", "-shutdown"]
def test_stop_gives_up_rather_than_killing_a_client_that_will_not_exit(monkeypatch):
monkeypatch.setattr(recognize, "steam_client_pids", lambda: [42])
monkeypatch.setattr(steamctl.subprocess, "run", lambda *a, **k: None)
with pytest.raises(steamctl.SteamStillRunning, match="42"):
steamctl.stop(LOGGER, timeout=1.0, sleep=lambda _: None)
def test_start_launches_steam_detached(monkeypatch):
seen = {}
def fake_popen(cmd, **kwargs):
seen["cmd"] = cmd
seen["kwargs"] = kwargs
monkeypatch.setattr(steamctl.subprocess, "Popen", fake_popen)
steamctl.start(LOGGER)
assert seen["cmd"] == ["steam"]
assert seen["kwargs"]["start_new_session"] is True