1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
import json
import sys
import tempfile
import types
import unittest
from pathlib import Path
from unittest.mock import Mock
sys.modules.setdefault(
"decky",
types.SimpleNamespace(DECKY_USER_HOME="/home/deck", logger=Mock()),
)
sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "py_modules"))
from lsfg_vk.flatpak_service import FlatpakService
class FlatpakServiceTests(unittest.TestCase):
def setUp(self):
self.tempdir = tempfile.TemporaryDirectory()
self.home = Path(self.tempdir.name) / "home" / "deck"
self.home.mkdir(parents=True)
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.user_branches = set()
self.system_branches = set()
self.filesystems = {}
self.service._bundled_extension_path = Mock(
side_effect=lambda branch: self._bundle(branch)
)
def tearDown(self):
self.tempdir.cleanup()
@staticmethod
def _result(stdout="", returncode=0, stderr=""):
return types.SimpleNamespace(stdout=stdout, returncode=returncode, stderr=stderr)
@staticmethod
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] == "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":
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()
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,
)
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 _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]
]
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",
)
response = self.service.ensure_plugin_support()
self.assertTrue(response["success"])
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["ready"])
self.assertFalse(self._mutating_commands())
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"
setup = self.service.ensure_plugin_support()
cleanup = self.service.remove_plugin_owned_extensions()
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())
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.assertTrue(response["success"])
self.assertFalse(response["ownership_uncertain"])
self.assertEqual(self.service._run_flatpak_command.call_count, 0)
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.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"])
def test_corrupt_ownership_metadata_fails_closed_without_flatpak_commands(self):
self.service.ownership_path.write_text("{not-json", encoding="utf-8")
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_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.assertEqual(parsed, {
"/home/deck/config": "ro",
"/home/deck/other": "rw",
"/tmp/create": "create",
})
if __name__ == "__main__":
unittest.main()
|
