Retrieve comments from the API if they are private (fixes #154) (#163)

Author: Mossop

src/jbi/bugzilla.py

@@ -227,6 +227,15 @@ def map_as_jira_comment(self):
         comment: BugzillaWebhookComment = self.bug.comment
         commenter: BugzillaWebhookUser = self.event.user
         comment_body: str = comment.body
+
+        if comment.is_private:
+            bug_comments = get_bugzilla().get_comments([self.bug.id])
+            comment_list = bug_comments["bugs"][str(self.bug.id)]["comments"]
+            matching_comments = [c for c in comment_list if c["id"] == comment.id]
+            if len(matching_comments) != 1:
+                return None
+            comment_body = matching_comments[0]["text"]
+
         body = f"*({commenter.login})* commented: \n{{quote}}{comment_body}{{quote}}"
         return body
 

src/jbi/whiteboard_actions/default.py

@@ -69,6 +69,10 @@ def comment_create_or_noop(self, payload: BugzillaWebhookRequest):
             )
             return {"status": "noop"}
 
+        comment = payload.map_as_jira_comment()
+        if comment is None:
+            return {"status": "noop"}
+
         jira_response = self.jira_client.issue_add_comment(
             issue_key=linked_issue_key,
             comment=payload.map_as_jira_comment(),

tests/unit/conftest.py

@@ -100,6 +100,59 @@ def webhook_comment_example(webhook_create_example) -> BugzillaWebhookRequest:
     return webhook_comment_example
 
 
+@pytest.fixture
+def webhook_private_comment_example(
+    webhook_create_example, mocked_bugzilla
+) -> BugzillaWebhookRequest:
+    webhook_comment_example: BugzillaWebhookRequest = webhook_create_example
+    webhook_comment_example.event.target = "comment"
+    webhook_comment_example.event.user.login = "[email protected]"  # type: ignore
+    assert webhook_comment_example.bug
+    webhook_comment_example.bug.comment = BugzillaWebhookComment.parse_obj(
+        {"id": 344, "number": 2, "is_private": True}
+    )
+    webhook_comment_example.bug.see_also = [
+        "https://mozilla.atlassian.net/browse/JBI-234"
+    ]
+
+    # Call to Bugzilla returns the actual bug comments.
+    mocked_bugzilla().get_comments.return_value = {
+        "bugs": {
+            str(webhook_comment_example.bug.id): {
+                "comments": [
+                    {
+                        "id": 343,
+                        "text": "not this one",
+                        "bug_id": webhook_comment_example.bug.id,
+                        "count": 1,
+                        "is_private": True,
+                        "creator": "[email protected]",
+                    },
+                    {
+                        "id": 344,
+                        "text": "hello",
+                        "bug_id": webhook_comment_example.bug.id,
+                        "count": 2,
+                        "is_private": True,
+                        "creator": "[email protected]",
+                    },
+                    {
+                        "id": 345,
+                        "text": "or this one",
+                        "bug_id": webhook_comment_example.bug.id,
+                        "count": 3,
+                        "is_private": True,
+                        "creator": "[email protected]",
+                    },
+                ]
+            }
+        },
+        "comments": {},
+    }
+
+    return webhook_comment_example
+
+
 @pytest.fixture
 def webhook_create_private_example(
     webhook_create_example, mocked_bugzilla

tests/unit/jbi/whiteboard_actions/test_default.py

@@ -112,6 +112,39 @@ def test_added_comment(webhook_comment_example: BugzillaWebhookRequest, mocked_j
     assert value["status"] == "comment"
 
 
+def test_added_private_comment(
+    webhook_private_comment_example: BugzillaWebhookRequest, mocked_jira
+):
+
+    callable_object = default.init(jira_project_key="")
+
+    value = callable_object(payload=webhook_private_comment_example)
+
+    mocked_jira().issue_add_comment.assert_called_once_with(
+        issue_key="JBI-234",
+        comment="*([email protected])* commented: \n{quote}hello{quote}",
+    )
+    assert value["status"] == "comment"
+
+
+def test_added_missing_private_comment(
+    webhook_private_comment_example: BugzillaWebhookRequest,
+    mocked_jira,
+    mocked_bugzilla,
+):
+
+    callable_object = default.init(jira_project_key="")
+    mocked_bugzilla().get_comments.return_value = {
+        "bugs": {str(webhook_private_comment_example.bug.id): {"comments": []}},
+        "comments": {},
+    }
+
+    value = callable_object(payload=webhook_private_comment_example)
+
+    mocked_jira().issue_add_comment.assert_not_called()
+    assert value["status"] == "noop"
+
+
 def test_added_comment_without_linked_issue(
     webhook_comment_example: BugzillaWebhookRequest, mocked_jira
 ):