Skip to content

feat: Add reset_approvals api #2279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 26, 2022
Merged

feat: Add reset_approvals api #2279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/gl_objects/merge_requests.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 4 additions & 0 deletions gitlab/exceptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,10 @@ class GitlabMRRebaseError(GitlabOperationError):
pass


class GitlabMRResetApprovalError(GitlabOperationError):
pass


class GitlabMRClosedError(GitlabOperationError):
pass

Expand Down
18 changes: 18 additions & 0 deletions gitlab/v4/objects/merge_requests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,24 @@ def rebase(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
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.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]:
Expand Down
9 changes: 9 additions & 0 deletions tests/functional/api/test_merge_requests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down