Something went wrong. Try again.
Steam Deck Doom modding setup automation for Doom Runner, UZDoom, Brutal Doom, and Project Brutality.
brutal-doom moddb python doom-runner linux-gaming project-brutality uzdoom doom steam-deck
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364from __future__ import annotations
import argparseimport jsonimport loggingimport zipfilefrom pathlib import Path
import pytest
from doomdeck.application.doomrunner import DoomRunnerLiveConfigSettings, doomrunner_options_paths, write_doomrunner_live_configfrom doomdeck.application.launchers import write_launchers_and_manifestfrom doomdeck.application.steam_input import write_managed_steam_input_profilefrom doomdeck.application.uzdoom import write_uzdoom_configsfrom doomdeck.application.validation import ( InstallationValidator, add_validation_item, format_validation_report, validation_has_failures,)from doomdeck.cli import validate_internalfrom doomdeck.domain.models import SteamInfofrom doomdeck.domain.paths import all_managed_dirs, build_dirsfrom doomdeck.infrastructure.binary_vdf import BinaryVDFfrom doomdeck.infrastructure.steam_shortcuts import empty_shortcuts_root, make_shortcut_entry, shortcut_entries
def make_executable(path: Path) -> None: path.write_text("#!/usr/bin/env sh\nexit 0\n", encoding="utf-8") path.chmod(0o755)
def test_validation_items_use_explicit_levels_and_format_report() -> None: report = []
add_validation_item(report, "PASS", "First check passed") add_validation_item(report, "FAIL", "Second check failed")
assert validation_has_failures(report) assert report[0].level == "PASS" assert format_validation_report(report) == ( "\n" "Validation report\n" "=================\n" "[PASS] First check passed\n" "[FAIL] Second check failed\n" )
def test_installation_validator_uses_injected_environment_check(tmp_path: Path) -> None: dirs = build_dirs(tmp_path / "Doom") validator = InstallationValidator( steamos_detector=lambda: (True, "SteamOS test fixture"), shell_syntax_checker=lambda _path: True, )
report = validator.validate(dirs, SteamInfo(None, None, None, [], None))
messages = {item.message: item.level for item in report} assert messages["SteamOS test fixture"] == "PASS" assert messages[f"Required path exists: {dirs.root}"] == "FAIL"
def test_installation_validator_checks_shell_syntax_through_dependency(tmp_path: Path) -> None: dirs = build_dirs(tmp_path / "Doom") script_path = dirs.launchers / "example.sh" script_path.parent.mkdir(parents=True) make_executable(script_path) checked_paths: list[Path] = []
def reject_shell_syntax(path: Path) -> bool: checked_paths.append(path) return False
validator = InstallationValidator( steamos_detector=lambda: (True, "SteamOS test fixture"), shell_syntax_checker=reject_shell_syntax, )
report = validator.validate(dirs, SteamInfo(None, None, None, [], None))
assert script_path in checked_paths messages = {item.message: item.level for item in report} assert messages[f"Shell syntax valid for {script_path}"] == "FAIL"
def test_validation_reports_non_object_json_configs_without_crashing(tmp_path: Path) -> None: dirs = build_dirs(tmp_path / "Doom") logger = logging.getLogger("test") args = argparse.Namespace(dry_run=False) manifest_path = dirs.doomrunner_config / "preset-manifest.json" live_options_path = doomrunner_options_paths(dirs)[0] manifest_path.parent.mkdir(parents=True) live_options_path.parent.mkdir(parents=True) manifest_path.write_text("[]", encoding="utf-8") live_options_path.write_text("[]", encoding="utf-8")
report = validate_internal(args, dirs, SteamInfo(None, None, None, [], None), logger)
messages = {item.message for item in report} assert f"Preset manifest JSON must be an object: {manifest_path}" in messages assert f"Doom Runner generated options JSON must be an object: {live_options_path}" in messages
def test_validation_reports_malformed_preset_manifest_without_crashing(tmp_path: Path) -> None: dirs = build_dirs(tmp_path / "Doom") logger = logging.getLogger("test") args = argparse.Namespace(dry_run=False) manifest_path = dirs.doomrunner_config / "preset-manifest.json" manifest_path.parent.mkdir(parents=True) manifest_path.write_text( """{ "schema": "doom-deck-setup/preset-manifest/v1", "generated_at": "2026-06-12T12:00:00", "root": "/tmp/Doom", "engine": {}, "iwad_directory": "/tmp/Doom/iwads", "pwad_directory": "/tmp/Doom/pwads", "mod_directories": {}, "presets": {}}""", encoding="utf-8", )
report = validate_internal(args, dirs, SteamInfo(None, None, None, [], None), logger)
failures = [item.message for item in report if item.level == "FAIL"] assert any("Preset manifest structure is invalid" in failure for failure in failures) assert any("Preset manifest presets must be a list" in failure for failure in failures)
def test_validation_reports_directory_valued_json_path_without_crashing(tmp_path: Path) -> None: dirs = build_dirs(tmp_path / "Doom") manifest_path = dirs.doomrunner_config / "preset-manifest.json" manifest_path.mkdir(parents=True)
report = validate_internal( argparse.Namespace(dry_run=False), dirs, SteamInfo(None, None, None, [], None), logging.getLogger("test"), )
assert any( item.level == "FAIL" and f"Preset manifest JSON is not a file: {manifest_path}" in item.message for item in report )
def test_validation_reports_invalid_utf8_json_without_crashing(tmp_path: Path) -> None: dirs = build_dirs(tmp_path / "Doom") manifest_path = dirs.doomrunner_config / "preset-manifest.json" manifest_path.parent.mkdir(parents=True) manifest_path.write_bytes(b"\xff\xfe")
report = validate_internal( argparse.Namespace(dry_run=False), dirs, SteamInfo(None, None, None, [], None), logging.getLogger("test"), )
assert any( item.level == "FAIL" and f"Preset manifest JSON could not be read: {manifest_path}" in item.message for item in report )
def test_uzdoom_configs_bind_quicksave_keys_without_direct_stick_click_quickload(tmp_path: Path) -> None: dirs = build_dirs(tmp_path / "Doom") logger = logging.getLogger("test")
write_uzdoom_configs(dirs, dry_run=False, logger=logger)
for profile in ["classic", "modern", "brutal", "project-brutality"]: autoexec = (dirs.uzdoom_config / profile / "autoexec.cfg").read_text(encoding="utf-8").lower() assert "bind f6 quicksave" in autoexec assert "bind f9 quickload" in autoexec assert "bind pad_lthumb quicksave" not in autoexec assert "bind pad_rthumb quickload" not in autoexec assert "bind e +deck_use_select" in autoexec
def test_validation_accepts_a_generated_managed_setup(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None: dirs = build_dirs(tmp_path / "Doom") logger = logging.getLogger("test") args = argparse.Namespace(dry_run=False, skip_doomrunner_live_config=False)
for directory in all_managed_dirs(dirs): directory.mkdir(parents=True, exist_ok=True)
(dirs.doomrunner / "DoomRunner.exe").write_bytes(b"exe") (dirs.uzdoom / "uzdoom.exe").write_bytes(b"exe") (dirs.iwads / "DOOM2.WAD").write_bytes(b"iwad") (dirs.brutal / "brutal-doom.pk3").write_bytes(b"brutal") (dirs.brutal / "brutal-doom.json").write_text("{}", encoding="utf-8") with zipfile.ZipFile(dirs.project_brutality / "project-brutality.pk3", "w") as archive: archive.writestr("gameinfo.txt", "") archive.writestr("zscript.zc", "") (dirs.project_brutality / "project-brutality.json").write_text("{}", encoding="utf-8") (dirs.backups / "existing-backup").write_text("", encoding="utf-8")
write_uzdoom_configs(dirs, dry_run=False, logger=logger) write_managed_steam_input_profile(dirs, dry_run=False, logger=logger) manifest = write_launchers_and_manifest( dirs, dirs.brutal / "brutal-doom.pk3", dirs.project_brutality / "project-brutality.pk3", dry_run=False, logger=logger, ) monkeypatch.setattr("doomdeck.cli.detect_steamos", lambda: (True, "SteamOS test fixture")) write_doomrunner_live_config( dirs, manifest, DoomRunnerLiveConfigSettings(dry_run=False), logger, process_detector=lambda _patterns: False, )
report = validate_internal(args, dirs, SteamInfo(None, None, None, [], None), logger)
failures = [item.message for item in report if item.level == "FAIL"] assert failures == [] assert any("Preset manifest includes Project Brutality preset" in item.message for item in report) assert any("Doom Runner generated config has launchable presets" in item.message for item in report) assert any("Project Brutality archive has expected UZDoom root files" in item.message for item in report)
def test_validation_fails_generated_preset_that_references_missing_mod_file(tmp_path: Path) -> None: dirs = build_dirs(tmp_path / "Doom") logger = logging.getLogger("test") args = argparse.Namespace(dry_run=False, skip_doomrunner_live_config=False)
for directory in all_managed_dirs(dirs): directory.mkdir(parents=True, exist_ok=True) (dirs.doomrunner / "DoomRunner.exe").write_bytes(b"exe") (dirs.uzdoom / "uzdoom.exe").write_bytes(b"exe") (dirs.iwads / "DOOM2.WAD").write_bytes(b"iwad") write_uzdoom_configs(dirs, dry_run=False, logger=logger) write_managed_steam_input_profile(dirs, dry_run=False, logger=logger) manifest = { "schema": "doom-deck-setup/preset-manifest/v1", "generated_at": "2026-06-12T12:00:00", "warning": "Generated", "root": str(dirs.root), "engine": { "name": "UZDoom", "executable": str(dirs.uzdoom / "uzdoom.exe"), "family": "UZDoom/ZDoom", "config_directory": str(dirs.uzdoom_config), "data_directory": str(dirs.root), }, "iwad_directory": str(dirs.iwads), "pwad_directory": str(dirs.pwads), "mod_directories": {"brutal_doom": str(dirs.brutal)}, "presets": [ { "name": "Brutal Doom", "category": "Brutal Doom", "engine": "UZDoom", "iwad": str(dirs.iwads / "DOOM2.WAD"), "files": [str(dirs.brutal / "brutal-doom.pk3")], "config": str(dirs.uzdoom_config / "modern" / "uzdoom.ini"), "autoexec": str(dirs.uzdoom_config / "modern" / "autoexec.cfg"), "launcher": str(dirs.launchers / "Brutal_Doom.sh"), } ], } (dirs.doomrunner_config / "preset-manifest.json").write_text(json.dumps(manifest), encoding="utf-8") write_doomrunner_live_config( dirs, manifest, DoomRunnerLiveConfigSettings(dry_run=False), logger, process_detector=lambda _patterns: False, )
report = validate_internal(args, dirs, SteamInfo(None, None, None, [], None), logger)
failures = [item.message for item in report if item.level == "FAIL"] assert any(f"Preset Brutal Doom mod file reference: {dirs.brutal / 'brutal-doom.pk3'}" == failure for failure in failures) assert any("Doom Runner generated config resolves UZDoom launch paths for presets" in failure for failure in failures)
def test_validation_reports_extra_doomdeck_steam_shortcuts(tmp_path: Path) -> None: dirs = build_dirs(tmp_path / "Doom") shortcuts_path = tmp_path / "Steam" / "userdata" / "123" / "config" / "shortcuts.vdf" shortcuts_path.parent.mkdir(parents=True) root = empty_shortcuts_root() shortcuts = shortcut_entries(root) shortcuts["0"] = make_shortcut_entry("Doom Runner", dirs.doomrunner / "DoomRunner.exe", dirs.doomrunner, tags=["Doom"]) shortcuts["1"] = make_shortcut_entry( "DoomDeck - Project Brutality", dirs.uzdoom / "uzdoom.exe", dirs.uzdoom, tags=["Doom"], launch_options="-iwad DOOM2.WAD", ) shortcuts_path.write_bytes(BinaryVDF.dumps(root)) validator = InstallationValidator( steamos_detector=lambda: (True, "SteamOS test fixture"), shell_syntax_checker=lambda _path: True, )
report = validator.validate(dirs, SteamInfo(tmp_path / "Steam", "123", shortcuts_path, [], None))
messages = {item.message: item.level for item in report} assert messages["Exactly one Steam shortcut exists for Windows Doom Runner with expected executable path"] == "PASS" assert messages["No extra DoomDeck preset Steam shortcuts remain: DoomDeck - Project Brutality"] == "FAIL"
def test_validation_rejects_quickload_tokens_outside_r5_activator(tmp_path: Path) -> None: dirs = build_dirs(tmp_path / "Doom") logger = logging.getLogger("test") profile = write_managed_steam_input_profile(dirs, dry_run=False, logger=logger) text = profile.read_text(encoding="utf-8").replace('"Long_Press"', '"Full_Press"', 1) profile.write_text( text + '\n"decoy" { "Long_Press" "long_press_time" "1500" "binding" "key_press F9" }\n', encoding="utf-8", )
report = validate_internal( argparse.Namespace(dry_run=False, skip_doomrunner_live_config=False), dirs, SteamInfo(None, None, None, [], None), logger, )
quickload_items = [item for item in report if "quick load requires long press" in item.message] assert len(quickload_items) == 1 assert quickload_items[0].level == "FAIL"
def test_validation_rejects_duplicate_quickload_block_outside_switches_group(tmp_path: Path) -> None: dirs = build_dirs(tmp_path / "Doom") logger = logging.getLogger("test") profile = write_managed_steam_input_profile(dirs, dry_run=False, logger=logger) text = profile.read_text(encoding="utf-8") marker_start = text.index('"button_back_right"') block_start = text.index("{", marker_start) depth = 0 block_end = block_start for block_end in range(block_start, len(text)): depth += (text[block_end] == "{") - (text[block_end] == "}") if depth == 0: break valid_block = text[marker_start : block_end + 1] unsafe_profile = text.replace('"Long_Press"', '"Full_Press"', 1) profile.write_text(valid_block + "\n" + unsafe_profile, encoding="utf-8")
report = validate_internal( argparse.Namespace(dry_run=False, skip_doomrunner_live_config=False), dirs, SteamInfo(None, None, None, [], None), logger, )
quickload_items = [item for item in report if "quick load requires long press" in item.message] assert len(quickload_items) == 1 assert quickload_items[0].level == "FAIL"