Return 4XX response if no bug is provided (fixes #418) (#222)

Co-authored-by: Mathieu Leplatre <[email protected]>

Author: bsieber-mozilla

jbi/models.py

@@ -326,7 +326,7 @@ class Config:
     webhook_id: int
     webhook_name: str
     event: BugzillaWebhookEvent
-    bug: Optional[BugzillaBug]
+    bug: BugzillaBug
 
     def map_as_jira_comment(self):
         """Extract comment from Webhook Event"""
@@ -388,8 +388,6 @@ def getbug_as_bugzilla_object(self) -> BugzillaBug:
     @functools.cached_property
     def bugzilla_object(self) -> BugzillaBug:
         """Returns the bugzilla bug object, querying the API as needed for private bugs"""
-        if not self.bug:
-            raise ValueError("missing bug reference")
         if not self.bug.is_private:
             return self.bug
         return self.getbug_as_bugzilla_object()

jbi/runner.py

@@ -27,19 +27,15 @@ def execute_action(
     The value returned by the action call is returned.
     """
     log_context = RunnerLogContext(
-        bug={
-            "id": request.bug.id if request.bug else None,
-        },
-        request=request,
+        bug=request.bug.dict(),
+        request=request.dict(),
         operation=Operation.HANDLE,
     )
     try:
         logger.debug(
             "Handling incoming request",
             extra=log_context.dict(),
         )
-        if not request.bug:
-            raise IgnoreInvalidRequestError("no bug data received")
 
         try:
             bug_obj: BugzillaBug = request.bugzilla_object

tests/unit/test_router.py

@@ -111,6 +111,17 @@ def test_webhook_is_200_if_action_raises_IgnoreInvalidRequestError(
         )
 
 
+def test_webhook_is_422_if_bug_information_missing(webhook_create_example):
+    webhook_create_example.bug = None
+
+    with TestClient(app) as anon_client:
+        response = anon_client.post(
+            "/bugzilla_webhook", data=webhook_create_example.json()
+        )
+        assert response.status_code == 422
+        assert response.json()["detail"][0]["msg"] == "none is not an allowed value"
+
+
 def test_read_version(anon_client):
     """__version__ returns the contents of version.json."""
     here = os.path.dirname(__file__)

tests/unit/test_runner.py

@@ -56,22 +56,6 @@ def test_private_request_is_allowed(
     assert payload.bug.id == 654321
 
 
-def test_request_is_ignored_because_no_bug(
-    webhook_create_example: BugzillaWebhookRequest,
-    actions_example: Actions,
-    settings: Settings,
-):
-    webhook_create_example.bug = None
-
-    with pytest.raises(IgnoreInvalidRequestError) as exc_info:
-        execute_action(
-            request=webhook_create_example,
-            actions=actions_example,
-            settings=settings,
-        )
-    assert str(exc_info.value) == "no bug data received"
-
-
 def test_request_is_ignored_because_no_action(
     webhook_create_example: BugzillaWebhookRequest,
     actions_example: Actions,