Zip artifact info (#232)

* Add zipped ipa and xcarchive readers into a new zip package

* Use go-utils/v2/log in the zip package

* Fix lint issues

* Test zip package

* Fix lint issues

Author: godrei

_integration_tests/test_helper.go

@@ -0,0 +1,79 @@
+package _integration_tests
+
+import (
+	"os"
+	"path/filepath"
+	"strings"
+	"testing"
+
+	"github.com/bitrise-io/go-utils/command/git"
+	"github.com/stretchr/testify/require"
+)
+
+const sampleArtifactsRepoURL = "https://github.com/bitrise-io/sample-artifacts.git"
+
+var reposToDir map[string]map[string]string
+
+func GetSampleArtifactsRepository(t *testing.T) string {
+	return GetRepository(t, sampleArtifactsRepoURL, "master")
+}
+
+func GetRepository(t *testing.T, url, branch string) string {
+	if repoDir := getRepoDir(url, branch); repoDir != "" {
+		return repoDir
+	}
+
+	tmpDir := createDirForRepo(t, url, branch)
+	gitCommand, err := git.New(tmpDir)
+	require.NoError(t, err)
+
+	out, err := gitCommand.Clone(url, "--depth=1", "--branch", branch).RunAndReturnTrimmedCombinedOutput()
+	require.NoError(t, err, out)
+
+	saveRepoDir(tmpDir, url, branch)
+
+	return tmpDir
+}
+
+func getRepoDir(url, branch string) string {
+	if reposToDir == nil {
+		return ""
+	}
+
+	branchToDir, ok := reposToDir[url]
+	if !ok {
+		return ""
+	}
+
+	dir, ok := branchToDir[branch]
+	if !ok {
+		return ""
+	}
+	return dir
+}
+
+func saveRepoDir(dir, url, branch string) {
+	if reposToDir == nil {
+		reposToDir = map[string]map[string]string{}
+	}
+
+	branchToDir, ok := reposToDir[url]
+	if !ok {
+		branchToDir = map[string]string{}
+	}
+
+	branchToDir[branch] = dir
+	reposToDir[url] = branchToDir
+}
+
+func createDirForRepo(t *testing.T, repo, branch string) string {
+	tmpDir, err := os.MkdirTemp("", "go-xcode")
+	require.NoError(t, err)
+
+	repoRootDir := strings.TrimSuffix(filepath.Base(repo), filepath.Ext(repo))
+	pth := filepath.Join(tmpDir, repoRootDir, branch)
+	err = os.MkdirAll(pth, os.ModePerm)
+	require.NoError(t, err)
+
+	return pth
+}

_integration_tests/zip/ipa_reader_test.go

@@ -0,0 +1,32 @@
+package zip
+
+import (
+	"path/filepath"
+	"testing"
+
+	"github.com/bitrise-io/go-utils/v2/log"
+	"github.com/bitrise-io/go-xcode/v2/_integration_tests"
+	"github.com/bitrise-io/go-xcode/v2/zip"
+	"github.com/stretchr/testify/require"
+)
+
+func TestIPAReader(t *testing.T) {
+	sampleArtifactsDir := _integration_tests.GetSampleArtifactsRepository(t)
+	watchTestIPAPath := filepath.Join(sampleArtifactsDir, "ipas", "watch-test.ipa")
+
+	r, err := zip.NewReader(watchTestIPAPath, log.NewLogger())
+	require.NoError(t, err)
+	defer func() {
+		require.NoError(t, r.Close())
+	}()
+
+	ipaReader := zip.NewIPAReader(*r)
+	plist, err := ipaReader.AppInfoPlist()
+	require.NoError(t, err)
+	bundleID, _ := plist.GetString("CFBundleIdentifier")
+	require.Equal(t, "bitrise.watch-test", bundleID)
+
+	profile, err := ipaReader.ProvisioningProfileInfo()
+	require.NoError(t, err)
+	require.Equal(t, "XC iOS: *", profile.Name)
+}

_integration_tests/zip/xcarchive_reader_test.go

@@ -0,0 +1,57 @@
+package zip
+
+import (
+	"path/filepath"
+	"testing"
+
+	"github.com/bitrise-io/go-utils/v2/log"
+	"github.com/bitrise-io/go-xcode/v2/_integration_tests"
+	"github.com/bitrise-io/go-xcode/v2/zip"
+	"github.com/stretchr/testify/require"
+)
+
+func TestXCArchiveReader_MacOSArchive(t *testing.T) {
+	sampleArtifactsDir := _integration_tests.GetSampleArtifactsRepository(t)
+	macOSXCArchivePath := filepath.Join(sampleArtifactsDir, "archives", "macos.xcarchive.zip")
+
+	r, err := zip.NewReader(macOSXCArchivePath, log.NewLogger())
+	require.NoError(t, err)
+	defer func() {
+		require.NoError(t, r.Close())
+	}()
+
+	xcarchiveReader := zip.NewXCArchiveReader(*r)
+	plist, err := xcarchiveReader.InfoPlist()
+	require.NoError(t, err)
+	name, _ := plist.GetString("Name")
+	require.Equal(t, "ActionExtension", name)
+
+	require.NoError(t, err)
+	require.Equal(t, true, xcarchiveReader.IsMacOS())
+}
+
+func TestXCArchiveReader_IOSArchive(t *testing.T) {
+	sampleArtifactsDir := _integration_tests.GetSampleArtifactsRepository(t)
+	iosXCArchiveIPAPath := filepath.Join(sampleArtifactsDir, "archives", "ios.xcarchive.zip")
+
+	r, err := zip.NewReader(iosXCArchiveIPAPath, log.NewLogger())
+	require.NoError(t, err)
+	defer func() {
+		require.NoError(t, r.Close())
+	}()
+
+	xcarchiveReader := zip.NewXCArchiveReader(*r)
+	plist, err := xcarchiveReader.InfoPlist()
+	require.NoError(t, err)
+	name, _ := plist.GetString("Name")
+	require.Equal(t, "code-sign-test", name)
+
+	require.NoError(t, err)
+	require.Equal(t, false, xcarchiveReader.IsMacOS())
+
+	iosXCArchiveReader := zip.NewIOSXCArchiveReader(*r)
+	appPlist, err := iosXCArchiveReader.AppInfoPlist()
+	require.NoError(t, err)
+	name, _ = appPlist.GetString("CFBundleIdentifier")
+	require.Equal(t, "com.bitrise.code-sign-test", name)
+}

bitrise.yml

@@ -5,6 +5,7 @@ workflows:
   ci:
     before_run:
     - test
+    - integration_test
 
   test:
     steps:
@@ -15,6 +16,13 @@ workflows:
         - skip_step_yml_validation: "yes"
     - go-list:
         inputs:
-        - exclude: |-
-            */mocks
+        - exclude: "*/mocks"
+    - go-test: { }
+
+  integration_test:
+    steps:
+    - change-workdir:
+        inputs:
+        - path: ./_integration_tests
+    - go-list: { }
     - go-test: { }

internals/zip/file.go

@@ -0,0 +1,30 @@
+package zip
+
+import (
+	"archive/zip"
+	"io"
+)
+
+// File ...
+type File interface {
+	Name() string
+	Open() (io.ReadCloser, error)
+}
+
+type defaultFile struct {
+	file *zip.File
+}
+
+func newDefaultFile(file *zip.File) File {
+	return defaultFile{file: file}
+}
+
+// Name ...
+func (file defaultFile) Name() string {
+	return file.file.Name
+}
+
+// Open ...
+func (file defaultFile) Open() (io.ReadCloser, error) {
+	return file.file.Open()
+}

internals/zip/reader.go

@@ -0,0 +1,42 @@
+package zip
+
+import (
+	"archive/zip"
+	"fmt"
+)
+
+// ReadCloser ...
+type ReadCloser interface {
+	Files() []File
+	Close() error
+}
+
+type defaultReadCloser struct {
+	zipReader *zip.ReadCloser
+}
+
+// NewDefaultReadCloser ...
+func NewDefaultReadCloser(archivePath string) (ReadCloser, error) {
+	zipReader, err := zip.OpenReader(archivePath)
+	if err != nil {
+		return nil, fmt.Errorf("failed to open archive %s: %w", archivePath, err)
+	}
+
+	return defaultReadCloser{
+		zipReader: zipReader,
+	}, nil
+}
+
+// Files ...
+func (readCloser defaultReadCloser) Files() []File {
+	var files []File
+	for _, file := range readCloser.zipReader.File {
+		files = append(files, newDefaultFile(file))
+	}
+	return files
+}
+
+// Close ...
+func (readCloser defaultReadCloser) Close() error {
+	return readCloser.zipReader.Close()
+}