Return extracted file list from Uncompress function

This will help to get absolute path of the files which we want
to extract using a filefilter so it would be easy to copy that
file to proper destination.

Author: praveenkumar

pkg/crc/machine/bundle/metadata.go

@@ -95,7 +95,7 @@ func (bundle *CrcBundleInfo) resolvePath(filename string) string {
 }
 
 func Extract(sourcepath string) (*CrcBundleInfo, error) {
-	err := extract.Uncompress(sourcepath, constants.MachineCacheDir)
+	_, err := extract.Uncompress(sourcepath, constants.MachineCacheDir)
 	if err != nil {
 		return nil, err
 	}

pkg/crc/oc/oc_cache.go

@@ -67,7 +67,7 @@ func (oc *OcCached) cacheOc() error {
 		}
 
 		// Extract the tarball and put it the cache directory.
-		err = extract.UncompressWithFilter(assetTmpFile, tmpDir, matchOcBinaryName)
+		_, err = extract.UncompressWithFilter(assetTmpFile, tmpDir, matchOcBinaryName)
 		if err != nil {
 			return errors.Wrapf(err, "Cannot uncompress '%s'", assetTmpFile)
 		}

pkg/crc/podman/podman_cache.go

@@ -67,7 +67,7 @@ func (podman *PodmanCached) cachePodman() error {
 	}
 
 	// Extract the tarball and put it the cache directory.
-	err = extract.Uncompress(assetTmpFile, tmpDir)
+	_, err = extract.Uncompress(assetTmpFile, tmpDir)
 	if err != nil {
 		return errors.Wrapf(err, "Cannot uncompress '%s'", assetTmpFile)
 	}

pkg/crc/preflight/preflight_check_tray_darwin.go

@@ -210,7 +210,7 @@ func downloadOrExtractTrayApp() error {
 	if err != nil && !goos.IsExist(err) {
 		return errors.Wrap(err, "Cannot create the target directory.")
 	}
-	err = extract.Uncompress(archivePath, outputPath)
+	_, err = extract.Uncompress(archivePath, outputPath)
 	if err != nil {
 		return errors.Wrapf(err, "Cannot uncompress '%s'", archivePath)
 	}

pkg/extract/extract.go

@@ -14,15 +14,15 @@ import (
 	"github.com/xi2/xz"
 )
 
-func UncompressWithFilter(tarball, targetDir string, fileFilter func(string) bool) error {
+func UncompressWithFilter(tarball, targetDir string, fileFilter func(string) bool) ([]string, error) {
 	return uncompress(tarball, targetDir, fileFilter)
 }
 
-func Uncompress(tarball, targetDir string) error {
+func Uncompress(tarball, targetDir string) ([]string, error) {
 	return uncompress(tarball, targetDir, nil)
 }
 
-func uncompress(tarball, targetDir string, fileFilter func(string) bool) error {
+func uncompress(tarball, targetDir string, fileFilter func(string) bool) ([]string, error) {
 	logging.Debugf("Uncompressing %s to %s", tarball, targetDir)
 
 	if strings.HasSuffix(tarball, ".zip") {
@@ -32,19 +32,19 @@ func uncompress(tarball, targetDir string, fileFilter func(string) bool) error {
 	var filereader io.Reader
 	file, err := os.Open(filepath.Clean(tarball))
 	if err != nil {
-		return err
+		return nil, err
 	}
 	defer file.Close()
 
 	if strings.HasSuffix(tarball, ".tar.xz") || strings.HasSuffix(tarball, ".crcbundle") {
 		filereader, err = xz.NewReader(file, 0)
 		if err != nil {
-			return err
+			return nil, err
 		}
 	} else if strings.HasSuffix(tarball, ".tar.gz") {
 		reader, err := gzip.NewReader(file)
 		if err != nil {
-			return err
+			return nil, err
 		}
 		defer reader.Close()
 		filereader = io.Reader(reader)
@@ -57,19 +57,20 @@ func uncompress(tarball, targetDir string, fileFilter func(string) bool) error {
 	return untar(filereader, targetDir, fileFilter)
 }
 
-func untar(reader io.Reader, targetDir string, fileFilter func(string) bool) error {
+func untar(reader io.Reader, targetDir string, fileFilter func(string) bool) ([]string, error) {
+	var extractedFiles []string
 	tarReader := tar.NewReader(reader)
 
 	for {
 		header, err := tarReader.Next()
 		switch {
 		// if no more files are found return
 		case err == io.EOF:
-			return nil
+			return extractedFiles, nil
 
 		// return any other error
 		case err != nil:
-			return err
+			return extractedFiles, err
 
 		// if the header is nil, just skip it (not sure how this happens)
 		case header == nil:
@@ -90,50 +91,52 @@ func untar(reader io.Reader, targetDir string, fileFilter func(string) bool) err
 		case tar.TypeDir:
 			if _, err := os.Stat(path); err != nil {
 				if err := os.MkdirAll(path, header.FileInfo().Mode()); err != nil {
-					return err
+					return nil, err
 				}
 			}
 
 		// if it's a file create it
 		case tar.TypeReg, tar.TypeGNUSparse:
 			// tar.Next() will externally only iterate files, so we might have to create intermediate directories here
 			if err = os.MkdirAll(filepath.Dir(path), 0750); err != nil {
-				return err
+				return nil, err
 			}
 			file, err := os.OpenFile(path, os.O_CREATE|os.O_TRUNC|os.O_WRONLY, header.FileInfo().Mode())
 			if err != nil {
-				return err
+				return nil, err
 			}
 			defer file.Close()
 
 			// copy over contents
 			if _, err := io.Copy(file, tarReader); err != nil {
-				return err
+				return nil, err
 			}
+			extractedFiles = append(extractedFiles, path)
 		}
 	}
 }
 
-func Unzip(archive, target string) error {
+func Unzip(archive, target string) ([]string, error) {
 	return unzip(archive, target, nil)
 }
 
-func unzip(archive, target string, fileFilter func(string) bool) error {
+func unzip(archive, target string, fileFilter func(string) bool) ([]string, error) {
+	var extractedFiles []string
 	reader, err := zip.OpenReader(archive)
 	if err != nil {
-		return err
+		return nil, err
 	}
 
 	if err := os.MkdirAll(target, 0750); err != nil {
-		return err
+		return nil, err
 	}
 
 	for _, file := range reader.File {
 		path := filepath.Join(target, file.Name) // #nosec G305
 
 		// Check for ZipSlip. More Info: https://snyk.io/research/zip-slip-vulnerability
 		if !strings.HasPrefix(path, filepath.Clean(target)+string(os.PathSeparator)) {
-			return fmt.Errorf("%s: illegal file path", path)
+			return nil, fmt.Errorf("%s: illegal file path", path)
 		}
 
 		if fileFilter != nil && !fileFilter(path) {
@@ -143,27 +146,28 @@ func unzip(archive, target string, fileFilter func(string) bool) error {
 		if file.FileInfo().IsDir() {
 			err = os.MkdirAll(path, file.Mode())
 			if err != nil {
-				return err
+				return nil, err
 			}
 			continue
 		}
 
 		fileReader, err := file.Open()
 		if err != nil {
-			return err
+			return nil, err
 		}
 		defer fileReader.Close()
 
 		targetFile, err := os.OpenFile(path, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, file.Mode())
 		if err != nil {
-			return err
+			return nil, err
 		}
 		defer targetFile.Close()
 
 		if _, err := io.Copy(targetFile, fileReader); err != nil {
-			return err
+			return nil, err
 		}
+		extractedFiles = append(extractedFiles, path)
 	}
 
-	return nil
+	return extractedFiles, nil
 }