summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLucas Zampieri <lzampier@redhat.com>2022-09-22 16:09:47 -0300
committerNejc Habjan <hab.nejc@gmail.com>2022-09-26 21:19:14 +0200
commit88693ff2d6f4eecf3c79d017df52738886e2d636 (patch)
treee1c65e4c58ab52df5dac135b673f6a19d64cc3bc
parent1714d0a980afdb648d203751dedf95ee95ac326e (diff)
downloadgitlab-88693ff2d6f4eecf3c79d017df52738886e2d636.tar.gz
feat: Add reset_approvals api
Added the newly added reset_approvals merge request api. Signed-off-by: Lucas Zampieri <lzampier@redhat.com>
-rw-r--r--docs/gl_objects/merge_requests.rst4
-rw-r--r--gitlab/exceptions.py4
-rw-r--r--gitlab/v4/objects/merge_requests.py18
-rw-r--r--tests/functional/api/test_merge_requests.py9
4 files changed, 35 insertions, 0 deletions
diff --git a/docs/gl_objects/merge_requests.rst b/docs/gl_objects/merge_requests.rst
index 473160a..18ad319 100644
--- a/docs/gl_objects/merge_requests.rst
+++ b/docs/gl_objects/merge_requests.rst
@@ -189,6 +189,10 @@ Attempt to rebase an MR::
mr.rebase()
+Clear all approvals of a merge request (possible with project or group access tokens only)::
+
+ mr.reset_approvals()
+
Get status of a rebase for an MR::
mr = project.mergerequests.get(mr_id, include_rebase_in_progress=True)
diff --git a/gitlab/exceptions.py b/gitlab/exceptions.py
index 633de5b..613e9a0 100644
--- a/gitlab/exceptions.py
+++ b/gitlab/exceptions.py
@@ -205,6 +205,10 @@ class GitlabMRRebaseError(GitlabOperationError):
pass
+class GitlabMRResetApprovalError(GitlabOperationError):
+ pass
+
+
class GitlabMRClosedError(GitlabOperationError):
pass
diff --git a/gitlab/v4/objects/merge_requests.py b/gitlab/v4/objects/merge_requests.py
index 6a47b7b..2e1ab09 100644
--- a/gitlab/v4/objects/merge_requests.py
+++ b/gitlab/v4/objects/merge_requests.py
@@ -328,6 +328,24 @@ class ProjectMergeRequest(
return self.manager.gitlab.http_put(path, post_data=data, **kwargs)
@cli.register_custom_action("ProjectMergeRequest")
+ @exc.on_http_error(exc.GitlabMRResetApprovalError)
+ def reset_approvals(
+ self, **kwargs: Any
+ ) -> Union[Dict[str, Any], requests.Response]:
+ """Clear all approvals of the merge request.
+
+ Args:
+ **kwargs: Extra options to send to the server (e.g. sudo)
+
+ Raises:
+ GitlabAuthenticationError: If authentication is not correct
+ GitlabMRResetApprovalError: If reset approval failed
+ """
+ path = f"{self.manager.path}/{self.encoded_id}/reset_approvals"
+ data: Dict[str, Any] = {}
+ return self.manager.gitlab.http_put(path, post_data=data, **kwargs)
+
+ @cli.register_custom_action("ProjectMergeRequest")
@exc.on_http_error(exc.GitlabGetError)
def merge_ref(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
"""Attempt to merge changes between source and target branches into
diff --git a/tests/functional/api/test_merge_requests.py b/tests/functional/api/test_merge_requests.py
index e64f923..73dae0e 100644
--- a/tests/functional/api/test_merge_requests.py
+++ b/tests/functional/api/test_merge_requests.py
@@ -117,6 +117,15 @@ def test_merge_request_rebase(project):
assert mr.rebase()
+def test_merge_request_reset_approvals(gitlab_url, project):
+ bot = project.access_tokens.create({"name": "bot", "scopes": ["api"]})
+ bot_gitlab = gitlab.Gitlab(gitlab_url, private_token=bot.token)
+ bot_project = bot_gitlab.projects.get(project.id, lazy=True)
+
+ mr = bot_project.mergerequests.list()[0]
+ assert mr.reset_approvals()
+
+
@pytest.mark.skip(reason="flaky test")
def test_merge_request_merge(project):
mr = project.mergerequests.list()[0]