Add support for the gitlab CI lint API

Gauvain Pocentek · Gauvain Pocentek · commit 40b9f4d62d5b · 2018-05-29T10:50:08.000+02:00
diff --git a/gitlab/__init__.py b/gitlab/__init__.py
@@ -227,6 +227,29 @@ def version(self):
 
         return self._server_version, self._server_revision
 
+    def lint(self, content, **kwargs):
+        """Validate a gitlab CI configuration.
+
+        Args:
+            content (txt): The .gitlab-ci.yml content
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabVerifyError: If the validation could not be done
+
+        Returns:
+            tuple: (True, []) if the file is valid, (False, errors(list))
+                otherwise
+        """
+        post_data = {'content': content}
+        try:
+            data = self.http_post('/ci/lint', post_data=post_data, **kwargs)
+        except Exception:
+            raise GitlabVerifyError
+
+        return (data['status'] == 'valid', data['errors'])
+
     def markdown(self, text, gfm=False, project=None, **kwargs):
         """Render an arbitrary Markdown document.
 
diff --git a/tools/python_test_v4.py b/tools/python_test_v4.py
@@ -64,6 +64,10 @@
 # html = gl.markdown('foo')
 # assert('foo' in html)
 
+success, errors = gl.lint('Invalid')
+assert(success is False)
+assert(errors)
+
 # sidekiq
 out = gl.sidekiq.queue_metrics()
 assert(isinstance(out, dict))
