refactor(uploads): _upload_string to _upload_path

TigreModerata · TigreModerata · commit a6eccfffa852 · 2023-11-19T20:09:45.000+01:00
test(UploadMixin): added unit test

test(UploadMixin): added case upload from path

Added test when uploading using filepath;
Removed file upload tests from unit/objects/test_projects

test(projects): cleanup

removed file upload vars and fixtures from test_projects
diff --git a/gitlab/mixins.py b/gitlab/mixins.py
@@ -952,19 +952,19 @@ class UploadMixin(_RestObjectBase):
     _module: ModuleType
     _parent_attrs: Dict[str, Any]
     _updated_attrs: Dict[str, Any]
-    _upload_string: str
+    _upload_path: str
     manager: base.RESTManager
 
     def _get_upload_path(self) -> str:
-        """Formats _upload_string with object attributes.
+        """Formats _upload_path with object attributes.
 
         Returns:
             The upload path
         """
         if TYPE_CHECKING:
-            assert isinstance(self._upload_string, str)
+            assert isinstance(self._upload_path, str)
         data = self.attributes
-        return self._upload_string.format(**data)
+        return self._upload_path.format(**data)
 
     @cli.register_custom_action(("Project", "ProjectWiki"), ("filename", "filepath"))
     @exc.on_http_error(exc.GitlabUploadError)
diff --git a/gitlab/v4/objects/projects.py b/gitlab/v4/objects/projects.py
@@ -163,7 +163,7 @@ class Project(
     RefreshMixin, SaveMixin, ObjectDeleteMixin, RepositoryMixin, UploadMixin, RESTObject
 ):
     _repr_attr = "path_with_namespace"
-    _upload_string = "/projects/{id}/uploads"
+    _upload_path = "/projects/{id}/uploads"
 
     access_tokens: ProjectAccessTokenManager
     accessrequests: ProjectAccessRequestManager
diff --git a/gitlab/v4/objects/wikis.py b/gitlab/v4/objects/wikis.py
@@ -15,7 +15,7 @@
 class ProjectWiki(SaveMixin, ObjectDeleteMixin, UploadMixin, RESTObject):
     _id_attr = "slug"
     _repr_attr = "slug"
-    _upload_string = "/projects/{project_id}/wikis/attachments"
+    _upload_path = "/projects/{project_id}/wikis/attachments"
 
 
 class ProjectWikiManager(CRUDMixin, RESTManager):
diff --git a/tests/unit/mixins/test_mixin_methods.py b/tests/unit/mixins/test_mixin_methods.py
@@ -1,8 +1,10 @@
+from unittest.mock import mock_open, patch
+
 import pytest
 import requests
 import responses
 
-from gitlab import base
+from gitlab import base, GitlabUploadError
 from gitlab import types as gl_types
 from gitlab.mixins import (
     CreateMixin,
@@ -15,6 +17,7 @@
     SetMixin,
     UpdateMethod,
     UpdateMixin,
+    UploadMixin,
 )
 
 
@@ -502,3 +505,44 @@ class M(SetMixin, FakeManager):
     assert obj.key == "foo"
     assert obj.value == "bar"
     assert responses.assert_call_count(url, 1) is True
+
+
+@responses.activate
+def test_upload_mixin(gl):
+    class TestClass(UploadMixin, FakeObject):
+        _upload_path = "/tests/{id}/uploads"
+
+    url = "http://localhost/api/v4/tests/42/uploads"
+    responses.add(
+        method=responses.POST,
+        url=url,
+        json={"id": 42, "file_name": "test.txt", "file_content": "testing contents"},
+        status=200,
+        match=[responses.matchers.query_param_matcher({})],
+    )
+
+    mgr = FakeManager(gl)
+    obj = TestClass(mgr, {"id": 42})
+
+    with pytest.raises(
+        GitlabUploadError, match="File contents and file path specified"
+    ):
+        obj.upload("test.txt", "testing contents", "/home/test.txt")
+
+    with pytest.raises(GitlabUploadError, match="No file contents or path specified"):
+        obj.upload("test.txt")
+
+    res_only_data = obj.upload("test.txt", "testing contents")
+    assert obj._get_upload_path() == "/tests/42/uploads"
+    assert isinstance(res_only_data, dict)
+    assert res_only_data["file_name"] == "test.txt"
+    assert res_only_data["file_content"] == "testing contents"
+    assert responses.assert_call_count(url, 1) is True
+
+    with patch("builtins.open", mock_open(read_data="raw\nfile\ndata")):
+        res_only_path = obj.upload("test.txt", None, "/filepath")
+    assert obj._get_upload_path() == "/tests/42/uploads"
+    assert isinstance(res_only_path, dict)
+    assert res_only_path["file_name"] == "test.txt"
+    assert res_only_path["file_content"] == "testing contents"
+    assert responses.assert_call_count(url, 2) is True
diff --git a/tests/unit/objects/test_projects.py b/tests/unit/objects/test_projects.py
@@ -2,12 +2,9 @@
 GitLab API: https://docs.gitlab.com/ce/api/projects.html
 """
 
-from unittest.mock import mock_open, patch
-
 import pytest
 import responses
 
-from gitlab import exceptions
 from gitlab.const import DEVELOPER_ACCESS, SEARCH_SCOPE_ISSUES
 from gitlab.v4.objects import (
     Project,
@@ -52,12 +49,7 @@
         "name": "name",
     },
 }
-upload_file_content = {
-    "alt": "filename",
-    "url": "/uploads/66dbcd21ec5d24ed6ea225176098d52b/filename.png",
-    "full_path": "/namespace/project/uploads/66dbcd21ec5d24ed6ea225176098d52b/filename.png",
-    "markdown": "![dk](/uploads/66dbcd21ec5d24ed6ea225176098d52b/filename.png)",
-}
+
 share_project_content = {
     "id": 1,
     "project_id": 1,
@@ -334,19 +326,6 @@ def resp_delete_project(accepted_content):
         yield rsps
 
 
-@pytest.fixture
-def resp_upload_file_project():
-    with responses.RequestsMock() as rsps:
-        rsps.add(
-            method=responses.POST,
-            url="http://localhost/api/v4/projects/1/uploads",
-            json=upload_file_content,
-            content_type="application/json",
-            status=201,
-        )
-        yield rsps
-
-
 @pytest.fixture
 def resp_share_project():
     with responses.RequestsMock() as rsps:
@@ -682,29 +661,6 @@ def test_delete_project(project, resp_delete_project):
     project.delete()
 
 
-def test_upload_file(project, resp_upload_file_project):
-    project.upload("filename.png", "raw\nfile\ndata")
-
-
-def test_upload_file_with_filepath(project, resp_upload_file_project):
-    with patch("builtins.open", mock_open(read_data="raw\nfile\ndata")):
-        project.upload("filename.png", None, "/filepath")
-
-
-def test_upload_file_without_filepath_nor_filedata(project):
-    with pytest.raises(
-        exceptions.GitlabUploadError, match="No file contents or path specified"
-    ):
-        project.upload("filename.png")
-
-
-def test_upload_file_with_filepath_and_filedata(project):
-    with pytest.raises(
-        exceptions.GitlabUploadError, match="File contents and file path specified"
-    ):
-        project.upload("filename.png", "filedata", "/filepath")
-
-
 def test_share_project(project, group, resp_share_project):
     project.share(group.id, DEVELOPER_ACCESS)
 
