Validate that step functions exist when parsing actions (#619)

Author: grahamalama

jbi/models.py

@@ -14,7 +14,7 @@
 from pydantic import BaseModel, Extra, Field, validator
 from pydantic_yaml import YamlModel
 
-from jbi import Operation
+from jbi import Operation, steps
 from jbi.errors import ActionNotFoundError
 
 logger = logging.getLogger(__name__)
@@ -41,6 +41,19 @@ class ActionSteps(BaseModel):
         "create_comment",
     ]
 
+    @validator("*")
+    def validate_steps(cls, function_names):  # pylint: disable=no-self-argument
+        """Validate that all configure step functions exist in the steps module"""
+
+        invalid_functions = [
+            func_name for func_name in function_names if not hasattr(steps, func_name)
+        ]
+        if invalid_functions:
+            raise ValueError(
+                f"The following functions are not available in the `steps` module: {', '.join(invalid_functions)}"
+            )
+        return function_names
+
 
 class JiraComponents(BaseModel):
     """Controls how Jira components are set on issues in the `maybe_update_components` step."""

jbi/router.py

@@ -101,7 +101,7 @@ def get_whiteboard_tags(
 @router.get("/bugzilla_webhooks/")
 def get_bugzilla_webhooks(bugzilla_service: BugzillaServiceDep):
     """API for viewing webhooks details"""
-    return bugzilla_service.client.list_webhooks()
+    return bugzilla_service.list_webhooks()
 
 
 @router.get("/jira_projects/")

tests/unit/test_models.py

@@ -23,6 +23,16 @@ def test_no_actions_fails():
     assert "ensure this value has at least 1 items" in str(exc_info.value)
 
 
+def test_default_invalid_step():
+    with pytest.raises(pydantic.ValidationError) as exc:
+        ActionSteps(new=["BOOM", "POW"], comment=["BAM"])
+    error_message = str(exc.value)
+
+    assert "BOOM" in error_message
+    assert "POW" in error_message
+    assert "BAM" in error_message
+
+
 def test_duplicated_whiteboard_tag_fails(action_factory):
     with pytest.raises(ValueError) as exc_info:
         Actions.parse_obj(

tests/unit/test_runner.py

@@ -283,11 +283,6 @@ def test_default_invalid_init():
         Executor()
 
 
-def test_default_invalid_step(action_params_factory):
-    with pytest.raises(AttributeError):
-        Executor(action_params_factory(steps={"new": ["unknown_step"]}))
-
-
 def test_unspecified_groups_come_from_default_steps(action_params_factory):
     action = Executor(action_params_factory(steps={"comment": ["create_comment"]}))