-
Notifications
You must be signed in to change notification settings - Fork 290
Expand file tree
/
Copy pathtest_webui_backend.py
More file actions
480 lines (372 loc) · 19.3 KB
/
Copy pathtest_webui_backend.py
File metadata and controls
480 lines (372 loc) · 19.3 KB
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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
"""unittest-based coverage for WebUI backend state management."""
import json
import os
import tempfile
import unittest
from pathlib import Path
from unittest.mock import patch
from simpletuner.cli.common import _find_webui_state_file
from simpletuner.simpletuner_sdk.server.services.webui_state import (
OnboardingStepState,
WebUIDefaults,
WebUIOnboardingState,
WebUIStateStore,
)
from simpletuner.simpletuner_sdk.server.utils.paths import get_config_directory
class WebUIStateStoreTests(unittest.TestCase):
def setUp(self) -> None:
self._tmpdir = tempfile.TemporaryDirectory()
self.temp_path = Path(self._tmpdir.name)
# Ensure we're using a clean isolated directory by setting SIMPLETUNER_WEB_UI_CONFIG
self.webui_dir = self.temp_path / "webui_state"
self._env_patches = patch.dict(
os.environ, {"HOME": str(self.temp_path), "SIMPLETUNER_WEB_UI_CONFIG": str(self.webui_dir)}
)
self._env_patches.start()
self.store = WebUIStateStore()
def tearDown(self) -> None:
self._env_patches.stop()
self._tmpdir.cleanup()
def test_initialization_creates_directory(self) -> None:
# Since we're setting SIMPLETUNER_WEB_UI_CONFIG, it should use that path
expected = self.webui_dir
self.assertTrue(expected.exists())
self.assertEqual(self.store.base_dir, expected)
def test_save_and_load_defaults(self) -> None:
# Use temp directories that actually exist
configs_dir = self.temp_path / "configs"
configs_dir.mkdir(exist_ok=True)
output_dir = self.temp_path / "output"
output_dir.mkdir(exist_ok=True)
# Create the active config directory
config_dir = configs_dir / "my-config"
config_dir.mkdir(exist_ok=True)
(config_dir / "config.json").write_text('{"test": true}')
defaults = WebUIDefaults(
configs_dir=str(configs_dir),
output_dir=str(output_dir),
active_config="my-config",
)
self.store.save_defaults(defaults)
loaded = self.store.load_defaults()
self.assertEqual(loaded.configs_dir, defaults.configs_dir)
self.assertEqual(loaded.output_dir, defaults.output_dir)
self.assertEqual(loaded.active_config, defaults.active_config)
def test_save_and_load_onboarding_state(self) -> None:
onboarding = WebUIOnboardingState()
step_state = OnboardingStepState()
step_state.value = "/some/path"
step_state.completed_version = 1
step_state.completed_at = "2025-01-01T00:00:00"
onboarding.steps["test_step"] = step_state
self.store.save_onboarding(onboarding)
loaded = self.store.load_onboarding()
self.assertIn("test_step", loaded.steps)
self.assertEqual(loaded.steps["test_step"].value, "/some/path")
self.assertEqual(loaded.steps["test_step"].completed_version, 1)
def test_record_onboarding_step(self) -> None:
self.store.record_onboarding_step(step_id="configs_dir", version=2, value="/new/configs")
onboarding = self.store.load_onboarding()
self.assertIn("configs_dir", onboarding.steps)
record = onboarding.steps["configs_dir"]
self.assertEqual(record.value, "/new/configs")
self.assertEqual(record.completed_version, 2)
self.assertIsNotNone(record.completed_at)
def test_load_state_combines_defaults_and_onboarding(self) -> None:
defaults = WebUIDefaults(configs_dir="/configs", output_dir="/output")
self.store.save_defaults(defaults)
self.store.record_onboarding_step("test_step", 1, "/test/value")
state = self.store.load_state()
self.assertEqual(state.defaults.configs_dir, "/configs")
self.assertEqual(state.defaults.output_dir, "/output")
self.assertIn("test_step", state.onboarding.steps)
def test_load_defaults_returns_empty_when_missing(self) -> None:
loaded = self.store.load_defaults()
self.assertIsInstance(loaded, WebUIDefaults)
self.assertIsNone(loaded.configs_dir)
self.assertIsNone(loaded.output_dir)
self.assertIsNone(loaded.active_config)
self.assertTrue(loaded.cloud_tab_enabled)
def test_legacy_defaults_without_cloud_tab_enabled_keeps_cloud_enabled(self) -> None:
defaults_file = self.store.base_dir / "defaults.json"
defaults_file.write_text(json.dumps({"theme": "dark"}))
loaded = self.store.load_defaults()
bundle = self.store.resolve_defaults(loaded)
self.assertTrue(loaded.cloud_tab_enabled)
self.assertTrue(bundle["resolved"]["cloud_tab_enabled"])
def test_null_cloud_tab_enabled_keeps_default_enabled(self) -> None:
defaults_file = self.store.base_dir / "defaults.json"
defaults_file.write_text(json.dumps({"cloud_tab_enabled": None}))
loaded = self.store.load_defaults()
self.assertTrue(loaded.cloud_tab_enabled)
def test_false_cloud_tab_enabled_is_preserved(self) -> None:
defaults_file = self.store.base_dir / "defaults.json"
defaults_file.write_text(json.dumps({"cloud_tab_enabled": False}))
loaded = self.store.load_defaults()
self.assertFalse(loaded.cloud_tab_enabled)
def test_load_onboarding_returns_empty_when_missing(self) -> None:
loaded = self.store.load_onboarding()
self.assertIsInstance(loaded, WebUIOnboardingState)
self.assertEqual(len(loaded.steps), 0)
def test_invalid_json_raises(self) -> None:
defaults_file = self.store.base_dir / "defaults.json"
defaults_file.write_text("{ invalid json }")
with self.assertRaisesRegex(ValueError, "Failed to read web UI state"):
self.store.load_defaults()
def test_path_normalization_behaviour(self) -> None:
defaults = WebUIDefaults(configs_dir="~/configs/../configs", output_dir="./output")
with patch.dict(os.environ, {"HOME": "/home/user"}):
self.store.save_defaults(defaults)
loaded = self.store.load_defaults()
self.assertEqual(loaded.configs_dir, "~/configs/../configs")
self.assertEqual(loaded.output_dir, "./output")
def test_concurrent_saves_do_not_corrupt_state(self) -> None:
import threading
def save_defaults(idx: int):
path_dir = self.temp_path / f"path_{idx}"
path_dir.mkdir(exist_ok=True)
defaults = WebUIDefaults(configs_dir=str(path_dir))
self.store.save_defaults(defaults)
threads = [threading.Thread(target=save_defaults, args=(i,)) for i in range(5)]
for thread in threads:
thread.start()
for thread in threads:
thread.join()
loaded = self.store.load_defaults()
self.assertIsNotNone(loaded.configs_dir)
# Check that it's one of the paths we created
self.assertTrue(any(loaded.configs_dir.endswith(f"path_{i}") for i in range(5)))
def test_accelerate_overrides_persist_and_normalize(self) -> None:
defaults = WebUIDefaults()
defaults.accelerate_overrides = {
"mode": "manual",
"num_processes": "4",
"--same_network": "false",
"--main_process_port": "12345",
"--unknown_key": 10,
"device_ids": ["0", 1, 1, 3],
"manual_count": "3",
}
self.store.save_defaults(defaults)
loaded = self.store.load_defaults()
self.assertEqual(loaded.accelerate_overrides.get("--num_processes"), 4)
self.assertFalse(loaded.accelerate_overrides.get("--same_network"))
self.assertEqual(loaded.accelerate_overrides.get("--main_process_port"), 12345)
self.assertNotIn("--unknown_key", loaded.accelerate_overrides)
self.assertEqual(loaded.accelerate_overrides.get("mode"), "manual")
self.assertEqual(loaded.accelerate_overrides.get("manual_count"), 3)
self.assertEqual(loaded.accelerate_overrides.get("device_ids"), [0, 1, 3])
def test_accelerate_hardware_mode_discards_num_processes(self) -> None:
defaults = WebUIDefaults()
defaults.accelerate_overrides = {
"mode": "hardware",
"--num_processes": "6",
"manual_count": "4",
}
self.store.save_defaults(defaults)
loaded = self.store.load_defaults()
self.assertEqual(loaded.accelerate_overrides.get("mode"), "hardware")
self.assertNotIn("--num_processes", loaded.accelerate_overrides)
# Manual metadata remains so users can switch back without losing previous input
self.assertEqual(loaded.accelerate_overrides.get("manual_count"), 4)
class WebUIWorkspacePathTests(unittest.TestCase):
def setUp(self) -> None:
self._tmpdir = tempfile.TemporaryDirectory()
self.temp_path = Path(self._tmpdir.name)
self.workspace = self.temp_path / "workspace"
self._env_patches = patch.dict(
os.environ,
{
"HOME": str(self.temp_path / "home"),
"SIMPLETUNER_WORKSPACE": str(self.workspace),
"SIMPLETUNER_WEB_UI_CONFIG": "",
"SIMPLETUNER_CONFIG_DIR": "",
"XDG_HOME": "",
"XDG_CONFIG_HOME": "",
},
)
self._env_patches.start()
def tearDown(self) -> None:
self._env_patches.stop()
self._tmpdir.cleanup()
def test_workspace_env_controls_webui_fallback_paths(self) -> None:
store = WebUIStateStore()
bundle = store.get_defaults_bundle()
self.assertEqual(store.base_dir, self.workspace / "webui")
self.assertEqual(bundle["fallbacks"]["configs_dir"], str(self.workspace / "config"))
self.assertEqual(bundle["fallbacks"]["output_dir"], str(self.workspace / "output"))
self.assertEqual(bundle["fallbacks"]["datasets_dir"], str(self.workspace / "datasets"))
def test_workspace_env_controls_cli_webui_state_discovery(self) -> None:
defaults_path = self.workspace / "webui" / "defaults.json"
defaults_path.parent.mkdir(parents=True)
defaults_path.write_text("{}", encoding="utf-8")
self.assertEqual(_find_webui_state_file("defaults.json"), defaults_path)
def test_workspace_env_controls_default_config_directory(self) -> None:
self.assertEqual(get_config_directory(), self.workspace / "config")
self.assertTrue((self.workspace / "config").exists())
class WebUIDefaultsUpdateTests(WebUIStateStoreTests):
def test_update_configs_dir_only_preserves_other_fields(self) -> None:
# Use temp directories that actually exist
old_configs_dir = self.temp_path / "old_configs"
old_configs_dir.mkdir(exist_ok=True)
old_output_dir = self.temp_path / "old_output"
old_output_dir.mkdir(exist_ok=True)
new_configs_dir = self.temp_path / "new_configs"
new_configs_dir.mkdir(exist_ok=True)
# Create the old config directory
old_config_dir = old_configs_dir / "old-config"
old_config_dir.mkdir(exist_ok=True)
(old_config_dir / "config.json").write_text('{"test": true}')
# Create the same config in new location
new_config_dir = new_configs_dir / "old-config"
new_config_dir.mkdir(exist_ok=True)
(new_config_dir / "config.json").write_text('{"test": true}')
defaults = WebUIDefaults(
configs_dir=str(old_configs_dir), output_dir=str(old_output_dir), active_config="old-config"
)
self.store.save_defaults(defaults)
loaded = self.store.load_defaults()
loaded.configs_dir = str(new_configs_dir)
self.store.save_defaults(loaded)
final = self.store.load_defaults()
self.assertEqual(final.configs_dir, str(new_configs_dir))
self.assertEqual(final.output_dir, str(old_output_dir))
self.assertEqual(final.active_config, "old-config")
def test_update_multiple_fields(self) -> None:
# Create temp directories
configs_dir = self.temp_path / "configs"
configs_dir.mkdir(exist_ok=True)
output_dir = self.temp_path / "output"
output_dir.mkdir(exist_ok=True)
defaults = WebUIDefaults()
defaults.configs_dir = str(configs_dir)
defaults.output_dir = str(output_dir)
self.store.save_defaults(defaults)
loaded = self.store.load_defaults()
self.assertEqual(loaded.configs_dir, str(configs_dir))
self.assertEqual(loaded.output_dir, str(output_dir))
class WebUIStateIntegrationTests(WebUIStateStoreTests):
def test_full_onboarding_flow(self) -> None:
# Create temp directories
configs_dir = self.temp_path / "user_configs"
configs_dir.mkdir(exist_ok=True)
output_dir = self.temp_path / "user_output"
output_dir.mkdir(exist_ok=True)
self.store.record_onboarding_step("default_configs_dir", version=2, value=str(configs_dir))
self.store.record_onboarding_step("default_output_dir", version=1, value=str(output_dir))
defaults = self.store.load_defaults()
defaults.configs_dir = str(configs_dir)
defaults.output_dir = str(output_dir)
self.store.save_defaults(defaults)
state = self.store.load_state()
self.assertEqual(state.defaults.configs_dir, str(configs_dir))
self.assertEqual(state.defaults.output_dir, str(output_dir))
self.assertEqual(len(state.onboarding.steps), 2)
def test_version_upgrade_handling(self) -> None:
self.store.record_onboarding_step("test_step", 1, "value1")
self.store.record_onboarding_step("test_step", 2, "value2")
onboarding = self.store.load_onboarding()
self.assertEqual(onboarding.steps["test_step"].completed_version, 2)
self.assertEqual(onboarding.steps["test_step"].value, "value2")
def test_reset_onboarding(self) -> None:
self.store.record_onboarding_step("step1", 1, "value1")
self.store.record_onboarding_step("step2", 1, "value2")
self.store.save_onboarding(WebUIOnboardingState())
onboarding = self.store.load_onboarding()
self.assertEqual(len(onboarding.steps), 0)
class WebUICollapsedSectionsTests(WebUIStateStoreTests):
def test_save_and_load_collapsed_sections(self) -> None:
"""Test saving and loading collapsed sections for a tab."""
sections = {"section1": True, "section2": False, "section3": True}
self.store.save_collapsed_sections("basic", sections)
loaded = self.store.get_collapsed_sections("basic")
self.assertEqual(loaded, sections)
self.assertTrue(loaded["section1"])
self.assertFalse(loaded["section2"])
self.assertTrue(loaded["section3"])
def test_get_collapsed_sections_returns_empty_when_missing(self) -> None:
"""Test that missing collapsed sections return empty dict."""
loaded = self.store.get_collapsed_sections("nonexistent_tab")
self.assertIsInstance(loaded, dict)
self.assertEqual(len(loaded), 0)
def test_save_collapsed_sections_for_multiple_tabs(self) -> None:
"""Test saving collapsed sections for multiple tabs independently."""
basic_sections = {"section1": True, "section2": False}
model_sections = {"section_a": False, "section_b": True}
self.store.save_collapsed_sections("basic", basic_sections)
self.store.save_collapsed_sections("model", model_sections)
loaded_basic = self.store.get_collapsed_sections("basic")
loaded_model = self.store.get_collapsed_sections("model")
self.assertEqual(loaded_basic, basic_sections)
self.assertEqual(loaded_model, model_sections)
self.assertNotEqual(loaded_basic, loaded_model)
def test_update_collapsed_sections_preserves_other_tabs(self) -> None:
"""Test updating one tab's sections doesn't affect other tabs."""
self.store.save_collapsed_sections("basic", {"section1": True})
self.store.save_collapsed_sections("model", {"section_a": False})
# Update basic tab
self.store.save_collapsed_sections("basic", {"section1": False, "section2": True})
# Model tab should be unchanged
loaded_model = self.store.get_collapsed_sections("model")
self.assertEqual(loaded_model, {"section_a": False})
# Basic tab should have new values
loaded_basic = self.store.get_collapsed_sections("basic")
self.assertEqual(loaded_basic, {"section1": False, "section2": True})
def test_empty_sections_can_be_saved(self) -> None:
"""Test that empty sections dict can be saved and loaded."""
self.store.save_collapsed_sections("basic", {})
loaded = self.store.get_collapsed_sections("basic")
self.assertEqual(loaded, {})
def test_ui_state_file_created(self) -> None:
"""Test that ui_state.json file is created when saving collapsed sections."""
self.store.save_collapsed_sections("basic", {"section1": True})
ui_state_file = self.store.base_dir / "ui_state.json"
self.assertTrue(ui_state_file.exists())
# Verify file contains expected structure
import json
with ui_state_file.open("r") as f:
data = json.load(f)
self.assertIn("collapsed_sections", data)
self.assertIn("basic", data["collapsed_sections"])
self.assertEqual(data["collapsed_sections"]["basic"]["section1"], True)
def test_load_ui_state_returns_empty_when_missing(self) -> None:
"""Test that load_ui_state returns empty dict when file doesn't exist."""
ui_state = self.store.load_ui_state()
self.assertIsInstance(ui_state, dict)
self.assertEqual(len(ui_state), 0)
def test_save_ui_state_with_custom_data(self) -> None:
"""Test saving arbitrary UI state data."""
custom_state = {
"collapsed_sections": {"basic": {"section1": True}},
"custom_field": "value",
"nested": {"data": [1, 2, 3]},
}
self.store.save_ui_state(custom_state)
loaded = self.store.load_ui_state()
self.assertEqual(loaded, custom_state)
def test_concurrent_collapsed_section_saves(self) -> None:
"""Test that concurrent saves to different tabs don't corrupt state.
Note: Due to race conditions in concurrent writes, not all tabs may be saved,
but the state file should remain valid JSON and contain at least one tab.
"""
import threading
def save_sections(tab_name: str, section_id: str):
sections = {section_id: True}
self.store.save_collapsed_sections(tab_name, sections)
threads = [threading.Thread(target=save_sections, args=(f"tab_{i}", f"section_{i}")) for i in range(5)]
for thread in threads:
thread.start()
for thread in threads:
thread.join()
# Verify state file is valid JSON and contains at least one tab
ui_state = self.store.load_ui_state()
collapsed = ui_state.get("collapsed_sections", {})
# At least one tab should be saved (race condition may lose some)
self.assertGreaterEqual(len(collapsed), 1)
# Verify the structure is correct for tabs that were saved
for tab_name, sections in collapsed.items():
self.assertIsInstance(sections, dict)
for section_id, is_collapsed in sections.items():
self.assertIsInstance(is_collapsed, bool)
if __name__ == "__main__":
unittest.main()