Add an extended action that supports syncing assignee and status.

Separates out a couple of key parts of the default action to allow
sub-classes to make minor changes before and after Jira is updated. This
includes:

  * Allowing sub-classes to modify the comments generated for existing
    issues
  * Allowing sub-classes to make changes to the Jira issue after the
    default action is done processing.

Then defines a new action that extends the default and syncs assignee
and status.

Author: Mossop

pyproject.toml

@@ -56,6 +56,8 @@ testpaths = [
     ignore='third_party'
     ignore-patterns = "tests/*"
     extension-pkg-whitelist = "pydantic"
+    [tool.pylint.SIMILARITIES]
+    ignore-signatures = "yes"
 
 [tool.isort]
 profile = "black"

src/jbi/whiteboard_actions/default.py

@@ -7,7 +7,7 @@
 """
 
 from src.app.environment import get_settings
-from src.jbi.bugzilla import BugzillaWebhookRequest
+from src.jbi.bugzilla import BugzillaBug, BugzillaWebhookRequest
 from src.jbi.errors import ActionError
 from src.jbi.services import get_bugzilla, get_jira, getbug_as_bugzilla_object
 
@@ -56,6 +56,22 @@ def comment_create_or_noop(self, payload: BugzillaWebhookRequest):
         )
         return {"status": "comment", "jira_response": jira_response}
 
+    def jira_comments_for_update(  # pylint: disable=no-self-use
+        self,
+        payload: BugzillaWebhookRequest,
+    ):
+        """Returns the comments to post to Jira for a changed bug"""
+        return payload.map_as_comments()
+
+    def update_issue(
+        self,
+        payload: BugzillaWebhookRequest,
+        bug_obj: BugzillaBug,
+        linked_issue_key: str,
+        is_new: bool,
+    ):
+        """Allows sub-classes to modify the Jira issue in response to a bug event"""
+
     def bug_create_or_update(
         self, payload: BugzillaWebhookRequest
     ):  # pylint: disable=too-many-locals
@@ -64,7 +80,7 @@ def bug_create_or_update(
         linked_issue_key = bug_obj.extract_from_see_also()  # type: ignore
         if linked_issue_key:
             # update
-            comments = payload.map_as_comments()
+            comments = self.jira_comments_for_update(payload)
             jira_response_update = self.jira_client.update_issue_field(
                 key=linked_issue_key, fields=bug_obj.map_as_jira_issue()
             )
@@ -76,6 +92,7 @@ def bug_create_or_update(
                         issue_key=linked_issue_key, comment=comment
                     )
                 )
+            self.update_issue(payload, bug_obj, linked_issue_key, False)
             return {
                 "status": "update",
                 "jira_responses": [jira_response_update, jira_response_comments],
@@ -131,6 +148,9 @@ def create_and_link_issue(self, payload, bug_obj):
             link_url=bugzilla_url,
             title="Bugzilla Ticket",
         )
+
+        self.update_issue(payload, bug_obj, jira_key_in_response, True)
+
         return {
             "status": "create",
             "bugzilla_response": bugzilla_response,

src/jbi/whiteboard_actions/extended.py

@@ -0,0 +1,89 @@
+"""
+Extended action that provides some additional features over the default:
+  * Updates the Jira assignee when the bug's assignee changes.
+  * Optionally updates the Jira status when the bug's resolution or status changes.
+
+`init` is required; and requires at minimum the
+`whiteboard_tag` and `jira_project_key`. `status_map` is optional.
+
+`init` should return a __call__able
+"""
+
+from src.jbi.bugzilla import BugzillaBug, BugzillaWebhookRequest
+from src.jbi.whiteboard_actions.default import DefaultExecutor
+
+
+def init(whiteboard_tag, jira_project_key, **kwargs):
+    """Function that takes required and optional params and returns a callable object"""
+    return ExtendedExecutor(
+        whiteboard_tag=whiteboard_tag, jira_project_key=jira_project_key, **kwargs
+    )
+
+
+class ExtendedExecutor(DefaultExecutor):
+    """Callable class that encapsulates the extended action."""
+
+    def __init__(self, **kwargs):
+        """Initialize ExtendedExecutor Object"""
+        super().__init__(**kwargs)
+        self.status_map = kwargs.get("status_map", {})
+
+    def jira_comments_for_update(
+        self,
+        payload: BugzillaWebhookRequest,
+    ):
+        """Returns the comments to post to Jira for a changed bug"""
+        return payload.map_as_comments(False, False)
+
+    def update_issue(
+        self,
+        payload: BugzillaWebhookRequest,
+        bug_obj: BugzillaBug,
+        linked_issue_key: str,
+        is_new: bool,
+    ):
+        def clear_assignee():
+            # New tickets already have no assignee.
+            if not is_new:
+                self.jira_client.update_issue_field(
+                    key=linked_issue_key, fields={"assignee": None}
+                )
+
+        changed_fields = payload.event.changed_fields() or []
+
+        # If this is a new issue or if the bug's assignee has changed then
+        # update the assignee.
+        if is_new or "assigned_to" in changed_fields:
+            if bug_obj.assigned_to == "[email protected]":
+                clear_assignee()
+            else:
+                # Look up this user in Jira
+                users = self.jira_client.user_find_by_user_string(
+                    query=bug_obj.assigned_to
+                )
+                if len(users) == 1:
+                    try:
+                        # There doesn't appear to be an easy way to verify that
+                        # this user can be assigned to this issue, so just try
+                        # and do it.
+                        self.jira_client.update_issue_field(
+                            key=linked_issue_key,
+                            fields={"assignee": {"accountId": users[0]["accountId"]}},
+                        )
+                    except IOError:
+                        # If that failed then just fall back to clearing the
+                        # assignee.
+                        clear_assignee()
+
+        # If this is a new issue or if the bug's status or resolution has
+        # changed then update the assignee.
+        if is_new or "status" in changed_fields or "resolution" in changed_fields:
+            # We use resolution if one exists or status otherwise.
+            status = bug_obj.resolution
+            if status == "":
+                status = bug_obj.status
+
+            if status in self.status_map:
+                self.jira_client.set_issue_status(
+                    linked_issue_key, self.status_map[status]
+                )