mirror of
https://github.com/kuhyx/steam-backlog-enforcer.git
synced 2026-11-22 23:22:18 +01:00
The installer ships as the steam_installer package beside steam_backlog_enforcer, with its tests, docs and Proton lock. The enforcer's fast install now starts the installer from this checkout. Both appinfo.vdf readers share one key-value decoder (steam_installer.appinfo_kv), and the duplicated test fixtures and helpers are folded into conftest and _cli_helpers so the whole-tree duplicate-code check is clean. check_requirements_sync treats sibling packages as first-party. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WzxdWZCxnNWLtpVwFLVk9w
235 lines
7.7 KiB
Python
235 lines
7.7 KiB
Python
"""Turning one free-form argument into a confirmed Steam app.
|
|
|
|
Four shapes have to work -- an AppID, a Steam URL, an exact title and a
|
|
partial title -- and the ambiguous cases have to fail rather than guess.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import Never
|
|
|
|
import pytest
|
|
|
|
from steam_installer import appinfo, resolve, target
|
|
|
|
|
|
def _metadata(appid: int) -> appinfo.AppMetadata:
|
|
return appinfo.AppMetadata(appid, "BeamNG.drive", "BeamNG.drive")
|
|
|
|
|
|
@pytest.fixture
|
|
def steam_knows_the_app(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
"""The steam knows the app fixture."""
|
|
monkeypatch.setattr(appinfo, "get_metadata", _metadata)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("text", "expected"),
|
|
[
|
|
("284160", (284160, "appid")),
|
|
(" 284160 ", (284160, "appid")),
|
|
("https://steamcommunity.com/app/284160/guides/", (284160, "url")),
|
|
("https://store.steampowered.com/app/284160/BeamNGdrive/", (284160, "url")),
|
|
("https://store.steampowered.com/app/284160", (284160, "url")),
|
|
("https://store.steampowered.com/app/284160/?snr=1_7", (284160, "url")),
|
|
("steamcommunity.com/app/284160/", (284160, "url")),
|
|
("BeamNG.drive", None),
|
|
("BeamNG", None),
|
|
("0", None),
|
|
("https://steamcommunity.com/id/someone/", None),
|
|
],
|
|
)
|
|
def test_parse_literal_recognises_appids_and_urls(
|
|
text: str, expected: tuple[int, str] | None
|
|
) -> None:
|
|
"""Parse literal recognises appids and urls."""
|
|
assert target.parse_literal(text) == expected
|
|
|
|
|
|
@pytest.mark.usefixtures("steam_knows_the_app")
|
|
def test_an_appid_is_confirmed_through_steamcmd() -> None:
|
|
"""An appid is confirmed through steamcmd."""
|
|
resolved = target.resolve_target("284160", None, interactive=False)
|
|
assert resolved.metadata.appid == 284160
|
|
assert resolved.source == "appid"
|
|
|
|
|
|
@pytest.mark.usefixtures("steam_knows_the_app")
|
|
def test_the_appid_flag_skips_detection_entirely() -> None:
|
|
"""The appid flag skips detection entirely."""
|
|
resolved = target.resolve_target("ignored name", 284160, interactive=False)
|
|
assert resolved.metadata.appid == 284160
|
|
assert resolved.source == "flag"
|
|
|
|
|
|
@pytest.mark.usefixtures("steam_knows_the_app")
|
|
def test_a_url_resolves_without_searching(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
"""A url resolves without searching."""
|
|
|
|
def no_search(_name: str) -> Never:
|
|
msg = "a URL must not trigger a search"
|
|
raise AssertionError(msg)
|
|
|
|
monkeypatch.setattr(resolve, "search", no_search)
|
|
resolved = target.resolve_target(
|
|
"https://steamcommunity.com/app/284160/guides/", None, interactive=False
|
|
)
|
|
assert resolved.source == "url"
|
|
|
|
|
|
@pytest.mark.usefixtures("steam_knows_the_app")
|
|
def test_a_single_search_hit_is_taken(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
"""A single search hit is taken."""
|
|
monkeypatch.setattr(
|
|
resolve, "search", lambda name: [resolve.SearchResult(284160, "BeamNG.drive")]
|
|
)
|
|
resolved = target.resolve_target("BeamNG", None, interactive=False)
|
|
assert resolved.metadata.appid == 284160
|
|
assert resolved.source == "only match"
|
|
|
|
|
|
def test_an_exact_title_wins_over_a_higher_ranked_sequel(
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
) -> None:
|
|
"""Steam ranks Portal 2 first for "Portal"; typing the full name must not
|
|
install the sequel."""
|
|
monkeypatch.setattr(
|
|
resolve,
|
|
"search",
|
|
lambda name: [
|
|
resolve.SearchResult(620, "Portal 2"),
|
|
resolve.SearchResult(400, "Portal"),
|
|
],
|
|
)
|
|
monkeypatch.setattr(
|
|
appinfo, "get_metadata", lambda appid: appinfo.AppMetadata(appid, "Portal", "P")
|
|
)
|
|
|
|
resolved = target.resolve_target("Portal", None, interactive=False)
|
|
|
|
assert resolved.metadata.appid == 400
|
|
assert resolved.source == "exact"
|
|
|
|
|
|
@pytest.mark.usefixtures("steam_knows_the_app")
|
|
def test_an_ambiguous_name_prompts_when_interactive(
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
) -> None:
|
|
"""An ambiguous name prompts when interactive."""
|
|
results = [resolve.SearchResult(1, "Witcher 3"), resolve.SearchResult(2, "Witcher")]
|
|
monkeypatch.setattr(resolve, "search", lambda name: results)
|
|
monkeypatch.setattr(resolve, "prompt_confirm", lambda r: r[1])
|
|
|
|
resolved = target.resolve_target("witch", None, interactive=True)
|
|
|
|
assert resolved.source == "picked"
|
|
|
|
|
|
def _two_witchers(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
monkeypatch.setattr(
|
|
resolve,
|
|
"search",
|
|
lambda name: [
|
|
resolve.SearchResult(1, "Witcher 3"),
|
|
resolve.SearchResult(2, "Witcher 2"),
|
|
],
|
|
)
|
|
|
|
|
|
@pytest.mark.usefixtures("steam_knows_the_app")
|
|
def test_an_ambiguous_name_fails_closed_when_not_interactive(
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
) -> None:
|
|
"""Guessing here is how the wrong 90 GB gets downloaded."""
|
|
_two_witchers(monkeypatch)
|
|
|
|
with pytest.raises(target.TargetError, match="Ambiguous"):
|
|
target.resolve_target("witch", None, interactive=False)
|
|
|
|
|
|
@pytest.mark.usefixtures("steam_knows_the_app")
|
|
def test_an_ambiguous_name_lists_the_candidates(
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
capsys: pytest.CaptureFixture[str],
|
|
) -> None:
|
|
"""An ambiguous name lists the candidates."""
|
|
_two_witchers(monkeypatch)
|
|
|
|
with pytest.raises(target.TargetError, match="Ambiguous"):
|
|
target.resolve_target("witch", None, interactive=False)
|
|
|
|
err = capsys.readouterr().err
|
|
assert "Witcher 3" in err
|
|
assert "Witcher 2" in err
|
|
|
|
|
|
def test_no_matches_is_an_error_not_a_default_pick(
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
) -> None:
|
|
"""No matches is an error not a default pick."""
|
|
monkeypatch.setattr(resolve, "search", lambda name: [])
|
|
with pytest.raises(target.TargetError, match="No Steam app matches"):
|
|
target.resolve_target("kwyjibo", None, interactive=False)
|
|
|
|
|
|
def test_search_being_unavailable_points_at_the_appid_workaround(
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
) -> None:
|
|
"""Search being unavailable points at the appid workaround."""
|
|
|
|
def boom(_name: str) -> Never:
|
|
msg = "tls blocked"
|
|
raise resolve.SearchUnavailableError(msg)
|
|
|
|
monkeypatch.setattr(resolve, "search", boom)
|
|
|
|
with pytest.raises(target.TargetError, match="numeric AppID"):
|
|
target.resolve_target("BeamNG", None, interactive=False)
|
|
|
|
|
|
def test_digits_that_are_not_an_appid_fall_through_to_a_name_search(
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
) -> None:
|
|
"""A game literally called "2048" exists, so digits are not unambiguous."""
|
|
tried = []
|
|
|
|
def metadata(appid: int) -> appinfo.AppMetadata:
|
|
tried.append(appid)
|
|
if appid == 2048:
|
|
msg = "no such app"
|
|
raise appinfo.AppInfoError(msg)
|
|
return appinfo.AppMetadata(appid, "2048", "2048")
|
|
|
|
monkeypatch.setattr(appinfo, "get_metadata", metadata)
|
|
monkeypatch.setattr(
|
|
resolve, "search", lambda name: [resolve.SearchResult(999, "2048")]
|
|
)
|
|
|
|
resolved = target.resolve_target("2048", None, interactive=False)
|
|
|
|
assert resolved.metadata.appid == 999
|
|
assert tried == [2048, 999]
|
|
|
|
|
|
def test_an_unknown_appid_from_a_url_does_not_fall_through(
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
) -> None:
|
|
"""A URL cannot also be a game's name, so there is nothing to fall back to."""
|
|
|
|
def boom(_appid: int) -> Never:
|
|
msg = "no such app"
|
|
raise appinfo.AppInfoError(msg)
|
|
|
|
monkeypatch.setattr(appinfo, "get_metadata", boom)
|
|
|
|
with pytest.raises(target.TargetError, match="not a known Steam app"):
|
|
target.resolve_target(
|
|
"https://store.steampowered.com/app/1/x/", None, interactive=False
|
|
)
|
|
|
|
|
|
def test_no_target_at_all_is_an_error() -> None:
|
|
"""No target at all is an error."""
|
|
with pytest.raises(target.TargetError, match="No target given"):
|
|
target.resolve_target(None, None, interactive=False)
|