Change Jira resolution field (fixes mozilla#200) (mozilla#228)

* Change Jira resolution field (fixes mozilla#200)

* Update secrets baseline

Author: leplatrem

.secrets.baseline

@@ -122,9 +122,9 @@
         "filename": "README.md",
         "hashed_secret": "04e78d6e804f2b59e6cb282cb9ed2c7bfd8a9737",
         "is_verified": false,
-        "line_number": 211
+        "line_number": 218
       }
     ]
   },
-  "generated_at": "2022-08-17T08:30:43Z"
+  "generated_at": "2022-08-30T10:02:55Z"
 }

README.md

@@ -121,6 +121,9 @@ If configured, the action supports setting the Jira issues's status when the Bug
 - `status_map` (optional)
     - mapping [str, str]
     - If defined, map the Bugzilla bug status to Jira issue status
+- `resolution_map` (optional)
+    - mapping [str, str]
+    - If defined, map the Bugzilla bug resolution to Jira issue resolution
 
 Example configuration:
 ```yaml
@@ -134,6 +137,10 @@ Example configuration:
       status_map:
         NEW: "In Progress"
         FIXED: "Closed"
+      resolution_map:
+        FIXED: "Done"
+        DUPLICATE: "Duplicate"
+        WONTFIX: "Won't Do"
 ```
 
 In this case if the bug changes to the NEW status the action will attempt to set the linked Jira

jbi/actions/default_with_assignee_and_status.py

@@ -27,18 +27,21 @@
 JIRA_REQUIRED_PERMISSIONS = DEFAULT_JIRA_REQUIRED_PERMISSIONS
 
 
-def init(status_map=None, **kwargs):
+def init(status_map=None, resolution_map=None, **kwargs):
     """Function that takes required and optional params and returns a callable object"""
-    return AssigneeAndStatusExecutor(status_map=status_map or {}, **kwargs)
+    return AssigneeAndStatusExecutor(
+        status_map=status_map or {}, resolution_map=resolution_map or {}, **kwargs
+    )
 
 
 class AssigneeAndStatusExecutor(DefaultExecutor):
     """Callable class that encapsulates the default_with_assignee_and_status action."""
 
-    def __init__(self, status_map, **kwargs):
+    def __init__(self, status_map, resolution_map, **kwargs):
         """Initialize AssigneeAndStatusExecutor Object"""
         super().__init__(**kwargs)
         self.status_map = status_map
+        self.resolution_map = resolution_map
 
     def jira_comments_for_update(
         self,
@@ -121,17 +124,43 @@ def 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 action has configured mappings for the issue resolution field, update it.
+            bz_resolution = bug_obj.resolution
+            jira_resolution = self.resolution_map.get(bz_resolution)
+            if jira_resolution:
+                logger.debug(
+                    "Updating Jira resolution to %s",
+                    jira_resolution,
+                    extra=log_context.dict(),
+                )
+                self.jira_client.update_issue_field(
+                    key=linked_issue_key,
+                    fields={"resolution": jira_resolution},
+                )
+            else:
+                logger.debug(
+                    "Bug resolution was not in the resolution map.",
+                    extra=log_context.update(
+                        operation=Operation.IGNORE,
+                        extra={
+                            **log_context.extra,
+                            "resolution_map": self.resolution_map,
+                        },
+                    ).dict(),
+                )
 
-            if status in self.status_map:
+            # We use resolution if one exists or status otherwise.
+            bz_status = bz_resolution or bug_obj.status
+            jira_status = self.status_map.get(bz_status)
+            if jira_status:
                 logger.debug(
                     "Updating Jira status to %s",
-                    self.status_map[status],
+                    jira_status,
                     extra=log_context.dict(),
                 )
                 self.jira_client.set_issue_status(
-                    linked_issue_key, self.status_map[status]
+                    linked_issue_key,
+                    jira_status,
                 )
             else:
                 logger.debug(

tests/conftest.py

@@ -105,6 +105,14 @@ def webhook_modify_example() -> BugzillaWebhookRequest:
     return webhook_payload
 
 
+@pytest.fixture
+def webhook_modify_resolution_example() -> BugzillaWebhookRequest:
+    bug = bug_factory(see_also=["https://mozilla.atlassian.net/browse/JBI-234"])
+    event = webhook_event_factory(action="modify", routing_key="bug.modify:resolution")
+    webhook_payload = webhook_factory(bug=bug, event=event)
+    return webhook_payload
+
+
 @pytest.fixture
 def webhook_change_status_assignee():
     changes = [

tests/unit/actions/test_default_with_assignee_and_status.py

@@ -270,3 +270,43 @@ def test_change_to_known_resolution(webhook_create_example, mocked_jira):
         },
     )
     mocked_jira.set_issue_status.assert_called_once_with("JBI-234", "Closed")
+
+
+def test_change_to_known_resolution_with_resolution_map(
+    webhook_modify_resolution_example, mocked_jira
+):
+    webhook_modify_resolution_example.bug.resolution = "DUPLICATE"
+
+    callable_object = action.init(
+        jira_project_key="JBI",
+        resolution_map={
+            "DUPLICATE": "Duplicate",
+        },
+    )
+    callable_object(payload=webhook_modify_resolution_example)
+
+    mocked_jira.update_issue_field.assert_called_with(  # not once
+        key="JBI-234",
+        fields={
+            "resolution": "Duplicate",
+        },
+    )
+
+
+def test_change_to_unknown_resolution_with_resolution_map(
+    webhook_modify_resolution_example, mocked_jira
+):
+    webhook_modify_resolution_example.bug.resolution = "WONTFIX"
+
+    callable_object = action.init(
+        jira_project_key="JBI",
+        resolution_map={
+            "DUPLICATE": "Duplicate",
+        },
+    )
+    callable_object(payload=webhook_modify_resolution_example)
+
+    mocked_jira.update_issue_field.assert_called_once_with(
+        key="JBI-234",
+        fields={"summary": "JBI Test", "labels": ["bugzilla", "devtest", "[devtest]"]},
+    )