Generalize more

Sq

Author: leplatrem

jbi/jira/service.py

@@ -241,16 +241,21 @@ 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_named_field(self, context: ActionContext, field: str, value: str):
+    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(
@@ -260,9 +265,7 @@ def update_issue_named_field(self, context: ActionContext, field: str, value: st
             bug.id,
             extra=context.model_dump(),
         )
-        fields: dict[str, Any] = {
-            field: {"name": value},
-        }
+        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",
@@ -290,34 +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."""
-        return self.update_issue_named_field(
-            context, field="resolution", value=jira_resolution
+        return self.update_issue_field(
+            context,
+            field="resolution",
+            value=jira_resolution,
+            wrap_value="name",
         )
 
     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
@@ -334,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"]})
@@ -343,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
 
@@ -576,9 +567,9 @@ def check_jira_all_project_issue_types_exist(actions, _get_service):
         action_issue_types = set(action.parameters.issue_type_map.values())
         project_issue_types = issue_types_by_project.get(action.jira_project_key, set())
         if missing_issue_types := action_issue_types - project_issue_types:
-            missing_issue_types_by_project[
-                action.jira_project_key
-            ] = missing_issue_types
+            missing_issue_types_by_project[action.jira_project_key] = (
+                missing_issue_types
+            )
     if missing_issue_types_by_project:
         return [
             checks.Warning(

jbi/models.py

@@ -73,6 +73,9 @@ class ActionParams(BaseModel, frozen=True):
     jira_project_key: str
     steps: ActionSteps = ActionSteps()
     jira_components: JiraComponents = JiraComponents()
+    jira_severity_field: str = "severity"
+    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] = {

jbi/steps.py

@@ -202,13 +202,14 @@ def maybe_assign_jira_user(
 
 def _maybe_update_issue_mapped_field(
     source_field: str,
-    target_field: str,
     context: ActionContext,
     parameters: ActionParams,
     jira_service: JiraService,
+    wrap_value: Optional[str] = None,
 ) -> StepResult:
     source_value = getattr(context.bug, source_field, None) or ""
-    target_value = getattr(parameters, f"{source_field}_map").get(source_value)
+    target_field = getattr(parameters, f"jira_{source_field}_field")
+    target_value = getattr(parameters, f"{target_field}_map").get(source_value)
     if target_value is None:
         logger.info(
             f"Bug {source_field} %r was not in the {source_field} map.",
@@ -220,16 +221,22 @@ def _maybe_update_issue_mapped_field(
         return (StepStatus.INCOMPLETE, context)
 
     if context.operation == Operation.CREATE:
-        resp = jira_service.update_issue_named_field(
-            context, target_field, target_value
+        resp = jira_service.update_issue_field(
+            context,
+            target_field,
+            target_value,
+            wrap_value,
         )
         context.append_responses(resp)
         return (StepStatus.SUCCESS, context)
 
     if context.operation == Operation.UPDATE:
         if source_field in context.event.changed_fields():
-            resp = jira_service.update_issue_named_field(
-                context, target_field, target_value
+            resp = jira_service.update_issue_field(
+                context,
+                target_field,
+                target_value,
+                wrap_value,
             )
             context.append_responses(resp)
             return (StepStatus.SUCCESS, context)
@@ -244,7 +251,7 @@ def maybe_update_issue_priority(
     Update the Jira issue priority
     """
     return _maybe_update_issue_mapped_field(
-        "priority", "priority", context, parameters, jira_service
+        "priority", context, parameters, jira_service, wrap_value="name"
     )
 
 
@@ -256,7 +263,7 @@ def maybe_update_issue_resolution(
     https://support.atlassian.com/jira-cloud-administration/docs/what-are-issue-statuses-priorities-and-resolutions/
     """
     return _maybe_update_issue_mapped_field(
-        "resolution", "resolution", context, parameters, jira_service
+        "resolution", context, parameters, jira_service, wrap_value="name"
     )
 
 
@@ -267,7 +274,7 @@ def maybe_update_issue_severity(
     Update the Jira issue severity
     """
     return _maybe_update_issue_mapped_field(
-        "severity", "severity", context, parameters, jira_service
+        "severity", context, parameters, jira_service, wrap_value="name"
     )
 
 
@@ -337,8 +344,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: