feat: fix func name, add func test, add docs

abhishekmsingh · nejch · commit 9857393ec625 · 2022-11-01T10:25:16.000+01:00
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
@@ -342,6 +342,15 @@ Import the project into a namespace and override parameters::
             override_params={'visibility': 'private'},
         )
 
+Import the project using file stored on a remote URL::
+
+    output = gl.projects.remote_import(
+        url="https://whatever.com/url/file.tar.gz",
+        path="my_new_remote_project",
+        name="My New Remote Project", 
+        namespace="my-group",
+        override_params={'visibility': 'private'},
+    )
 
 Project custom attributes
 =========================
diff --git a/gitlab/v4/objects/projects.py b/gitlab/v4/objects/projects.py
@@ -851,7 +851,7 @@ def import_project(
             "/projects/import", post_data=data, files=files, **kwargs
         )
 
-    def import_project_from_remote(
+    def remote_import(
         self,
         url: str,
         path: str,
diff --git a/tests/functional/api/test_import_export.py b/tests/functional/api/test_import_export.py
@@ -1,5 +1,7 @@
 import time
 
+import pytest
+
 import gitlab
 
 
@@ -64,3 +66,15 @@ def test_project_import_export(gl, project, temp_dir):
         count += 1
         if count == 15:
             raise Exception("Project import taking too much time")
+
+
+def test_project_remote_import(gl):
+    with pytest.raises(gitlab.exceptions.GitlabHttpError) as err_info:
+        gl.projects.remote_import(
+            "ftp://whatever.com/url", "remote-project", "remote-project", "root"
+        )
+    assert err_info.value.response_code == 400
+    assert (
+        "File url is blocked: Only allowed schemes are https"
+        in err_info.value.error_message
+    )
diff --git a/tests/unit/objects/test_project_import_export.py b/tests/unit/objects/test_project_import_export.py
@@ -30,7 +30,7 @@ def resp_import_project():
 
 
 @pytest.fixture
-def resp_import_project_from_remote():
+def resp_remote_import():
     content = {
         "id": 1,
         "description": None,
@@ -123,8 +123,8 @@ def test_import_project(gl, resp_import_project):
     assert project_import["import_status"] == "scheduled"
 
 
-def test_import_project_from_remote(gl, resp_import_project_from_remote):
-    project_import = gl.projects.import_project_from_remote(
+def test_remote_import(gl, resp_remote_import):
+    project_import = gl.projects.remote_import(
         "https://whatever.com/url", "remote-project", "remote-project", "root"
     )
     assert project_import["import_status"] == "scheduled"

Original file line number	Diff line number	Diff line change
`@@ -851,7 +851,7 @@ def import_project(`
`851`	`851`	`"/projects/import", post_data=data, files=files, **kwargs`
`852`	`852`	`)`
`853`	`853`
`854`		`- def import_project_from_remote(`
	`854`	`+ def remote_import(`
`855`	`855`	`self,`
`856`	`856`	`url: str,`
`857`	`857`	`path: str,`