[Prefix] Support user-supplied compression format for the tarball (#431)

Author: giordano

Project.toml

@@ -1,7 +1,7 @@
 name = "BinaryBuilderBase"
 uuid = "7f725544-6523-48cd-82d1-3fa08ff4056e"
 authors = ["Elliot Saba <staticfloat@gmail.com>"]
-version = "1.38.0"
+version = "1.39.0"
 
 [deps]
 Bzip2_jll = "6e34b625-4abd-537c-b88f-471c36dfa7a0"

src/ArchiveUtils.jl

@@ -1,6 +1,7 @@
 using Base: SHA1
 using Downloads, Tar, p7zip_jll, pigz_jll, SimpleBufferStream, SHA
 using Pkg.Artifacts: artifact_exists, artifact_path, query_override
+using XZ_jll: xz
 
 export unpack, list_tarball_files, verify, download_verify
 
@@ -146,14 +147,16 @@ end
 # function
 function archive_artifact(hash::SHA1, tarball_path::String;
                           honor_overrides::Bool=false,
-                          package::Function=package)
+                          package::Function=package,
+                          compression_format::String="gzip",
+                          )
 
     if !artifact_exists(hash)
         error("Unable to archive artifact $(bytes2hex(hash.bytes)): does not exist!")
     end
 
     # Package it up
-    package(artifact_path(hash), tarball_path)
+    package(artifact_path(hash), tarball_path; format=compression_format)
 
     # Calculate its sha256 and return that
     return open(tarball_path, "r") do io
@@ -170,6 +173,8 @@ function package(src_dir::AbstractString, tarball_path::AbstractString;
     # does not.
     compress_cmd = if format == "gzip"
         pipeline(`$(pigz()) --no-time --no-name -9`, stdout=tarball_path)
+    elseif format == "xz"
+        pipeline(`$(xz()) -T0 -9`; stdout=tarball_path)
     else
         pipeline(`$(p7zip()) a -si -t$format -mx9 $tarball_path`, stdout=devnull)
     end

src/Prefix.jl

@@ -122,7 +122,9 @@ end
             version::VersionNumber;
             platform::AbstractPlatform = HostPlatform(),
             verbose::Bool = false, force::Bool = false,
-            filter = Returns(true))
+            filter = Returns(true),
+            compression_format::String = "gzip",
+           )
 
 Build a tarball of the `prefix`, storing the tarball at `output_base`, appending the version
 number `version`, a platform-dependent suffix and a file extension.  If `platform` is not
@@ -137,7 +139,8 @@ The are additional keyword arguments:
   should be packaged, and `false` otherwise.  The arguments are `(prefix, path)`, where
   `prefix` is the directory where the prefix is stored, and `path` is the path, within the
   prefix, of the file or directory.  This keyword allows you to filter out from the tarball
-  certain files or directories.
+  certain files or directories
+* `compression_format` specifies the compression format used for the tarball.
 """
 function package(prefix::Prefix,
                  output_base::AbstractString,
@@ -146,9 +149,19 @@ function package(prefix::Prefix,
                  verbose::Bool = false,
                  force::Bool = false,
                  filter = Returns(true),
+                 compression_format::String = "gzip",
                  )
     # Calculate output path
-    out_path = "$(output_base).v$(version).$(triplet(platform)).tar.gz"
+    extension = if compression_format == "gzip"
+        "gz"
+    elseif compression_format == "xz"
+        "xz"
+    elseif compression_format == "bzip2"
+        "bz2"
+    else
+        error("Unsupported compression format $(compression_format)")
+    end
+    out_path = "$(output_base).v$(version).$(triplet(platform)).tar.$(extension)"
 
     if isfile(out_path)
         if force

test/archive_utils.jl

@@ -97,7 +97,7 @@ using Test
 
                 # Test custom `package` function and ensure failure if no `tarball_path` file
                 # is created.
-                package_alt(src_dir, tarball_path) = nothing
+                package_alt(src_dir, tarball_path; format=nothing) = nothing
                 @test !isfile(tarball_path)
                 @test_throws SystemError archive_artifact(hash, tarball_path, package=package_alt)
 

test/prefix.jl

@@ -69,20 +69,25 @@ end
             write(f, "use_julia=true\n")
         end
 
-        # Next, package it up as a .tar.gz file
-        tarball_path, tarball_hash = @test_logs (:info, r"^Tree hash of contents of") (:info, r"^SHA256 of") begin
-            package(prefix, "./libfoo", v"1.0.0"; verbose=true)
+        for compression_format in ("gzip", "xz", "bzip2")
+            # Next, package it up as a tarball
+            tarball_path, tarball_hash = @test_logs (:info, r"^Tree hash of contents of") (:info, r"^SHA256 of") begin
+                package(prefix, "./libfoo", v"1.0.0"; verbose=true, compression_format)
+            end
+            @test isfile(tarball_path)
+
+            # Check that we are calculating the hash properly
+            tarball_hash_check = open(tarball_path, "r") do f
+                bytes2hex(sha256(f))
+            end
+            @test tarball_hash_check == tarball_hash
         end
-        @test isfile(tarball_path)
-
-        # Check that we are calculating the hash properly
-        tarball_hash_check = open(tarball_path, "r") do f
-            bytes2hex(sha256(f))
-        end
-        @test tarball_hash_check == tarball_hash
 
         # Test that packaging into a file that already exists fails
         @test_throws ErrorException package(prefix, "./libfoo", v"1.0.0")
+
+        # Test error path with unsupported compression format
+        @test_throws ErrorException package(prefix, "./libfoo-new", v"1.0.0"; compression_format="unknown")
     end
 
     # Test that we can inspect the contents of the tarball