suggestions from code review; some pre-commit suggestions. Naming updates for consistency.

Author: Bryan Sieber

poetry.lock

@@ -15,9 +15,8 @@ prometheus-client = "^0.13.1"
 python-bugzilla = "^3.2.0"
 atlassian-python-api = "^3.20.1"
 dockerflow = "2022.1.0"
-types-PyYAML = "^6.0.4"
 Jinja2 = "^3.0.3"
-pydantic-yaml = {extras = ["pyyaml"], version = "^0.6.1"}
+pydantic-yaml = {extras = ["pyyaml","ruamel"], version = "^0.6.1"}
 
 
 [tool.poetry.dev-dependencies]

pyproject.toml

@@ -18,10 +18,10 @@ class ConfigError(Exception):
 
 
 @lru_cache
-def get_yaml_configurations(
+def get_actions(
     jbi_config_file: str = f"config/config.{settings.env}.yaml",
 ) -> Actions:
-    """Convert and validate YAML configuration to python dict"""
+    """Convert and validate YAML configuration to Action object"""
 
     with open(jbi_config_file, encoding="utf-8") as file:
         try:
@@ -31,3 +31,8 @@ def get_yaml_configurations(
         except ValidationError as exception:
             jbi_logger.exception(exception)
             raise ConfigError("Errors exist.") from exception
+
+
+def get_actions_dict():
+    """Returns dict of"""
+    return get_actions().dict()["actions"]

src/jbi/configuration.py

@@ -10,10 +10,9 @@
 from pydantic_yaml import YamlModel
 
 
-class ActionConfig(YamlModel, extra=Extra.allow):
-    """
-    ActionConfig is the inner model of `actions` in yaml
+class Action(YamlModel, extra=Extra.allow):
     """
+    Action is the inner model for each action in the configuration file"""
 
     action: str = "src.jbi.whiteboard_actions.default"
     enabled: bool = False
@@ -43,13 +42,13 @@ def validate_action_config(
 
 class Actions(YamlModel):
     """
-    Actions is the overall model from parsing the yaml config `actions` sections
+    Actions is the overall model for the list of `actions` in the configuration file
     """
 
-    actions: Dict[str, ActionConfig]
+    actions: Dict[str, Action]
 
     @validator("actions")
-    def validate_action_yaml_jbi_naming(
+    def validate_action_matches_whiteboard(
         cls, actions
     ):  # pylint: disable=no-self-argument, no-self-use
         """

src/jbi/model.py

@@ -35,39 +35,37 @@ def bugzilla_webhook(
 def get_whiteboard_tag(
     whiteboard_tag: Optional[str] = None,
 ):
-    """API for viewing whiteboard_tags"""
-    data = configuration.get_yaml_configurations().dict()["actions"]
+    """API for viewing whiteboard_tags and associated data"""
+    actions = configuration.get_actions_dict()
     if whiteboard_tag:
-        wb_val = data.get(whiteboard_tag)
+        wb_val = actions.get(whiteboard_tag)
         if wb_val:
-            data = wb_val
-    return data
+            actions = wb_val
+    return actions
 
 
 @api_router.get("/actions/")
 def get_actions_by_type(action_type: Optional[str] = None):
-    """API for viewing actions"""
-    configured_actions = configuration.get_yaml_configurations().dict()["actions"]
+    """API for viewing actions within the config; `action_type` matched on end of action identifier"""
+    actions = configuration.get_actions_dict()
     if action_type:
         data = [
-            a["action"]
-            for a in configured_actions.values()
-            if a["action"].endswith(action_type)
+            a["action"] for a in actions.values() if a["action"].endswith(action_type)
         ]
     else:
-        data = [a["action"] for a in configured_actions.values()]
+        data = [a["action"] for a in actions.values()]
     return data
 
 
 @api_router.get("/powered_by_jbi", response_class=HTMLResponse)
 def powered_by_jbi(request: Request, enabled: Optional[bool] = None):
     """API for `Powered By` endpoint"""
-    data = configuration.get_yaml_configurations().dict()["actions"]
+    actions = configuration.get_actions_dict()
     context = {
         "request": request,
         "title": "Powered by JBI",
-        "num_configs": len(data),
-        "data": data,
+        "num_configs": len(actions),
+        "data": actions,
         "enable_query": enabled,
     }
     return templates.TemplateResponse("powered_by_template.html", context)

src/jbi/router.py

@@ -9,11 +9,9 @@
 
 def test_mock_jbi_files():
     with pytest.raises(configuration.ConfigError):
-        configuration.get_yaml_configurations(
-            jbi_config_file="tests/unit/jbi/test-config.yaml"
-        )
+        configuration.get_actions(jbi_config_file="tests/unit/jbi/test-config.yaml")
 
 
 def test_actual_jbi_files():
-    jbi_map = configuration.get_yaml_configurations()
+    jbi_map = configuration.get_actions()
     assert jbi_map