mirror of
https://github.com/Dispatcharr/Dispatcharr.git
synced 2026-07-17 16:50:53 +00:00
b2496dc4e7
- Replaced the plugin listing mechanism with a more efficient handler iteration for event actions. - Enhanced logging to provide clearer insights into the dispatching process and plugin action execution. - Added error handling to ensure that failures in one plugin action do not block subsequent actions. - Updated tests to cover new behavior and ensure proper handling of enabled and disabled plugins.
81 lines
3 KiB
Python
81 lines
3 KiB
Python
"""PluginManager must release geventpool checkouts after every run/stop."""
|
|
|
|
from contextlib import contextmanager
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
from django.test import SimpleTestCase
|
|
|
|
from apps.plugins.loader import LoadedPlugin, PluginManager
|
|
|
|
|
|
class PluginRunActionDbCleanupTests(SimpleTestCase):
|
|
@contextmanager
|
|
def _manager_with_plugin(self, run_impl):
|
|
instance = MagicMock()
|
|
instance.run = run_impl
|
|
lp = LoadedPlugin(
|
|
key="test_plugin",
|
|
name="Test Plugin",
|
|
instance=instance,
|
|
actions=[{"id": "do_work"}],
|
|
)
|
|
pm = PluginManager()
|
|
cfg = MagicMock(enabled=True, settings={})
|
|
with patch.object(pm, "get_plugin", return_value=lp), patch(
|
|
"apps.plugins.loader.PluginConfig.objects.get", return_value=cfg
|
|
):
|
|
yield pm
|
|
|
|
@patch("apps.plugins.loader.close_old_connections")
|
|
def test_run_action_closes_connections_on_success(self, mock_close):
|
|
with self._manager_with_plugin(lambda *_a, **_k: {"status": "ok"}) as pm:
|
|
result = pm.run_action("test_plugin", "do_work")
|
|
|
|
self.assertEqual(result, {"status": "ok"})
|
|
mock_close.assert_called_once()
|
|
|
|
@patch("apps.plugins.loader.close_old_connections")
|
|
def test_run_action_closes_connections_on_plugin_error(self, mock_close):
|
|
def _boom(*_a, **_k):
|
|
raise RuntimeError("plugin failed")
|
|
|
|
with self._manager_with_plugin(_boom) as pm:
|
|
with self.assertRaises(RuntimeError):
|
|
pm.run_action("test_plugin", "do_work")
|
|
|
|
mock_close.assert_called_once()
|
|
|
|
@patch("apps.plugins.loader.close_old_connections")
|
|
def test_stop_plugin_closes_connections(self, mock_close):
|
|
instance = MagicMock()
|
|
instance.stop = MagicMock()
|
|
lp = LoadedPlugin(
|
|
key="test_plugin",
|
|
name="Test Plugin",
|
|
instance=instance,
|
|
)
|
|
pm = PluginManager()
|
|
cfg = MagicMock(enabled=True, settings={})
|
|
with patch.object(pm, "get_plugin", return_value=lp), patch(
|
|
"apps.plugins.loader.PluginConfig.objects.get", return_value=cfg
|
|
):
|
|
self.assertTrue(pm.stop_plugin("test_plugin", reason="shutdown"))
|
|
|
|
mock_close.assert_called_once()
|
|
|
|
|
|
class PluginDiscoverDbCleanupTests(SimpleTestCase):
|
|
@patch("apps.plugins.loader.close_old_connections")
|
|
@patch.object(PluginManager, "_discover_plugins_impl", return_value={})
|
|
def test_discover_plugins_closes_connections(self, _mock_impl, mock_close):
|
|
pm = PluginManager()
|
|
pm.discover_plugins(sync_db=False)
|
|
mock_close.assert_called_once()
|
|
|
|
@patch("apps.plugins.loader.close_old_connections")
|
|
def test_discover_plugins_cache_hit_skips_close(self, mock_close):
|
|
pm = PluginManager()
|
|
pm._discovery_completed = True
|
|
pm._last_reload_token = pm._get_reload_token()
|
|
pm.discover_plugins(sync_db=False, use_cache=True)
|
|
mock_close.assert_not_called()
|