feat: introduce related_issues to merge requests

xakepnz · web-flow · commit ea589f2ca536 · 2024-09-23T22:07:35.000+12:00
diff --git a/docs/gl_objects/merge_requests.rst b/docs/gl_objects/merge_requests.rst
@@ -144,6 +144,10 @@ List the changes of a MR::
 
     changes = mr.changes()
 
+List issues related to this merge request::
+
+    related_issues = mr.related_issues()
+
 List issues that will close on merge::
 
     mr.closes_issues()
diff --git a/gitlab/v4/objects/merge_requests.py b/gitlab/v4/objects/merge_requests.py
@@ -197,6 +197,35 @@ def cancel_merge_when_pipeline_succeeds(self, **kwargs: Any) -> Dict[str, str]:
             assert isinstance(server_data, dict)
         return server_data
 
+    @cli.register_custom_action(cls_names="ProjectMergeRequest")
+    @exc.on_http_error(exc.GitlabListError)
+    def related_issues(self, **kwargs: Any) -> RESTObjectList:
+        """List issues related to this merge request."
+
+        Args:
+            all: If True, return all the items, without pagination
+            per_page: Number of items to retrieve per request
+            page: ID of the page to return (starts with page 1)
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabListError: If the list could not be retrieved
+
+        Returns:
+            List of issues
+        """
+
+        path = f"{self.manager.path}/{self.encoded_id}/related_issues"
+        data_list = self.manager.gitlab.http_list(path, iterator=True, **kwargs)
+
+        if TYPE_CHECKING:
+            assert isinstance(data_list, gitlab.GitlabList)
+
+        manager = ProjectIssueManager(self.manager.gitlab, parent=self.manager._parent)
+
+        return RESTObjectList(manager, ProjectIssue, data_list)
+
     @cli.register_custom_action(cls_names="ProjectMergeRequest")
     @exc.on_http_error(exc.GitlabListError)
     def closes_issues(self, **kwargs: Any) -> RESTObjectList:
diff --git a/tests/unit/objects/test_merge_requests.py b/tests/unit/objects/test_merge_requests.py
@@ -40,6 +40,9 @@
             "web_url": "http://gitlab.example.com//kenyatta_oconnell",
         }
     ],
+    "related_issues": [
+        1, 2
+    ]
 }
 
 reviewers_content = [
@@ -93,6 +96,11 @@ def resp_get_merge_request_reviewers():
         yield rsps
 
 
+def test_list_related_issues(project, resp_list_merge_requests):
+    mrs = project.mergerequests.list()
+    assert isinstance(mrs[0], ProjectMergeRequest)
+    assert mrs[0].related_issues == mr_content["related_issues"]
+
 def test_list_project_merge_requests(project, resp_list_merge_requests):
     mrs = project.mergerequests.list()
     assert isinstance(mrs[0], ProjectMergeRequest)
