Add support for project housekeeping

Gauvain Pocentek · Gauvain Pocentek · commit 9ede6529884e · 2017-11-12T07:38:28.000+01:00
Closes #368
diff --git a/docs/gl_objects/projects.py b/docs/gl_objects/projects.py
@@ -180,6 +180,10 @@
 contributors = project.repository_contributors()
 # end repository contributors
 
+# housekeeping
+project.housekeeping()
+# end housekeeping
+
 # files get
 f = project.files.get(file_path='README.rst', ref='master')
 
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
@@ -114,6 +114,12 @@ Archive/unarchive a project:
    Previous versions used ``archive_`` and ``unarchive_`` due to a naming issue,
    they have been deprecated but not yet removed.
 
+Start the housekeeping job:
+
+.. literalinclude:: projects.py
+   :start-after: # housekeeping
+   :end-before: # end housekeeping
+
 List the repository tree:
 
 .. literalinclude:: projects.py
diff --git a/gitlab/exceptions.py b/gitlab/exceptions.py
@@ -189,6 +189,10 @@ class GitlabCherryPickError(GitlabOperationError):
     pass
 
 
+class GitlabHousekeepingError(GitlabOperationError):
+    pass
+
+
 def raise_error_from_response(response, error, expected_code=200):
     """Tries to parse gitlab error message from response and raises error.
 
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
@@ -2328,6 +2328,22 @@ def trigger_pipeline(self, ref, token, variables={}, **kwargs):
         post_data = {'ref': ref, 'token': token, 'variables': variables}
         self.manager.gitlab.http_post(path, post_data=post_data, **kwargs)
 
+    @cli.register_custom_action('Project')
+    @exc.on_http_error(exc.GitlabHousekeepingError)
+    def housekeeping(self, **kwargs):
+        """Start the housekeeping task.
+
+        Args:
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabHousekeepingError: If the server failed to perform the
+                                     request
+        """
+        path = '/projects/%s/housekeeping' % self.get_id()
+        self.manager.gitlab.http_post(path, **kwargs)
+
     # see #56 - add file attachment features
     @cli.register_custom_action('Project', ('filename', 'filepath'))
     @exc.on_http_error(exc.GitlabUploadError)
diff --git a/tools/python_test_v4.py b/tools/python_test_v4.py
@@ -331,6 +331,9 @@
 commit.comments.create({'note': 'This is a commit comment'})
 assert(len(commit.comments.list()) == 1)
 
+# housekeeping
+admin_project.housekeeping()
+
 # repository
 tree = admin_project.repository_tree()
 assert(len(tree) != 0)
