Skip to content

fix(projects): support approval_rules endpoint for projects #919

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 2 commits into from
Oct 27, 2019
Merged

fix(projects): support approval_rules endpoint for projects #919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2cef2bb
fix(projects): support `approval_rules` endpoint for projects
srikanthchelluri Oct 23, 2019
94bac44
test(projects): support `approval_rules` endpoint for projects
srikanthchelluri Oct 27, 2019
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
15 changes: 15 additions & 0 deletions docs/gl_objects/mr_approvals.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ References

+ :class:`gitlab.v4.objects.ProjectApproval`
+ :class:`gitlab.v4.objects.ProjectApprovalManager`
+ :class:`gitlab.v4.objects.ProjectApprovalRule`
+ :class:`gitlab.v4.objects.ProjectApprovalRuleManager`
+ :attr:`gitlab.v4.objects.Project.approvals`
+ :class:`gitlab.v4.objects.ProjectMergeRequestApproval`
+ :class:`gitlab.v4.objects.ProjectMergeRequestApprovalManager`
Expand All @@ -22,6 +24,19 @@ References
Examples
--------

List project-level MR approval rules::

p_mras = project.approvalrules.list()

Change project-level MR approval rule::

p_approvalrule.user_ids = [234]
p_approvalrule.save()

Delete project-level MR approval rule::

p_approvalrule.delete()

Get project-level or MR-level MR approvals settings::

p_mras = project.approvals.get()
Expand Down
14 changes: 14 additions & 0 deletions gitlab/v4/objects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3777,6 +3777,19 @@ def set_approvers(self, approver_ids=None, approver_group_ids=None, **kwargs):
self.gitlab.http_put(path, post_data=data, **kwargs)


class ProjectApprovalRule(SaveMixin, ObjectDeleteMixin, RESTObject):
_id_attr = "id"


class ProjectApprovalRuleManager(
ListMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager
):
_path = "/projects/%(project_id)s/approval_rules"
_obj_cls = ProjectApprovalRule
_from_parent_attrs = {"project_id": "id"}
_create_attrs = (("name", "approvals_required"), ("user_ids", "group_ids"))


class ProjectDeployment(RESTObject, SaveMixin):
pass

Expand Down Expand Up @@ -3888,6 +3901,7 @@ class Project(SaveMixin, ObjectDeleteMixin, RESTObject):
_managers = (
("accessrequests", "ProjectAccessRequestManager"),
("approvals", "ProjectApprovalManager"),
("approvalrules", "ProjectApprovalRuleManager"),
("badges", "ProjectBadgeManager"),
("boards", "ProjectBoardManager"),
("branches", "ProjectBranchManager"),
Expand Down
16 changes: 16 additions & 0 deletions tools/ee-test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,22 @@ def end_log():
mr.approvals.set_approvers([1], [])
approval = mr.approvals.get()
assert approval.approvers[0]["user"]["id"] == 1

ars = project1.approvalrules.list(all=True)
assert len(ars) == 0
project.approvalrules.create(
{"name": "approval-rule", "approvals_required": 1, "group_ids": [group1.id]}
)
ars = project1.approvalrules.list(all=True)
assert len(ars) == 1
ars[0].approvals_required == 2
ars[0].save()
ars = project1.approvalrules.list(all=True)
assert len(ars) == 1
assert ars[0].approvals_required == 2
ars[0].delete()
ars = project1.approvalrules.list(all=True)
assert len(ars) == 0
end_log()

start_log("geo nodes")
Expand Down