Fix #569: documentation whiteboard tags matching (#579)

* Fix #569: documentation whiteboard tags matching

* Update jbi/models.py

Co-authored-by: grahamalama <[email protected]>

---------

Co-authored-by: grahamalama <[email protected]>

Author: leplatrem

README.md

@@ -12,6 +12,9 @@ System to sync Bugzilla bugs to Jira issues.
 - The events are transformed into Jira issues
 - The system sets the `see_also` field of the Bugzilla bug with the URL to the Jira issue
 
+> **Note:** whiteboard tags are string between brackets, and can have prefixes/suffixes using
+> dashes (eg. ``[project]``, ``[project-fx-h2]``, ``[backlog-project]``).
+
 ## Diagram Overview
 
 ``` mermaid

jbi/actions/steps.py

@@ -291,7 +291,7 @@ def _build_labels_update(labels_brackets, added, removed=None):
 
 def sync_whiteboard_labels(context: ActionContext, **parameters):
     """
-    Set whiteboard tags as labels on the Jira issue
+    Set whiteboard tags as labels on the Jira issue.
     """
     labels_brackets = parameters.get("labels_brackets", "no")
     if labels_brackets not in ("yes", "no", "both"):

jbi/models.py

@@ -264,7 +264,12 @@ def extract_from_see_also(self):
         return None
 
     def lookup_action(self, actions: Actions) -> Action:
-        """Find first matching action from bug's whiteboard list"""
+        """
+        Find first matching action from bug's whiteboard field.
+
+        Tags are strings between brackets and can have prefixes/suffixes
+        using dashes (eg. ``[project]``, ``[project-moco]``, ``[backlog-project]``).
+        """
         if self.whiteboard:
             for tag, action in actions.by_tag.items():
                 # [tag-word], [word-tag], [tag-], [tag], but not [wordtag]

tests/unit/test_bugzilla.py

@@ -53,9 +53,14 @@ def test_lookup_action_found(whiteboard, actions_example):
 @pytest.mark.parametrize(
     "whiteboard",
     [
-        "example DevTest",
+        "DevTest",
+        "foo DevTest",
+        "DevTest bar",
+        "foo DevTest bar",
         "[fooDevTest]",
+        "[foo DevTest]",
         "[DevTestbar]",
+        "[DevTest bar]",
         "[fooDevTestbar]",
         "[fooDevTest-bar]",
         "[foo-DevTestbar]",