Fix #604: Add product prefix to components for maybe_update_components (#607)

* Fix #604: Add product prefix to components for `maybe_update_components`

* Use config object as suggested by @grahamalama

Author: leplatrem

config/config.local.yaml

@@ -6,4 +6,5 @@
   parameters:
     jira_project_key: DevTest
     jira_components:
-      - "Main"
+      set_custom_components:
+        - "Main"

config/config.nonprod.yaml

@@ -169,7 +169,8 @@
   parameters:
     jira_project_key: JB
     jira_components:
-      - "Data Platform Infrastructure"
+      set_custom_components:
+        - "Data Platform Infrastructure"
     steps:
       new:
         - create_issue
@@ -210,7 +211,8 @@
   parameters:
     jira_project_key: JB
     jira_components:
-      - "Data Quality"
+      set_custom_components:
+        - "Data Quality"
     steps:
       new:
         - create_issue

config/config.prod.yaml

@@ -234,7 +234,8 @@
   parameters:
     jira_project_key: SE
     jira_components:
-      - "remote-settings"
+      set_custom_components:
+        - "remote-settings"
     steps:
       new:
         - create_issue
@@ -306,7 +307,8 @@
   parameters:
     jira_project_key: DENG
     jira_components:
-      - "Data Platform Infrastructure"
+      set_custom_components:
+        - "Data Platform Infrastructure"
     steps:
       new:
         - create_issue
@@ -347,7 +349,8 @@
   parameters:
     jira_project_key: DENG
     jira_components:
-      - "Data Quality"
+      set_custom_components:
+        - "Data Quality"
     steps:
       new:
         - create_issue

docs/actions.md

@@ -49,8 +49,20 @@ Parameters are used by `step` functions to control what Bugzilla data is synced
     - If defined, the specified steps are executed. The group of steps listed under `new` are executed when a Bugzilla event occurs on a ticket that is unknown to Jira. The steps under `existing`, when the Bugzilla ticket is already linked to a Jira issue. The steps under `comment` when a comment is posted on a linked Bugzilla ticket.
     If one of these groups is not specified, the default steps will be used.
 - `jira_components` (optional)
-   - list [str]
-   - If defined, the created issues will be assigned the specified components.
+   - object
+   - Controls how Jira components are set on issues in the `maybe_update_components` step.
+     - `use_bug_component` (optional)
+        - bool
+        - Set bug's component as issue component, eg. ``General`` (default `true`)
+     - `use_bug_product` (optional)
+        - bool
+        - Set bug's product as issue component, eg. ``Core`` (default `false`)
+     - `use_bug_component_with_product_prefix` (optional)
+       - bool
+       - Set bug's full component as issue component, eg. ``Core::General`` (default `false`)
+     - `set_custom_components` (optional)
+        - list[str]
+        - If defined, the issues will be assigned the specified components (default `[]`)
 - `labels_brackets` (optional)
     - enum ["yes", "no", "both"]
     - Controls whether issue labels should have brackets or not in the `sync_whiteboard_labels` step (default: "no")

jbi/models.py

@@ -42,12 +42,21 @@ class ActionSteps(BaseModel):
     ]
 
 
+class JiraComponents(BaseModel):
+    """Controls how Jira components are set on issues in the `maybe_update_components` step."""
+
+    use_bug_component: bool = True
+    use_bug_product: bool = False
+    use_bug_component_with_product_prefix: bool = False
+    set_custom_components: list[str] = []
+
+
 class ActionParams(BaseModel):
     """Params passed to Action step functions"""
 
     jira_project_key: str
     steps: ActionSteps = ActionSteps()
-    jira_components: list[str] = []
+    jira_components: JiraComponents = JiraComponents()
     labels_brackets: str = Field("no", enum=["yes", "no", "both"])
     status_map: dict[str, str] = {}
     resolution_map: dict[str, str] = {}
@@ -191,6 +200,14 @@ class BugzillaBug(BaseModel):
     assigned_to: Optional[str]
     comment: Optional[BugzillaWebhookComment]
 
+    @property
+    def product_component(self) -> str:
+        """Return the component prefixed with the product
+        as show in the Bugzilla UI (eg. ``Core::General``).
+        """
+        result = self.product + "::" if self.product else ""
+        return result + self.component if self.component else result
+
     def is_assigned(self) -> bool:
         """Return `true` if the bug is assigned to a user."""
         return self.assigned_to != "[email protected]"

jbi/services/jira.py

@@ -197,7 +197,7 @@ def _validate_permissions(all_projects_perms):
 
 def _all_projects_components_exist(actions: Actions):
     components_by_project = {
-        action.parameters.jira_project_key: action.parameters.jira_components
+        action.parameters.jira_project_key: action.parameters.jira_components.set_custom_components
         for action in actions
     }
     success = True

jbi/steps.py

@@ -231,9 +231,16 @@ def maybe_update_components(context: ActionContext, parameters: ActionParams):
     """
     Update the Jira issue components
     """
-    candidate_components = set(parameters.jira_components)
-    if context.bug.component:
+    candidate_components = set(parameters.jira_components.set_custom_components)
+    if context.bug.component and parameters.jira_components.use_bug_component:
         candidate_components.add(context.bug.component)
+    if context.bug.product and parameters.jira_components.use_bug_product:
+        candidate_components.add(context.bug.product)
+    if (
+        context.bug.product_component
+        and parameters.jira_components.use_bug_component_with_product_prefix
+    ):
+        candidate_components.add(context.bug.product_component)
     client = jira.get_client()
 
     # Fetch all projects components, and match their id by name.
@@ -247,8 +254,8 @@ def maybe_update_components(context: ActionContext, parameters: ActionParams):
     # Warn if some specified components are unknown
     if candidate_components:
         logger.warning(
-            "Could not find components %s in project",
-            candidate_components,
+            "Could not find components %r in project",
+            ", ".join(sorted(candidate_components)),
             extra=context.dict(),
         )
 

tests/unit/services/test_jira.py

@@ -7,7 +7,7 @@
 from requests.exceptions import ConnectionError
 
 from jbi.environment import get_settings
-from jbi.models import Actions
+from jbi.models import Actions, JiraComponents
 from jbi.services import jira
 
 pytestmark = pytest.mark.no_mocked_jira
@@ -126,7 +126,10 @@ def test_all_projects_components_exist(
         json=project_components,
     )
     action = action_factory(
-        parameters={"jira_project_key": "ABC", "jira_components": jira_components}
+        parameters={
+            "jira_project_key": "ABC",
+            "jira_components": JiraComponents(set_custom_components=jira_components),
+        }
     )
     actions = Actions(__root__=[action])
     result = jira._all_projects_components_exist(actions)

tests/unit/test_models.py

@@ -70,6 +70,20 @@ def test_extract_see_also(see_also, expected):
     assert bug.extract_from_see_also() == expected
 
 
+@pytest.mark.parametrize(
+    "product,component,expected",
+    [
+        (None, None, ""),
+        (None, "General", "General"),
+        ("Product", None, "Product::"),
+        ("Product", "General", "Product::General"),
+    ],
+)
+def test_product_component(product, component, expected):
+    bug = bug_factory(product=product, component=component)
+    assert bug.product_component == expected
+
+
 @pytest.mark.parametrize(
     "whiteboard",
     [

tests/unit/test_steps.py

@@ -7,7 +7,7 @@
 from jbi import steps
 from jbi.environment import get_settings
 from jbi.errors import IncompleteStepError
-from jbi.models import ActionContext
+from jbi.models import ActionContext, JiraComponents
 from jbi.runner import Executor
 from jbi.services.jira import JiraCreateError
 from tests.conftest import action_params_factory
@@ -602,45 +602,129 @@ def test_change_to_unknown_resolution_with_resolution_map(
 @pytest.mark.parametrize(
     "project_components,bug_component,config_components,expected_jira_components,expected_logs",
     [
+        # Default, only from bug.
         (
+            # Jira project components
             [
                 {
                     "id": "10000",
                     "name": "Component 1",
                 },
                 {
                     "id": "42",
-                    "name": "Remote Settings",
+                    "name": "Toolbar",
                 },
             ],
+            # Bug component
             "Toolbar",
-            ["Remote Settings"],
+            # Config
+            JiraComponents(),
+            # Expected issue components
             [{"id": "42"}],
-            ["Could not find components {'Toolbar'} in project"],
+            # Expected logs
+            [],
         ),
-        # Without components in config
+        # Only from config.
         (
+            # Jira project components
             [
                 {
-                    "id": "37",
-                    "name": "Toolbar",
+                    "id": "10000",
+                    "name": "Component 1",
+                },
+                {
+                    "id": "42",
+                    "name": "Remote Settings",
                 },
             ],
+            # Bug component
             "Toolbar",
+            # Config
+            JiraComponents(
+                use_bug_component=False, set_custom_components=["Remote Settings"]
+            ),
+            # Expected issue components
+            [{"id": "42"}],
+            # Expected logs
             [],
-            [{"id": "37"}],
+        ),
+        # Using bug product.
+        (
+            # Jira project components
+            [
+                {
+                    "id": "10000",
+                    "name": "JBI",
+                },
+                {
+                    "id": "20000",
+                    "name": "Framework",
+                },
+            ],
+            # Bug component
+            "Framework",
+            JiraComponents(use_bug_product=True),
+            # Expected issue components
+            [{"id": "10000"}, {"id": "20000"}],
+            # Expected logs
             [],
         ),
+        # Using bug prefixed component.
+        (
+            # Jira project components
+            [
+                {
+                    "id": "10000",
+                    "name": "JBI::",
+                },
+                {
+                    "id": "20000",
+                    "name": "General",
+                },
+            ],
+            # Bug component
+            None,
+            # Config
+            JiraComponents(use_bug_component_with_product_prefix=True),
+            # Expected issue components
+            [{"id": "10000"}],
+            # Expected logs
+            [],
+        ),
+        # Using bug prefixed component.
+        (
+            # Jira project components
+            [
+                {
+                    "id": "10000",
+                    "name": "JBI::General",
+                },
+            ],
+            # Bug component
+            "General",
+            # Config
+            JiraComponents(use_bug_component_with_product_prefix=True),
+            # Expected issue components
+            [{"id": "10000"}],
+            # Expected logs
+            ["Could not find components 'General' in project"],
+        ),
         # Without components in project
         (
+            # Jira project component
             [],
+            # Bug component
             "Toolbar",
+            # Config
+            JiraComponents(),
+            # Expected issue components
             [],
-            [],
-            ["Could not find components {'Toolbar'} in project"],
+            # Expected logs
+            ["Could not find components 'Toolbar' in project"],
         ),
         # With more than one in config
         (
+            # Jira project component
             [
                 {
                     "id": "10000",
@@ -651,9 +735,13 @@ def test_change_to_unknown_resolution_with_resolution_map(
                     "name": "Remote Settings",
                 },
             ],
+            # Bug component
             None,
-            ["Search", "Remote Settings"],
+            # Config
+            JiraComponents(set_custom_components=["Search", "Remote Settings"]),
+            # Expected issue components
             [{"id": "10000"}, {"id": "42"}],
+            # Expected logs
             [],
         ),
     ],
@@ -711,7 +799,8 @@ def test_maybe_update_components_failing(
     action_params_factory,
 ):
     mocked_jira.get_project_components.return_value = [
-        {"id": 1, "name": context_update_example.bug.component}
+        {"id": 1, "name": context_update_example.bug.component},
+        {"id": 2, "name": context_update_example.bug.product_component},
     ]
     mocked_jira.update_issue_field.side_effect = requests.exceptions.HTTPError(
         "Field 'components' cannot be set", response=mock.MagicMock(status_code=400)