8000 fix(members): use new *All objects for *AllManager managers · python-gitlab/python-gitlab@755e0a3 · GitHub
[go: up one dir, main page]
Skip to content

Commit 755e0a3

Browse files
JohnVillalovosJohnVillalovos
committed
fix(members): use new *All objects for *AllManager managers
Change it so that: GroupMemberAllManager uses GroupMemberAll object ProjectMemberAllManager uses ProjectMemberAll object Create GroupMemberAll and ProjectMemberAll objects that do not support any Mixin type methods. Previously we were using GroupMember and ProjectMember which support the `save()` and `delete()` methods but those methods will not work with objects retrieved using the `/members/all/` API calls. `list()` API calls: [1] GET /groups/:id/members/all GET /projects/:id/members/all `get()` API calls: [2] GET /groups/:id/members/all/:user_id GET /projects/:id/members/all/:user_id Closes: #1825 Closes: #848 [1] https://docs.gitlab.com/ee/api/members.html#list-all-members-of-a-group-or-project-including-inherited-and-invited-members [2] https://docs.gitlab.com/ee/api/members.html#get-a-member-of-a-group-or-project-including-inherited-and-invited-members
1 parent 4a000b6 commit 755e0a3

File tree

2 files changed

+44
-6
lines changed

2 files changed

+44
-6
lines changed

‎gitlab/v4/objects/members.py

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,11 @@
1717
"GroupBillableMemberMembership",
1818
"GroupBillableMemberMembershipManager",
1919
"GroupMember",
20+
"GroupMemberAll",
2021
"GroupMemberManager",
2122
"GroupMemberAllManager",
2223
"ProjectMember",
24+
"ProjectMemberAll",
2325
"ProjectMemberManager",
2426
"ProjectMemberAllManager",
2527
]
@@ -70,15 +72,19 @@ class GroupBillableMemberMembershipManager(ListMixin, RESTManager):
7072
_from_parent_attrs = {"group_id": "group_id", "user_id": "id"}
7173

7274

75+
class GroupMemberAll(RESTObject):
76+
_short_print_attr = "username"
77+
78+
7379
class GroupMemberAllManager(RetrieveMixin, RESTManager):
7480
_path = "/groups/{group_id}/members/all"
75-
_obj_cls = GroupMember
81+
_obj_cls = GroupMemberAll
7682
_from_parent_attrs = {"group_id": "id"}
7783

7884
def get(
7985
self, id: Union[str, int], lazy: bool = False, **kwargs: Any
80-
) -> GroupMember:
81-
return cast(GroupMember, super().get(id=id, lazy=lazy, **kwargs))
86+
) -> GroupMemberAll:
87+
return cast(GroupMemberAll, super().get(id=id, lazy=lazy, **kwargs))
8288

8389

8490
class ProjectMember(SaveMixin, ObjectDeleteMixin, RESTObject):
@@ -103,12 +109,16 @@ def get(
103109
return cast(ProjectMember, super().get(id=id, lazy=lazy, **kwargs))
104110

105111

112+
class ProjectMemberAll(RESTObject):
113+
_short_print_attr = "username"
114+
115+
106116
class ProjectMemberAllManager(RetrieveMixin, RESTManager):
107117
_path = "/projects/{project_id}/members/all"
108-
_obj_cls = ProjectMember
118+
_obj_cls = ProjectMemberAll
109119
_from_parent_attrs = {"project_id": "id"}
110120

111121
def get(
112122
self, id: Union[str, int], lazy: bool = False, **kwargs: Any
113-
) -> ProjectMember:
114-
return cast(ProjectMember, super().get(id=id, lazy=lazy, **kwargs))
123+
) -> ProjectMemberAll:
124+
return cast(ProjectMemberAll, super().get(id=id, lazy=lazy, **kwargs))

‎tests/functional/cli/test_cli_v4.py

Lines changed: 28 additions & 0 deletions
< 4C4C /tr>
Original file line numberDiff line numberDiff line change
@@ -701,6 +701,31 @@ def test_delete_group_deploy_token(gitlab_cli, group_deploy_token):
701701
# TODO assert not in list
702702

703703

704+
def test_project_member_all(gitlab_cli, project):
705+
cmd = [
706+
"project-member-all",
707+
"list",
708+
"--project-id",
709+
project.id,
710+
]
711+
ret = gitlab_cli(cmd)
712+
713+
assert ret.success
714+
715+
716+
def test_group_member_all(gitlab_cli, group):
717+
cmd = [
718+
"group-member-all",
719+
"list",
720+
"--group-id",
721+
group.id,
722+
]
723+
ret = gitlab_cli(cmd)
724+
725+
assert ret.success
726+
727+
728+
# Deleting the project and group. Add your tests above here.
704729
def test_delete_project(gitlab_cli, project):
705730
cmd = ["project", "delete", "--id", project.id]
706731
ret = gitlab_cli(cmd)
@@ -713,3 +738,6 @@ def test_delete_group(gitlab_cli, group):
713738
ret = gitlab_cli(cmd)
714739

715740
assert ret.success
741+
742+
743+
# Don't add tests below here as the group and project have been deleted

0 commit comments

Comments
 (0)
0