Allow disabling syncing whiteboard fields to Jira. Fixes #201 (#206)

* Allow changing or disabling the field used to store status whiteboard labels. Fixes #201

* Disable label syncing for flowstate.

Author: Mossop

.secrets.baseline

@@ -122,9 +122,9 @@
         "filename": "README.md",
         "hashed_secret": "04e78d6e804f2b59e6cb282cb9ed2c7bfd8a9737",
         "is_verified": false,
-        "line_number": 194
+        "line_number": 211
       }
     ]
   },
-  "generated_at": "2022-07-28T11:58:31Z"
+  "generated_at": "2022-08-17T08:30:43Z"
 }

README.md

@@ -74,6 +74,9 @@ It will also set the Jira issue URL in the Bugzilla bug `see_also` field.
 - `jira_project_key`
     - string
     - The Jira project identifier
+- `sync_whiteboard_labels`
+    - boolean
+    - Whether to sync the Bugzilla status whiteboard labels to Jira. Defaults to `true`.
 
 Example configuration:
 ```yaml
@@ -85,6 +88,17 @@ Example configuration:
       jira_project_key: EXMPL
 ```
 
+Example configuration that disables setting labels in Jira:
+```yaml
+    whiteboard_tag: example
+    contact: [email protected]
+    description: example configuration
+    module: jbi.actions.default
+    parameters:
+      jira_project_key: EXMPL
+      sync_whiteboard_labels: false
+```
+
 ### Default with assignee and status action
 The `jbi.actions.default_with_assignee_and_status` action adds some additional
 features on top of the default.
@@ -101,6 +115,9 @@ If configured, the action supports setting the Jira issues's status when the Bug
 - `jira_project_key`
     - string
     - The Jira project identifier
+- `sync_whiteboard_labels`
+    - boolean
+    - Whether to sync the Bugzilla status whiteboard labels to Jira. Defaults to `true`.
 - `status_map` (optional)
     - mapping [str, str]
     - If defined, map the Bugzilla bug status to Jira issue status

config/config.prod.yaml

@@ -40,6 +40,7 @@
   module: jbi.actions.default_with_assignee_and_status
   parameters:
     jira_project_key: MR2
+    sync_whiteboard_labels: false
     status_map:
       ASSIGNED: In Progress
       FIXED: In Review

jbi/actions/default.py

@@ -1,10 +1,13 @@
 """
 Default action is listed below.
 `init` is required; and requires at minimum the `jira_project_key` parameter.
+The `label_field` parameter configures which Jira field is used to store the
+labels generated from the Bugzilla status whiteboard.
 
 `init` should return a __call__able
 """
 import logging
+from typing import Any
 
 from jbi import ActionResult, Operation
 from jbi.environment import get_settings
@@ -25,9 +28,13 @@
 }
 
 
-def init(jira_project_key, **kwargs):
+def init(jira_project_key, sync_whiteboard_labels=True, **kwargs):
     """Function that takes required and optional params and returns a callable object"""
-    return DefaultExecutor(jira_project_key=jira_project_key, **kwargs)
+    return DefaultExecutor(
+        jira_project_key=jira_project_key,
+        sync_whiteboard_labels=sync_whiteboard_labels,
+        **kwargs,
+    )
 
 
 class DefaultExecutor:
@@ -36,6 +43,7 @@ class DefaultExecutor:
     def __init__(self, jira_project_key, **kwargs):
         """Initialize DefaultExecutor Object"""
         self.jira_project_key = jira_project_key
+        self.sync_whiteboard_labels = kwargs.get("sync_whiteboard_labels", True)
 
         self.bugzilla_client = get_bugzilla()
         self.jira_client = get_jira()
@@ -100,6 +108,17 @@ def comment_create_or_noop(self, payload: BugzillaWebhookRequest) -> ActionResul
         )
         return True, {"jira_response": jira_response}
 
+    def jira_fields(self, bug_obj: BugzillaBug):
+        """Extract bug info as jira issue dictionary"""
+        fields: dict[str, Any] = {
+            "summary": bug_obj.summary,
+        }
+
+        if self.sync_whiteboard_labels:
+            fields["labels"] = bug_obj.get_jira_labels()
+
+        return fields
+
     def jira_comments_for_update(
         self,
         payload: BugzillaWebhookRequest,
@@ -143,7 +162,7 @@ def bug_create_or_update(
             },
         )
         jira_response_update = self.jira_client.update_issue_field(
-            key=linked_issue_key, fields=bug_obj.map_as_jira_issue()
+            key=linked_issue_key, fields=self.jira_fields(bug_obj)
         )
 
         comments = self.jira_comments_for_update(payload)
@@ -193,7 +212,7 @@ def create_and_link_issue(  # pylint: disable=too-many-locals
         ]
 
         fields = {
-            **bug_obj.map_as_jira_issue(),  # type: ignore
+            **self.jira_fields(bug_obj),  # type: ignore
             "issuetype": {"name": bug_obj.issue_type()},
             "description": description,
             "project": {"key": self.jira_project_key},

jbi/models.py

@@ -266,13 +266,6 @@ def issue_type(self) -> str:
         type_map: dict = {"enhancement": "Task", "task": "Task", "defect": "Bug"}
         return type_map.get(self.type, "Task")
 
-    def map_as_jira_issue(self) -> dict:
-        """Extract bug info as jira issue dictionary"""
-        return {
-            "summary": self.summary,
-            "labels": self.get_jira_labels(),
-        }
-
     def extract_from_see_also(self):
         """Extract Jira Issue Key from see_also if jira url present"""
         if not self.see_also and len(self.see_also) > 0:

tests/unit/actions/test_default.py

@@ -202,3 +202,24 @@ def test_jira_returns_an_error(
         callable_object(payload=webhook_create_example)
 
     assert str(exc_info.value) == "response contains error: {'errors': ['Boom']}"
+
+
+def test_disabled_label_field(
+    webhook_create_example: BugzillaWebhookRequest, mocked_jira, mocked_bugzilla
+):
+    mocked_bugzilla.getbug.return_value = webhook_create_example.bug
+    mocked_bugzilla.get_comments.return_value = {
+        "bugs": {"654321": {"comments": [{"text": "Initial comment"}]}}
+    }
+    callable_object = default.init(jira_project_key="JBI", sync_whiteboard_labels=False)
+
+    callable_object(payload=webhook_create_example)
+
+    mocked_jira.create_issue.assert_called_once_with(
+        fields={
+            "summary": "JBI Test",
+            "issuetype": {"name": "Bug"},
+            "description": "Initial comment",
+            "project": {"key": "JBI"},
+        },
+    )