diff options
Diffstat (limited to 'tests')
| -rw-r--r-- | tests/test_flatpak_service.py | 341 | ||||
| -rw-r--r-- | tests/test_plugin_flatpak_lifecycle.py | 62 | ||||
| -rw-r--r-- | tests/test_plugin_migration.py | 5 | ||||
| -rw-r--r-- | tests/test_steam_service.py | 120 | ||||
| -rw-r--r-- | tests/test_wrapper_service.py | 145 |
5 files changed, 277 insertions, 396 deletions
diff --git a/tests/test_flatpak_service.py b/tests/test_flatpak_service.py index d5baf61..6e7067f 100644 --- a/tests/test_flatpak_service.py +++ b/tests/test_flatpak_service.py @@ -24,17 +24,16 @@ class FlatpakServiceTests(unittest.TestCase): self.service = FlatpakService() self.service.user_home = self.home self.service.config_dir = self.home / ".config/lsfg-vk" + self.service.config_dir.mkdir(parents=True) self.service.config_file_path = self.service.config_dir / "conf.toml" self.service.check_flatpak_available = Mock(return_value=True) self.service._run_flatpak_command = Mock(side_effect=self._run_flatpak_command) - self.runtime_ref = "org.freedesktop.Platform/x86_64/24.08" - self.runtime_metadata = "" self.user_branches = set() self.system_branches = set() - self.install_branch = "24.08" - self.bundle = self.home / "lsfg-vk-24.08.flatpak" - self.bundle.write_bytes(b"bundle") - self.service._bundled_extension_path = Mock(return_value=self.bundle) + self.filesystems = {} + self.service._bundled_extension_path = Mock( + side_effect=lambda branch: self._bundle(branch) + ) def tearDown(self): self.tempdir.cleanup() @@ -47,252 +46,172 @@ class FlatpakServiceTests(unittest.TestCase): def _extension_line(branch): return f"org.freedesktop.Platform.VulkanLayer.lsfgvk\tx86_64\t{branch}\n" + def _bundle(self, branch): + path = self.home / f"lsfg-vk-{branch}.flatpak" + path.write_bytes(b"bundle") + return path + + def _override_output(self): + if not self.filesystems: + return "" + values = ";".join( + f"{path}:{mode}" for path, mode in sorted(self.filesystems.items()) + ) + return f"[Context]\nfilesystems={values};\n" + def _run_flatpak_command(self, args, **_kwargs): - if args[0] == "info" and args[1] == "--show-runtime": - return self._result(self.runtime_ref + "\n") - if args[0] == "info" and args[1] == "--show-metadata": - return self._result(self.runtime_metadata) if args[0] == "list": branches = self.user_branches if "--user" in args else self.system_branches return self._result("".join(self._extension_line(branch) for branch in sorted(branches))) if args[0] == "install": - self.user_branches.add(self.install_branch) + bundle = Path(args[-1]) + self.user_branches.add(bundle.stem.removeprefix("lsfg-vk-")) return self._result() if args[0] == "uninstall": self.user_branches.discard(args[-1].rsplit("/", 1)[-1]) return self._result() - raise AssertionError(f"Unexpected Flatpak command: {args}") - - def test_runtime_branch_mapping_is_strict_and_branch_specific(self): - self.assertEqual( - FlatpakService.runtime_branch_from_ref( - "org.freedesktop.Platform/x86_64/24.08" - ), - "24.08", - ) - self.assertEqual( - FlatpakService.runtime_branch_from_ref( - "org.freedesktop.Platform//25.08" - ), - "25.08", - ) - with self.assertRaises(ValueError): - FlatpakService.runtime_branch_from_ref("org.gnome.Sdk/x86_64/46") - with self.assertRaises(ValueError): - FlatpakService.runtime_branch_from_ref( - "org.freedesktop.Platform/x86_64/26.08" + if args[0] == "override" and "--show" in args: + return self._result(self._override_output()) + if args[0] == "override": + filesystem = next( + (arg.removeprefix("--filesystem=") for arg in args if arg.startswith("--filesystem=")), + None, ) - - def test_runtime_branch_mapping_reads_documented_gl_metadata(self): - metadata = """ -[Extension org.freedesktop.Platform.GL] -versions=25.08;25.08-extra;1.4 -version=1.4 -""" - self.assertEqual(FlatpakService.runtime_branch_from_metadata(metadata), "25.08") - with self.assertRaises(ValueError): - FlatpakService.runtime_branch_from_metadata( - "[Extension org.freedesktop.Platform.GL]\nversions=26.08;26.08-extra;1.4\n" + if filesystem is not None: + path, _, mode = filesystem.rpartition(":") + self.filesystems[path] = mode + return self._result() + filesystem = next( + (arg.removeprefix("--nofilesystem=") for arg in args if arg.startswith("--nofilesystem=")), + None, ) + if filesystem is not None: + self.filesystems.pop(filesystem, None) + return self._result() + raise AssertionError(f"Unexpected Flatpak command: {args}") - def test_resolve_reads_required_runtime_instead_of_any_installed_branch(self): - self.user_branches = {"23.08"} - - response = self.service.resolve_app_support("com.example.Game") + def _mutating_commands(self): + return [ + call.args[0] + for call in self.service._run_flatpak_command.call_args_list + if call.args[0][0] in {"install", "uninstall", "override"} + and "--show" not in call.args[0] + ] - self.assertTrue(response["success"]) - self.assertEqual(response["runtime_branch"], "24.08") - self.assertEqual(response["support_status"], "needs-runtime") - self.assertFalse(response["extension_installed"]) - self.assertEqual( - self.service._run_flatpak_command.call_args_list[0].args[0], - ["info", "--show-runtime", "com.example.Game"], - ) - self.assertEqual( - self.service._run_flatpak_command.call_args_list[1].args[0], - ["list", "--user", "--runtime", "--columns=application,arch,branch"], - ) - self.assertEqual( - self.service._run_flatpak_command.call_args_list[2].args[0], - ["list", "--system", "--runtime", "--columns=application,arch,branch"], + def test_ensure_installs_all_bundled_branches_and_exact_read_only_grants(self): + configured_dll = self.home / "Games" / "Lossless Scaling" / "lsfg-vk.dll" + self.service.config_file_path.write_text( + f'version = 2\n[global]\ndll = {json.dumps(str(configured_dll))}\n', + encoding="utf-8", ) - def test_resolve_maps_kde_and_gnome_runtimes_from_gl_metadata(self): - metadata = "[Extension org.freedesktop.Platform.GL]\nversions=25.08;25.08-extra;1.4\n" - for runtime in ("org.kde.Platform/x86_64/6.10", "org.gnome.Platform/x86_64/49"): - with self.subTest(runtime=runtime): - self.service._run_flatpak_command.reset_mock() - self.runtime_ref = runtime - self.runtime_metadata = metadata - response = self.service.resolve_app_support("com.example.Game") - self.assertEqual(response["runtime_branch"], "25.08") - self.assertEqual(response["support_status"], "needs-runtime") - self.assertEqual( - self.service._run_flatpak_command.call_args_list[1].args[0], - ["info", "--show-metadata", runtime], - ) - - def test_system_extension_is_ready_without_installing_a_user_copy(self): - self.system_branches = {"24.08"} - - response = self.service.ensure_app_support("com.example.Game") + response = self.service.ensure_plugin_support() self.assertTrue(response["success"]) - self.assertEqual(response["support_status"], "ready") - self.assertEqual( - [call.args[0][0] for call in self.service._run_flatpak_command.call_args_list], - ["info", "list", "list"], - ) - self.assertFalse(any(call.args[0][0] == "install" for call in self.service._run_flatpak_command.call_args_list)) - - def test_install_records_only_a_new_user_owned_branch(self): - response = self.service.install_extension("24.08") + self.assertTrue(response["ready"]) + self.assertEqual(response["installed_branches"], ["23.08", "24.08", "25.08"]) + expected_grants = {str(self.service.config_dir), str(configured_dll.parent)} + self.assertEqual(set(self.filesystems), expected_grants) + self.assertEqual(set(self.filesystems.values()), {"ro"}) + metadata = json.loads(self.service.ownership_path.read_text(encoding="utf-8")) + self.assertEqual(metadata["version"], 2) + self.assertEqual(metadata["plugin_owned_branches"], ["23.08", "24.08", "25.08"]) + self.assertEqual(set(metadata["plugin_owned_filesystems"]), expected_grants) + installs = [command for command in self._mutating_commands() if command[0] == "install"] + grants = [command for command in self._mutating_commands() if "--filesystem=" in " ".join(command)] + self.assertEqual(len(installs), 3) + self.assertEqual(len(grants), 2) + self.assertNotIn("--filesystem=/home", " ".join(" ".join(command) for command in grants)) + self.assertNotIn("--filesystem=--", " ".join(" ".join(command) for command in grants)) + + def test_repeated_setup_is_a_no_op_when_state_is_correct(self): + self.assertTrue(self.service.ensure_plugin_support()["success"]) + self.service._run_flatpak_command.reset_mock() + + response = self.service.ensure_plugin_support() self.assertTrue(response["success"]) - self.assertTrue(response["enabled"]) - self.assertTrue(response["installed"]) - install_args = self.service._run_flatpak_command.call_args_list[2].args[0] - self.assertEqual(install_args[:4], ["install", "--user", "--noninteractive", "--or-update"]) - self.assertEqual( - json.loads(self.service.ownership_path.read_text(encoding="utf-8")), - {"version": 1, "plugin_owned_branches": ["24.08"]}, - ) - - def test_preexisting_branch_is_not_claimed_or_removed(self): - self.user_branches = {"24.08"} - - install_response = self.service.install_extension("24.08") - cleanup_response = self.service.remove_plugin_owned_extensions() + self.assertTrue(response["ready"]) + self.assertFalse(self._mutating_commands()) - self.assertTrue(install_response["success"]) - self.assertTrue(install_response["enabled"]) - self.assertTrue(install_response["installed"]) - self.assertFalse(self.service.ownership_path.exists()) - self.assertTrue(cleanup_response["success"]) - self.assertEqual(self.service._run_flatpak_command.call_count, 2) - - def test_extension_toggle_preserves_preexisting_branch(self): - self.user_branches = {"24.08"} - - enable_response = self.service.set_extension_enabled("24.08", True) - disable_response = self.service.set_extension_enabled("24.08", False) - - self.assertTrue(enable_response["success"]) - self.assertTrue(enable_response["enabled"]) - self.assertTrue(enable_response["installed"]) - self.assertTrue(disable_response["success"]) - self.assertTrue(disable_response["enabled"]) - self.assertTrue(disable_response["installed"]) - self.assertFalse(disable_response["removed"]) - self.assertEqual(self.user_branches, {"24.08"}) - self.assertEqual( - [call.args[0][0] for call in self.service._run_flatpak_command.call_args_list], - ["list", "list", "list", "list"], - ) - - def test_extension_toggle_removes_owned_user_branch_but_preserves_system_branch(self): - self.service.ownership_path.parent.mkdir(parents=True, exist_ok=True) - self.service.ownership_path.write_text( - json.dumps({"version": 1, "plugin_owned_branches": ["24.08"]}), - encoding="utf-8", - ) - self.user_branches = {"24.08"} + def test_preexisting_branches_and_grants_are_not_claimed_or_removed(self): + self.user_branches = {"23.08"} self.system_branches = {"24.08"} + preexisting_config = str(self.service.config_dir) + self.filesystems[preexisting_config] = "ro" - disable_response = self.service.set_extension_enabled("24.08", False) - repeat_response = self.service.set_extension_enabled("24.08", False) + setup = self.service.ensure_plugin_support() + cleanup = self.service.remove_plugin_owned_extensions() - self.assertTrue(disable_response["success"]) - self.assertTrue(disable_response["enabled"]) - self.assertTrue(disable_response["removed"]) - self.assertTrue(repeat_response["success"]) - self.assertTrue(repeat_response["enabled"]) - self.assertTrue(repeat_response["installed"]) - self.assertEqual(self.user_branches, set()) + self.assertTrue(setup["success"]) + self.assertTrue(cleanup["success"]) + self.assertEqual(self.user_branches, {"23.08"}) self.assertEqual(self.system_branches, {"24.08"}) + self.assertEqual(self.filesystems, {preexisting_config: "ro"}) + self.assertFalse(self.service.ownership_path.exists()) + repeat = self.service.remove_plugin_owned_extensions() + self.assertTrue(repeat["success"]) + + def test_uninstall_removes_plugin_owned_state_and_preserves_unrelated_override(self): + unrelated = str(self.home / "Games" / "Other") + self.filesystems[unrelated] = "ro" + + self.assertTrue(self.service.ensure_plugin_support()["success"]) + cleanup = self.service.remove_plugin_owned_extensions() + + self.assertTrue(cleanup["success"]) + self.assertEqual(cleanup["removed_branches"], ["23.08", "24.08", "25.08"]) + self.assertEqual(set(cleanup["removed_filesystem_grants"]), { + str(self.service.config_dir), + str(self.home / ".local/share/Steam/steamapps/common/Lossless Scaling"), + }) + self.assertEqual(self.user_branches, set()) + self.assertEqual(self.filesystems, {unrelated: "ro"}) self.assertFalse(self.service.ownership_path.exists()) - uninstall_commands = [ - call.args[0] - for call in self.service._run_flatpak_command.call_args_list - if call.args[0][0] == "uninstall" - ] - self.assertEqual(len(uninstall_commands), 1) - def test_corrupt_ownership_metadata_fails_closed(self): - self.service.ownership_path.parent.mkdir(parents=True, exist_ok=True) - self.service.ownership_path.write_text("{not-json", encoding="utf-8") + def test_cleanup_is_idempotent_after_owned_state_is_gone(self): + self.assertTrue(self.service.ensure_plugin_support()["success"]) + self.assertTrue(self.service.remove_plugin_owned_extensions()["success"]) + self.service._run_flatpak_command.reset_mock() response = self.service.remove_plugin_owned_extensions() - self.assertFalse(response["success"]) - self.assertTrue(response["ownership_uncertain"]) + self.assertTrue(response["success"]) + self.assertFalse(response["ownership_uncertain"]) self.assertEqual(self.service._run_flatpak_command.call_count, 0) - def test_dangling_ownership_symlink_fails_closed(self): - self.service.ownership_path.parent.mkdir(parents=True, exist_ok=True) - self.service.ownership_path.symlink_to(self.home / "missing-metadata") + def test_changed_owned_grant_is_preserved_and_metadata_is_retained(self): + self.assertTrue(self.service.ensure_plugin_support()["success"]) + config_path = str(self.service.config_dir) + self.filesystems[config_path] = "rw" response = self.service.remove_plugin_owned_extensions() self.assertFalse(response["success"]) - self.assertTrue(response["ownership_uncertain"]) - self.assertEqual(self.service._run_flatpak_command.call_count, 0) - - def test_ensure_app_support_installs_only_the_app_runtime_branch(self): - response = self.service.ensure_app_support("com.example.Game") + self.assertEqual(self.filesystems[config_path], "rw") + self.assertTrue(self.service.ownership_path.exists()) + remaining = json.loads(self.service.ownership_path.read_text(encoding="utf-8")) + self.assertIn(config_path, remaining["plugin_owned_filesystems"]) - self.assertTrue(response["success"]) - self.assertEqual(response["support_status"], "ready") - self.assertEqual(response["runtime_branch"], "24.08") - install_args = next( - call.args[0] - for call in self.service._run_flatpak_command.call_args_list - if call.args[0][0] == "install" - ) - self.assertEqual(install_args[0], "install") - self.assertIn("--user", install_args) - self.assertNotIn("23.08", install_args) - self.assertEqual( - json.loads(self.service.ownership_path.read_text(encoding="utf-8")), - {"version": 1, "plugin_owned_branches": ["24.08"]}, - ) + def test_corrupt_ownership_metadata_fails_closed_without_flatpak_commands(self): + self.service.ownership_path.write_text("{not-json", encoding="utf-8") - def test_two_shortcuts_using_one_flatpak_share_one_extension_branch(self): - first = self.service.ensure_app_support("net.pcsx2.PCSX2") - second = self.service.ensure_app_support("net.pcsx2.PCSX2.Dev") + response = self.service.remove_plugin_owned_extensions() - self.assertEqual(first["support_status"], "ready") - self.assertEqual(second["support_status"], "ready") - install_commands = [ - call.args[0] - for call in self.service._run_flatpak_command.call_args_list - if call.args[0][0] == "install" - ] - self.assertEqual(len(install_commands), 1) - self.assertEqual( - json.loads(self.service.ownership_path.read_text(encoding="utf-8")), - {"version": 1, "plugin_owned_branches": ["24.08"]}, - ) + self.assertFalse(response["success"]) + self.assertTrue(response["ownership_uncertain"]) + self.assertEqual(self.service._run_flatpak_command.call_count, 0) - def test_cleanup_removes_all_owned_branches_without_reusing_stale_metadata(self): - self.service.ownership_path.parent.mkdir(parents=True, exist_ok=True) - self.service.ownership_path.write_text( - json.dumps({"version": 1, "plugin_owned_branches": ["23.08", "24.08"]}), - encoding="utf-8", + def test_global_override_parser_handles_permissions_and_unrelated_entries(self): + parsed = FlatpakService._parse_filesystems( + "[Context]\nfilesystems=/home/deck/config:ro;/home/deck/other:rw;/tmp/create:create;\n" ) - self.user_branches = {"23.08", "24.08"} - - response = self.service.remove_plugin_owned_extensions() - self.assertTrue(response["success"]) - self.assertEqual(response["removed_branches"], ["23.08", "24.08"]) - self.assertFalse(self.service.ownership_path.exists()) - uninstall_commands = [ - call.args[0] - for call in self.service._run_flatpak_command.call_args_list - if call.args[0][0] == "uninstall" - ] - self.assertEqual(len(uninstall_commands), 2) + self.assertEqual(parsed, { + "/home/deck/config": "ro", + "/home/deck/other": "rw", + "/tmp/create": "create", + }) if __name__ == "__main__": diff --git a/tests/test_plugin_flatpak_lifecycle.py b/tests/test_plugin_flatpak_lifecycle.py new file mode 100644 index 0000000..25f09b6 --- /dev/null +++ b/tests/test_plugin_flatpak_lifecycle.py @@ -0,0 +1,62 @@ +import asyncio +import sys +import types +import unittest +from unittest.mock import Mock + + +sys.modules.setdefault( + "decky", + types.SimpleNamespace( + DECKY_HOME="/decky", + DECKY_USER_HOME="/home/deck", + logger=Mock(), + ), +) +sys.modules.setdefault("tomllib", types.SimpleNamespace(loads=Mock())) +sys.path.insert(0, "py_modules") + +from lsfg_vk.plugin import Plugin + + +class PluginFlatpakLifecycleTests(unittest.TestCase): + def test_install_and_reload_ensure_global_flatpak_support(self): + plugin = Plugin.__new__(Plugin) + plugin.installation_service = Mock() + plugin.installation_service.install.return_value = {"success": True} + plugin.installation_service.check_installation.return_value = {"installed": True} + plugin.flatpak_service = Mock() + plugin.flatpak_service.ensure_plugin_support.return_value = {"success": True} + plugin.wrapper_service = Mock() + plugin.wrapper_service.repair.return_value = {"success": True} + + installed = asyncio.run(plugin.install_lsfg_vk()) + asyncio.run(plugin._main()) + + self.assertTrue(installed["success"]) + self.assertEqual(plugin.flatpak_service.ensure_plugin_support.call_count, 2) + plugin.wrapper_service.repair.assert_called_once_with() + + def test_unload_does_not_remove_persistent_flatpak_setup(self): + plugin = Plugin.__new__(Plugin) + plugin.installation_service = Mock() + plugin.flatpak_service = Mock() + + asyncio.run(plugin._unload()) + + plugin.flatpak_service.remove_plugin_owned_extensions.assert_not_called() + + def test_uninstall_is_the_flatpak_cleanup_boundary(self): + plugin = Plugin.__new__(Plugin) + plugin.installation_service = Mock() + plugin.flatpak_service = Mock() + plugin.flatpak_service.remove_plugin_owned_extensions.return_value = {"success": True} + + asyncio.run(plugin._uninstall()) + + plugin.installation_service.cleanup_on_uninstall.assert_called_once_with() + plugin.flatpak_service.remove_plugin_owned_extensions.assert_called_once_with() + + +if __name__ == "__main__": + unittest.main() diff --git a/tests/test_plugin_migration.py b/tests/test_plugin_migration.py index a392f85..100f677 100644 --- a/tests/test_plugin_migration.py +++ b/tests/test_plugin_migration.py @@ -21,7 +21,10 @@ class PluginMigrationTests(unittest.TestCase): sys.modules["tomllib"] = types.SimpleNamespace(loads=Mock()) try: sys.path.insert(0, "py_modules") + import lsfg_vk.plugin as plugin_module from lsfg_vk.plugin import Plugin + previous_plugin_decky = plugin_module.decky + plugin_module.decky = decky plugin = Plugin.__new__(Plugin) plugin.installation_service = Mock() @@ -35,6 +38,8 @@ class PluginMigrationTests(unittest.TestCase): plugin.installation_service.install.assert_not_called() plugin.flatpak_service.migrate_v2.assert_not_called() finally: + if "plugin_module" in locals(): + plugin_module.decky = previous_plugin_decky sys.path.remove("py_modules") if previous_decky is None: sys.modules.pop("decky", None) diff --git a/tests/test_steam_service.py b/tests/test_steam_service.py index 636c87f..95bd2a2 100644 --- a/tests/test_steam_service.py +++ b/tests/test_steam_service.py @@ -1,3 +1,4 @@ +import tempfile import sys import types import unittest @@ -15,102 +16,79 @@ from lsfg_vk.steam_service import SteamService, classify_shortcut_transport class SteamTransportTests(unittest.TestCase): - def test_only_direct_canonical_flatpak_forms_are_classified(self): + def test_only_a_direct_usr_bin_flatpak_target_is_special(self): self.assertEqual( - classify_shortcut_transport( - "/usr/bin/flatpak", - "run com.example.PCSX2 --fullscreen", - ), - {"kind": "flatpak", "flatpakAppId": "com.example.PCSX2"}, - ) - self.assertEqual( - classify_shortcut_transport( - "flatpak", - "run com.example.PCSX2 --fullscreen", - ), - {"kind": "flatpak", "flatpakAppId": "com.example.PCSX2"}, - ) - self.assertEqual( - classify_shortcut_transport( - "/usr/bin/flatpak run com.example.PCSX2", - "--fullscreen", - ), - {"kind": "flatpak", "flatpakAppId": "com.example.PCSX2"}, - ) - self.assertEqual( - classify_shortcut_transport( - "/usr/bin/bash", - "~/launch-game.sh --fullscreen", - ), - {"kind": "host"}, - ) - self.assertEqual( - classify_shortcut_transport( - "/usr/bin/flatpak", - "--user run com.example.PCSX2", - ), - {"kind": "host"}, - ) - self.assertEqual( - classify_shortcut_transport( - "/usr/bin/flatpak", - "run bash ~/launch-game.sh", - ), - {"kind": "host"}, - ) - self.assertEqual( - classify_shortcut_transport( - "~/.lsfg", - "run --branch=stable --arch=x86_64 com.example.PCSX2", - ), - {"kind": "flatpak", "flatpakAppId": "com.example.PCSX2"}, + classify_shortcut_transport("/usr/bin/flatpak", "run com.example.Game --fullscreen"), + {"kind": "flatpak"}, ) + for executable, options in ( + ("flatpak", "run com.example.Game"), + ("/usr/bin/flatpak run com.example.Game", "--fullscreen"), + ("~/.lsfg", "run com.example.Game"), + ("/usr/bin/bash", "~/launch-game.sh --fullscreen"), + ): + with self.subTest(executable=executable, options=options): + self.assertEqual(classify_shortcut_transport(executable, options), {"kind": "host"}) + self.assertEqual( - classify_shortcut_transport( - "/home/deck/.lsfg", - "run com.example.PCSX2", - ), - {"kind": "flatpak", "flatpakAppId": "com.example.PCSX2"}, + classify_shortcut_transport("/usr/bin/flatpak", "--user run com.example.Game"), + {"kind": "flatpak"}, ) self.assertEqual( - classify_shortcut_transport("~/.lsfg", "--profile high"), - {"kind": "host"}, + classify_shortcut_transport('"~/.lsfg" "/usr/bin/flatpak"', "run com.example.Game"), + {"kind": "flatpak"}, ) + self.assertEqual(classify_shortcut_transport("~/.lsfg", "run com.example.Game"), {"kind": "host"}) - def test_shortcut_data_preserves_transport_inputs(self): + def test_direct_flatpak_shortcut_keeps_arguments_without_an_app_id(self): game = SteamService._shortcut_game( { "appid": 123456, - "AppName": "PCSX2 shortcut", + "AppName": "Flatpak shortcut", "Exe": "/usr/bin/flatpak", "LaunchOptions": "run net.pcsx2.PCSX2 --fullscreen", "StartDir": "/home/deck/Games", } ) - self.assertEqual(game["appid"], "123456") - self.assertEqual(game["transport"], { - "kind": "flatpak", - "flatpakAppId": "net.pcsx2.PCSX2", - }) + self.assertEqual(game["transport"], {"kind": "flatpak"}) self.assertEqual(game["executable"], "/usr/bin/flatpak") self.assertEqual(game["arguments"], "run net.pcsx2.PCSX2 --fullscreen") self.assertEqual(game["startDir"], "/home/deck/Games") - def test_wrapped_flatpak_shortcut_remains_a_flatpak_target(self): + def test_shell_targets_are_opaque_host_targets(self): game = SteamService._shortcut_game( { - "appid": 987654, - "AppName": "Wrapped Flatpak", - "Exe": "~/.lsfg", - "LaunchOptions": "run --branch=stable --arch=x86_64 com.example.Game", + "appid": 654321, + "AppName": "EmuDeck-style launcher", + "Exe": "/usr/bin/bash", + "LaunchOptions": "~/Emulators/launch-game.sh --game-id foo", } ) - self.assertEqual(game["transport"], { - "kind": "flatpak", - "flatpakAppId": "com.example.Game", - }) + self.assertEqual(game["transport"], {"kind": "host"}) + + def test_normal_steam_manifest_always_uses_host_transport(self): + with tempfile.TemporaryDirectory() as directory: + home = Path(directory) + steamapps = home / ".local/share/Steam/steamapps" + steamapps.mkdir(parents=True) + (steamapps / "appmanifest_123.acf").write_text( + '"AppState" {\n\t"name" "Steam game"\n}\n', + encoding="utf-8", + ) + service = SteamService() + service.user_home = home + + response = service.get_installed_games() + + self.assertTrue(response["success"]) + self.assertEqual(response["games"], [{ + "appid": "123", + "name": "Steam game", + "nonSteam": False, + "transport": {"kind": "host"}, + }]) if __name__ == "__main__": diff --git a/tests/test_wrapper_service.py b/tests/test_wrapper_service.py index 0632d93..52b2aef 100644 --- a/tests/test_wrapper_service.py +++ b/tests/test_wrapper_service.py @@ -1,3 +1,4 @@ +import json import os import subprocess import sys @@ -27,6 +28,7 @@ class WrapperServiceTests(unittest.TestCase): self.service.local_bin_dir = self.home / ".local/bin" self.service.config_dir = self.home / ".config/lsfg-vk" self.service.sidecar_path = self.service.config_dir / "workarounds.json" + self.service.config_file_path = self.service.config_dir / "conf.toml" self.service.wrapper_path = self.service.local_bin_dir / "lsfg" def tearDown(self): @@ -51,6 +53,7 @@ class WrapperServiceTests(unittest.TestCase): def test_writes_owned_dispatcher_and_validates_shell(self): response = self.service.set("123", self._state(dxvkFrameRate=60, enableZink=True)) + self.assertTrue(response["success"]) self.assertEqual(response["wrapper_path"], "~/.lsfg") self.assertTrue(response["wrapper_owned"]) @@ -58,8 +61,10 @@ class WrapperServiceTests(unittest.TestCase): self.assertEqual(subprocess.run(["/bin/sh", "-n", str(self.service.wrapper_path)]).returncode, 0) self.assertIn(self.service.MARKER, self.service.wrapper_path.read_text(encoding="utf-8")) self.assertEqual(self.service.get("123")["state"], self._state(dxvkFrameRate=60, enableZink=True)) + document = json.loads(self.service.sidecar_path.read_text(encoding="utf-8")) + self.assertNotIn("transport", document["apps"]["123"]) - def test_dispatch_clears_managed_values_preserves_other_environment_and_appends_config(self): + def test_dispatch_exports_required_workaround_context_and_clears_disable_flags(self): self.service.set( "123", self._state(dxvkFrameRate=30, disableSteamdeckMode=True, disableVkbasalt=True, enableZink=True), @@ -72,11 +77,15 @@ class WrapperServiceTests(unittest.TestCase): "DXVK_FRAME_RATE": "5", "ENABLE_GAMESCOPE_WSI": "1", "DISABLE_VKBASALT": "0", + "DISABLE_LSFGVK": "1", + "DISABLE_LSFG": "1", "MESA_LOADER_DRIVER_OVERRIDE": "llvmpipe", "MANGOHUD": "1", }, ) values = dict(line.split("=", 1) for line in result.stdout.splitlines() if "=" in line) + self.assertEqual(values["SteamAppId"], "123") + self.assertEqual(values["LSFGVK_CONFIG"], str(self.service.config_file_path)) self.assertEqual(values["ENABLE_GAMESCOPE_WSI"], "0") self.assertEqual(values["DXVK_HDR"], "0") self.assertEqual(values["SteamDeck"], "0") @@ -87,7 +96,8 @@ class WrapperServiceTests(unittest.TestCase): self.assertEqual(values["DXVK_CONFIG"], "dxgi.syncInterval = 0; dxvk.maxFrameRate = 30") self.assertEqual(values["MANGOHUD"], "1") self.assertNotIn("DXVK_FRAME_RATE", values) - self.assertNotIn("ENABLE_VKBASALT", values) + self.assertNotIn("DISABLE_LSFGVK", values) + self.assertNotIn("DISABLE_LSFG", values) def test_appid_fallback_and_unmatched_passthrough(self): self.service.set("123", self._state(disableGamescopeWsi=False, disableHdr=False)) @@ -100,8 +110,9 @@ class WrapperServiceTests(unittest.TestCase): check=True, ) fallback_values = dict(line.split("=", 1) for line in fallback.stdout.splitlines() if "=" in line) + self.assertEqual(fallback_values["SteamAppId"], "456") self.assertEqual(fallback_values["SteamDeck"], "0") - self.assertEqual(fallback_values["SteamGameId"], "456") + self.assertEqual(fallback_values["LSFGVK_CONFIG"], str(self.service.config_file_path)) passthrough = subprocess.run( [str(self.service.wrapper_path), "/usr/bin/env"], @@ -114,130 +125,35 @@ class WrapperServiceTests(unittest.TestCase): self.assertEqual(passthrough_values["KEEP"], "yes") self.assertEqual(passthrough_values["DXVK_HDR"], "1") - def test_flatpak_shortcut_receives_env_arguments_and_original_target(self): - fake_flatpak = self.home / ".local/bin/flatpak" - fake_flatpak.parent.mkdir(parents=True, exist_ok=True) - fake_flatpak.write_text( - "#!/bin/sh\n" - "printf 'ARG:%s\\n' \"$@\"\n", - encoding="utf-8", - ) - fake_flatpak.chmod(0o755) - self.service.set( - "123", - self._state(dxvkFrameRate=20, enableZink=True), - str(fake_flatpak), - False, - {"kind": "flatpak", "flatpakAppId": "com.example.Game"}, - ) - result = self._run(123, "run", "com.example.Game", "--windowed", env={"DXVK_CONFIG": "foo=1"}) - args = result.stdout.splitlines() - self.assertEqual(args[0], "ARG:run") - self.assertIn("ARG:--filesystem=" + str(self.service.config_dir) + ":rw", args) - self.assertIn("ARG:--filesystem=" + str(self.home / ".local/share/Steam/steamapps/common/Lossless Scaling") + ":ro", args) - self.assertIn("ARG:--env=LSFGVK_CONFIG=" + str(self.service.config_file_path), args) - self.assertIn("ARG:--env=LSFGVK_FLATPAK=1", args) - self.assertIn("ARG:--env=SteamAppId=123", args) - self.assertIn("ARG:--env=ENABLE_GAMESCOPE_WSI=0", args) - self.assertIn("ARG:--env=DXVK_HDR=0", args) - self.assertIn("ARG:--env=__GLX_VENDOR_LIBRARY_NAME=mesa", args) - self.assertIn("ARG:--env=MESA_LOADER_DRIVER_OVERRIDE=zink", args) - self.assertIn("ARG:--env=GALLIUM_DRIVER=zink", args) - self.assertIn("ARG:--env=DXVK_CONFIG=foo=1; dxvk.maxFrameRate = 20", args) - self.assertIn("ARG:com.example.Game", args) - self.assertIn("ARG:--windowed", args) - - def test_flatpak_full_executable_form_is_preserved(self): - fake_flatpak = self.home / ".local/bin/flatpak" - fake_flatpak.parent.mkdir(parents=True, exist_ok=True) - fake_flatpak.write_text( - "#!/bin/sh\n" - "printf 'ARG:%s\\n' \"$@\"\n", - encoding="utf-8", - ) - fake_flatpak.chmod(0o755) + def test_direct_flatpak_state_has_only_original_target_transport(self): response = self.service.set( "123", - self._state(), - f"{fake_flatpak} run com.example.Game", - False, - {"kind": "flatpak", "flatpakAppId": "com.example.Game"}, - ) - self.assertTrue(response["success"]) - result = self._run(123, "--windowed") - args = result.stdout.splitlines() - self.assertEqual(args[0], "ARG:run") - self.assertIn("ARG:com.example.Game", args) - self.assertIn("ARG:--windowed", args) - - def test_host_transport_does_not_store_shortcut_target(self): - self.service.set( - "123", - self._state(), + self._state(enableZink=True), "/usr/bin/flatpak", False, - {"kind": "flatpak", "flatpakAppId": "com.example.Game"}, - ) - response = self.service.set( - "123", - self._state(), - "/usr/bin/ignored", - False, - {"kind": "host"}, - ) - self.assertTrue(response["success"]) - self.assertIsNone(response["shortcut_exe"]) - self.assertIsNone(self.service.get("123")["shortcut_exe"]) - - def test_flatpak_transport_rejects_non_run_invocation(self): - fake_flatpak = self.home / ".local/bin/flatpak" - fake_flatpak.parent.mkdir(parents=True, exist_ok=True) - fake_flatpak.write_text("#!/bin/sh\nexit 0\n", encoding="utf-8") - fake_flatpak.chmod(0o755) - response = self.service.set( - "123", - self._state(), - str(fake_flatpak), - False, - {"kind": "flatpak", "flatpakAppId": "com.example.Game"}, + {"kind": "flatpak"}, ) - self.assertTrue(response["success"]) - result = subprocess.run( - [str(self.service.wrapper_path), "bash", "launch-game.sh"], - env={"PATH": "/usr/bin:/bin", "SteamAppId": "123"}, - capture_output=True, - text=True, - ) - self.assertEqual(result.returncode, 64) - self.assertIn("direct flatpak run", result.stderr) - def test_flatpak_transport_rejects_external_app_id_change(self): - fake_flatpak = self.home / ".local/bin/flatpak" - fake_flatpak.parent.mkdir(parents=True, exist_ok=True) - fake_flatpak.write_text("#!/bin/sh\nexit 0\n", encoding="utf-8") - fake_flatpak.chmod(0o755) - response = self.service.set( - "123", - self._state(), - str(fake_flatpak), - False, - {"kind": "flatpak", "flatpakAppId": "com.example.Game"}, - ) self.assertTrue(response["success"]) - result = subprocess.run( - [str(self.service.wrapper_path), "run", "com.other.Game"], - env={"PATH": "/usr/bin:/bin", "SteamAppId": "123"}, - capture_output=True, - text=True, - ) - self.assertEqual(result.returncode, 64) - self.assertIn("application ID changed externally", result.stderr) + self.assertEqual(response["transport"], {"kind": "flatpak"}) + self.assertEqual(response["shortcut_exe"], "/usr/bin/flatpak") + document = json.loads(self.service.sidecar_path.read_text(encoding="utf-8")) + self.assertEqual(document["apps"]["123"]["transport"], {"kind": "flatpak"}) + wrapper = self.service.wrapper_path.read_text(encoding="utf-8") + self.assertIn("LSFGVK_FLATPAK=1", wrapper) + self.assertIn("SteamAppId=\"$appid\"", wrapper) + self.assertIn("export LSFGVK_CONFIG", wrapper) + self.assertNotIn("--filesystem=", wrapper) + self.assertIn('exec "$shortcut_exe" "$@"', wrapper) + self.assertEqual(subprocess.run(["/bin/sh", "-n", str(self.service.wrapper_path)]).returncode, 0) def test_invalid_state_and_foreign_wrapper_fail_closed(self): invalid = self.service.set("0", self.service.default_state()) self.assertFalse(invalid["success"]) invalid = self.service.set("123", {**self.service.default_state(), "dxvkFrameRate": 61}) self.assertFalse(invalid["success"]) + invalid = self.service.set("123", self.service.default_state(), "/tmp/flatpak", False, {"kind": "flatpak"}) + self.assertFalse(invalid["success"]) self.service.local_bin_dir.mkdir(parents=True, exist_ok=True) self.service.wrapper_path.write_text("#!/bin/sh\necho foreign\n", encoding="utf-8") @@ -249,6 +165,7 @@ class WrapperServiceTests(unittest.TestCase): def test_remove_keeps_a_safe_owned_passthrough_wrapper(self): self.service.set("123", self.service.default_state()) response = self.service.remove("123") + self.assertTrue(response["success"]) self.assertIsNone(self.service.get("123")["state"]) self.assertTrue(self.service.wrapper_path.exists()) |