Explain why we set return value of getbug

Author: leplatrem

jbi/actions/default.py

@@ -74,7 +74,6 @@ def __call__(  # pylint: disable=inconsistent-return-statements
 
     def comment_create_or_noop(self, payload: BugzillaWebhookRequest) -> ActionResult:
         """Confirm issue is already linked, then apply comments; otherwise noop"""
-        assert payload.bug  # make pylint happy. See #219
         bug_obj = payload.bug
         linked_issue_key = bug_obj.extract_from_see_also()
 
@@ -145,7 +144,6 @@ def bug_create_or_update(
         self, payload: BugzillaWebhookRequest
     ) -> ActionResult:  # pylint: disable=too-many-locals
         """Create and link jira issue with bug, or update; rollback if multiple events fire"""
-        assert payload.bug  # make pylint happy. See #219
         bug_obj = payload.bug
         linked_issue_key = bug_obj.extract_from_see_also()  # type: ignore
         if not linked_issue_key:
@@ -241,6 +239,7 @@ def create_and_link_issue(  # pylint: disable=too-many-locals
         # In the time taken to create the Jira issue the bug may have been updated so
         # re-retrieve it to ensure we have the latest data.
         bug_obj = self.bugzilla_client.getbug(payload.bug.id)
+
         jira_key_in_bugzilla = bug_obj.extract_from_see_also()
         _duplicate_creation_event = (
             jira_key_in_bugzilla is not None

jbi/runner.py

@@ -45,7 +45,7 @@ def execute_action(
             raise IgnoreInvalidRequestError(
                 "bug not accessible or bugzilla down"
             ) from err
-        assert request.bug  # make pylint happy. See #219
+
         log_context = log_context.update(bug=request.bug)
         try:
             action = request.bug.lookup_action(actions)

tests/unit/actions/test_default.py

@@ -29,9 +29,9 @@ def test_default_returns_callable_without_data(mocked_bugzilla, mocked_jira):
 def test_default_returns_callable_with_data(
     webhook_create_example, mocked_jira, mocked_bugzilla
 ):
+    mocked_bugzilla.getbug.return_value = webhook_create_example.bug
     sentinel = mock.sentinel
     mocked_jira.create_or_update_issue_remote_links.return_value = sentinel
-    mocked_bugzilla.getbug.return_value = webhook_create_example.bug
     callable_object = default.init(jira_project_key="")
 
     handled, details = callable_object(payload=webhook_create_example)

tests/unit/actions/test_default_with_assignee_and_status.py

@@ -26,6 +26,7 @@ def test_create_with_no_assignee(webhook_create_example, mocked_jira, mocked_bug
 
 def test_create_with_assignee(webhook_create_example, mocked_jira, mocked_bugzilla):
     webhook_create_example.bug.assigned_to = "[email protected]"
+    # Make sure the bug fetched the second time in `create_and_link_issue()` also has the assignee.
     mocked_bugzilla.getbug.return_value = webhook_create_example.bug
     mocked_jira.create_issue.return_value = {"key": "JBI-534"}
     mocked_jira.user_find_by_user_string.return_value = [{"accountId": "6254"}]
@@ -148,13 +149,12 @@ def test_create_with_unknown_status(
 def test_create_with_known_status(webhook_create_example, mocked_jira, mocked_bugzilla):
     webhook_create_example.bug.status = "ASSIGNED"
     webhook_create_example.bug.resolution = ""
-
-    mocked_jira.create_issue.return_value = {"key": "JBI-534"}
-
+    # Make sure the bug fetched the second time in `create_and_link_issue()` also has the status.
     mocked_bugzilla.getbug.return_value = webhook_create_example.bug
     mocked_bugzilla.get_comments.return_value = {
         "bugs": {"654321": {"comments": [{"text": "Initial comment"}]}}
     }
+    mocked_jira.create_issue.return_value = {"key": "JBI-534"}
 
     callable_object = action.init(
         jira_project_key="JBI",