Add tmpdir command flag and refactor CommonOptions (zarf-dev#600)

* Add tmpdir command flag and refactor CommonOptions
* Add docs for tmpdir command flag
* Add tests for package create, inspect and deploy with --tmpdir
* Refactor package deploy test for --tmpdir
* Simplify test for --tmpdir in package deploy

Author: Racer159

.golangci.yml

@@ -14,6 +14,8 @@ linters:
     - varnamelen
     - wrapcheck
     - wsl
+    - paralleltest
+    - gochecknoglobals
 issues:
   exclude-use-default: false
   new: true

docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_create.md

@@ -10,6 +10,7 @@ zarf package create [flags]
 
 ```
       --confirm             Confirm package creation without prompting
+      --tmpdir              Specify the temporary directory to use for intermediate files
   -h, --help                help for create
       --skip-sbom           Skip generating SBOM for this package
       --zarf-cache string   Specify the location of the Zarf image cache (default ".zarf-image-cache")

docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_deploy.md

@@ -11,6 +11,7 @@ zarf package deploy [PACKAGE] [flags]
 ```
       --components string   Comma-separated list of components to install.  Adding this flag will skip the init prompts for which components to install
       --confirm             Confirm package deployment without prompting
+      --tmpdir              Specify the temporary directory to use for intermediate files
   -h, --help                help for deploy
       --insecure --shasum   Skip shasum validation of remote package. Required if deploying a remote package and --shasum is not provided
       --shasum --insecure   Shasum of the package to deploy. Required if deploying a remote package and --insecure is not provided

docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_inspect.md

@@ -9,7 +9,8 @@ zarf package inspect [PACKAGE] [flags]
 ### Options
 
 ```
-  -h, --help   help for inspect
+      --tmpdir      Specify the temporary directory to use for intermediate files
+  -h, --help        help for inspect
 ```
 
 ### Options inherited from parent commands

docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_init.md

@@ -15,6 +15,7 @@ zarf init [flags]
 ```
       --components string      Comma-separated list of components to install.  Adding this flag will skip the init prompts for which components to install
       --confirm                Confirm the install without prompting
+      --tmpdir                 Specify the temporary directory to use for intermediate files
   -h, --help                   help for init
       --nodeport string        Nodeport to access the Zarf container registry. Between [30000-32767]
       --secret string          Root secret value that is used to 'seed' other secrets

src/cmd/initialize.go

@@ -54,7 +54,7 @@ var initCmd = &cobra.Command{
 			// If the init-package doesn't exist in the executable directory, suggest trying to download
 			if utils.InvalidPath(config.DeployOptions.PackagePath) {
 
-				if config.DeployOptions.Confirm {
+				if config.CommonOptions.Confirm {
 					message.Fatalf(nil, "This command requires a zarf-init package, but one was not found on the local system.")
 				}
 
@@ -100,7 +100,8 @@ var initCmd = &cobra.Command{
 
 func init() {
 	rootCmd.AddCommand(initCmd)
-	initCmd.Flags().BoolVar(&config.DeployOptions.Confirm, "confirm", false, "Confirm the install without prompting")
+	initCmd.Flags().BoolVar(&config.CommonOptions.Confirm, "confirm", false, "Confirm the install without prompting")
+	initCmd.Flags().StringVar(&config.CommonOptions.TempDirectory, "tmpdir", "", "Specify the temporary directory to use for intermediate files")
 	initCmd.Flags().StringVar(&config.DeployOptions.Components, "components", "", "Comma-separated list of components to install.")
 	initCmd.Flags().StringVar(&config.DeployOptions.StorageClass, "storage-class", "", "Describe the StorageClass to be used")
 	initCmd.Flags().StringVar(&config.DeployOptions.Secret, "secret", "", "Root secret value that is used to 'seed' other secrets")

src/cmd/package.go

@@ -108,16 +108,19 @@ func init() {
 	packageCmd.AddCommand(packageDeployCmd)
 	packageCmd.AddCommand(packageInspectCmd)
 
-	packageCreateCmd.Flags().BoolVar(&config.DeployOptions.Confirm, "confirm", false, "Confirm package creation without prompting")
+	packageCreateCmd.Flags().BoolVar(&config.CommonOptions.Confirm, "confirm", false, "Confirm package creation without prompting")
+	packageCreateCmd.Flags().StringVar(&config.CommonOptions.TempDirectory, "tmpdir", "", "Specify the temporary directory to use for intermediate files")
 	packageCreateCmd.Flags().StringVar(&zarfImageCache, "zarf-cache", config.ZarfDefaultImageCachePath, "Specify the location of the Zarf image cache")
 	packageCreateCmd.Flags().StringVarP(&config.CreateOptions.OutputDirectory, "output-directory", "o", "", "Specify the output directory for the created Zarf package")
 	packageCreateCmd.Flags().BoolVar(&config.CreateOptions.SkipSBOM, "skip-sbom", false, "Skip generating SBOM for this package")
 	packageCreateCmd.Flags().BoolVar(&config.CreateOptions.Insecure, "insecure", false, "Allow insecure registry connections when pulling OCI images")
 
-	packageDeployCmd.Flags().BoolVar(&config.DeployOptions.Confirm, "confirm", false, "Confirm package deployment without prompting")
+	packageDeployCmd.Flags().BoolVar(&config.CommonOptions.Confirm, "confirm", false, "Confirm package deployment without prompting")
+	packageDeployCmd.Flags().StringVar(&config.CommonOptions.TempDirectory, "tmpdir", "", "Specify the temporary directory to use for intermediate files")
 	packageDeployCmd.Flags().StringVar(&config.DeployOptions.Components, "components", "", "Comma-separated list of components to install.  Adding this flag will skip the init prompts for which components to install")
 	packageDeployCmd.Flags().BoolVar(&insecureDeploy, "insecure", false, "Skip shasum validation of remote package. Required if deploying a remote package and `--shasum` is not provided")
 	packageDeployCmd.Flags().StringVar(&shasum, "shasum", "", "Shasum of the package to deploy. Required if deploying a remote package and `--insecure` is not provided")
-
 	packageDeployCmd.Flags().StringVar(&config.DeployOptions.SGetKeyPath, "sget", "", "Path to public sget key file for remote packages signed via cosign")
+
+	packageInspectCmd.Flags().StringVar(&config.CommonOptions.TempDirectory, "tmpdir", "", "Specify the temporary directory to use for intermediate files")
 }

src/cmd/prepare.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"io/ioutil"
 
+	"github.com/defenseunicorns/zarf/src/config"
 	"github.com/defenseunicorns/zarf/src/internal/packager"
 
 	"github.com/AlecAivazis/survey/v2"
@@ -20,11 +21,11 @@ var prepareCmd = &cobra.Command{
 }
 
 var prepareTransformGitLinks = &cobra.Command{
-	Use:   "patch-git [HOST] [FILE]",
+	Use:     "patch-git [HOST] [FILE]",
 	Aliases: []string{"p"},
 	Short: "Converts all .git URLs to the specified Zarf HOST and with the Zarf URL pattern in a given FILE.  NOTE: \n" +
-	"This should only be used for manifests that are not mutated by the Zarf Agent Mutating Webhook.",
-	Args:  cobra.ExactArgs(2),
+		"This should only be used for manifests that are not mutated by the Zarf Agent Mutating Webhook.",
+	Args: cobra.ExactArgs(2),
 	Run: func(cmd *cobra.Command, args []string) {
 		host, fileName := args[0], args[1]
 
@@ -57,10 +58,10 @@ var prepareTransformGitLinks = &cobra.Command{
 }
 
 var prepareComputeFileSha256sum = &cobra.Command{
-	Use:   "sha256sum [FILE|URL]",
+	Use:     "sha256sum [FILE|URL]",
 	Aliases: []string{"s"},
-	Short: "Generate a SHA256SUM for the given file",
-	Args:  cobra.ExactArgs(1),
+	Short:   "Generate a SHA256SUM for the given file",
+	Args:    cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		fileName := args[0]
 		hash, err := utils.GetSha256Sum(fileName)
@@ -75,7 +76,7 @@ var prepareComputeFileSha256sum = &cobra.Command{
 var prepareFindImages = &cobra.Command{
 	Use:     "find-images",
 	Aliases: []string{"f"},
-	Args:   cobra.MaximumNArgs(1),
+	Args:    cobra.MaximumNArgs(1),
 	Short:   "Evaluates components in a zarf file to identify images specified in their helm charts and manifests",
 	Long: "Evaluates components in a zarf file to identify images specified in their helm charts and manifests.\n\n" +
 		"Components that have repos that host helm charts can be processed by providing the --repo-chart-path.",
@@ -98,5 +99,5 @@ func init() {
 	prepareCmd.AddCommand(prepareFindImages)
 
 	prepareFindImages.Flags().StringVarP(&repoHelmChartPath, "repo-chart-path", "p", "", `If git repos hold helm charts, often found with gitops tools, specify the chart path, e.g. "/" or "/chart"`)
-
+	prepareFindImages.Flags().StringVar(&config.CommonOptions.TempDirectory, "tmpdir", "", "Specify the temporary directory to use for intermediate files")
 }

src/config/config.go

@@ -49,6 +49,9 @@ var (
 	// CLIVersion track the version of the CLI
 	CLIVersion = "unset"
 
+	// CommonOptions tracks user-defined values that apply across commands.
+	CommonOptions types.ZarfCommonOptions
+
 	// CreeateOptions tracks the user-defined options used to create the package
 	CreateOptions types.ZarfCreateOptions
 

src/internal/git/pull.go

@@ -3,6 +3,7 @@ package git
 import (
 	"context"
 
+	"github.com/defenseunicorns/zarf/src/config"
 	"github.com/defenseunicorns/zarf/src/internal/message"
 	"github.com/defenseunicorns/zarf/src/internal/utils"
 	"github.com/go-git/go-git/v5"
@@ -14,7 +15,7 @@ import (
 const onlineRemoteName = "online-upstream"
 
 func DownloadRepoToTemp(gitUrl string, spinner *message.Spinner) string {
-	path, _ := utils.MakeTempDir()
+	path, _ := utils.MakeTempDir(config.CommonOptions.TempDirectory)
 	// If downloading to temp, grab all tags since the repo isn't being
 	// packaged anyway, and it saves us from having to fetch the tags
 	// later if we need them

src/internal/helm/post-render.go

@@ -43,7 +43,7 @@ func NewRenderer(options ChartOptions, actionConfig *action.Configuration) *rend
 func (r *renderer) Run(renderedManifests *bytes.Buffer) (*bytes.Buffer, error) {
 	message.Debugf("helm.Run(renderedManifests *bytes.Buffer)")
 	// This is very low cost and consistent for how we replace elsewhere, also good for debugging
-	tempDir, _ := utils.MakeTempDir()
+	tempDir, _ := utils.MakeTempDir(config.CommonOptions.TempDirectory)
 	path := tempDir + "/chart.yaml"
 
 	// Write the context to a file for processing

src/internal/packager/common.go

@@ -42,7 +42,7 @@ type tempPaths struct {
 }
 
 func createPaths() tempPaths {
-	basePath, _ := utils.MakeTempDir()
+	basePath, _ := utils.MakeTempDir(config.CommonOptions.TempDirectory)
 	return tempPaths{
 		base: basePath,
 
@@ -98,9 +98,10 @@ func confirmAction(configPath, userMessage string, sbomViewFiles []string) bool
 
 	// Display prompt if not auto-confirmed
 	var confirmFlag bool
-	if config.DeployOptions.Confirm {
+	if config.CommonOptions.Confirm {
 		message.Infof("%s Zarf package confirmed", userMessage)
-		return config.DeployOptions.Confirm
+
+		return config.CommonOptions.Confirm
 	} else {
 		prompt := &survey.Confirm{
 			Message: userMessage + " this Zarf package?",

src/internal/packager/components.go

@@ -123,7 +123,7 @@ func isRequiredOrRequested(component types.ZarfComponent, requestedComponentName
 		return true
 	} else {
 		// Otherwise,check if this is one of the components that has been requested
-		if len(requestedComponentNames) > 0 || config.DeployOptions.Confirm {
+		if len(requestedComponentNames) > 0 || config.CommonOptions.Confirm {
 			for _, requestedComponent := range requestedComponentNames {
 				// If the component name matches one of the requested components, then return true
 				if strings.ToLower(requestedComponent) == component.Name {
@@ -140,7 +140,7 @@ func isRequiredOrRequested(component types.ZarfComponent, requestedComponentName
 // Confirm optional component
 func confirmOptionalComponent(component types.ZarfComponent) (confirmComponent bool) {
 	// Confirm flag passed, just use defaults
-	if config.DeployOptions.Confirm {
+	if config.CommonOptions.Confirm {
 		return component.Default
 	}
 
@@ -165,7 +165,7 @@ func confirmOptionalComponent(component types.ZarfComponent) (confirmComponent b
 
 func confirmChoiceGroup(componentGroup []types.ZarfComponent) types.ZarfComponent {
 	// Confirm flag passed, just use defaults
-	if config.DeployOptions.Confirm {
+	if config.CommonOptions.Confirm {
 		var componentNames []string
 		for _, component := range componentGroup {
 			// If the component is default, then return it

src/internal/utils/io.go

@@ -17,8 +17,8 @@ import (
 
 var TempPathPrefix = "zarf-"
 
-func MakeTempDir() (string, error) {
-	tmp, err := ioutil.TempDir("", TempPathPrefix)
+func MakeTempDir(tmpDir string) (string, error) {
+	tmp, err := ioutil.TempDir(tmpDir, TempPathPrefix)
 	message.Debugf("Creating temp path %s", tmp)
 	return tmp, err
 }

src/test/e2e/00_use_cli_test.go

@@ -25,10 +25,13 @@ func TestUseCLI(t *testing.T) {
 	// output, err = exec.Command("bash", "-c", "\"echo 'random test data 🦄' > shasum-test-file\"").Output()
 	shasumTestFilePath := "shasum-test-file"
 
-	// run `zarf create` with a specified image cache location
+	// run `zarf package create` with a specified image cache location
 	imageCachePath := "/tmp/.image_cache-location"
 
-	e2e.cleanFiles(shasumTestFilePath, imageCachePath)
+	// run `zarf package create` with a specified tmp location
+	otherTmpPath := "/tmp/othertmp"
+
+	e2e.cleanFiles(shasumTestFilePath, imageCachePath, otherTmpPath)
 
 	testfile, _ := os.Create(shasumTestFilePath)
 	cmd := exec.Command("echo", "random test data 🦄")
@@ -69,14 +72,28 @@ func TestUseCLI(t *testing.T) {
 	// TODO: remove this once #511 is merged
 	_ = os.Chdir("examples/game")
 	tmpBin := fmt.Sprintf("../../%s", e2e.zarfBinPath)
+	pkgName := fmt.Sprintf("zarf-package-dos-games-%s.tar.zst", e2e.arch)
+
 	stdOut, stdErr, err = utils.ExecCommandWithContext(context.TODO(), true, tmpBin, "package", "create", "examples/game", "--confirm", "--zarf-cache", imageCachePath)
 	require.NoError(t, err, stdOut, stdErr)
+
+	stdOut, stdErr, err = utils.ExecCommandWithContext(context.TODO(), true, tmpBin, "package", "inspect", pkgName)
+	require.NoError(t, err, stdOut, stdErr)
+
+	_ = os.Mkdir(otherTmpPath, 0750)
+	stdOut, stdErr, err = utils.ExecCommandWithContext(context.TODO(), true, tmpBin, "package", "create", "examples/game", "--confirm", "--zarf-cache", imageCachePath, "--tmpdir", otherTmpPath, "--log-level=debug")
+	require.Contains(t, stdErr, otherTmpPath, "The other tmp path should show as being created")
+	require.NoError(t, err, stdOut, stdErr)
+
+	stdOut, stdErr, err = utils.ExecCommandWithContext(context.TODO(), true, tmpBin, "package", "inspect", pkgName, "--tmpdir", otherTmpPath, "--log-level=debug")
+	require.Contains(t, stdErr, otherTmpPath, "The other tmp path should show as being created")
+	require.NoError(t, err, stdOut, stdErr)
 	// Reset temp chdir
 	_ = os.Chdir("../..")
 
 	files, err := ioutil.ReadDir(imageCachePath)
 	require.NoError(t, err, "Error when reading image cache path")
 	assert.Greater(t, len(files), 1)
 
-	e2e.cleanFiles(shasumTestFilePath, imageCachePath)
+	e2e.cleanFiles(shasumTestFilePath, imageCachePath, otherTmpPath)
 }

src/test/e2e/03_temp_directory_deploy_test.go

@@ -0,0 +1,31 @@
+package test
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestTempDirectoryDeploy(t *testing.T) {
+	t.Log("E2E: Temporary directory deploy")
+
+	// run `zarf package deploy` with a specified tmp location
+	otherTmpPath := "/tmp/othertmp"
+
+	e2e.setup(t)
+	defer e2e.teardown(t)
+
+	e2e.cleanFiles(otherTmpPath)
+
+	path := fmt.Sprintf("build/zarf-package-component-choice-%s.tar.zst", e2e.arch)
+
+	_ = os.Mkdir(otherTmpPath, 0750)
+
+	stdOut, stdErr, err := e2e.execZarfCommand("package", "deploy", path, "--confirm", "--tmpdir", otherTmpPath, "--log-level=debug")
+	require.Contains(t, stdErr, otherTmpPath, "The other tmp path should show as being created")
+	require.NoError(t, err, stdOut, stdErr)
+
+	e2e.cleanFiles(otherTmpPath)
+}

src/types/runtime.go

@@ -1,9 +1,14 @@
 package types
 
+// ZarfCommonOptions tracks the user-defined preferences used across commands.
+type ZarfCommonOptions struct {
+	Confirm       bool
+	TempDirectory string
+}
+
 // ZarfDeployOptions tracks the user-defined preferences during a package deployment
 type ZarfDeployOptions struct {
 	PackagePath string
-	Confirm     bool
 	Components  string
 	SGetKeyPath string