Bitbucket: add support for downloading repository archives (#791)

Author: sworisbreathing

atlassian/bitbucket/__init__.py

@@ -2368,6 +2368,51 @@ def delete_repo_condition(self, project_key, repo_key, id_condition):
         url = self._url_repo_condition(project_key, repo_key, id_condition)
         return self.delete(url) or {}
 
+    def download_repo_archive(
+        self,
+        project_key,
+        repository_slug,
+        dest_fd,
+        at=None,
+        filename=None,
+        format=None,
+        path=None,
+        prefix=None,
+        chunk_size=128,
+    ):
+        """
+        Downloads a repository archive.
+        Note that the data is written to the specified file-like object,
+        rather than simply being returned.
+        For further information visit:
+           https://docs.atlassian.com/bitbucket-server/rest/7.13.0/bitbucket-rest.html#idp199
+        :param project_key:
+        :param repository_slug:
+        :param dest_fd: a file-like object to which the archive will be written
+        :param at: string: Optional, the commit to download an archive of; if not supplied, an archive of the default branch is downloaded
+        :param filename: string: Optional, a filename to include the "Content-Disposition" header
+        :param format: string: Optional, the format to stream the archive in; must be one of: zip, tar, tar.gz or tgz. If not specified, then the archive will be in zip format.
+        :param paths: string: Optional, path to include in the streamed archive
+        :param prefix: string: Optional, a prefix to apply to all entries in the streamed archive; if the supplied prefix does not end with a trailing /, one will be added automatically
+        :param chunk_size: int: Optional, download chunk size. Defeault is 128
+        """
+        url = f"{self._url_repo(project_key, repository_slug)}/archive"
+        params = {}
+        if at is not None:
+            params["at"] = at
+        if filename is not None:
+            params["filename"] = filename
+        if format is not None:
+            params["format"] = format
+        if path is not None:
+            params["path"] = path
+        if prefix is not None:
+            params["prefix"] = prefix
+        headers = {"Accept": "*/*"}
+        response = self.get(url, params=params, headers=headers, advanced_mode=True)
+        for chunk in response.iter_content(chunk_size=chunk_size):
+            dest_fd.write(chunk)
+
     @deprecated(
         version="2.0.2",
         reason="Use atlassian.bitbucket.cloud instead of atlassian.bitbucket",

atlassian/bitbucket/server/projects/repos/__init__.py

@@ -275,3 +275,34 @@ def users(self):
         API docs: https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp285
         """
         return self.__users
+
+    def download_archive(self, dest_fd, at=None, filename=None, format=None, path=None, prefix=None, chunk_size=128):
+        """
+        Downloads a repository archive.
+        Note that the data is written to the specified file-like object,
+        rather than simply being returned.
+        For further information visit:
+           https://docs.atlassian.com/bitbucket-server/rest/7.13.0/bitbucket-rest.html#idp199
+        :param dest_fd: a file-like object to which the archive will be written
+        :param at: string: Optional, the commit to download an archive of; if not supplied, an archive of the default branch is downloaded
+        :param filename: string: Optional, a filename to include the "Content-Disposition" header
+        :param format: string: Optional, the format to stream the archive in; must be one of: zip, tar, tar.gz or tgz. If not specified, then the archive will be in zip format.
+        :param paths: string: Optional, path to include in the streamed archive
+        :param prefix: string: Optional, a prefix to apply to all entries in the streamed archive; if the supplied prefix does not end with a trailing /, one will be added automatically
+        :param chunk_size: int: Optional, download chunk size. Defeault is 128
+        """
+        params = {}
+        if at is not None:
+            params["at"] = at
+        if filename is not None:
+            params["filename"] = filename
+        if format is not None:
+            params["format"] = format
+        if path is not None:
+            params["path"] = path
+        if prefix is not None:
+            params["prefix"] = prefix
+        headers = {"Accept": "*/*"}
+        response = self.get("archive", params=params, headers=headers, advanced_mode=True)
+        for chunk in response.iter_content(chunk_size=chunk_size):
+            dest_fd.write(chunk)

examples/bitbucket/bitbucket_download_repo_archive.py

@@ -0,0 +1,12 @@
+# coding=utf-8
+from atlassian import Bitbucket
+
+bitbucket = Bitbucket(url="http://localhost:7990", username="admin", password="admin")
+
+with open("archive.tgz", mode="wb") as dest_fd:
+    bitbucket.download_repo_archive(
+        project_key="DEMO",
+        repository_slug="example-repository",
+        at="master",
+        format="tar.gz",
+    )

tests/responses/bitbucket/server/rest/api/1.0/projects/PRJ/repos/my-repo1-slug/archive/GET

@@ -0,0 +1,4 @@
+responses = {
+    None: b"\x50\x4b\x03\x04\x0a\x00\x00\x00\x00\x00\x14\x75\xc4\x52\xb4\x05\x4d\x93\x0e\x00\x00\x00\x0e\x00\x00\x00\x09\x00\x00\x00\x72\x65\x61\x64\x6d\x65\x2e\x6d\x64\x54\x65\x73\x74\x20\x72\x65\x61\x64\x6d\x65\x2e\x6d\x64\x50\x4b\x01\x02\x3f\x00\x0a\x00\x00\x00\x00\x00\x14\x75\xc4\x52\xb4\x05\x4d\x93\x0e\x00\x00\x00\x0e\x00\x00\x00\x09\x00\x24\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00\x72\x65\x61\x64\x6d\x65\x2e\x6d\x64\x0a\x00\x20\x00\x00\x00\x00\x00\x01\x00\x18\x00\x8a\x6d\xf9\xc4\xfb\x58\xd7\x01\x8a\x6d\xf9\xc4\xfb\x58\xd7\x01\x93\xfa\xc8\xc4\xfb\x58\xd7\x01\x50\x4b\x05\x06\x00\x00\x00\x00\x01\x00\x01\x00\x5b\x00\x00\x00\x35\x00\x00\x00\x00\x00",
+    "at=CommitId": b"\x50\x4b\x03\x04\x0a\x00\x00\x00\x00\x00\xaa\x75\xc4\x52\x6e\xb0\x98\x60\x1a\x00\x00\x00\x1a\x00\x00\x00\x09\x00\x00\x00\x72\x65\x61\x64\x6d\x65\x2e\x6d\x64\x54\x65\x73\x74\x20\x72\x65\x61\x64\x6d\x65\x2e\x6d\x64\x20\x61\x74\x20\x43\x6f\x6d\x6d\x69\x74\x49\x64\x50\x4b\x01\x02\x3f\x00\x0a\x00\x00\x00\x00\x00\xaa\x75\xc4\x52\x6e\xb0\x98\x60\x1a\x00\x00\x00\x1a\x00\x00\x00\x09\x00\x24\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00\x72\x65\x61\x64\x6d\x65\x2e\x6d\x64\x0a\x00\x20\x00\x00\x00\x00\x00\x01\x00\x18\x00\x78\xa8\x10\x6c\xfc\x58\xd7\x01\x78\xa8\x10\x6c\xfc\x58\xd7\x01\x93\xfa\xc8\xc4\xfb\x58\xd7\x01\x50\x4b\x05\x06\x00\x00\x00\x00\x01\x00\x01\x00\x5b\x00\x00\x00\x41\x00\x00\x00\x00\x00",
+}

tests/test_bitbucket_server.py

@@ -1,6 +1,8 @@
 # coding: utf8
+import io
 import pytest
 import sys
+import zipfile
 
 from atlassian.bitbucket.server import Server
 
@@ -272,3 +274,19 @@ def test_repository_permissions(self):
         user = repo.users.get("jcitizen1")
         assert user.name == "jcitizen1", "Get a user"
         assert user.delete() == {}, "Delete a user"
+
+    def test_download_repo_archive(self):
+        repo = BITBUCKET.projects.get("PRJ").repos.get("my-repo1-slug")
+        with io.BytesIO() as buf:
+            repo.download_archive(buf)
+            with zipfile.ZipFile(buf) as archive:
+                assert archive.namelist() == ["readme.md"]
+                with archive.open("readme.md") as file_in_archive:
+                    assert file_in_archive.read() == b"Test readme.md"
+
+        with io.BytesIO() as buf:
+            repo.download_archive(buf, at="CommitId")
+            with zipfile.ZipFile(buf) as archive:
+                assert archive.namelist() == ["readme.md"]
+                with archive.open("readme.md") as file_in_archive:
+                    assert file_in_archive.read() == b"Test readme.md at CommitId"