mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-08-01 08:48:05 +00:00
Chuck
782731052d
CodeRabbit review on #405 flagged two things in _reinstall_with_rollback, both verified against current code: - Real race: the web UI runs Flask with threaded=True and there's a single update route, so two overlapping requests for the same plugin_id (double-click, two tabs) can interleave. The loser could rename the winner's in-progress install aside mid-download, deleting its own rollback safety net — worse than the bug this function exists to fix. Added a lazy per-plugin_id lock dict (mirrors the plugin_manager per-plugin lock pattern) held for the whole function. - _safe_remove_directory's return value was ignored at both call sites. Stale-aside cleanup failure now aborts cleanly instead of falling through to a rename that would fail anyway with a less useful error; post-success backup-removal failure now logs instead of failing silently (still returns True — the update itself succeeded, and the next update self-heals the leftover aside). Left the third nitpick (test_stale_aside_from_previous_crash_is_cleared) addressed by asserting the stale dir is actually gone and that install_plugin was reached, rather than just the end-to-end result. Added a concurrency regression test asserting install_plugin never runs for the same plugin_id while another call is in flight.
172 lines
7.1 KiB
Python
172 lines
7.1 KiB
Python
"""Tests for atomic plugin updates (store_manager._reinstall_with_rollback).
|
|
|
|
Regression for a field data-loss incident: update_plugin's reinstall paths
|
|
(monorepo migration AND routine archive updates) deleted the installed
|
|
plugin BEFORE downloading its replacement — a mid-update network failure
|
|
permanently destroyed the plugin. Seen live: a Pi with broken DNS lost 12
|
|
plugins from one update pass.
|
|
"""
|
|
|
|
import json
|
|
import os
|
|
import sys
|
|
import threading
|
|
import time
|
|
from pathlib import Path
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
|
|
sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
|
|
|
|
from src.plugin_system.store_manager import PluginStoreManager # noqa: E402
|
|
|
|
PLUGIN_ID = "rollback-test-plugin"
|
|
|
|
|
|
@pytest.fixture
|
|
def store(tmp_path):
|
|
mgr = PluginStoreManager(plugins_dir=str(tmp_path))
|
|
plugin_dir = tmp_path / PLUGIN_ID
|
|
plugin_dir.mkdir()
|
|
(plugin_dir / "manifest.json").write_text(json.dumps(
|
|
{"id": PLUGIN_ID, "name": "Rollback Test", "version": "1.0.0"}))
|
|
(plugin_dir / "manager.py").write_text("# old version marker\n")
|
|
return mgr, plugin_dir
|
|
|
|
|
|
class TestReinstallWithRollback:
|
|
def test_failed_install_restores_old_version(self, store):
|
|
"""The whole point: a failed download must leave the old install."""
|
|
mgr, plugin_dir = store
|
|
with patch.object(mgr, "install_plugin", return_value=False):
|
|
ok = mgr._reinstall_with_rollback(PLUGIN_ID, plugin_dir)
|
|
assert ok is False
|
|
assert plugin_dir.exists()
|
|
assert "old version marker" in (plugin_dir / "manager.py").read_text()
|
|
# no aside debris left behind
|
|
leftovers = [p for p in plugin_dir.parent.iterdir()
|
|
if "standalone-backup" in p.name]
|
|
assert leftovers == []
|
|
|
|
def test_install_exception_restores_old_version(self, store):
|
|
mgr, plugin_dir = store
|
|
with patch.object(mgr, "install_plugin",
|
|
side_effect=RuntimeError("network down")):
|
|
ok = mgr._reinstall_with_rollback(PLUGIN_ID, plugin_dir)
|
|
assert ok is False
|
|
assert plugin_dir.exists()
|
|
assert "old version marker" in (plugin_dir / "manager.py").read_text()
|
|
|
|
def test_successful_install_removes_aside(self, store):
|
|
mgr, plugin_dir = store
|
|
|
|
def fake_install(plugin_id):
|
|
new_dir = plugin_dir # same path, new content
|
|
new_dir.mkdir(exist_ok=True)
|
|
(new_dir / "manager.py").write_text("# new version\n")
|
|
(new_dir / "manifest.json").write_text(json.dumps(
|
|
{"id": PLUGIN_ID, "name": "Rollback Test", "version": "2.0.0"}))
|
|
return True
|
|
|
|
with patch.object(mgr, "install_plugin", side_effect=fake_install):
|
|
ok = mgr._reinstall_with_rollback(PLUGIN_ID, plugin_dir)
|
|
assert ok is True
|
|
assert "new version" in (plugin_dir / "manager.py").read_text()
|
|
leftovers = [p for p in plugin_dir.parent.iterdir()
|
|
if "standalone-backup" in p.name]
|
|
assert leftovers == []
|
|
|
|
def test_partial_download_debris_is_replaced_by_old_version(self, store):
|
|
"""A failed install that left a partial directory must still roll back."""
|
|
mgr, plugin_dir = store
|
|
|
|
def fake_partial_install(plugin_id):
|
|
plugin_dir.mkdir(exist_ok=True)
|
|
(plugin_dir / "half-downloaded.tmp").write_text("junk")
|
|
return False
|
|
|
|
with patch.object(mgr, "install_plugin", side_effect=fake_partial_install):
|
|
ok = mgr._reinstall_with_rollback(PLUGIN_ID, plugin_dir)
|
|
assert ok is False
|
|
assert "old version marker" in (plugin_dir / "manager.py").read_text()
|
|
assert not (plugin_dir / "half-downloaded.tmp").exists()
|
|
|
|
def test_stale_aside_from_previous_crash_is_cleared(self, store):
|
|
mgr, plugin_dir = store
|
|
stale = plugin_dir.parent / f"{PLUGIN_ID}.standalone-backup-migrating"
|
|
stale.mkdir()
|
|
(stale / "old.txt").write_text("stale")
|
|
with patch.object(mgr, "install_plugin", return_value=False) as mock_install:
|
|
ok = mgr._reinstall_with_rollback(PLUGIN_ID, plugin_dir)
|
|
# The reinstall itself still fails (mocked) and the old install is
|
|
# restored, but the stale aside must not have survived — otherwise
|
|
# it would have blocked this run's own rename (or a future one).
|
|
assert not stale.exists()
|
|
mock_install.assert_called_once_with(PLUGIN_ID)
|
|
assert ok is False
|
|
assert plugin_dir.exists()
|
|
assert "old version marker" in (plugin_dir / "manager.py").read_text()
|
|
|
|
def test_concurrent_updates_for_same_plugin_are_serialized(self, store):
|
|
"""Two overlapping requests for the same plugin_id (double-click,
|
|
two browser tabs — the web UI runs Flask with threaded=True) must
|
|
not interleave: the loser must wait for the winner to finish
|
|
rather than renaming the winner's in-progress install aside and
|
|
stealing its rollback safety net."""
|
|
mgr, plugin_dir = store
|
|
|
|
active = 0
|
|
max_active = 0
|
|
guard = threading.Lock()
|
|
|
|
def fake_install(plugin_id):
|
|
nonlocal active, max_active
|
|
with guard:
|
|
active += 1
|
|
max_active = max(max_active, active)
|
|
time.sleep(0.05)
|
|
plugin_dir.mkdir(exist_ok=True)
|
|
(plugin_dir / "manager.py").write_text("# new version\n")
|
|
(plugin_dir / "manifest.json").write_text(json.dumps(
|
|
{"id": PLUGIN_ID, "name": "Rollback Test", "version": "2.0.0"}))
|
|
with guard:
|
|
active -= 1
|
|
return True
|
|
|
|
results = []
|
|
|
|
def worker():
|
|
results.append(mgr._reinstall_with_rollback(PLUGIN_ID, plugin_dir))
|
|
|
|
with patch.object(mgr, "install_plugin", side_effect=fake_install):
|
|
threads = [threading.Thread(target=worker) for _ in range(2)]
|
|
for t in threads:
|
|
t.start()
|
|
for t in threads:
|
|
t.join(timeout=5)
|
|
|
|
assert max_active == 1, "install_plugin ran concurrently for the same plugin_id"
|
|
assert results == [True, True]
|
|
assert plugin_dir.exists()
|
|
assert "new version" in (plugin_dir / "manager.py").read_text()
|
|
leftovers = [p for p in plugin_dir.parent.iterdir()
|
|
if "standalone-backup" in p.name]
|
|
assert leftovers == []
|
|
|
|
def test_aside_name_is_invisible_to_discovery(self, store, tmp_path):
|
|
"""The aside still contains a manifest.json — discovery must skip it
|
|
(relies on the existing '.standalone-backup-' exclusion)."""
|
|
mgr, plugin_dir = store
|
|
from src.plugin_system.plugin_manager import PluginManager
|
|
aside = plugin_dir.parent / f"{PLUGIN_ID}.standalone-backup-migrating"
|
|
plugin_dir.rename(aside)
|
|
pm = PluginManager(plugins_dir=str(tmp_path), config_manager=None,
|
|
display_manager=None, cache_manager=None)
|
|
found = pm._scan_directory_for_plugins(Path(tmp_path))
|
|
assert PLUGIN_ID not in found
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(pytest.main([__file__, "-v"]))
|