feat(groups): add support for shared projects API

nejch · JohnVillalovos · commit 66461ba519a8 · 2022-07-26T22:41:59.000-07:00
diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst
@@ -31,11 +31,15 @@ List a group's projects::
 
     projects = group.projects.list()
 
+List a group's shared projects::
+
+    projects = group.shared_projects.list()
+
 .. note::
 
-   ``GroupProject`` objects returned by this API call are very limited, and do
-   not provide all the features of ``Project`` objects. If you need to
-   manipulate projects, create a new ``Project`` object::
+   ``GroupProject`` and ``SharedProject`` objects returned by these two API calls
+   are very limited, and do not provide all the features of ``Project`` objects.
+   If you need to manipulate projects, create a new ``Project`` object::
 
        first_group_project = group.projects.list()[0]
        manageable_project = gl.projects.get(first_group_project.id, lazy=True)
diff --git a/gitlab/v4/objects/groups.py b/gitlab/v4/objects/groups.py
@@ -34,7 +34,7 @@
 from .milestones import GroupMilestoneManager  # noqa: F401
 from .notification_settings import GroupNotificationSettingsManager  # noqa: F401
 from .packages import GroupPackageManager  # noqa: F401
-from .projects import GroupProjectManager  # noqa: F401
+from .projects import GroupProjectManager, SharedProjectManager  # noqa: F401
 from .push_rules import GroupPushRulesManager
 from .runners import GroupRunnerManager  # noqa: F401
 from .statistics import GroupIssuesStatisticsManager  # noqa: F401
@@ -79,6 +79,7 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject):
     notificationsettings: GroupNotificationSettingsManager
     packages: GroupPackageManager
     projects: GroupProjectManager
+    shared_projects: SharedProjectManager
     pushrules: GroupPushRulesManager
     registry_repositories: GroupRegistryRepositoryManager
     runners: GroupRunnerManager
diff --git a/gitlab/v4/objects/projects.py b/gitlab/v4/objects/projects.py
@@ -103,6 +103,8 @@
     "ProjectRemoteMirrorManager",
     "ProjectStorage",
     "ProjectStorageManager",
+    "SharedProject",
+    "SharedProjectManager",
 ]
 
 
@@ -1081,3 +1083,26 @@ class ProjectStorageManager(GetWithoutIdMixin, RESTManager):
 
     def get(self, **kwargs: Any) -> ProjectStorage:
         return cast(ProjectStorage, super().get(**kwargs))
+
+
+class SharedProject(RESTObject):
+    pass
+
+
+class SharedProjectManager(ListMixin, RESTManager):
+    _path = "/groups/{group_id}/projects/shared"
+    _obj_cls = SharedProject
+    _from_parent_attrs = {"group_id": "id"}
+    _list_filters = (
+        "archived",
+        "visibility",
+        "order_by",
+        "sort",
+        "search",
+        "simple",
+        "starred",
+        "with_issues_enabled",
+        "with_merge_requests_enabled",
+        "min_access_level",
+        "with_custom_attributes",
+    )
diff --git a/tests/unit/objects/test_groups.py b/tests/unit/objects/test_groups.py
@@ -9,8 +9,21 @@
 
 import gitlab
 from gitlab.v4.objects import GroupDescendantGroup, GroupSubgroup
+from gitlab.v4.objects.projects import GroupProject, SharedProject
 
 content = {"name": "name", "id": 1, "path": "path"}
+projects_content = [
+    {
+        "id": 9,
+        "description": "foo",
+        "default_branch": "master",
+        "name": "Html5 Boilerplate",
+        "name_with_namespace": "Experimental / Html5 Boilerplate",
+        "path": "html5-boilerplate",
+        "path_with_namespace": "h5bp/html5-boilerplate",
+        "namespace": {"id": 5, "name": "Experimental", "path": "h5bp", "kind": "group"},
+    }
+]
 subgroup_descgroup_content = [
     {
         "id": 2,
@@ -80,6 +93,19 @@ def resp_groups():
         yield rsps
 
 
+@pytest.fixture
+def resp_list_group_projects():
+    with responses.RequestsMock() as rsps:
+        rsps.add(
+            method=responses.GET,
+            url=re.compile(r"http://localhost/api/v4/groups/1/projects(/shared)?"),
+            json=projects_content,
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
 @pytest.fixture
 def resp_list_subgroups_descendant_groups():
     with responses.RequestsMock() as rsps:
@@ -211,6 +237,18 @@ def test_create_group_export(group, resp_export):
     assert export.message == "202 Accepted"
 
 
+def test_list_group_projects(group, resp_list_group_projects):
+    projects = group.projects.list()
+    assert isinstance(projects[0], GroupProject)
+    assert projects[0].path == projects_content[0]["path"]
+
+
+def test_list_group_shared_projects(group, resp_list_group_projects):
+    projects = group.shared_projects.list()
+    assert isinstance(projects[0], SharedProject)
+    assert projects[0].path == projects_content[0]["path"]
+
+
 def test_list_group_subgroups(group, resp_list_subgroups_descendant_groups):
     subgroups = group.subgroups.list()
     assert isinstance(subgroups[0], GroupSubgroup)
