Merge pull request #95 from GabrielSalla/generalize-plugin-attribute-retrieval

 Generalize plugin attribute retrieval

Author: GabrielSalla

configs/configs-scalable.yaml

@@ -17,7 +17,7 @@ application_database_settings:
   pool_size: 10
 
 application_queue:
-  type: plugin.aws.sqs
+  type: plugin.aws.queues.sqs
   name: app
   url: http://motoserver:5000/123456789012/app
   region: us-east-1

docker/docker-compose-scalable.yaml

@@ -34,7 +34,7 @@ services:
       retries: 3
       start_period: 2s
     environment:
-      CONFIGS_FILE: configs-scalable.yaml
+      CONFIGS_FILE: configs/configs-scalable.yaml
       SAMPLE_SLACK_CHANNEL: C07NCL94SDT
       SAMPLE_SLACK_MENTION: U07NFGGMB98
       SLACK_WEBSOCKET_ENABLED: true
@@ -67,7 +67,7 @@ services:
       retries: 3
       start_period: 2s
     environment:
-      CONFIGS_FILE: configs-scalable.yaml
+      CONFIGS_FILE: configs/configs-scalable.yaml
       SAMPLE_SLACK_CHANNEL: C07NCL94SDT
       SAMPLE_SLACK_MENTION: U07NFGGMB98
       SLACK_WEBSOCKET_ENABLED: true

docs/plugins/aws.md

@@ -26,7 +26,7 @@ AWS_APPLICATION_SECRET_ACCESS_KEY=SOME_SECRET_ACCESS_KEY
 To use the AWS plugin queue, configure its parameters in the configuration file under the setting `application_queue`.
 
 The queue settings are:
-- `type`: The plugin type, which should be `plugin.aws.sqs`.
+- `type`: The plugin type, which should be `plugin.aws.queues.sqs`.
 - `name`: The queue name.
 - `url`: The queue URL.
 - `region`: The region where the queue is located. If not configured, the region will be taken from the environment variables for the provided credentials.
@@ -37,7 +37,7 @@ The queue settings are:
 Suggested configuration for local development or testing:
 ```yaml
 application_queue:
-  type: plugin.aws.sqs
+  type: plugin.aws.queues.sqs
   name: app
   url: http://motoserver:5000/123456789012/app
   region: us-east-1

resources/kubernetes_template/config_map.yaml

@@ -23,7 +23,7 @@ data:
       pool_size: 10
 
     application_queue:
-      type: plugin.aws.sqs
+      type: plugin.aws.queues.sqs
       name: app
       url: http://motoserver:5000/123456789012/app
       region: us-east-1

src/components/executor/request_handler.py

@@ -7,12 +7,12 @@
 import prometheus_client
 from pydantic import ValidationError
 
-import plugins
 import registry as registry
 from base_exception import BaseSentinelaException
 from configs import configs
 from data_models.request_payload import RequestPayload
 from models import Alert, Issue
+from plugins.attribute_select import get_plugin_attribute
 
 _logger = logging.getLogger("request_handler")
 
@@ -88,21 +88,10 @@ async def issue_drop(message_payload: RequestPayload) -> None:
 def get_action(action_name: str) -> Callable[[RequestPayload], Coroutine[Any, Any, None]] | None:
     """Get the action function by its name, checking if it is a plugin action"""
     if action_name.startswith("plugin."):
-        plugin_name, action_name = action_name.split(".")[1:3]
-
-        plugin = plugins.loaded_plugins.get(plugin_name)
-        if plugin is None:
-            _logger.warning(f"Plugin '{plugin_name}' unknown")
-            return None
-
-        plugin_actions = getattr(plugin, "actions", None)
-        if plugin_actions is None:
-            _logger.warning(f"Plugin '{plugin_name}' doesn't have actions")
-            return None
-
-        action = getattr(plugin_actions, action_name, None)
-        if action is None:
-            _logger.warning(f"Action '{plugin_name}.{action_name}' unknown")
+        try:
+            action = get_plugin_attribute(action_name)
+        except ValueError as e:
+            _logger.warning(e.args[0])
             return None
 
         return cast(Callable[[RequestPayload], Coroutine[Any, Any, None]], action)

src/message_queue/__init__.py

@@ -1,7 +1,7 @@
 from typing import Any
 
 from configs import configs
-from plugins.queue_select import get_plugin_queue
+from plugins.attribute_select import get_plugin_attribute
 
 from .internal_queue import InternalQueue
 from .protocols import Message, Queue
@@ -18,7 +18,18 @@ async def init() -> None:
     if queue_type == "internal":
         queue = InternalQueue(config=configs.application_queue)
     elif queue_type.startswith("plugin."):
-        queue_class = get_plugin_queue(queue_type)
+        queue_module = get_plugin_attribute(queue_type)
+
+        try:
+            queue_class: type[Queue] = queue_module.Queue
+        except AttributeError:
+            raise ValueError(f"'Queue' class not found for '{queue_type}'")
+
+        if not isinstance(queue_class, Queue):
+            raise ValueError(
+                f"'Queue' class in '{queue_type}' does not implement the Queue protocol"
+            )
+
         queue = queue_class(config=configs.application_queue)
     else:
         raise ValueError(f"Invalid queue type '{queue_type}'")

src/plugins/attribute_select.py

@@ -0,0 +1,27 @@
+from typing import Any
+
+import plugins
+
+
+def get_plugin_attribute(attribute_path: str) -> Any:
+    """Retrieves a plugin attribute based on the provided attribute path."""
+    _, plugin_name, *parts = attribute_path.split(".")
+    if len(parts) < 2:
+        raise ValueError("Attribute path must specify a plugin and at least two attributes")
+
+    plugin = plugins.loaded_plugins.get(plugin_name)
+    if plugin is None:
+        raise ValueError(f"Plugin '{plugin_name}' not loaded")
+
+    target_path_parts = []
+    target: Any = plugin
+
+    for part in parts:
+        target_path_parts.append(part)
+        target = getattr(target, part, None)
+
+        if target is None:
+            target_path = ".".join(target_path_parts)
+            raise ValueError(f"Plugin '{plugin_name}' has no attribute '{target_path}'")
+
+    return target

src/plugins/aws/queues/sqs/sqs_queue.py

@@ -15,7 +15,7 @@
 
 @dataclass
 class SQSQueueConfig:
-    type: Literal["plugin.aws.sqs"]
+    type: Literal["plugin.aws.queues.sqs"]
     name: str
     url: str
     region: str | None = None

src/plugins/queue_select.py

@@ -1,6 +1,6 @@
 import asyncio
 import time
-from unittest.mock import AsyncMock
+from unittest.mock import AsyncMock, MagicMock
 
 import pytest
 
@@ -165,54 +165,27 @@ async def test_action(message_payload): ...
 
     monkeypatch.setattr(plugins, "loaded_plugins", {"plugin1": Plugin}, raising=False)
 
-    assert request_handler.get_action("plugin.plugin1.test_action") == Plugin.actions.test_action
+    expected_action = Plugin.actions.test_action
+    assert request_handler.get_action("plugin.plugin1.actions.test_action") == expected_action
 
 
 async def test_get_action_unknown_plugin(caplog, monkeypatch):
-    """'get_action' should return 'None' when the plugin doesn't exists"""
-    monkeypatch.setattr(plugins, "loaded_plugins", {"plugin1": "plugin1"}, raising=False)
+    """'get_action' should return 'None' when the attribute path could not be resolved"""
+    monkeypatch.setattr(
+        request_handler,
+        "get_plugin_attribute",
+        MagicMock(side_effect=ValueError("Some error from the function")),
+    )
 
     action = request_handler.get_action("plugin.plugin2.test_action")
 
     assert action is None
-    assert_message_in_log(caplog, "Plugin 'plugin2' unknown")
-
-
-async def test_get_action_plugin_no_actions(caplog, monkeypatch):
-    """'get_action' should return 'None' when the plugin doesn't have actions"""
-
-    class Plugin: ...
-
-    monkeypatch.setattr(plugins, "loaded_plugins", {"plugin1": Plugin}, raising=False)
-
-    action = request_handler.get_action("plugin.plugin1.test_action")
-
-    assert action is None
-    assert_message_in_log(caplog, "Plugin 'plugin1' doesn't have actions")
-
-
-async def test_get_action_unknown_action(caplog, monkeypatch):
-    """'get_action' should return 'None' when the action doesn't exists"""
-
-    class Plugin:
-        class actions: ...
-
-    monkeypatch.setattr(plugins, "loaded_plugins", {"plugin1": Plugin}, raising=False)
-
-    action = request_handler.get_action("plugin.plugin1.test_action")
-
-    assert action is None
-    assert_message_in_log(caplog, "Action 'plugin1.test_action' unknown")
+    assert_message_in_log(caplog, "Some error from the function")
 
 
 @pytest.mark.parametrize(
     "action_name",
-    [
-        "alert_acknowledge",
-        "alert_lock",
-        "alert_solve",
-        "issue_drop",
-    ],
+    ["alert_acknowledge", "alert_lock", "alert_solve", "issue_drop"],
 )
 async def test_run_action(monkeypatch, action_name):
     """'run' should executed the requested action"""