summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2018-06-09 17:22:39 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2018-06-09 17:22:47 +0200
commit39c8ad5a9405469370e429548e08aa475797b92b (patch)
tree5f27f5e22bb290aba927a84df81a9453b0aa9bc5
parent5a855fdb7f9eadc00e8b917d43a601fdc45d514a (diff)
downloadgitlab-39c8ad5a9405469370e429548e08aa475797b92b.tar.gz
Add geo nodes API support
Fixes #524
-rw-r--r--docs/api-objects.rst1
-rw-r--r--docs/gl_objects/geo_nodes.rst43
-rw-r--r--gitlab/__init__.py1
-rw-r--r--gitlab/exceptions.py4
-rw-r--r--gitlab/v4/objects.py77
-rwxr-xr-xtools/ee-test.py6
6 files changed, 132 insertions, 0 deletions
diff --git a/docs/api-objects.rst b/docs/api-objects.rst
index 127cfa2..4e7961d 100644
--- a/docs/api-objects.rst
+++ b/docs/api-objects.rst
@@ -19,6 +19,7 @@ API examples
gl_objects/environments
gl_objects/events
gl_objects/features
+ gl_objects/geo_nodes
gl_objects/groups
gl_objects/issues
gl_objects/boards
diff --git a/docs/gl_objects/geo_nodes.rst b/docs/gl_objects/geo_nodes.rst
new file mode 100644
index 0000000..44ed391
--- /dev/null
+++ b/docs/gl_objects/geo_nodes.rst
@@ -0,0 +1,43 @@
+#########
+Geo nodes
+#########
+
+Reference
+---------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.GeoNode`
+ + :class:`gitlab.v4.objects.GeoNodeManager`
+ + :attr:`gitlab.Gitlab.geonodes`
+
+* GitLab API: https://docs.gitlab.com/ee/api/geo_nodes.html
+
+Examples
+--------
+
+List the geo nodes::
+
+ nodes = gl.geonodes.list()
+
+Get the status of all the nodes::
+
+ status = gl.geonodes.status()
+
+Get a specific node and its status::
+
+ node = gl.geonodes.get(node_id)
+ node.status()
+
+Edit a node configuration::
+
+ node.url = 'https://secondary.mygitlab.domain'
+ node.save()
+
+Delete a node::
+
+ node.delete()
+
+List the sync failure on the current node::
+
+ failures = gl.geonodes.current_failures()
diff --git a/gitlab/__init__.py b/gitlab/__init__.py
index 2159492..4cf81ea 100644
--- a/gitlab/__init__.py
+++ b/gitlab/__init__.py
@@ -105,6 +105,7 @@ class Gitlab(object):
self.broadcastmessages = objects.BroadcastMessageManager(self)
self.deploykeys = objects.DeployKeyManager(self)
+ self.geonodes = objects.GeoNodeManager(self)
self.gitlabciymls = objects.GitlabciymlManager(self)
self.gitignores = objects.GitignoreManager(self)
self.groups = objects.GroupManager(self)
diff --git a/gitlab/exceptions.py b/gitlab/exceptions.py
index 514d742..4aec7fc 100644
--- a/gitlab/exceptions.py
+++ b/gitlab/exceptions.py
@@ -217,6 +217,10 @@ class GitlabRenderError(GitlabOperationError):
pass
+class GitlabRepairError(GitlabOperationError):
+ pass
+
+
def on_http_error(error):
"""Manage GitlabHttpError exceptions.
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
index d6ae6c5..8feb09b 100644
--- a/gitlab/v4/objects.py
+++ b/gitlab/v4/objects.py
@@ -3444,3 +3444,80 @@ class TodoManager(ListMixin, DeleteMixin, RESTManager):
return int(result)
except ValueError:
return 0
+
+
+class GeoNode(SaveMixin, ObjectDeleteMixin, RESTObject):
+ @cli.register_custom_action('GeoNode')
+ @exc.on_http_error(exc.GitlabRepairError)
+ def repair(self, **kwargs):
+ """Repair the OAuth authentication of the geo node.
+
+ Args:
+ **kwargs: Extra options to send to the server (e.g. sudo)
+
+ Raises:
+ GitlabAuthenticationError: If authentication is not correct
+ GitlabRepairError: If the server failed to perform the request
+ """
+ path = '/geo_nodes/%s/repair' % self.get_id()
+ server_data = self.manager.gitlab.http_post(path, **kwargs)
+ self._update_attrs(server_data)
+
+ @cli.register_custom_action('GeoNode')
+ @exc.on_http_error(exc.GitlabGetError)
+ def status(self, **kwargs):
+ """Get the status of the geo node.
+
+ Args:
+ **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:
+ dict: The status of the geo node
+ """
+ path = '/geo_nodes/%s/status' % self.get_id()
+ return self.manager.gitlab.http_get(path, **kwargs)
+
+
+class GeoNodeManager(RetrieveMixin, UpdateMixin, DeleteMixin, RESTManager):
+ _path = '/geo_nodes'
+ _obj_cls = GeoNode
+ _update_attrs = (tuple(), ('enabled', 'url', 'files_max_capacity',
+ 'repos_max_capacity'))
+
+ @cli.register_custom_action('GeoNodeManager')
+ @exc.on_http_error(exc.GitlabGetError)
+ def status(self, **kwargs):
+ """Get the status of all the geo nodes.
+
+ Args:
+ **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:
+ list: The status of all the geo nodes
+ """
+ return self.gitlab.http_list('/geo_nodes/status', **kwargs)
+
+ @cli.register_custom_action('GeoNodeManager')
+ @exc.on_http_error(exc.GitlabGetError)
+ def current_failures(self, **kwargs):
+ """Get the list of failures on the current geo node.
+
+ Args:
+ **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:
+ list: The list of failures
+ """
+ return self.gitlab.http_list('/geo_nodes/current/failures', **kwargs)
diff --git a/tools/ee-test.py b/tools/ee-test.py
index 3120efe..792c28e 100755
--- a/tools/ee-test.py
+++ b/tools/ee-test.py
@@ -27,3 +27,9 @@ project.approvals.set_approvers([1], [])
approval = project.approvals.get()
assert(approval.approvers[0]['user']['id'] == 1)
end_log()
+
+start_log('geo nodes')
+# very basic tests because we only have 1 node...
+nodes = gl.geonodes.list()
+status = gl.geonodes.status()
+end_log()