Add default_with_assignee_and_status action (#75)

Author: Mossop

README.md

@@ -18,6 +18,7 @@ The system reads the action configuration from a YAML file, one per environment.
 Below is a full example of an action configuration:
 ```yaml
     action: src.jbi.whiteboard_actions.default
+    allow_private: false
     contact: [[email protected]]
     description: example configuration
     enabled: true
@@ -31,6 +32,12 @@ A bit more about the different fields...
     - string
     - default: [src.jbi.whiteboard_actions.default](src/jbi/whiteboard_actions/default.py)
     - The specified Python module must be available in the `PYTHONPATH`
+- `allow_private` (optional)
+    - bool [true, false]
+    - default: false
+    - If false bugs that are not public will not be synchronized. Note that in order to synchronize
+      private bugs the bugzilla user that JBI runs as must be in the security groups that are making
+      the bug private.
 - `contact`
     - list of strings
     - If an issue arises with the workflow, communication will be established with these contacts
@@ -54,6 +61,37 @@ A bit more about the different fields...
 [View 'prod' configurations here.](config/config.prod.yaml)
 
 
+## Default with assignee and status action
+The `src.jbi.whiteboard_actions.default_with_assignee_and_status` action adds some additional
+features on top of the default.
+
+It will attempt to assign the Jira issue the same person as the bug is assigned to. This relies on
+the user using the same email address in both Bugzilla and Jira. If the user does not exist in Jira
+then the assignee is cleared from the Jira issue.
+
+The action supports setting the Jira issues's status when the Bugzilla status and resolution change.
+This is defined using a mapping on a per-project basis configured in the `status_map` field of the
+`parameters` field.
+
+An example configuration:
+```yaml
+    action: src.jbi.whiteboard_actions.default_with_assignee_and_status
+    contact: [[email protected]]
+    description: example configuration
+    enabled: true
+    parameters:
+      jira_project_key: EXMPL
+      whiteboard_tag: example
+      status_map:
+        NEW: "In Progress"
+        FIXED: "Closed"
+```
+
+In this case if the bug changes to the NEW status the action will attempt to set the linked Jira
+issue status to "In Progress". If the bug changes to RESOLVED FIXED it will attempt to set the
+linked Jira issue status to "Closed". If the bug changes to a status not listed in `status_map` then
+no change will be made to the Jira issue.
+
 ### Custom Actions
 If you're looking for a unique capability for your team's data flow, you can add your own python methods and functionality[...read more here.](src/jbi/whiteboard_actions/README.md)
 

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/bugzilla.py

@@ -42,6 +42,18 @@ class BugzillaWebhookEvent(BaseModel):
     target: Optional[str]
     routing_key: Optional[str]
 
+    def changed_fields(self) -> Optional[List[str]]:
+        """Returns the names of changed fields in a bug"""
+        if self.changes:
+            return [c.field for c in self.changes]
+
+        # Private bugs don't include the changes field in the event, but the
+        # field names are in the routing key.
+        if self.routing_key is not None and self.routing_key[0:11] == "bug.modify:":
+            return self.routing_key[11:].split(",")
+
+        return None
+
 
 class BugzillaWebhookAttachment(BaseModel):
     """Bugzilla Attachment Object"""

src/jbi/services.py

@@ -16,6 +16,7 @@ def get_jira():
         url=settings.jira_base_url,
         username=settings.jira_username,
         password=settings.jira_api_key,  # package calls this param 'password' but actually expects an api key
+        cloud=True,  # we run against an instance of Jira cloud
     )
 
 

src/jbi/whiteboard_actions/default.py

@@ -83,6 +83,22 @@ def comment_create_or_noop(
         )
         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, bug_obj: BugzillaBug
     ):  # pylint: disable=too-many-locals
@@ -105,7 +121,7 @@ def bug_create_or_update(
             key=linked_issue_key, fields=bug_obj.map_as_jira_issue()
         )
 
-        comments = payload.map_as_comments()
+        comments = self.jira_comments_for_update(payload)
         jira_response_comments = []
         for i, comment in enumerate(comments):
             logger.debug(
@@ -119,6 +135,9 @@ def bug_create_or_update(
                     issue_key=linked_issue_key, comment=comment
                 )
             )
+
+        self.update_issue(payload, bug_obj, linked_issue_key, is_new=False)
+
         return {
             "status": "update",
             "jira_responses": [jira_response_update, jira_response_comments],
@@ -201,6 +220,9 @@ def create_and_link_issue(
             link_url=bugzilla_url,
             title="Bugzilla Ticket",
         )
+
+        self.update_issue(payload, bug_obj, jira_key_in_response, is_new=True)
+
         return {
             "status": "create",
             "bugzilla_response": bugzilla_response,

src/jbi/whiteboard_actions/default_with_assignee_and_status.py

@@ -0,0 +1,122 @@
+"""
+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
+"""
+import logging
+
+from src.jbi.bugzilla import BugzillaBug, BugzillaWebhookRequest
+from src.jbi.whiteboard_actions.default import DefaultExecutor
+
+logger = logging.getLogger(__name__)
+
+
+def init(status_map=None, **kwargs):
+    """Function that takes required and optional params and returns a callable object"""
+    return AssigneeAndStatusExecutor(status_map=status_map or {}, **kwargs)
+
+
+class AssigneeAndStatusExecutor(DefaultExecutor):
+    """Callable class that encapsulates the default_with_assignee_and_status action."""
+
+    def __init__(self, status_map, **kwargs):
+        """Initialize AssigneeAndStatusExecutor Object"""
+        super().__init__(**kwargs)
+        self.status_map = 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(
+            status_log_enabled=False, assignee_log_enabled=False
+        )
+
+    def update_issue(
+        self,
+        payload: BugzillaWebhookRequest,
+        bug_obj: BugzillaBug,
+        linked_issue_key: str,
+        is_new: bool,
+    ):
+        changed_fields = payload.event.changed_fields() or []
+
+        log_context = {
+            "bug": {
+                "id": bug_obj.id,
+                "status": bug_obj.status,
+                "resolution": bug_obj.resolution,
+                "assigned_to": bug_obj.assigned_to,
+            },
+            "jira": linked_issue_key,
+            "changed_fields": changed_fields,
+        }
+
+        def clear_assignee():
+            # New tickets already have no assignee.
+            if not is_new:
+                logger.debug("Clearing assignee", extra=log_context)
+                self.jira_client.update_issue_field(
+                    key=linked_issue_key, fields={"assignee": None}
+                )
+
+        # 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:
+                logger.debug(
+                    "Attempting to update assignee",
+                    extra=log_context,
+                )
+                # 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 as exception:
+                        logger.debug(
+                            "Setting assignee failed: %s", exception, extra=log_context
+                        )
+                        # If that failed then just fall back to clearing the
+                        # assignee.
+                        clear_assignee()
+                else:
+                    logger.debug("No assignee found", extra=log_context)
+                    clear_assignee()
+
+        # If this is a new issue or if the bug's status or resolution has
+        # changed then update the issue status.
+        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 or bug_obj.status
+
+            if status in self.status_map:
+                logger.debug(
+                    "Updating Jira status to %s",
+                    self.status_map[status],
+                    extra=log_context,
+                )
+                self.jira_client.set_issue_status(
+                    linked_issue_key, self.status_map[status]
+                )
+            else:
+                logger.debug(
+                    "Bug status was not in the status map.",
+                    extra={**log_context, "status_map": self.status_map},
+                )

tests/unit/jbi/test_bugzilla.py

@@ -64,3 +64,41 @@ def test_get_jira_labels_multiple():
 def test_extract_see_also(see_also, expected):
     test_bug = bugzilla.BugzillaBug(id=0, see_also=see_also)
     assert test_bug.extract_from_see_also() == expected
+
+
+def test_payload_changes(webhook_request_example):
+    assert webhook_request_example.event.changed_fields() is None
+
+    webhook_request_example.event = bugzilla.BugzillaWebhookEvent.parse_obj(
+        {
+            "action": "modify",
+            "routing_key": "bug.modify",
+            "target": "bug",
+            "changes": [
+                {"field": "assigned_to", "removed": "", "added": "dtownsend"},
+                {"field": "status", "removed": "UNCONFIRMED", "added": "NEW"},
+            ],
+            "time": "2022-03-23T20:10:17.495000+00:00",
+            "user": {
+                "id": 123456,
+                "login": "[email protected]",
+                "real_name": "Nobody [ :nobody ]",
+            },
+        }
+    )
+    assert webhook_request_example.event.changed_fields() == ["assigned_to", "status"]
+
+    webhook_request_example.event = bugzilla.BugzillaWebhookEvent.parse_obj(
+        {
+            "action": "modify",
+            "routing_key": "bug.modify:assigned_to,status",
+            "target": "bug",
+            "time": "2022-03-23T20:10:17.495000+00:00",
+            "user": {
+                "id": 123456,
+                "login": "[email protected]",
+                "real_name": "Nobody [ :nobody ]",
+            },
+        }
+    )
+    assert webhook_request_example.event.changed_fields() == ["assigned_to", "status"]