Zarf files archive path support

examples/archive-path/zarf.yaml

@@ -0,0 +1,27 @@
+kind: ZarfPackageConfig
+metadata:
+  name: archive-path
+  description: "Test archive path"
+
+
+components:
+  - name: download-flux
+    required: true
+    files:
+      - source: https://github.com/fluxcd/flux2/releases/download/v2.0.1/flux_2.0.1_darwin_arm64.tar.gz
+        # target: /Users/cmwylie19/zarf/flux
+        target:  flux
+        executable: true
+        shasum: 520f25324d42e222ccdc75009659452808adcbecb2b744f2ebf037e14e18cd69
+        archivePath: flux
+  - name: flux-version
+    required: true
+    actions:
+      onDeploy:
+        before:
+          - cmd: ./flux -v
+            description: What's the version
+            mute: false
+          - cmd: rm flux
+            description: Remove the zipped
+

src/config/lang/english.go

@@ -27,6 +27,7 @@ const (
 	ErrCreatingDir         = "failed to create directory %s: %s"
 	ErrRemoveFile          = "failed to remove file %s: %s"
 	ErrUnarchive           = "failed to unarchive %s: %s"
+	ErrFilename            = "failed to extract filename from url %s: %s"
 )
 
 // Zarf CLI commands.

src/pkg/packager/common.go

@@ -17,7 +17,7 @@ import (
 	"strings"
 
 	"github.com/AlecAivazis/survey/v2"
-	"github.com/Masterminds/semver/v3"
+	"github.com/Masterminds/semver"
 	"github.com/defenseunicorns/zarf/src/config/lang"
 	"github.com/defenseunicorns/zarf/src/internal/cluster"
 	"github.com/defenseunicorns/zarf/src/internal/packager/sbom"

src/pkg/packager/create.go

@@ -383,6 +383,34 @@ func (p *Packager) addComponent(index int, component types.ZarfComponent, isSkel
 			if err := utils.DownloadToFile(file.Source, dst, component.CosignKeyPath); err != nil {
 				return fmt.Errorf(lang.ErrDownloading, file.Source, err.Error())
 			}
+			// Verify we can decompress the file
+			if file.ArchivePath != "" || helpers.SupportedCompressionFormat(file.Source) {
+				// extract filename from target
+				dstFileName, err := helpers.ExtractFilenameFromURL(file.Source)
+				if err != nil {
+					message.Fatalf(err, lang.ErrFilename, file.Source, err.Error())
+				}
+				// For archiver support, we need to rename the file to the original
+				newDst, err := helpers.RenamePathWithFilename(dst, dstFileName)
+				if err != nil {
+					fmt.Printf("Could not renamePathWithFilename %s, %s, %s", file.Target, dst, err.Error())
+				}
+
+				err = os.Rename(dst, newDst)
+				if err != nil {
+					return fmt.Errorf(lang.ErrWritingFile, dst, err)
+				}
+
+				// Decompress the file into the target directory
+				err = archiver.Unarchive(newDst, helpers.GetDirFromFilename(dst))
+				if err != nil {
+					message.Fatalf(err, lang.CmdToolsArchiverDecompressErr, err.Error())
+				}
+
+				// for Sha256sum rename dst
+				dst = newDst
+
+			}
 		} else {
 			if err := utils.CreatePathAndCopy(file.Source, dst); err != nil {
 				return fmt.Errorf("unable to copy file %s: %w", file.Source, err)
@@ -397,6 +425,15 @@ func (p *Packager) addComponent(index int, component types.ZarfComponent, isSkel
 			if actualShasum, _ := utils.GetCryptoHashFromFile(dst, crypto.SHA256); actualShasum != file.Shasum {
 				return fmt.Errorf("shasum mismatch for file %s: expected %s, got %s", file.Source, file.Shasum, actualShasum)
 			}
+
+			if file.ArchivePath != "" {
+				// Remove all files in directory other file
+				err = helpers.KeepOnlyFiles(filepath.Dir(dst), []string{file.ArchivePath, filepath.Base(dst)})
+				if err != nil {
+					fmt.Println("Error cleaning up directory", err.Error())
+				}
+			}
+
 		}
 
 		if file.Executable || utils.IsDir(dst) {

src/pkg/packager/deploy.go

@@ -319,10 +319,18 @@ func (p *Packager) processComponentFiles(component types.ZarfComponent, pkgLocat
 
 		// If a shasum is specified check it again on deployment as well
 		if file.Shasum != "" {
+			tempFileLocation := fileLocation
+			if file.ArchivePath != "" {
+				fileSource := filepath.Base(file.Source)
+
+				fileLocation, _ = helpers.RenamePathWithFilename(fileLocation, fileSource)
+			}
+
 			spinner.Updatef("Validating SHASUM for %s", file.Target)
 			if shasum, _ := utils.GetCryptoHashFromFile(fileLocation, crypto.SHA256); shasum != file.Shasum {
 				return fmt.Errorf("shasum mismatch for file %s: expected %s, got %s", file.Source, file.Shasum, shasum)
 			}
+			fileLocation = tempFileLocation
 		}
 
 		// Replace temp target directory and home directory

src/pkg/utils/helpers/compression.go

@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2021-Present The Zarf Authors
+
+// Package helpers provides generic helper functions with no external imports
+package helpers
+
+import (
+	"strings"
+)
+
+func SupportedCompressionFormat(filename string) bool {
+	supportedFormats := []string{".tar.gz", ".br", ".bz2", ".zip", ".lz4", ".sz", ".xz", ".zz", ".zst"}
+
+	for _, format := range supportedFormats {
+		if strings.HasSuffix(filename, format) {
+			return true
+		}
+	}
+	return false
+}

src/pkg/utils/helpers/files.go

@@ -0,0 +1,53 @@
+package helpers
+
+import (
+	"fmt"
+	"net/url"
+	"os"
+	"path"
+	"path/filepath"
+)
+
+func KeepOnlyFiles(directory string, fileNames []string) error {
+	files, err := os.ReadDir(directory)
+	if err != nil {
+		return err
+	}
+
+	filesToKeep := make(map[string]bool)
+	for _, fileName := range fileNames {
+		filesToKeep[fileName] = true
+	}
+
+	for _, file := range files {
+		filePath := filepath.Join(directory, file.Name())
+		if !filesToKeep[file.Name()] {
+			err := os.RemoveAll(filePath)
+			if err != nil {
+				return err
+			}
+			fmt.Println("Deleted:", filePath)
+		}
+	}
+
+	return nil
+}
+
+func GetDirFromFilename(target string) string {
+	return filepath.Dir(target)
+}
+func RenamePathWithFilename(target, fileName string) (string, error) {
+	dir := filepath.Dir(target)
+	newPath := filepath.Join(dir, fileName)
+	return newPath, nil
+}
+
+func ExtractFilenameFromURL(urlStr string) (string, error) {
+	parsedURL, err := url.Parse(urlStr)
+	if err != nil {
+		return "", err
+	}
+
+	filename := path.Base(parsedURL.Path)
+	return filename, nil
+}

src/types/component.go

@@ -79,11 +79,12 @@ type ZarfComponentOnlyCluster struct {
 
 // ZarfFile defines a file to deploy.
 type ZarfFile struct {
-	Source     string   `json:"source" jsonschema:"description=Local folder or file path or remote URL to pull into the package"`
-	Shasum     string   `json:"shasum,omitempty" jsonschema:"description=(files only) Optional SHA256 checksum of the file"`
-	Target     string   `json:"target" jsonschema:"description=The absolute or relative path where the file or folder should be copied to during package deploy"`
-	Executable bool     `json:"executable,omitempty" jsonschema:"description=(files only) Determines if the file should be made executable during package deploy"`
-	Symlinks   []string `json:"symlinks,omitempty" jsonschema:"description=List of symlinks to create during package deploy"`
+	Source      string   `json:"source" jsonschema:"description=Local folder or file path or remote URL to pull into the package"`
+	Shasum      string   `json:"shasum,omitempty" jsonschema:"description=(files only) Optional SHA256 checksum of the file"`
+	Target      string   `json:"target" jsonschema:"description=The absolute or relative path where the file or folder should be copied to during package deploy"`
+	Executable  bool     `json:"executable,omitempty" jsonschema:"description=(files only) Determines if the file should be made executable during package deploy"`
+	Symlinks    []string `json:"symlinks,omitempty" jsonschema:"description=List of symlinks to create during package deploy"`
+	ArchivePath string   `json:"archivePath,omitempty" jsonschema:"description=Local folder or file to be extracted into the package"`
 }
 
 // ZarfChart defines a helm chart to be deployed.