Zarf files archive path support

docs/3-create-a-zarf-package/4-zarf-schema.md

@@ -980,6 +980,22 @@ Must be one of:
 </blockquote>
 </details>
 
+<details>
+<summary>
+<strong> <a name="components_items_files_items_archivePath"></a>archivePath</strong>
+</summary>
+&nbsp;
+<blockquote>
+
+**Description:** Local folder or file to be extracted into the package
+
+|          |          |
+| -------- | -------- |
+| **Type** | `string` |
+
+</blockquote>
+</details>
+
 </blockquote>
 </details>
 

packages/distros/eks/zarf.yaml

@@ -20,6 +20,16 @@ variables:
     default: "1.23"
 
 components:
+  - name: test-archive
+    description: Test archive
+    required: true
+    files:
+      - source: https://github.com/weaveworks/eksctl/releases/download/v0.147.0/eksctl_Darwin_arm64.tar.gz
+        target: eksctl
+        shasum: 1d7dd5b9907de1cb3fa7832659db29f50530444d10e77b4a8eb27aa648da6fab
+        archivePath: eksctl
+        executable: true
+
   - name: load-eksctl
     required: true
     actions:

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"
+	ErrFileExtract         = "failed to extract filename %s from archive %s: %s"
 )
 
 // Zarf CLI commands.

src/pkg/packager/create.go

@@ -380,9 +380,24 @@ func (p *Packager) addComponent(index int, component types.ZarfComponent, isSkel
 			if isSkeleton {
 				continue
 			}
+
 			if err := utils.DownloadToFile(file.Source, dst, component.CosignKeyPath); err != nil {
 				return fmt.Errorf(lang.ErrDownloading, file.Source, err.Error())
 			}
+
+			if file.ArchivePath != "" {
+				compressFileName, _ := helpers.ExtractFilenameFromURL(file.Source)
+				archiveFile := filepath.Dir(dst) + "/" + compressFileName
+				targetFile := filepath.Dir(dst) + "/" + file.Target
+				err = os.Rename(targetFile, archiveFile)
+				if err != nil {
+					return fmt.Errorf(lang.ErrWritingFile, dst, err)
+				}
+				err = helpers.FindAndCopyFileFromArchive(archiveFile, file.ArchivePath, filepath.Dir(dst))
+				if err != nil {
+					return fmt.Errorf(lang.ErrFileExtract, file.ArchivePath, archiveFile, err)
+				}
+			}
 		} else {
 			if err := utils.CreatePathAndCopy(file.Source, dst); err != nil {
 				return fmt.Errorf("unable to copy file %s: %w", file.Source, err)

src/pkg/utils/helpers/files.go

@@ -0,0 +1,50 @@
+// 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 (
+	"io"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/mholt/archiver/v3"
+)
+
+// FindAndCopyFileFromArchive inspects an archive file, and copies the target file to the destination
+func FindAndCopyFileFromArchive(archivePath, targetFile, destinationDir string) error {
+	err := archiver.Walk(archivePath, func(f archiver.File) error {
+		if strings.HasSuffix(f.Name(), targetFile) {
+			// read the file in the compressed file
+			data, err := io.ReadAll(f)
+			if err != nil {
+				return err
+			}
+
+			// Create or open the destination file for writing
+			destinationPath := filepath.Join(destinationDir, filepath.Base(f.Name()))
+			destinationFile, err := os.Create(destinationPath)
+			if err != nil {
+				return err
+			}
+			defer destinationFile.Close()
+
+			// Write the data to the destination file
+			_, err = destinationFile.Write(data)
+			if err != nil {
+				return err
+			}
+
+		}
+		// Remove the compressed file
+		err := os.Remove(archivePath)
+		if err != nil {
+			return err
+		}
+		return nil
+	})
+
+	return err
+}

src/pkg/utils/helpers/url.go

@@ -7,6 +7,7 @@ package helpers
 import (
 	"fmt"
 	"net/url"
+	"path"
 )
 
 // Nonstandard URL schemes or prefixes
@@ -40,3 +41,14 @@ func DoHostnamesMatch(url1 string, url2 string) (bool, error) {
 
 	return parsedURL1.Hostname() == parsedURL2.Hostname(), nil
 }
+
+// ExtractFilenameFromURL returns filename from URL string
+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/pkg/utils/helpers/url_test.go

@@ -90,6 +90,29 @@ func (suite *TestURLSuite) Test_2_DoHostnamesMatch() {
 	suite.False(b)
 }
 
+func (suite *TestURLSuite) Test_3_ExtractFilenameFromURL() {
+	urls := []string{
+		"https://zarf.dev/file.txt",
+		"https://docs.zarf.dev/file.txt",
+		"https://zarf.dev/docs/file.tar.gz",
+		"https://defenseunicorns.com/file.yaml",
+		"https://google.com/file.md",
+	}
+	expectations := []string{
+		"file.txt",
+		"file.txt",
+		"file.tar.gz",
+		"file.yaml",
+		"file.md",
+	}
+
+	for idx, url := range urls {
+		actualURL, err := ExtractFilenameFromURL(url)
+		suite.NoError(err)
+		suite.Equal(actualURL, expectations[idx])
+	}
+
+}
 func TestURL(t *testing.T) {
 	suite.Run(t, new(TestURLSuite))
 }

src/test/e2e/00_use_cli_test.go

@@ -155,6 +155,26 @@ func TestUseCLI(t *testing.T) {
 		require.NoError(t, err, stdOut, stdErr)
 	})
 
+	t.Run("zarf package create for archive path", func(t *testing.T) {
+		t.Parallel()
+		stdOut, stdErr, err := e2e.Zarf("package", "create", "packages/distros/eks", "--zarf-cache", "--confirm")
+		require.NoError(t, err, stdOut, stdErr)
+	})
+
+	t.Run("zarf package inspect for archive path", func(t *testing.T) {
+		t.Parallel()
+		path := "build/zarf-package-distro-eks-multi-0.0.2.tar.zst"
+		stdOut, stdErr, err := e2e.Zarf("package", "inspect", path)
+		require.NoError(t, err, stdOut, stdErr)
+	})
+
+	t.Run("zarf package deploy for archive path", func(t *testing.T) {
+		t.Parallel()
+		path := "build/zarf-package-distro-eks-multi-0.0.2.tar.zst"
+		stdOut, stdErr, err := e2e.Zarf("package", "deploy", path, "--confirm")
+		require.NoError(t, err, stdOut, stdErr)
+	})
+
 	t.Run("remove cache", func(t *testing.T) {
 		t.Parallel()
 		tmpdir := t.TempDir()

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.

src/ui/lib/api-types.ts

@@ -718,6 +718,10 @@ export interface BigBang {
 }
 
 export interface ZarfFile {
+    /**
+     * Local folder or file to be extracted into the package
+     */
+    archivePath?: string;
     /**
      * (files only) Determines if the file should be made executable during package deploy
      */
@@ -1593,6 +1597,7 @@ const typeMap: any = {
         { json: "version", js: "version", typ: "" },
     ], false),
     "ZarfFile": o([
+        { json: "archivePath", js: "archivePath", typ: u(undefined, "") },
         { json: "executable", js: "executable", typ: u(undefined, true) },
         { json: "shasum", js: "shasum", typ: u(undefined, "") },
         { json: "source", js: "source", typ: "" },

zarf.schema.json

@@ -794,6 +794,10 @@
           },
           "type": "array",
           "description": "List of symlinks to create during package deploy"
+        },
+        "archivePath": {
+          "type": "string",
+          "description": "Local folder or file to be extracted into the package"
         }
       },
       "additionalProperties": false,