Migrate ziputil from v1 to v2

Swap go-utils v1 ziputil (which shelled out to /usr/bin/zip) for the
pure-Go go-utils/v2 ziputil ZipManager. A ZipManager is constructed in
main and passed into collectFilesToDeploy and the pipeline-intermediate
collector. Bumping go-utils/v2 also re-vendors env, fileutil and pathutil.

Add integration tests for the collectFilesToDeploy compress path that run
against a real ZipManager, covering symlink storage and archive contents.

Author: godrei

collect_files_to_deploy_integration_test.go

@@ -0,0 +1,105 @@
+// Integration tests that zip real files on disk: symlink and permission handling cannot be
+// verified against a mocked filesystem.
+package main
+
+import (
+	"archive/zip"
+	"io"
+	"os"
+	"path/filepath"
+	"testing"
+
+	loggerV2 "github.com/bitrise-io/go-utils/v2/log"
+	pathutil2 "github.com/bitrise-io/go-utils/v2/pathutil"
+	"github.com/bitrise-io/go-utils/v2/ziputil"
+	"github.com/stretchr/testify/require"
+)
+
+func TestCollectFilesToDeploy_compressDir_producesZipWithContentsAndSymlink(t *testing.T) {
+	srcDir := t.TempDir()
+	tmpDir := t.TempDir()
+
+	require.NoError(t, os.WriteFile(filepath.Join(srcDir, "top.txt"), []byte("top"), 0644))
+	require.NoError(t, os.MkdirAll(filepath.Join(srcDir, "sub"), 0755))
+	require.NoError(t, os.WriteFile(filepath.Join(srcDir, "sub", "nested.txt"), []byte("nested"), 0644))
+	require.NoError(t, os.Symlink("top.txt", filepath.Join(srcDir, "link.txt")))
+
+	config := Config{IsCompress: true}
+	files, err := collectFilesToDeploy(srcDir, config, tmpDir, newZipManager(), loggerV2.NewLogger())
+	require.NoError(t, err)
+
+	wantZip := filepath.Join(tmpDir, filepath.Base(srcDir)+".zip")
+	require.Equal(t, []string{wantZip}, files)
+
+	entries := readZip(t, wantZip)
+	require.Equal(t, "top", entries["top.txt"].content)
+	require.Equal(t, "nested", entries["sub/nested.txt"].content)
+
+	// isContentOnly=true: entries are relative to srcDir, not prefixed with its basename.
+	require.NotContains(t, entries, filepath.Base(srcDir)+"/top.txt")
+
+	// The symlink must be stored as a symlink pointing at its target, not followed and inlined.
+	link, ok := entries["link.txt"]
+	require.True(t, ok, "symlink entry missing from archive")
+	require.True(t, link.mode&os.ModeSymlink != 0, "link.txt should be stored as a symlink")
+	require.Equal(t, "top.txt", link.content)
+}
+
+func TestCollectFilesToDeploy_compressDir_usesCustomZipName(t *testing.T) {
+	srcDir := t.TempDir()
+	tmpDir := t.TempDir()
+	require.NoError(t, os.WriteFile(filepath.Join(srcDir, "a.txt"), []byte("a"), 0644))
+
+	config := Config{IsCompress: true, ZipName: "custom-name"}
+	files, err := collectFilesToDeploy(srcDir, config, tmpDir, newZipManager(), loggerV2.NewLogger())
+	require.NoError(t, err)
+	require.Equal(t, []string{filepath.Join(tmpDir, "custom-name.zip")}, files)
+}
+
+func TestCollectFilesToDeploy_compressEmptyDir_returnsNothing(t *testing.T) {
+	config := Config{IsCompress: true}
+	files, err := collectFilesToDeploy(t.TempDir(), config, t.TempDir(), newZipManager(), loggerV2.NewLogger())
+	require.NoError(t, err)
+	require.Empty(t, files)
+}
+
+func TestCollectFilesToDeploy_uncompressedDir_listsFilesSkipsSubdirs(t *testing.T) {
+	srcDir := t.TempDir()
+	require.NoError(t, os.WriteFile(filepath.Join(srcDir, "a.txt"), []byte("a"), 0644))
+	require.NoError(t, os.MkdirAll(filepath.Join(srcDir, "sub"), 0755))
+
+	config := Config{IsCompress: false}
+	files, err := collectFilesToDeploy(srcDir, config, t.TempDir(), newZipManager(), loggerV2.NewLogger())
+	require.NoError(t, err)
+	require.Equal(t, []string{filepath.Join(srcDir, "a.txt")}, files)
+}
+
+func newZipManager() *ziputil.ZipManager {
+	return ziputil.NewZipManager(pathutil2.NewPathChecker())
+}
+
+type zipEntry struct {
+	content string
+	mode    os.FileMode
+}
+
+func readZip(t *testing.T, zipPath string) map[string]zipEntry {
+	t.Helper()
+	r, err := zip.OpenReader(zipPath)
+	require.NoError(t, err)
+	defer r.Close()
+
+	entries := map[string]zipEntry{}
+	for _, f := range r.File {
+		if f.FileInfo().IsDir() {
+			continue
+		}
+		rc, err := f.Open()
+		require.NoError(t, err)
+		content, err := io.ReadAll(rc)
+		require.NoError(t, rc.Close())
+		require.NoError(t, err)
+		entries[f.Name] = zipEntry{content: string(content), mode: f.Mode()}
+	}
+	return entries
+}

go.mod

@@ -9,7 +9,7 @@ require (
 	github.com/bitrise-io/go-steputils v1.0.6
 	github.com/bitrise-io/go-steputils/v2 v2.0.0-alpha.49
 	github.com/bitrise-io/go-utils v1.0.15
-	github.com/bitrise-io/go-utils/v2 v2.0.0-alpha.34
+	github.com/bitrise-io/go-utils/v2 v2.0.0-alpha.36.0.20260612135825-fa80291d0871
 	github.com/bitrise-io/go-xcode v1.3.3
 	github.com/bitrise-io/go-xcode/v2 v2.0.0-alpha.80
 	github.com/docker/go-units v0.5.0

go.sum

@@ -24,8 +24,8 @@ github.com/bitrise-io/go-utils v1.0.2/go.mod h1:ZY1DI+fEpZuFpO9szgDeICM4QbqoWVt0
 github.com/bitrise-io/go-utils v1.0.15 h1:KRQjNiPrkxBRM6G5fQy05v0p0r8wycWfKVb+Ko+Vtg0=
 github.com/bitrise-io/go-utils v1.0.15/go.mod h1:ZY1DI+fEpZuFpO9szgDeICM4QbqoWVt0RSY3tRI1heY=
 github.com/bitrise-io/go-utils/v2 v2.0.0-alpha.10/go.mod h1:Ta/ards3Ih/3Q6X8tBtcj6zTHcNf1hRSXv1E8lPgIYk=
-github.com/bitrise-io/go-utils/v2 v2.0.0-alpha.34 h1:xsLfhItfs4SCCAesbv7UtKpldNqievDvtHggSuBI2+w=
-github.com/bitrise-io/go-utils/v2 v2.0.0-alpha.34/go.mod h1:5Z/vkUZ2BIY7IAVlMGns3ypRjd+J872YBSCJaLWVo/U=
+github.com/bitrise-io/go-utils/v2 v2.0.0-alpha.36.0.20260612135825-fa80291d0871 h1:pYOZwG/04O9KIE+8/wbqQ4SXwLWm/6zFU+vV2BL9Ag4=
+github.com/bitrise-io/go-utils/v2 v2.0.0-alpha.36.0.20260612135825-fa80291d0871/go.mod h1:5Z/vkUZ2BIY7IAVlMGns3ypRjd+J872YBSCJaLWVo/U=
 github.com/bitrise-io/go-xcode v1.3.3 h1:aYkSMWP+1/n2ZabRy3OMfeaWmE4l1gAPq63azx06LIw=
 github.com/bitrise-io/go-xcode v1.3.3/go.mod h1:9OwsvrhZ4A2JxHVoEY7CPcABAKA+OE7FQqFfBfvbFuY=
 github.com/bitrise-io/go-xcode/v2 v2.0.0-alpha.80 h1:/pq5C8nvn71HSsGyqhv76XcEgM/XZpYwMvBl4R+OczQ=

main.go

@@ -27,7 +27,7 @@ import (
 	"github.com/bitrise-io/go-utils/v2/fileutil"
 	loggerV2 "github.com/bitrise-io/go-utils/v2/log"
 	pathutil2 "github.com/bitrise-io/go-utils/v2/pathutil"
-	"github.com/bitrise-io/go-utils/ziputil"
+	"github.com/bitrise-io/go-utils/v2/ziputil"
 	iosparser "github.com/bitrise-io/go-xcode/v2/metaparser"
 	"github.com/bitrise-steplib/steps-deploy-to-bitrise-io/deployment"
 	"github.com/bitrise-steplib/steps-deploy-to-bitrise-io/fileredactor"
@@ -142,6 +142,7 @@ func main() {
 
 	pathModifier := pathutil2.NewPathModifier()
 	pathChecker := pathutil2.NewPathChecker()
+	zipManager := ziputil.NewZipManager(pathChecker)
 	pathProcessor := fileredactor.NewFilePathProcessor(pathModifier, pathChecker)
 	filePaths, err := pathProcessor.ProcessFilePaths(config.FilesToRedact)
 	if err != nil {
@@ -175,7 +176,7 @@ func main() {
 			fail(logger, "Failed to expand path: %s, error: %s", config.DeployPath, err)
 		}
 
-		filesToDeploy, err := collectFilesToDeploy(absDeployPth, config, tmpDir, logger)
+		filesToDeploy, err := collectFilesToDeploy(absDeployPth, config, tmpDir, zipManager, logger)
 		if err != nil {
 			fail(logger, "%s", err)
 		}
@@ -186,7 +187,7 @@ func main() {
 	if strings.TrimSpace(config.PipelineIntermediateFiles) != "" {
 		zipComparator := deployment.NewZipComparator(deployment.DefaultReadZipFunction)
 		repository := env.NewRepository()
-		collector := deployment.NewCollector(zipComparator, deployment.DefaultIsDirFunction, ziputil.ZipDir, repository, tmpDir)
+		collector := deployment.NewCollector(zipComparator, deployment.DefaultIsDirFunction, zipManager.ZipDir, repository, tmpDir)
 		deployableItems, err = collector.AddIntermediateFiles(deployableItems, config.PipelineIntermediateFiles)
 		if err != nil {
 			fail(logger, "%s", err)
@@ -390,7 +391,7 @@ func clearDeployFiles(filesToDeploy []string, logger loggerV2.Logger) []string {
 	return clearedFilesToDeploy
 }
 
-func collectFilesToDeploy(absDeployPth string, config Config, tmpDir string, logger loggerV2.Logger) (filesToDeploy []string, err error) {
+func collectFilesToDeploy(absDeployPth string, config Config, tmpDir string, zipManager *ziputil.ZipManager, logger loggerV2.Logger) (filesToDeploy []string, err error) {
 	pathExists, err := pathutil.IsPathExists(absDeployPth)
 	if err != nil {
 		return nil, fmt.Errorf("failed to check if %s exists: %s", absDeployPth, err)
@@ -427,7 +428,7 @@ func collectFilesToDeploy(absDeployPth string, config Config, tmpDir string, log
 		}
 		tmpZipPath := filepath.Join(tmpDir, zipName+".zip")
 
-		if err := ziputil.ZipDir(absDeployPth, tmpZipPath, true); err != nil {
+		if err := zipManager.ZipDir(absDeployPth, tmpZipPath, true); err != nil {
 			return nil, fmt.Errorf("failed to zip output dir, error: %s", err)
 		}