implement PluginDisabled exception to handle disabled plugins

thrau · thrau · commit ce67efeea85b · 2021-09-26T19:33:16.000+02:00
diff --git a/localstack/plugin/__init__.py b/localstack/plugin/__init__.py
@@ -1,4 +1,12 @@
-from .core import Plugin, PluginFinder, PluginLifecycleListener, PluginSpec, PluginType
+from .core import (
+    Plugin,
+    PluginDisabled,
+    PluginException,
+    PluginFinder,
+    PluginLifecycleListener,
+    PluginSpec,
+    PluginType,
+)
 from .manager import PluginManager, PluginSpecResolver
 
 name = "plugin"
@@ -11,4 +19,6 @@
     "PluginFinder",
     "PluginManager",
     "PluginSpecResolver",
+    "PluginException",
+    "PluginDisabled",
 ]
diff --git a/localstack/plugin/core.py b/localstack/plugin/core.py
@@ -3,6 +3,20 @@
 from typing import Any, Callable, Dict, List, Tuple, Type, Union
 
 
+class PluginException(Exception):
+    def __init__(self, message, namespace: str = None, name: str = None) -> None:
+        super().__init__(message)
+        self.namespace = namespace
+        self.name = name
+
+
+class PluginDisabled(PluginException):
+    def __init__(self, namespace: str, name: str):
+        super(PluginDisabled, self).__init__("plugin %s:%s is disabled" % (namespace, name))
+        self.namespace = namespace
+        self.name = name
+
+
 class Plugin(abc.ABC):
     """A generic LocalStack plugin.
 
diff --git a/localstack/plugin/manager.py b/localstack/plugin/manager.py
@@ -2,7 +2,15 @@
 import threading
 from typing import Any, Callable, Dict, Generic, Iterable, List, Tuple, TypeVar, Union
 
-from .core import Plugin, PluginFinder, PluginLifecycleListener, PluginSpec, PluginSpecResolver
+from .core import (
+    Plugin,
+    PluginDisabled,
+    PluginException,
+    PluginFinder,
+    PluginLifecycleListener,
+    PluginSpec,
+    PluginSpecResolver,
+)
 
 LOG = logging.getLogger(__name__)
 
@@ -166,8 +174,9 @@ def load(self, name: str) -> P:
             raise container.load_error
 
         if not container.is_loaded:
-            # plugin should_load returned False
-            raise ValueError("plugin %s:%s is deactivated" % (self.namespace, name))
+            raise PluginException(
+                "plugin did not load correctly", namespace=self.namespace, name=name
+            )
 
         return container.plugin
 
@@ -186,6 +195,8 @@ def load_all(self, propagate_exceptions=False) -> List[P]:
             try:
                 plugin = self.load(name)
                 plugins.append(plugin)
+            except PluginDisabled as e:
+                LOG.debug("%s", e)
             except Exception as e:
                 if propagate_exceptions:
                     raise
@@ -251,8 +262,7 @@ def _load_plugin(self, container: PluginContainer):
             plugin = container.plugin
 
             if not plugin.should_load():
-                LOG.debug("not loading deactivated plugin %s", plugin_spec)
-                return
+                raise PluginDisabled(namespace=self.namespace, name=container.plugin_spec.name)
 
             args = self.load_args
             kwargs = self.load_kwargs
diff --git a/tests/unit/plugin/test_manager.py b/tests/unit/plugin/test_manager.py
@@ -2,7 +2,7 @@
 
 import pytest
 
-from localstack.plugin import Plugin, PluginFinder, PluginManager, PluginSpec
+from localstack.plugin import Plugin, PluginDisabled, PluginFinder, PluginManager, PluginSpec
 
 
 class DummyPlugin(Plugin):
@@ -167,4 +167,13 @@ def test_load_all_propagate_exception(self):
 
         ex.match("controlled load fail")
 
+    def test_load_disabled_plugin(self, dummy_plugin_finder):
+        manager = PluginManager("test.plugins.dummy", finder=dummy_plugin_finder)
+
+        with pytest.raises(PluginDisabled) as ex:
+            manager.load("shouldnotload")
+
+        assert ex.value.namespace == "test.plugins.dummy"
+        assert ex.value.name == "shouldnotload"
+
     # TODO: test lifecycle listeners
