diff --git a/docs/api-objects.rst b/docs/api-objects.rst index 127cfa25a..4e7961d6a 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 000000000..44ed391f4 --- /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 215949221..4cf81ead9 100644 --- a/gitlab/__init__.py +++ b/gitlab/__init__.py @@ -105,6 +105,7 @@ def __init__(self, url, private_token=None, oauth_token=None, email=None, 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 514d742ca..4aec7fcba 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 d6ae6c5cf..8feb09b1d 100644 --- a/gitlab/v4/objects.py +++ b/gitlab/v4/objects.py @@ -3444,3 +3444,80 @@ def mark_all_as_done(self, **kwargs): 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 3120efedf..792c28e80 100755 --- a/tools/ee-test.py +++ b/tools/ee-test.py @@ -27,3 +27,9 @@ def end_log(): 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()