Fix #521: do not add brackets on issue labels by default (#559)

* Fix #521: add option to control brackets on issue labels

* Add missing test for ValueError

* Change default value to "no"

Author: leplatrem

config/config.nonprod.yaml

@@ -5,6 +5,7 @@
   description: Nonprod testing whiteboard tag (JBI Bin Project)
   parameters:
     jira_project_key: JB
+    labels_brackets: both
 
 - whiteboard_tag: flowstate
   allow_private: true
@@ -28,6 +29,7 @@
         - maybe_update_issue_resolution
         - maybe_update_issue_status
         - sync_whiteboard_labels
+    labels_brackets: both
     status_map:
       ASSIGNED: In Progress
       FIXED: In Review
@@ -54,6 +56,7 @@
         - maybe_update_issue_resolution
         - maybe_update_issue_status
         - sync_whiteboard_labels
+    labels_brackets: both
     status_map:
       ASSIGNED: To Do
       REOPENED: To Do
@@ -87,6 +90,7 @@
         - maybe_assign_jira_user
         - maybe_update_issue_status
         - sync_whiteboard_labels
+    labels_brackets: both
     status_map:
       UNCONFIRMED: Backlog
       NEW: Backlog
@@ -128,6 +132,7 @@
         - sync_whiteboard_labels
       comment:
         - create_comment
+    labels_brackets: both
     status_map:
       UNCONFIRMED: Backlog
       NEW: Backlog
@@ -167,6 +172,7 @@
         - sync_whiteboard_labels
       comment:
         - create_comment
+    labels_brackets: both
     status_map:
       UNCONFIRMED: To Do
       NEW: To Do
@@ -207,6 +213,7 @@
         - maybe_update_issue_status
       comment:
         - create_comment
+    labels_brackets: both
     status_map:
       UNCONFIRMED: Backlog
       NEW: Backlog
@@ -247,6 +254,7 @@
         - maybe_update_issue_status
       comment:
         - create_comment
+    labels_brackets: both
     status_map:
       UNCONFIRMED: To Do
       NEW: To Do

config/config.prod.yaml

@@ -6,12 +6,14 @@
   # module: jbi.actions.default
   parameters:
     jira_project_key: WEBEXT
+    labels_brackets: both
 
 - whiteboard_tag: fidedi
   bugzilla_user_id: tbd
   description: Firefox Desktop Integration whiteboard tag
   parameters:
     jira_project_key: FIDEDI
+    labels_brackets: both
 
 - whiteboard_tag: fidefe
   bugzilla_user_id: 159069
@@ -33,7 +35,8 @@
         - maybe_assign_jira_user
         - maybe_update_issue_resolution
         - maybe_update_issue_status
-        - sync_whiteboard_labels
+        - sync_whiteboard_label
+    labels_brackets: both
     status_map:
       ASSIGNED: In Progress
       FIXED: Closed
@@ -73,6 +76,7 @@
   description: Privacy & Security and Anti-Tracking Team whiteboard tag
   parameters:
     jira_project_key: FXATPS
+    labels_brackets: both
 
 - whiteboard_tag: fxcm
   bugzilla_user_id: 713707
@@ -95,6 +99,7 @@
         - maybe_update_issue_resolution
         - maybe_update_issue_status
         - sync_whiteboard_labels
+    labels_brackets: both
     status_map:
       ASSIGNED: To Do
       REOPENED: To Do
@@ -128,6 +133,7 @@
         - maybe_assign_jira_user
         - maybe_update_issue_status
         - sync_whiteboard_labels
+    labels_brackets: both
     status_map:
       UNCONFIRMED: Backlog
       NEW: Backlog
@@ -169,6 +175,7 @@
         - sync_whiteboard_labels
       comment:
         - create_comment
+    labels_brackets: both
     status_map:
       UNCONFIRMED: Backlog
       NEW: Backlog
@@ -190,48 +197,56 @@
   description: Firefox Sync Team whiteboard tag
   parameters:
     jira_project_key: SYNC
+    labels_brackets: both
 
 - whiteboard_tag: disco
   bugzilla_user_id: 624105
   description: DISCO whiteboard tag
   parameters:
     jira_project_key: DISCO
+    labels_brackets: both
 
 - whiteboard_tag: mv3
   bugzilla_user_id: tbd
   description: MV3 whiteboard tag
   parameters:
     jira_project_key: WEBEXT
+    labels_brackets: both
 
 - whiteboard_tag: nimbus
   bugzilla_user_id: 624105
   description: Nimbus whiteboard tag
   parameters:
     jira_project_key: EXP
+    labels_brackets: both
 
 - whiteboard_tag: omc
   bugzilla_user_id: 711631
   description: Firefox Messaging System whiteboard tag
   parameters:
     jira_project_key: OMC
+    labels_brackets: both
 
 - whiteboard_tag: prodtest
   bugzilla_user_id: 644672
   description: Prod testing whiteboard tag (JBI Bin Project)
   parameters:
     jira_project_key: JB
+    labels_brackets: both
 
 - whiteboard_tag: proton
   bugzilla_user_id: tbd
   description: Proton whiteboard tag for Firefox Frontend
   parameters:
     jira_project_key: FIDEFE
+    labels_brackets: both
 
 - whiteboard_tag: relops
   bugzilla_user_id: tbd
   description: Release Operations Team Tag
   parameters:
     jira_project_key: RELOPS
+    labels_brackets: both
 
 - whiteboard_tag: remote-settings
   bugzilla_user_id: 576226
@@ -254,12 +269,14 @@
         - sync_whiteboard_labels
       comment:
         - create_comment
+    labels_brackets: both
 
 - whiteboard_tag: sng
   bugzilla_user_id: 696039
   description: Search Next Generation Team Tag
   parameters:
     jira_project_key: SNG
+    labels_brackets: both
 
 - whiteboard_tag: sp3
   bugzilla_user_id: 396948
@@ -284,6 +301,7 @@
         - sync_whiteboard_labels
       comment:
         - create_comment
+    labels_brackets: both
     status_map:
       UNCONFIRMED: To Do
       NEW: To Do

docs/actions.md

@@ -72,6 +72,9 @@ to the Bugzilla ticket on the Jira issue.
 - `jira_components` (optional)
    - list [str]
    - If defined, the created issues will be assigned the specified components.
+- `labels_brackets` (optional)
+    - enum ["yes", "no", "both"]
+    - Controls whether issue labels should have brackets or not in the `sync_whiteboard_labels` step (default: "no")
 - `status_map` (optional)
     - mapping [str, str]
     - If defined, map the Bugzilla bug status (or resolution) to Jira issue status
@@ -159,6 +162,7 @@ linked Jira issue status to "Closed". If the bug changes to a status not listed
 - `maybe_update_issue_resolution`
 - `maybe_update_issue_status`
 - `create_comment`
+- `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
 
 ### Custom Actions

jbi/actions/steps.py

@@ -260,22 +260,30 @@ def maybe_update_components(context: ActionContext, **parameters):
     return context, (resp,)
 
 
-def _whiteboard_as_labels(whiteboard: Optional[str]) -> list[str]:
+def _whiteboard_as_labels(labels_brackets: str, whiteboard: Optional[str]) -> list[str]:
     """Split the whiteboard string into a list of labels"""
     splitted = whiteboard.replace("[", "").split("]") if whiteboard else []
     stripped = [x.strip() for x in splitted if x not in ["", " "]]
     # Jira labels can't contain a " ", convert to "."
     nospace = [wb.replace(" ", ".") for wb in stripped]
     with_brackets = [f"[{wb}]" for wb in nospace]
-    return ["bugzilla"] + nospace + with_brackets
+
+    if labels_brackets == "yes":
+        labels = with_brackets
+    elif labels_brackets == "both":
+        labels = nospace + with_brackets
+    else:
+        labels = nospace
+
+    return ["bugzilla"] + labels
 
 
-def _build_labels_update(added, removed=None):
-    after = _whiteboard_as_labels(added)
+def _build_labels_update(labels_brackets, added, removed=None):
+    after = _whiteboard_as_labels(labels_brackets, added)
     # We don't bother detecting if label was already there.
     updates = [{"add": label} for label in after]
     if removed:
-        before = _whiteboard_as_labels(removed)
+        before = _whiteboard_as_labels(labels_brackets, removed)
         deleted = sorted(set(before).difference(set(after)))  # sorted for unit testing
         updates.extend([{"remove": label} for label in deleted])
     return updates
@@ -285,18 +293,29 @@ def sync_whiteboard_labels(context: ActionContext, **parameters):
     """
     Set whiteboard tags as labels on the Jira issue
     """
+    labels_brackets = parameters.get("labels_brackets", "no")
+    if labels_brackets not in ("yes", "no", "both"):
+        raise ValueError(
+            f"Invalid value {labels_brackets} for 'labels_brackets' parameter."
+        )
 
     # On update of whiteboard field, add/remove corresponding labels
     if context.event.changes:
         changes_by_field = {change.field: change for change in context.event.changes}
         if change := changes_by_field.get("whiteboard"):
-            updates = _build_labels_update(added=change.added, removed=change.removed)
+            updates = _build_labels_update(
+                added=change.added,
+                removed=change.removed,
+                labels_brackets=labels_brackets,
+            )
         else:
             # Whiteboard field not changed, ignore.
             return context, ()
     else:
         # On creation, just add them all.
-        updates = _build_labels_update(added=context.bug.whiteboard)
+        updates = _build_labels_update(
+            added=context.bug.whiteboard, labels_brackets=labels_brackets
+        )
 
     try:
         resp = jira.get_client().update_issue(

tests/unit/actions/test_steps.py

@@ -569,6 +569,29 @@ def test_sync_whiteboard_labels(context_create_example: ActionContext, mocked_ji
     )
     callable_object(context=context_create_example)
 
+    mocked_jira.update_issue.assert_called_once_with(
+        issue_key=context_create_example.jira.issue,
+        update={
+            "update": {
+                "labels": [
+                    {"add": "bugzilla"},
+                    {"add": "devtest"},
+                ]
+            }
+        },
+    )
+
+
+def test_sync_whiteboard_labels_with_brackets(
+    context_create_example: ActionContext, mocked_jira
+):
+    callable_object = default.init(
+        jira_project_key=context_create_example.jira.project,
+        steps={"new": ["sync_whiteboard_labels"]},
+        labels_brackets="both",
+    )
+    callable_object(context=context_create_example)
+
     mocked_jira.update_issue.assert_called_once_with(
         issue_key=context_create_example.jira.issue,
         update={
@@ -583,6 +606,19 @@ def test_sync_whiteboard_labels(context_create_example: ActionContext, mocked_ji
     )
 
 
+def test_sync_whiteboard_labels_misconfigured_brackets(
+    context_create_example: ActionContext,
+):
+    callable_object = default.init(
+        jira_project_key=context_create_example.jira.project,
+        steps={"new": ["sync_whiteboard_labels"]},
+        labels_brackets=42,
+    )
+    with pytest.raises(ValueError) as exc_info:
+        callable_object(context=context_create_example)
+    assert str(exc_info.value) == "Invalid value 42 for 'labels_brackets' parameter."
+
+
 def test_sync_whiteboard_labels_update(
     context_update_example: ActionContext, mocked_jira
 ):
@@ -607,8 +643,6 @@ def test_sync_whiteboard_labels_update(
                 "labels": [
                     {"add": "bugzilla"},
                     {"add": "remotesettings"},
-                    {"add": "[remotesettings]"},
-                    {"remove": "[server]"},
                     {"remove": "server"},
                 ]
             }