Updates from final comments in PR #1; minor cleanup

Author: Bryan Sieber

src/jbi/configuration.py

@@ -43,6 +43,7 @@ def process_actions(action_configuration) -> Dict[str, Dict]:
     for yaml_action_key, inner_action_dict in action_configuration.items():
         inner_action_dict.setdefault("action", "src.jbi.whiteboard_actions.default")
         inner_action_dict.setdefault("enabled", False)
+        inner_action_dict.setdefault("parameters", {})
         validate_action_yaml_jbi_naming(
             yaml_action_key=yaml_action_key, action_dict=inner_action_dict
         )
@@ -53,24 +54,18 @@ def process_actions(action_configuration) -> Dict[str, Dict]:
 
 def validate_action_yaml_jbi_naming(yaml_action_key, action_dict):
     # Validate yaml_action_key == parameters.whiteboard_tag
-    try:
-        action_parameters = action_dict.get("parameters")
-        wb_tag = action_parameters.get("whiteboard_tag")
-        if yaml_action_key != wb_tag:
-            raise ConfigError(
-                f"Expected action key '{wb_tag}', found `{yaml_action_key}."
-                "(from the `parameters.whiteboard_tag` field)."
-            )
-    except (TypeError, AttributeError) as exception:
-        raise ConfigError("Action is not properly setup.") from exception
+    wb_tag = action_dict["parameters"].get("whiteboard_tag")
+    if yaml_action_key != wb_tag:
+        raise ConfigError(
+            f"Expected action key '{wb_tag}', found `{yaml_action_key}."
+            "(from the `parameters.whiteboard_tag` field)."
+        )
 
 
 def validate_action_yaml_module(action_dict: Dict[str, Any]):
     # Validate action: exists, has init function, and has expected params
     try:
         action: str = action_dict.get("action")  # type: ignore
-        print(action_dict)
-        print(action)
         action_parameters: Optional[Dict[str, Any]] = action_dict.get("parameters")
         action_module: ModuleType = importlib.import_module(action)
         if not action_module:

src/jbi/router.py

@@ -78,7 +78,7 @@ def create_inner_html_table(data: Dict, enable_query: Optional[bool]):
     agg_table = ""
     header = """
         <tr>
-            <th>Key</th>
+            <th>Identifier</th>
             <th>Action</th>
             <th>Contact</th>
             <th>Description </th>
@@ -89,12 +89,10 @@ def create_inner_html_table(data: Dict, enable_query: Optional[bool]):
     for key, value in data.items():
         enabled = value.get("enabled")
         if enable_query is None or enabled is enable_query:
-            parameters = ", ".join(
-                f"{k}={v}" for k, v in value.get("parameters").items()
-            )
+            parameters = ", ".join(f"{k}={v}" for k, v in value["parameters"].items())
             per_row = f"""
             <tr>
-                <td class="key">{key}</td>
+                <td class="identifier">{key}</td>
                 <td class="action">{value.get("action")}</td>
                 <td class="contact">{value.get("contact")}</td>
                 <td class="description">{value.get("description")}</td>

src/jbi/whiteboard_actions/README.md

@@ -1,20 +1,20 @@
 ## Looking to add a new action?
-"actions" are python functions that, once added into `src/jbi/whiteboard_actions/` dir,
+"actions" are python modules that, if available in the PYTHONPATH,
 can be run by updating the `action` attribute of the yaml config file.
 
 ### Create a new action...
 Let's create a `new_action`!
-1. First, add a new python file called "my_team_action" in the `src/jbi/whiteboard_actions/` dir.
+1. First, add a new python file called `my_team_action.py` in the `src/jbi/whiteboard_actions/` directory.
 1. Add the python function `init` to a new "my_team_action" module, let's use the following:
     ```python
     def init(whiteboard_tag, jira_project_key, optional_param=42):
         return lambda payload, context: print("Hi world!")
     ```
-    1. In the above example whiteboard_tag and jira_project_key are required
-    1. optional_param, which has a default value--is not required to run this action
+    1. In the above example `whiteboard_tag` and `jira_project_key` parameters are required
+    1. `optional_param`, which has a default value and is not required to run this action
     1. init returns a `__call__`able object that the system calls with the bugzilla request and yaml configuration objects
 1. Using `payload` and `context` perform the desired processing!
     1. `payload` is bugzilla webhook payload
-    1. `context` is the full yaml blob as a python dict (if additional context is desired)
+    1. `parameters` is the yaml section `parameters` as a python dict
     1. Use the available service calls from `src/jbi/services.py' (or make new ones)
-1. Now the action `src.jbi.whiteboard_actions.my_team_actions` can be added to a configuration.
+1. Now the action `src.jbi.whiteboard_actions.my_team_actions` can be added to a configuration yaml under the `action` key.

src/jbi/whiteboard_actions/default.py

@@ -13,8 +13,8 @@ def __init__(self, **kwargs):
         self.whiteboard_tag = kwargs.get("whiteboard_tag")
         self.jira_project_key = kwargs.get("jira_project_key")
 
-    def __call__(self, payload, context):
+    def __call__(self, payload, parameters):
         # Called from BZ webhook
         # Call Jira SDK with project key etc.
         print(payload)
-        print(context)
+        print(parameters)