feat(objects): support get project storage endpoint

nejch · JohnVillalovos · commit 8867ee59884a · 2022-05-27T08:55:35.000-07:00
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
@@ -783,3 +783,30 @@ Get all additional statistics of a project::
 Get total fetches in last 30 days of a project::
 
     total_fetches = project.additionalstatistics.get().fetches['total']
+
+Project storage
+=============================
+
+This endpoint requires admin access.
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectStorage`
+  + :class:`gitlab.v4.objects.ProjectStorageManager`
+  + :attr:`gitlab.v4.objects.Project.storage`
+
+* GitLab API: https://docs.gitlab.com/ee/api/projects.html#get-the-path-to-repository-storage
+
+Examples
+---------
+
+Get the repository storage details for a project::
+
+    storage = project.storage.get()
+
+Get the repository storage disk path::
+
+    disk_path = project.storage.get().disk_path
diff --git a/gitlab/v4/objects/projects.py b/gitlab/v4/objects/projects.py
@@ -9,6 +9,7 @@
 from gitlab.mixins import (
     CreateMixin,
     CRUDMixin,
+    GetWithoutIdMixin,
     ListMixin,
     ObjectDeleteMixin,
     RefreshMixin,
@@ -80,6 +81,8 @@
     "ProjectForkManager",
     "ProjectRemoteMirror",
     "ProjectRemoteMirrorManager",
+    "ProjectStorage",
+    "ProjectStorageManager",
 ]
 
 
@@ -180,6 +183,7 @@ class Project(RefreshMixin, SaveMixin, ObjectDeleteMixin, RepositoryMixin, RESTO
     runners: ProjectRunnerManager
     services: ProjectServiceManager
     snippets: ProjectSnippetManager
+    storage: "ProjectStorageManager"
     tags: ProjectTagManager
     triggers: ProjectTriggerManager
     users: ProjectUserManager
@@ -1013,3 +1017,18 @@ class ProjectRemoteMirrorManager(ListMixin, CreateMixin, UpdateMixin, RESTManage
         required=("url",), optional=("enabled", "only_protected_branches")
     )
     _update_attrs = RequiredOptional(optional=("enabled", "only_protected_branches"))
+
+
+class ProjectStorage(RefreshMixin, RESTObject):
+    pass
+
+
+class ProjectStorageManager(GetWithoutIdMixin, RESTManager):
+    _path = "/projects/{project_id}/storage"
+    _obj_cls = ProjectStorage
+    _from_parent_attrs = {"project_id": "id"}
+
+    def get(
+        self, id: Optional[Union[int, str]] = None, **kwargs: Any
+    ) -> Optional[ProjectStorage]:
+        return cast(Optional[ProjectStorage], super().get(id=id, **kwargs))
diff --git a/tests/functional/api/test_projects.py b/tests/functional/api/test_projects.py
@@ -3,6 +3,7 @@
 import pytest
 
 import gitlab
+from gitlab.v4.objects.projects import ProjectStorage
 
 
 def test_create_project(gl, user):
@@ -285,6 +286,12 @@ def test_project_stars(project):
     assert project.star_count == 0
 
 
+def test_project_storage(project):
+    storage = project.storage.get()
+    assert isinstance(storage, ProjectStorage)
+    assert storage.repository_storage == "default"
+
+
 def test_project_tags(project, project_file):
     tag = project.tags.create({"tag_name": "v1.0", "ref": "main"})
     assert len(project.tags.list()) == 1
diff --git a/tests/unit/objects/test_projects.py b/tests/unit/objects/test_projects.py
@@ -12,6 +12,7 @@
     StarredProject,
     UserProject,
 )
+from gitlab.v4.objects.projects import ProjectStorage
 
 project_content = {"name": "name", "id": 1}
 languages_content = {
@@ -49,6 +50,19 @@ def resp_get_project():
         yield rsps
 
 
+@pytest.fixture
+def resp_get_project_storage():
+    with responses.RequestsMock() as rsps:
+        rsps.add(
+            method=responses.GET,
+            url="http://localhost/api/v4/projects/1/storage",
+            json={"project_id": 1, "disk_path": "/disk/path"},
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
 @pytest.fixture
 def resp_user_projects():
     with responses.RequestsMock() as rsps:
@@ -256,6 +270,12 @@ def test_get_project_languages(project, resp_list_languages):
     assert coffee_script == 00.01
 
 
+def test_get_project_storage(project, resp_get_project_storage):
+    storage = project.storage.get()
+    assert isinstance(storage, ProjectStorage)
+    assert storage.disk_path == "/disk/path"
+
+
 @pytest.mark.skip(reason="missing test")
 def test_archive_project(gl):
     pass
