Fix #256: Add components parameter (#275)

* Add components parameter

* Add check about Jira components in heartbeat

Author: leplatrem

README.md

@@ -83,6 +83,9 @@ to the Bugzilla ticket on the Jira issue.
     - mapping [str, list[str]]
     - 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.
+- `components` (optional)
+   - list [str]
+   - If defined, the created issues will be assigned the specified components.
 - `sync_whiteboard_labels` (optional)
     - boolean
     - Whether to sync the Bugzilla status whiteboard labels to Jira. Defaults to `true`.

config/config.local.yaml

@@ -6,3 +6,5 @@
   enabled: true
   parameters:
     jira_project_key: DevTest
+    components:
+      - "Main"

jbi/actions/steps.py

@@ -31,6 +31,7 @@ def create_comment(context: ActionContext, **parameters):
 def create_issue(context: ActionContext, **parameters):
     """Create the Jira issue with the first comment as the description."""
     sync_whiteboard_labels: bool = parameters.get("sync_whiteboard_labels", True)
+    components: list[str] = parameters.get("components", [])
     bug = context.bug
 
     # In the payload of a bug creation, the `comment` field is `null`.
@@ -42,6 +43,7 @@ def create_issue(context: ActionContext, **parameters):
         context,
         description,
         sync_whiteboard_labels=sync_whiteboard_labels,
+        components=components,
     )
     issue_key = jira_create_response.get("key")
 

jbi/services/jira.py

@@ -67,6 +67,8 @@ def check_health(actions: Actions) -> ServiceHealth:
         "up": is_up,
         "all_projects_are_visible": is_up and _all_projects_visible(actions),
         "all_projects_have_permissions": _all_projects_permissions(actions),
+        "all_projects_components_exist": is_up
+        and _all_projects_components_exist(actions),
     }
     return health
 
@@ -144,6 +146,28 @@ def _validate_permissions(all_projects_perms):
     return not misconfigured
 
 
+def _all_projects_components_exist(actions: Actions):
+    components_by_project = {
+        action.parameters["jira_project_key"]: action.parameters["components"]
+        for action in actions
+        if "components" in action.parameters
+    }
+    success = True
+    for project, specified_components in components_by_project.items():
+        all_project_components = get_client().get_project_components(project)
+        all_components_names = set(comp["name"] for comp in all_project_components)
+        unknown = set(specified_components) - all_components_names
+        if unknown:
+            logger.error(
+                "Jira project %s does not have components %s",
+                project,
+                unknown,
+            )
+            success = False
+
+    return success
+
+
 class JiraCreateError(Exception):
     """Error raised on Jira issue creation."""
 
@@ -152,6 +176,7 @@ def create_jira_issue(
     context: ActionContext,
     description: str,
     sync_whiteboard_labels: bool,
+    components: list[str],
 ):
     """Create a Jira issue with the specified fields and return its key."""
     bug = context.bug
@@ -169,7 +194,19 @@ def create_jira_issue(
     if sync_whiteboard_labels:
         fields["labels"] = bug.get_jira_labels()
 
-    jira_response_create = get_client().create_issue(fields=fields)
+    client = get_client()
+
+    if components:
+        # Fetch all projects components, and match their id by name.
+        all_project_components = client.get_project_components(context.jira.project)
+        components_id = [
+            {"id": comp["id"]}
+            for comp in all_project_components
+            if comp["name"] in components
+        ]
+        fields["components"] = components_id
+
+    jira_response_create = client.create_issue(fields=fields)
 
     # Jira response can be of the form: List or Dictionary
     if isinstance(jira_response_create, list):

tests/conftest.py

@@ -53,10 +53,13 @@ def mocked_bugzilla(request):
 
 
 @pytest.fixture(autouse=True)
-def mocked_jira():
-    with mock.patch("jbi.services.jira.Jira") as mocked_jira:
-        yield mocked_jira()
-        jira.get_client.cache_clear()
+def mocked_jira(request):
+    if "no_mocked_jira" in request.keywords:
+        yield None
+    else:
+        with mock.patch("jbi.services.jira.Jira") as mocked_jira:
+            yield mocked_jira()
+            jira.get_client.cache_clear()
 
 
 @pytest.fixture

tests/unit/services/test_jira.py

@@ -1,5 +1,10 @@
+import json
 from unittest import mock
 
+import pytest
+import responses
+
+from jbi.environment import get_settings
 from jbi.services import jira
 
 
@@ -19,3 +24,43 @@ def test_timer_is_used_on_jira_create_issue():
         jira_client.create_issue({})
 
     mocked.timer.assert_called_with("jbi.jira.methods.create_issue.timer")
+
+
+@pytest.mark.no_mocked_jira
+def test_create_issue_with_components(mocked_responses, context_create_example):
+    url = f"{get_settings().jira_base_url}rest/api/2/project/{context_create_example.jira.project}/components"
+    mocked_responses.add(
+        responses.GET,
+        url,
+        json=[
+            {
+                "id": "10000",
+                "name": "Component 1",
+            },
+            {
+                "id": "42",
+                "name": "Remote Settings",
+            },
+        ],
+    )
+
+    url = f"{get_settings().jira_base_url}rest/api/2/issue"
+    mocked_responses.add(
+        responses.POST,
+        url,
+        json={
+            "id": "10000",
+            "key": "ED-24",
+        },
+    )
+
+    jira.create_jira_issue(
+        context_create_example,
+        "Description",
+        sync_whiteboard_labels=False,
+        components=["Remote Settings"],
+    )
+
+    posted_data = json.loads(mocked_responses.calls[-1].request.body)
+
+    assert posted_data["fields"]["components"] == [{"id": "42"}]

tests/unit/test_router.py

@@ -151,6 +151,7 @@ def test_read_heartbeat_all_services_fail(anon_client, mocked_jira, mocked_bugzi
             "up": False,
             "all_projects_are_visible": False,
             "all_projects_have_permissions": False,
+            "all_projects_components_exist": False,
         },
         "bugzilla": {
             "up": False,
@@ -171,6 +172,7 @@ def test_read_heartbeat_jira_services_fails(anon_client, mocked_jira, mocked_bug
             "up": False,
             "all_projects_are_visible": False,
             "all_projects_have_permissions": False,
+            "all_projects_components_exist": False,
         },
         "bugzilla": {
             "up": True,
@@ -194,6 +196,7 @@ def test_read_heartbeat_bugzilla_services_fails(
             "up": True,
             "all_projects_are_visible": True,
             "all_projects_have_permissions": False,
+            "all_projects_components_exist": False,
         },
         "bugzilla": {
             "up": False,
@@ -206,6 +209,7 @@ def test_read_heartbeat_success(anon_client, mocked_jira, mocked_bugzilla):
     mocked_bugzilla.logged_in = True
     mocked_jira.get_server_info.return_value = {}
     mocked_jira.projects.return_value = [{"key": "DevTest"}]
+    mocked_jira.get_project_components.return_value = [{"name": "Main"}]
     mocked_jira.get_permissions.return_value = {
         "permissions": {
             "ADD_COMMENTS": {"havePermission": True},
@@ -223,6 +227,7 @@ def test_read_heartbeat_success(anon_client, mocked_jira, mocked_bugzilla):
             "up": True,
             "all_projects_are_visible": True,
             "all_projects_have_permissions": True,
+            "all_projects_components_exist": True,
         },
         "bugzilla": {
             "up": True,
@@ -243,6 +248,7 @@ def test_jira_heartbeat_visible_projects(anon_client, mocked_jira, mocked_bugzil
             "up": True,
             "all_projects_are_visible": False,
             "all_projects_have_permissions": False,
+            "all_projects_components_exist": False,
         },
         "bugzilla": {
             "up": True,
@@ -254,6 +260,7 @@ def test_jira_heartbeat_missing_permissions(anon_client, mocked_jira, mocked_bug
     """/__heartbeat__ fails if configured projects don't match."""
     mocked_bugzilla.logged_in = True
     mocked_jira.get_server_info.return_value = {}
+    mocked_jira.get_project_components.return_value = [{"name": "Main"}]
     mocked_jira.get_project_permission_scheme.return_value = {
         "permissions": {
             "ADD_COMMENTS": {"havePermission": True},
@@ -271,18 +278,30 @@ def test_jira_heartbeat_missing_permissions(anon_client, mocked_jira, mocked_bug
             "up": True,
             "all_projects_are_visible": False,
             "all_projects_have_permissions": False,
+            "all_projects_components_exist": True,
         },
         "bugzilla": {
             "up": True,
         },
     }
 
 
+def test_jira_heartbeat_unknown_components(anon_client, mocked_jira, mocked_bugzilla):
+    mocked_bugzilla.logged_in = True
+    mocked_jira.get_server_info.return_value = {}
+
+    resp = anon_client.get("/__heartbeat__")
+
+    assert resp.status_code == 503
+    assert not resp.json()["jira"]["all_projects_components_exist"]
+
+
 def test_head_heartbeat(anon_client, mocked_jira, mocked_bugzilla):
     """/__heartbeat__ support head requests"""
     mocked_bugzilla.logged_in = True
     mocked_jira.get_server_info.return_value = {}
     mocked_jira.projects.return_value = [{"key": "DevTest"}]
+    mocked_jira.get_project_components.return_value = [{"name": "Main"}]
     mocked_jira.get_permissions.return_value = {
         "permissions": {
             "ADD_COMMENTS": {"havePermission": True},