feat(namespaces): add support for namespace existence API

nejch · JohnVillalovos · commit 4882cb22f55c · 2022-07-24T14:17:17.000-07:00
diff --git a/docs/gl_objects/namespaces.rst b/docs/gl_objects/namespaces.rst
@@ -23,3 +23,15 @@ List namespaces::
 Search namespaces::
 
     namespaces = gl.namespaces.list(search='foo')
+
+Get a namespace by ID or path::
+
+  namespace = gl.namespaces.get("my-namespace")
+
+Get existence of a namespace by path::
+
+  namespace = gl.namespaces.exists("new-namespace")
+
+  if namespace.exists:
+      # get suggestions of namespaces that don't already exist
+      print(namespace.suggests)
diff --git a/gitlab/v4/objects/namespaces.py b/gitlab/v4/objects/namespaces.py
@@ -1,7 +1,10 @@
-from typing import Any, cast, Union
+from typing import Any, cast, TYPE_CHECKING, Union
 
+from gitlab import cli
+from gitlab import exceptions as exc
 from gitlab.base import RESTManager, RESTObject
 from gitlab.mixins import RetrieveMixin
+from gitlab.utils import EncodedId
 
 __all__ = [
     "Namespace",
@@ -20,3 +23,25 @@ class NamespaceManager(RetrieveMixin, RESTManager):
 
     def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Namespace:
         return cast(Namespace, super().get(id=id, lazy=lazy, **kwargs))
+
+    @cli.register_custom_action("NamespaceManager", ("namespace", "parent_id"))
+    @exc.on_http_error(exc.GitlabGetError)
+    def exists(self, namespace: str, **kwargs: Any) -> Namespace:
+        """Get existence of a namespace by path.
+
+        Args:
+            namespace: The path to the namespace.
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabGetError: If the server failed to perform the request
+
+        Returns:
+            Data on namespace existence returned from the server.
+        """
+        path = f"{self.path}/{EncodedId(namespace)}/exists"
+        server_data = self.gitlab.http_get(path, **kwargs)
+        if TYPE_CHECKING:
+            assert isinstance(server_data, dict)
+        return self._obj_cls(self, server_data)
diff --git a/tests/functional/api/test_gitlab.py b/tests/functional/api/test_gitlab.py
@@ -126,12 +126,20 @@ def test_hooks(gl):
 
 
 def test_namespaces(gl, get_all_kwargs):
-    namespace = gl.namespaces.list(**get_all_kwargs)
-    assert namespace
+    current_user = gl.user.username
 
-    namespace = gl.namespaces.list(search="root", **get_all_kwargs)[0]
+    namespaces = gl.namespaces.list(**get_all_kwargs)
+    assert namespaces
+
+    namespaces = gl.namespaces.list(search=current_user, **get_all_kwargs)
+    assert namespaces[0].kind == "user"
+
+    namespace = gl.namespaces.get(current_user)
     assert namespace.kind == "user"
 
+    namespace = gl.namespaces.exists(current_user)
+    assert namespace.exists
+
 
 def test_notification_settings(gl):
     settings = gl.notificationsettings.get()
