Merge pull request #803 from python-gitlab/feat/related_mr

max-wittig · web-flow · commit ad1c0dda37f5 · 2019-07-01T18:41:58.000+02:00
feat: add support for issue.related_merge_requests
diff --git a/docs/gl_objects/issues.rst b/docs/gl_objects/issues.rst
@@ -180,6 +180,10 @@ Get the list of merge requests that will close an issue when merged::
 
     mrs = issue.closed_by()
 
+Get the merge requests related to an issue::
+
+    mrs = issue.related_merge_requests()
+
 Get the list of participants::
 
     users = issue.participants()
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
@@ -2186,6 +2186,24 @@ def move(self, to_project_id, **kwargs):
         server_data = self.manager.gitlab.http_post(path, post_data=data, **kwargs)
         self._update_attrs(server_data)
 
+    @cli.register_custom_action("ProjectIssue")
+    @exc.on_http_error(exc.GitlabGetError)
+    def related_merge_requests(self, **kwargs):
+        """List merge requests related to the issue.
+
+        Args:
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabGetErrot: If the merge requests could not be retrieved
+
+        Returns:
+            list: The list of merge requests.
+        """
+        path = "%s/%s/related_merge_requests" % (self.manager.path, self.get_id())
+        return self.manager.gitlab.http_get(path, **kwargs)
+
     @cli.register_custom_action("ProjectIssue")
     @exc.on_http_error(exc.GitlabGetError)
     def closed_by(self, **kwargs):
diff --git a/tools/python_test_v4.py b/tools/python_test_v4.py
@@ -566,6 +566,8 @@
 
 assert issue1.user_agent_detail()["user_agent"]
 assert issue1.participants()
+assert type(issue1.closed_by()) == list
+assert type(issue1.related_merge_requests()) == list
 
 # issues labels and events
 label2 = admin_project.labels.create({"name": "label2", "color": "#aabbcc"})
