Fix #554: configurable issue type (#557)

* Fix #554: configurable issue type

* Add missing tests as suggested by @grahamalama

* Fix tests after merge

Author: leplatrem

.github/ISSUE_TEMPLATE/new-config.yaml

@@ -50,6 +50,7 @@ body:
       description: Select the data you'd like to sync to Jira issues
       options:
         - label: Component (from the Bug and as specified in config)
+        - label: Issue Type (please provide mapping, eg. `enhancement` -> `Story`)
         - label: Status (please provide mapping, eg. `RESOLVED` -> `Done`)
         - label: Resolution (please provide mapping, eg. `WONTFIX` -> `Won't do`)
         - label: Whiteboard tags (as labels)

docs/actions.md

@@ -78,6 +78,9 @@ to the Bugzilla ticket on the Jira issue.
 - `resolution_map` (optional)
     - mapping [str, str]
     - If defined, map the Bugzilla bug resolution to Jira issue resolution
+- `issue_type_map` (optional)
+    - mapping [str, str]
+    - If defined, map the Bugzilla type to Jira issue type (default: ``Bug`` if ``defect`` else ``Task``)
 
 Minimal configuration:
 ```yaml

jbi/actions/steps.py

@@ -35,12 +35,20 @@ def create_issue(context: ActionContext, **parameters):
     """Create the Jira issue with the first comment as the description."""
     bug = context.bug
 
+    # If not specified, issue type will be either 'Bug' or 'Task'
+    issue_type_map = parameters.get(
+        "issue_type_map", {"enhancement": "Task", "task": "Task", "defect": "Bug"}
+    )
+    if not isinstance(issue_type_map, dict):
+        raise TypeError("The 'issue_type_map' parameter must be a dictionary.")
+    issue_type = issue_type_map.get(bug.type, "Task")
+
     # In the payload of a bug creation, the `comment` field is `null`.
     # We fetch the list of comments to use the first one as the Jira issue description.
     comment_list = bugzilla.get_client().get_comments(bug.id)
     description = comment_list[0].text if comment_list else ""
 
-    jira_create_response = jira.create_jira_issue(context, description)
+    jira_create_response = jira.create_jira_issue(context, description, issue_type)
     issue_key = jira_create_response.get("key")
 
     context = context.update(jira=context.jira.update(issue=issue_key))

jbi/models.py

@@ -234,11 +234,6 @@ def is_assigned(self) -> bool:
         """Return `true` if the bug is assigned to a user."""
         return self.assigned_to != "[email protected]"
 
-    def issue_type(self) -> str:
-        """Get the Jira issue type for this bug"""
-        type_map: dict = {"enhancement": "Task", "task": "Task", "defect": "Bug"}
-        return type_map.get(self.type, "Task")
-
     def extract_from_see_also(self):
         """Extract Jira Issue Key from see_also if jira url present"""
         if not self.see_also or len(self.see_also) == 0:

jbi/services/jira.py

@@ -232,10 +232,7 @@ class JiraCreateError(Exception):
     """Error raised on Jira issue creation."""
 
 
-def create_jira_issue(
-    context: ActionContext,
-    description: str,
-):
+def create_jira_issue(context: ActionContext, description: str, issue_type: str):
     """Create a Jira issue with basic fields in the project and return its key."""
     bug = context.bug
     logger.debug(
@@ -245,7 +242,7 @@ def create_jira_issue(
     )
     fields: dict[str, Any] = {
         "summary": bug.summary,
-        "issuetype": {"name": bug.issue_type()},
+        "issuetype": {"name": issue_type},
         "description": description[:JIRA_DESCRIPTION_CHAR_LIMIT],
         "project": {"key": context.jira.project},
     }

tests/unit/actions/test_steps.py

@@ -61,6 +61,80 @@ def test_created_public(
     )
 
 
+def test_misconfigured_issue_type(
+    context_create_example: ActionContext, mocked_jira, mocked_bugzilla
+):
+    context_create_example.bug.type = "enhancement"
+
+    callable_object = default.init(
+        jira_project_key=context_create_example.jira.project,
+        steps={"new": ["create_issue"]},
+        issue_type_map=["Epic"],  # list instead dict!
+    )
+    with pytest.raises(TypeError):
+        callable_object(context=context_create_example)
+
+
+def test_created_with_custom_issue_type_and_fallback(
+    context_create_example: ActionContext, mocked_jira, mocked_bugzilla
+):
+    context_create_example.bug.type = "enhancement"
+    mocked_jira.create_issue.return_value = {"key": "k"}
+    mocked_bugzilla.get_bug.return_value = context_create_example.bug
+    mocked_bugzilla.get_comments.return_value = [
+        comment_factory(text="Initial comment")
+    ]
+
+    callable_object = default.init(
+        jira_project_key=context_create_example.jira.project,
+        steps={"new": ["create_issue"]},
+        issue_type_map={
+            "task": "Epic",
+        },
+    )
+
+    callable_object(context=context_create_example)
+
+    mocked_jira.create_issue.assert_called_once_with(
+        fields={
+            "summary": "JBI Test",
+            "issuetype": {"name": "Task"},
+            "description": "Initial comment",
+            "project": {"key": "JBI"},
+        },
+    )
+
+
+def test_created_with_custom_issue_type(
+    context_create_example: ActionContext, mocked_jira, mocked_bugzilla
+):
+    context_create_example.bug.type = "task"
+    mocked_jira.create_issue.return_value = {"key": "k"}
+    mocked_bugzilla.get_bug.return_value = context_create_example.bug
+    mocked_bugzilla.get_comments.return_value = [
+        comment_factory(text="Initial comment")
+    ]
+
+    callable_object = default.init(
+        jira_project_key=context_create_example.jira.project,
+        steps={"new": ["create_issue"]},
+        issue_type_map={
+            "task": "Epic",
+        },
+    )
+
+    callable_object(context=context_create_example)
+
+    mocked_jira.create_issue.assert_called_once_with(
+        fields={
+            "summary": "JBI Test",
+            "issuetype": {"name": "Epic"},
+            "description": "Initial comment",
+            "project": {"key": "JBI"},
+        },
+    )
+
+
 def test_modified_public(context_update_example: ActionContext, mocked_jira):
     context_update_example.event.changes = [
         webhook_event_change_factory(field="summary", removed="", added="JBI Test")

tests/unit/services/test_jira.py

@@ -25,10 +25,7 @@ def test_jira_create_issue_is_instrumented(
         },
     )
 
-    jira.create_jira_issue(
-        context_create_example,
-        "Description",
-    )
+    jira.create_jira_issue(context_create_example, "Description", issue_type="Task")
     jira_client = jira.get_client()
 
     jira_client.create_issue({})
@@ -98,7 +95,9 @@ def test_jira_does_not_retry_4XX(mocked_responses, context_create_example):
     )
 
     with pytest.raises(requests.HTTPError):
-        jira.create_jira_issue(context=context_create_example, description="")
+        jira.create_jira_issue(
+            context=context_create_example, description="", issue_type="Task"
+        )
 
     assert len(mocked_responses.calls) == 1