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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
|
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_file_path = self.service.config_dir / "conf.toml"
self.service.ownership_path.parent.mkdir(parents=True, exist_ok=True)
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.user_extension_origin = "flathub"
self.apps = {"com.example.Game": "Example Game"}
self.dll_dir = self.home / ".local/share/Steam/steamapps/common/Lossless Scaling"
self.service._dll_directory = Mock(return_value=self.dll_dir)
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"
@staticmethod
def _parse_override(content):
section = None
filesystems = []
unset_environment = []
environment = {}
other = []
for raw in content.splitlines():
line = raw.strip()
if line.startswith("[") and line.endswith("]"):
section = line[1:-1]
continue
key, separator, value = line.partition("=")
if not separator:
continue
if section == "Context" and key == "filesystems":
filesystems.extend(item for item in value.split(";") if item)
elif section == "Context" and key == "unset-environment":
unset_environment.extend(item for item in value.split(";") if item)
elif section == "Environment":
environment[key] = value
else:
other.append((section, key, value))
return filesystems, unset_environment, environment, other
@staticmethod
def _serialize_override(filesystems, unset_environment, environment):
lines = ["[Context]"]
if filesystems:
lines.append("filesystems=" + ";".join(filesystems) + ";")
if unset_environment:
lines.append("unset-environment=" + ";".join(unset_environment) + ";")
if environment:
lines.append("")
lines.append("[Environment]")
lines.extend(f"{key}={value}" for key, value in environment.items())
return "\n".join(lines) + "\n"
def _apply_override(self, args):
app_id = args[-1]
path = self.service._override_path(app_id)
content = path.read_text(encoding="utf-8") if path.exists() else ""
filesystems, unset_environment, environment, _ = self._parse_override(content)
for arg in args[2:-1]:
if arg.startswith("--filesystem="):
value = arg.split("=", 1)[1]
if value not in filesystems:
filesystems.append(value)
elif arg.startswith("--env="):
key, value = arg.split("=", 1)[1].split("=", 1)
environment[key] = value
if key in unset_environment:
unset_environment.remove(key)
elif arg.startswith("--unset-env="):
key = arg.split("=", 1)[1]
environment.pop(key, None)
if key not in unset_environment:
unset_environment.append(key)
path.parent.mkdir(parents=True, exist_ok=True)
path.write_text(
self._serialize_override(filesystems, unset_environment, environment),
encoding="utf-8",
)
return self._result()
def _run_flatpak_command(self, args, **_kwargs):
if args[:2] == ["info", "--show-runtime"]:
return self._result(self.runtime_ref + "\n")
if args[:2] == ["info", "--show-metadata"]:
return self._result(self.runtime_metadata)
if args[:3] == ["info", "--user", "--show-origin"]:
return self._result(self.user_extension_origin)
if args[:2] == ["list", "--app"]:
return self._result("".join(f"{name}\t{app_id}\n" for app_id, name in self.apps.items()))
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.runtime_ref.rsplit("/", 1)[-1])
return self._result()
if args[0] == "uninstall":
self.user_branches.discard(args[-1].rsplit("/", 1)[-1])
return self._result()
if args[:3] == ["override", "--user", "--show"]:
path = self.service._override_path(args[-1])
return self._result(path.read_text(encoding="utf-8") if path.exists() else "")
if args[:2] == ["override", "--user"]:
return self._apply_override(args)
raise AssertionError(f"Unexpected Flatpak command: {args}")
def test_resolves_freedesktop_and_derived_runtimes(self):
runtime, branch = self.service._resolve_runtime("com.example.Game")
self.assertEqual(runtime, self.runtime_ref)
self.assertEqual(branch, "24.08")
self.runtime_ref = "org.kde.Platform/x86_64/6.10"
self.runtime_metadata = "[Extension org.freedesktop.Platform.GL]\nversions=25.08;25.08-extra;1.4\n"
runtime, branch = self.service._resolve_runtime("com.example.Game")
self.assertEqual(runtime, self.runtime_ref)
self.assertEqual(branch, "25.08")
def test_prepare_app_installs_runtime_and_persists_narrow_override(self):
response = self.service.prepare_app("com.example.Game")
self.assertTrue(response["success"])
self.assertTrue(response["prepared"])
self.assertTrue(response["owned"])
self.assertEqual(response["runtime_branch"], "24.08")
self.assertEqual(self.user_branches, {"24.08"})
install_calls = [
call.args[0]
for call in self.service._run_flatpak_command.call_args_list
if call.args[0][0] == "install"
]
self.assertEqual(
install_calls,
[[
"install",
"--user",
"--noninteractive",
"--or-update",
"flathub",
"org.freedesktop.Platform.VulkanLayer.lsfgvk//24.08",
]],
)
status = self.service._app_override_status("com.example.Game")
self.assertTrue(status["prepared"])
content = self.service._override_path("com.example.Game").read_text(encoding="utf-8")
self.assertIn(str(self.service.config_dir) + ":ro", content)
self.assertIn(str(self.dll_dir) + ":ro", content)
self.assertIn("LSFGVK_CONFIG=" + str(self.service.config_file_path), content)
self.assertIn("LSFGVK_FLATPAK=1", content)
self.assertNotIn("ENABLE_GAMESCOPE_WSI", content)
state = json.loads(self.service.ownership_path.read_text(encoding="utf-8"))
self.assertEqual(state["plugin_owned_branches"], ["24.08"])
self.assertIn("com.example.Game", state["prepared_apps"])
def test_prepare_is_idempotent(self):
first = self.service.prepare_app("com.example.Game")
first_content = self.service._override_path("com.example.Game").read_bytes()
second = self.service.prepare_app("com.example.Game")
self.assertTrue(first["success"])
self.assertTrue(second["success"])
self.assertEqual(first_content, self.service._override_path("com.example.Game").read_bytes())
install_calls = [call for call in self.service._run_flatpak_command.call_args_list if call.args[0][0] == "install"]
self.assertEqual(len(install_calls), 1)
def test_replaces_extension_from_another_remote(self):
self.user_branches = {"24.08"}
self.user_extension_origin = "lsfgvk-origin"
response = self.service.install_extension("24.08")
self.assertTrue(response["success"])
commands = [call.args[0] for call in self.service._run_flatpak_command.call_args_list]
self.assertIn(
[
"uninstall",
"--user",
"--noninteractive",
"org.freedesktop.Platform.VulkanLayer.lsfgvk/x86_64/24.08",
],
commands,
)
self.assertEqual(self.user_branches, {"24.08"})
def test_preinstalled_runtime_is_not_owned(self):
self.system_branches = {"24.08"}
response = self.service.prepare_app("com.example.Game")
self.assertTrue(response["success"])
state = json.loads(self.service.ownership_path.read_text(encoding="utf-8"))
self.assertEqual(state["plugin_owned_branches"], [])
self.assertIn("com.example.Game", state["prepared_apps"])
def test_external_preparation_is_preserved(self):
path = self.service._override_path("com.example.Game")
path.parent.mkdir(parents=True, exist_ok=True)
path.write_text(
self._serialize_override(
[str(self.service.config_dir) + ":ro", str(self.dll_dir) + ":ro"],
["DISABLE_LSFGVK", "DISABLE_LSFG"],
{
"LSFGVK_CONFIG": str(self.service.config_file_path),
"LSFGVK_FLATPAK": "1",
},
),
encoding="utf-8",
)
self.system_branches = {"24.08"}
response = self.service.prepare_app("com.example.Game")
self.assertTrue(response["success"])
self.assertTrue(response["prepared"])
self.assertFalse(response["owned"])
self.assertFalse(self.service.ownership_path.exists())
def test_remove_restores_exact_previous_override(self):
self.system_branches = {"24.08"}
original = "[Context]\nfilesystems=~/Documents;\n\n[Environment]\nFOO=bar\n"
path = self.service._override_path("com.example.Game")
path.parent.mkdir(parents=True, exist_ok=True)
path.write_text(original, encoding="utf-8")
self.assertTrue(self.service.prepare_app("com.example.Game")["success"])
response = self.service.remove_app_override("com.example.Game")
self.assertTrue(response["success"])
self.assertEqual(path.read_text(encoding="utf-8"), original)
self.assertFalse(self.service.ownership_path.exists())
def test_remove_deletes_override_created_by_plugin(self):
self.system_branches = {"24.08"}
self.assertTrue(self.service.prepare_app("com.example.Game")["success"])
path = self.service._override_path("com.example.Game")
self.assertTrue(path.exists())
response = self.service.remove_app_override("com.example.Game")
self.assertTrue(response["success"])
self.assertFalse(path.exists())
self.assertFalse(self.service.ownership_path.exists())
def test_remove_fails_closed_after_external_change(self):
self.system_branches = {"24.08"}
self.assertTrue(self.service.prepare_app("com.example.Game")["success"])
path = self.service._override_path("com.example.Game")
with path.open("a", encoding="utf-8") as handle:
handle.write("EXTERNAL=1\n")
response = self.service.remove_app_override("com.example.Game")
self.assertFalse(response["success"])
self.assertIn("changed after preparation", response["error"])
self.assertTrue(path.exists())
self.assertTrue(self.service.ownership_path.exists())
def test_full_cleanup_removes_only_owned_state(self):
self.system_branches = {"23.08"}
self.assertTrue(self.service.prepare_app("com.example.Game")["success"])
self.assertEqual(self.user_branches, {"24.08"})
response = self.service.remove_plugin_owned_environment()
self.assertTrue(response["success"])
self.assertEqual(response["removed_apps"], ["com.example.Game"])
self.assertEqual(response["removed_branches"], ["24.08"])
self.assertEqual(self.user_branches, set())
self.assertEqual(self.system_branches, {"23.08"})
self.assertFalse(self.service.ownership_path.exists())
def test_corrupt_ownership_metadata_fails_closed(self):
self.service.ownership_path.write_text("{not-json", encoding="utf-8")
response = self.service.remove_plugin_owned_environment()
self.assertFalse(response["success"])
self.assertEqual(self.service._run_flatpak_command.call_count, 0)
if __name__ == "__main__":
unittest.main()
|
