Revert "Ref #520: add typing for action parameters (#523)"

This reverts commit c178e30.

Author: grahamalama

jbi/models.py

@@ -9,7 +9,7 @@
 import warnings
 from inspect import signature
 from types import ModuleType
-from typing import Callable, Literal, Mapping, Optional, TypedDict
+from typing import Any, Callable, Literal, Mapping, Optional, TypedDict
 from urllib.parse import ParseResult, urlparse
 
 from pydantic import BaseModel, Extra, Field, PrivateAttr, root_validator, validator
@@ -23,19 +23,6 @@
 JIRA_HOSTNAMES = ("jira", "atlassian")
 
 
-class ActionParameters(BaseModel):
-    """Action parameters"""
-
-    # For runner
-    jira_project_key: str
-    steps: Optional[dict[str, list[str]]] = None
-    # For steps
-    status_map: Optional[dict[str, str]] = None
-    resolution_map: Optional[dict[str, str]] = None
-    jira_components: Optional[list[str]] = None
-    sync_whiteboard_labels: bool = True
-
-
 class Action(YamlModel):
     """
     Action is the inner model for each action in the configuration file"""
@@ -46,21 +33,21 @@ class Action(YamlModel):
     description: str
     enabled: bool = True
     allow_private: bool = False
-    parameters: ActionParameters
+    parameters: dict = {}
     _caller: Optional[Callable] = PrivateAttr(default=None)
     _required_jira_permissions: set[str] = PrivateAttr(default=None)
 
     @property
     def jira_project_key(self):
         """Return the configured project key."""
-        return self.parameters.jira_project_key
+        return self.parameters["jira_project_key"]
 
     @property
     def caller(self) -> Callable:
         """Return the initialized callable for this action."""
         if self._caller is None:
             action_module: ModuleType = importlib.import_module(self.module)
-            initialized: Callable = action_module.init(**self.parameters.dict())  # type: ignore
+            initialized: Callable = action_module.init(**self.parameters)  # type: ignore
             self._caller = initialized
         return self._caller
 
@@ -78,23 +65,18 @@ def validate_action_config(cls, values):  # pylint: disable=no-self-argument
         """Validate action: exists, has init function, and has expected params"""
         try:
             module: str = values["module"]  # type: ignore
-            try:
-                action_parameters = values["parameters"].dict()
-            except KeyError:
-                action_parameters = {}
+            action_parameters: Optional[dict[str, Any]] = values["parameters"]
             action_module: ModuleType = importlib.import_module(module)
             if not action_module:
                 raise TypeError("Module is not found.")
             if not hasattr(action_module, "init"):
                 raise TypeError("Module is missing `init` method.")
 
-            signature(action_module.init).bind(**action_parameters)
+            signature(action_module.init).bind(**action_parameters)  # type: ignore
         except ImportError as exception:
             raise ValueError(f"unknown Python module `{module}`.") from exception
         except (TypeError, AttributeError) as exception:
-            raise ValueError(
-                f"action '{module}' is not properly setup. {exception}"
-            ) from exception
+            raise ValueError(f"action is not properly setup.{exception}") from exception
         return values
 
 
@@ -126,7 +108,11 @@ def get(self, tag: Optional[str]) -> Optional[Action]:
     @functools.cached_property
     def configured_jira_projects_keys(self) -> set[str]:
         """Return the list of Jira project keys from all configured actions"""
-        return {action.jira_project_key for action in self.__root__}
+        return {
+            action.jira_project_key
+            for action in self.__root__
+            if "jira_project_key" in action.parameters
+        }
 
     @validator("__root__")
     def validate_actions(  # pylint: disable=no-self-argument

jbi/runner.py

@@ -81,7 +81,7 @@ def execute_action(
             event=event,
             operation=Operation.IGNORE,
             jira=JiraContext(project=action.jira_project_key, issue=linked_issue_key),
-            extra={k: str(v) for k, v in action.parameters.dict().items()},
+            extra={k: str(v) for k, v in action.parameters.items()},
         )
 
         if action_context.jira.issue is None:

jbi/services/jira.py

@@ -129,8 +129,9 @@ def _all_projects_permissions(actions: Actions):
 def _fetch_project_permissions(actions):
     """Fetches permissions for the configured projects"""
     required_perms_by_project = {
-        action.parameters.jira_project_key: action.required_jira_permissions
+        action.parameters["jira_project_key"]: action.required_jira_permissions
         for action in actions
+        if "jira_project_key" in action.parameters
     }
     client = get_client()
     all_projects_perms = {}
@@ -183,8 +184,9 @@ def _validate_permissions(all_projects_perms):
 
 def _all_projects_components_exist(actions: Actions):
     components_by_project = {
-        action.parameters.jira_project_key: action.parameters.jira_components
+        action.parameters["jira_project_key"]: action.parameters["jira_components"]
         for action in actions
+        if "jira_components" in action.parameters
     }
     success = True
     for project, specified_components in components_by_project.items():

tests/fixtures/bugzilla_action.py

@@ -3,5 +3,5 @@ def __call__(self, bug, event):
         return {"bug": bug, "event": event}
 
 
-def init(**kwargs):
+def init():
     return FakeBugzillaAction()

tests/unit/test_models.py

@@ -1,7 +1,7 @@
 import pytest
 from fastapi.encoders import jsonable_encoder
 
-from jbi.models import Action, ActionParameters, Actions
+from jbi.models import Action, Actions
 from tests.fixtures.factories import action_factory
 
 
@@ -13,7 +13,6 @@ def test_model_serializes():
             "bugzilla_user_id": 123456,
             "description": "test config",
             "module": "tests.fixtures.bugzilla_action",
-            "parameters": ActionParameters(jira_project_key="fooo"),
         }
     )
     action.caller(bug=None, event=None)
@@ -30,7 +29,6 @@ def test_model_with_user_list_serializes():
             "bugzilla_user_id": [123456, 654321, 000000, 111111],
             "description": "test config",
             "module": "tests.fixtures.bugzilla_action",
-            "parameters": ActionParameters(jira_project_key="fooo"),
         }
     )
     action.caller(bug=None, event=None)
@@ -46,7 +44,6 @@ def test_model_with_user_list_of_one_serializes():
                 "bugzilla_user_id": [123456],
                 "description": "test config",
                 "module": "tests.fixtures.bugzilla_action",
-                "parameters": ActionParameters(jira_project_key="fooo"),
             }
         )
         action.caller(bug=None, event=None)
@@ -70,7 +67,7 @@ def test_unknown_module_fails():
 def test_bad_module_fails():
     with pytest.raises(ValueError) as exc_info:
         Actions.parse_obj([{"whiteboard_tag": "x", "module": "jbi.runner"}])
-    assert "action 'jbi.runner' is not properly setup" in str(exc_info.value)
+    assert "action is not properly setup" in str(exc_info.value)
 
 
 def test_duplicated_whiteboard_tag_fails():