Fix #247 #464: add maybe_update_issue_priority and maybe_update_issue_severity steps (#889)

leplatrem · web-flow · commit 0a181ee161f8 · 2024-03-06T09:43:10.000Z
* Mention 'sync_keywords_labels' in docs

* Generalize code of resolution field

* Add support for priority and severity

* Generalize more

Sq

* Remove default parameters values for severity and priority

* Adjust severity field according to mozilla-hub

* Add missing tests

* Refactor generic method

* Add default priority mapping
diff --git a/docs/actions.md b/docs/actions.md
@@ -149,9 +149,12 @@ linked Jira issue status to "Closed". If the bug changes to a status not listed
 - `update_issue`
 - `add_jira_comments_for_changes`
 - `maybe_assign_jira_user`
+- `maybe_update_issue_priority`
 - `maybe_update_issue_resolution`
+- `maybe_update_issue_severity`
 - `maybe_update_issue_status`
 - `create_comment`
+- `sync_keywords_labels`
 - `sync_whiteboard_labels`
 - `maybe_update_components`: looks at the component that's set on the bug (if any) and any components added to the project configuration with the `jira_components` parameter (see above). If those components are available on the Jira side as well, they're added to the Jira issue
 
diff --git a/jbi/jira/service.py b/jbi/jira/service.py
@@ -241,15 +241,41 @@ def assign_jira_user(self, context: ActionContext, email: str):
             # 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.
-            return self.client.update_issue_field(
-                key=issue_key,
-                fields={"assignee": {"accountId": jira_user_id}},
+            return self.update_issue_field(
+                context, "assignee", jira_user_id, wrap_value="accountId"
             )
         except (requests_exceptions.HTTPError, IOError) as exc:
             raise ValueError(
                 f"Could not assign {jira_user_id} to issue {issue_key}"
             ) from exc
 
+    def update_issue_field(
+        self,
+        context: ActionContext,
+        field: str,
+        value: Any,
+        wrap_value: Optional[str] = None,
+    ):
+        bug = context.bug
+        issue_key = context.jira.issue
+        logger.info(
+            f"Updating {field} of Jira issue %s to %s for Bug %s",
+            issue_key,
+            value,
+            bug.id,
+            extra=context.model_dump(),
+        )
+        fields: dict[str, Any] = {field: {wrap_value: value} if wrap_value else value}
+        response = self.client.update_issue_field(key=issue_key, fields=fields)
+        logger.info(
+            f"Updated {field} of Jira issue %s to %s for Bug %s",
+            issue_key,
+            value,
+            bug.id,
+            extra={"response": response, **context.model_dump()},
+        )
+        return response
+
     def update_issue_status(self, context: ActionContext, jira_status: str):
         """Update the status of the Jira issue"""
         issue_key = context.jira.issue
@@ -267,51 +293,25 @@ def update_issue_status(self, context: ActionContext, jira_status: str):
 
     def update_issue_summary(self, context: ActionContext):
         """Update's an issue's summary with the description of an incoming bug"""
-
-        bug = context.bug
-        issue_key = context.jira.issue
-        logger.info(
-            "Update summary of Jira issue %s for Bug %s",
-            issue_key,
-            bug.id,
-            extra=context.model_dump(),
-        )
         truncated_summary = markdown_to_jira(
-            bug.summary or "", max_length=JIRA_DESCRIPTION_CHAR_LIMIT
+            context.bug.summary or "", max_length=JIRA_DESCRIPTION_CHAR_LIMIT
+        )
+        return self.update_issue_field(
+            context, field="summary", value=truncated_summary
         )
-        fields: dict[str, str] = {
-            "summary": truncated_summary,
-        }
-        jira_response = self.client.update_issue_field(key=issue_key, fields=fields)
-        return jira_response
 
     def update_issue_resolution(self, context: ActionContext, jira_resolution: str):
         """Update the resolution of the Jira issue."""
-        issue_key = context.jira.issue
-        assert issue_key  # Until we have more fine-grained typing of contexts
-
-        logger.info(
-            "Updating resolution of Jira issue %s to %s",
-            issue_key,
-            jira_resolution,
-            extra=context.model_dump(),
+        return self.update_issue_field(
+            context,
+            field="resolution",
+            value=jira_resolution,
+            wrap_value="name",
         )
-        response = self.client.update_issue_field(
-            key=issue_key,
-            fields={"resolution": {"name": jira_resolution}},
-        )
-        logger.info(
-            "Updated resolution of Jira issue %s to %s",
-            issue_key,
-            jira_resolution,
-            extra={"response": response, **context.model_dump()},
-        )
-        return response
 
     def update_issue_components(
         self,
-        issue_key: str,
-        project: str,
+        context: ActionContext,
         components: Iterable[str],
     ) -> tuple[Optional[dict], set]:
         """Attempt to add components to the specified issue
@@ -328,7 +328,9 @@ def update_issue_components(
         missing_components = set(components)
         jira_components = []
 
-        all_project_components = self.client.get_project_components(project)
+        all_project_components = self.client.get_project_components(
+            context.jira.project
+        )
         for comp in all_project_components:
             if comp["name"] in missing_components:
                 jira_components.append({"id": comp["id"]})
@@ -337,13 +339,8 @@ def update_issue_components(
         if not jira_components:
             return None, missing_components
 
-        logger.info(
-            "attempting to add components '%s' to issue '%s'",
-            ",".join(components),
-            issue_key,
-        )
-        resp = self.client.update_issue_field(
-            key=issue_key, fields={"components": jira_components}
+        resp = self.update_issue_field(
+            context, field="components", value=jira_components
         )
         return resp, missing_components
 
diff --git a/jbi/models.py b/jbi/models.py
@@ -74,9 +74,20 @@ class ActionParams(BaseModel, frozen=True):
     jira_project_key: str
     steps: ActionSteps = ActionSteps()
     jira_components: JiraComponents = JiraComponents()
+    jira_severity_field: str = "customfield_10716"
+    jira_priority_field: str = "priority"
+    jira_resolution_field: str = "resolution"
     labels_brackets: Literal["yes", "no", "both"] = "no"
     status_map: dict[str, str] = {}
+    priority_map: dict[str, str] = {
+        "P1": "P1",
+        "P2": "P2",
+        "P3": "P3",
+        "P4": "Low",
+        "P5": "Lowest",
+    }
     resolution_map: dict[str, str] = {}
+    severity_map: dict[str, str] = {}
     issue_type_map: dict[str, str] = {"task": "Task", "defect": "Bug"}
 
 
diff --git a/jbi/steps.py b/jbi/steps.py
@@ -200,39 +200,74 @@ def maybe_assign_jira_user(
     return (StepStatus.NOOP, context)
 
 
-def maybe_update_issue_resolution(
-    context: ActionContext, *, parameters: ActionParams, jira_service: JiraService
+def _maybe_update_issue_mapped_field(
+    source_field: str,
+    context: ActionContext,
+    parameters: ActionParams,
+    jira_service: JiraService,
+    wrap_value: Optional[str] = None,
 ) -> StepResult:
-    """
-    Update the Jira issue status
-    https://support.atlassian.com/jira-cloud-administration/docs/what-are-issue-statuses-priorities-and-resolutions/
-    """
-
-    bz_resolution = context.bug.resolution or ""
-    jira_resolution = parameters.resolution_map.get(bz_resolution)
-
-    if jira_resolution is None:
+    source_value = getattr(context.bug, source_field, None) or ""
+    target_field = getattr(parameters, f"jira_{source_field}_field")
+    target_value = getattr(parameters, f"{source_field}_map").get(source_value)
+    if target_value is None:
         logger.info(
-            "Bug resolution %r was not in the resolution map.",
-            bz_resolution,
+            f"Bug {source_field} %r was not in the {source_field} map.",
+            source_value,
             extra=context.update(
                 operation=Operation.IGNORE,
             ).model_dump(),
         )
         return (StepStatus.INCOMPLETE, context)
 
-    if context.operation == Operation.CREATE:
-        resp = jira_service.update_issue_resolution(context, jira_resolution)
-        context.append_responses(resp)
-        return (StepStatus.SUCCESS, context)
+    if (
+        context.operation == Operation.UPDATE
+        and source_field not in context.event.changed_fields()
+    ):
+        return (StepStatus.NOOP, context)
 
-    if context.operation == Operation.UPDATE:
-        if "resolution" in context.event.changed_fields():
-            resp = jira_service.update_issue_resolution(context, jira_resolution)
-            context.append_responses(resp)
-            return (StepStatus.SUCCESS, context)
+    resp = jira_service.update_issue_field(
+        context,
+        target_field,
+        target_value,
+        wrap_value,
+    )
+    context.append_responses(resp)
+    return (StepStatus.SUCCESS, context)
 
-    return (StepStatus.NOOP, context)
+
+def maybe_update_issue_priority(
+    context: ActionContext, *, parameters: ActionParams, jira_service: JiraService
+) -> StepResult:
+    """
+    Update the Jira issue priority
+    """
+    return _maybe_update_issue_mapped_field(
+        "priority", context, parameters, jira_service, wrap_value="name"
+    )
+
+
+def maybe_update_issue_resolution(
+    context: ActionContext, *, parameters: ActionParams, jira_service: JiraService
+) -> StepResult:
+    """
+    Update the Jira issue status
+    https://support.atlassian.com/jira-cloud-administration/docs/what-are-issue-statuses-priorities-and-resolutions/
+    """
+    return _maybe_update_issue_mapped_field(
+        "resolution", context, parameters, jira_service, wrap_value="name"
+    )
+
+
+def maybe_update_issue_severity(
+    context: ActionContext, *, parameters: ActionParams, jira_service: JiraService
+) -> StepResult:
+    """
+    Update the Jira issue severity
+    """
+    return _maybe_update_issue_mapped_field(
+        "severity", context, parameters, jira_service, wrap_value="value"
+    )
 
 
 def maybe_update_issue_status(
@@ -301,8 +336,7 @@ def maybe_update_components(
 
     try:
         resp, missing_components = jira_service.update_issue_components(
-            issue_key=context.jira.issue,
-            project=parameters.jira_project_key,
+            context=context,
             components=candidate_components,
         )
     except requests_exceptions.HTTPError as exc:
diff --git a/tests/unit/jira/test_service.py b/tests/unit/jira/test_service.py
@@ -203,8 +203,10 @@ def test_update_issue_resolution(
         jira_service.update_issue_resolution(context=context, jira_resolution="DONEZO")
 
     before, after = capturelogs.messages
-    assert before == "Updating resolution of Jira issue JBI-234 to DONEZO"
-    assert after == "Updated resolution of Jira issue JBI-234 to DONEZO"
+    assert (
+        before == "Updating resolution of Jira issue JBI-234 to DONEZO for Bug 654321"
+    )
+    assert after == "Updated resolution of Jira issue JBI-234 to DONEZO for Bug 654321"
 
 
 def test_update_issue_resolution_raises(
@@ -230,7 +232,9 @@ def test_update_issue_resolution_raises(
             )
 
     [message] = capturelogs.messages
-    assert message == "Updating resolution of Jira issue JBI-234 to DONEZO"
+    assert (
+        message == "Updating resolution of Jira issue JBI-234 to DONEZO for Bug 654321"
+    )
 
 
 def test_create_jira_issue(
diff --git a/tests/unit/test_steps.py b/tests/unit/test_steps.py
