feat: unpinned resources (images/repos/files) warning on zarf prepare lint

Makefile

@@ -8,8 +8,10 @@ KEY ?= ""
 
 # Figure out which Zarf binary we should use based on the operating system we are on
 ZARF_BIN := ./build/zarf
+BUILD_CLI_FOR_SYSTEM := build-cli-linux-amd
 ifeq ($(OS),Windows_NT)
 	ZARF_BIN := $(addsuffix .exe,$(ZARF_BIN))
+	BUILD_CLI_FOR_SYSTEM := build-cli-windows-amd
 else
 	UNAME_S := $(shell uname -s)
 	UNAME_P := $(shell uname -p)
@@ -19,13 +21,14 @@ else
 		endif
 		ifeq ($(UNAME_P),i386)
 			ZARF_BIN := $(addsuffix -intel,$(ZARF_BIN))
+			BUILD_CLI_FOR_SYSTEM = build-cli-mac-intel
 		endif
 		ifeq ($(UNAME_P),arm)
 			ZARF_BIN := $(addsuffix -apple,$(ZARF_BIN))
+			BUILD_CLI_FOR_SYSTEM = build-cli-mac-apple
 		endif
 	endif
 endif
-.DEFAULT_GOAL := help
 
 CLI_VERSION ?= $(if $(shell git describe --tags),$(shell git describe --tags),"UnknownVersion")
 BUILD_ARGS := -s -w -X github.com/defenseunicorns/zarf/src/config.CLIVersion=$(CLI_VERSION)
@@ -45,11 +48,13 @@ BUILD_DATE := $(shell date -u +'%Y-%m-%dT%H:%M:%SZ')
 BUILD_ARGS += -X k8s.io/component-base/version.gitCommit=$(GIT_SHA)
 BUILD_ARGS += -X k8s.io/component-base/version.buildDate=$(BUILD_DATE)
 
+.DEFAULT_GOAL := build
+
 .PHONY: help
 help: ## Display this help information
 	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) \
-	  | sort | awk 'BEGIN {FS = ":.*?## "}; \
-	  {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+		| sort | awk 'BEGIN {FS = ":.*?## "}; \
+		{printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
 clean: ## Clean the build directory
 	rm -rf build
@@ -62,6 +67,9 @@ delete-packages: ## Delete all Zarf package tarballs in the project recursively
 	find . -type f -name 'zarf-package-*' -delete
 
 # Note: the path to the main.go file is not used due to https://github.com/golang/go/issues/51831#issuecomment-1074188363
+.PHONY: build
+build: ## Build the Zarf CLI for the machines OS and architecture
+	$(MAKE) $(BUILD_CLI_FOR_SYSTEM)
 
 build-cli-linux-amd: ## Build the Zarf CLI for Linux on AMD64
 	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags="$(BUILD_ARGS)" -o build/zarf .
@@ -89,6 +97,9 @@ docs-and-schema: ## Generate the Zarf Documentation and Schema
 	hack/gen-cli-docs.sh
 	ZARF_CONFIG=hack/empty-config.toml hack/create-zarf-schema.sh
 
+lint-packages-and-examples: build-cli-for-system ## Recursively lint all zarf.yaml files in the repo except for those dedicated to tests
+	hack/lint_all_zarf_packages.sh $(ZARF_BIN)
+
 # INTERNAL: a shim used to build the agent image only if needed on Windows using the `test` command
 init-package-local-agent:
 	@test "$(AGENT_IMAGE_TAG)" != "local" || $(MAKE) build-local-agent-image

docs/2-the-zarf-cli/100-cli-commands/zarf_dev.md

@@ -28,7 +28,7 @@ Commands useful for developing packages
 * [zarf dev deploy](zarf_dev_deploy.md)	 - [beta] Creates and deploys a Zarf package from a given directory
 * [zarf dev find-images](zarf_dev_find-images.md)	 - Evaluates components in a Zarf file to identify images specified in their helm charts and manifests
 * [zarf dev generate-config](zarf_dev_generate-config.md)	 - Generates a config file for Zarf
-* [zarf dev lint](zarf_dev_lint.md)	 - Verifies the package schema
+* [zarf dev lint](zarf_dev_lint.md)	 - Lints the given package for valid schema and recommended practices
 * [zarf dev patch-git](zarf_dev_patch-git.md)	 - Converts all .git URLs to the specified Zarf HOST and with the Zarf URL pattern in a given FILE.  NOTE:
 This should only be used for manifests that are not mutated by the Zarf Agent Mutating Webhook.
 * [zarf dev sha256sum](zarf_dev_sha256sum.md)	 - Generates a SHA256SUM for the given file

docs/2-the-zarf-cli/100-cli-commands/zarf_dev_lint.md

@@ -1,11 +1,11 @@
 # zarf dev lint
 <!-- Auto-generated by hack/gen-cli-docs.sh -->
 
-Verifies the package schema
+Lints the given package for valid schema and recommended practices
 
 ## Synopsis
 
-Verifies the package schema and warns the user if they have variables that won't be evaluated
+Verifies the package schema, checks if any variables won't be evaluated, and checks for unpinned images/repos/files
 
 ```
 zarf dev lint [ DIRECTORY ] [flags]
@@ -14,7 +14,9 @@ zarf dev lint [ DIRECTORY ] [flags]
 ## Options
 
 ```
-  -h, --help   help for lint
+  -f, --flavor string        The flavor of components to include in the resulting package (i.e. have a matching or empty "only.flavor" key)
+  -h, --help                 help for lint
+      --set stringToString   Specify package variables to set on the command line (KEY=value) (default [])
 ```
 
 ## Options inherited from parent commands

hack/lint_all_zarf_packages.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+ZARF_BIN=$1
+LINT_SRC_TEST=$2
+SCRIPT=$(realpath "$0")
+SCRIPTPATH=$(dirname "$SCRIPT")
+cd "$SCRIPTPATH" || exit
+cd ..
+find "." -type f -name 'zarf.yaml' | while read -r yaml_file; do
+  dir=$(dirname "$yaml_file")
+  if [[ "$dir" == *src/test/* ]] && [ "$LINT_SRC_TEST" != true ]; then
+      continue
+  fi
+  echo "Running 'zarf prepare lint' in directory: $dir"
+  $ZARF_BIN prepare lint "$dir"
+  echo "---"
+done

src/cmd/common/utils.go

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2021-Present The Zarf Authors
+
+// Package common handles command configuration across all commands
+package common
+
+import (
+	"github.com/defenseunicorns/zarf/src/types"
+)
+
+// SetBaseDirectory sets base directory on package config when given in args
+func SetBaseDirectory(args []string, pkgConfig *types.PackagerConfig) {
+	if len(args) > 0 {
+		pkgConfig.CreateOpts.BaseDir = args[0]
+	} else {
+		pkgConfig.CreateOpts.BaseDir = "."
+	}
+}

src/cmd/dev.go

@@ -38,17 +38,9 @@ var devDeployCmd = &cobra.Command{
 	Use:   "deploy",
 	Args:  cobra.MaximumNArgs(1),
 	Short: lang.CmdDevDeployShort,
-	Long: lang.CmdDevDeployLong,
+	Long:  lang.CmdDevDeployLong,
 	Run: func(cmd *cobra.Command, args []string) {
-		if len(args) > 0 {
-			pkgConfig.CreateOpts.BaseDir = args[0]
-		} else {
-			var err error
-			pkgConfig.CreateOpts.BaseDir, err = os.Getwd()
-			if err != nil {
-				message.Fatalf(err, lang.CmdPackageCreateErr, err.Error())
-			}
-		}
+		common.SetBaseDirectory(args, &pkgConfig)
 
 		v := common.GetViper()
 		pkgConfig.CreateOpts.SetVariables = helpers.TransformAndMergeMap(
@@ -71,15 +63,15 @@ var devDeployCmd = &cobra.Command{
 var devTransformGitLinksCmd = &cobra.Command{
 	Use:     "patch-git HOST FILE",
 	Aliases: []string{"p"},
-	Short:   lang.CmdPreparePatchGitShort,
+	Short:   lang.CmdDevPatchGitShort,
 	Args:    cobra.ExactArgs(2),
 	Run: func(cmd *cobra.Command, args []string) {
 		host, fileName := args[0], args[1]
 
 		// Read the contents of the given file
 		content, err := os.ReadFile(fileName)
 		if err != nil {
-			message.Fatalf(err, lang.CmdPreparePatchGitFileReadErr, fileName)
+			message.Fatalf(err, lang.CmdDevPatchGitFileReadErr, fileName)
 		}
 
 		pkgConfig.InitOpts.GitServer.Address = host
@@ -94,17 +86,17 @@ var devTransformGitLinksCmd = &cobra.Command{
 		// Ask the user before this destructive action
 		confirm := false
 		prompt := &survey.Confirm{
-			Message: fmt.Sprintf(lang.CmdPreparePatchGitOverwritePrompt, fileName),
+			Message: fmt.Sprintf(lang.CmdDevPatchGitOverwritePrompt, fileName),
 		}
 		if err := survey.AskOne(prompt, &confirm); err != nil {
-			message.Fatalf(nil, lang.CmdPreparePatchGitOverwriteErr, err.Error())
+			message.Fatalf(nil, lang.CmdDevPatchGitOverwriteErr, err.Error())
 		}
 
 		if confirm {
 			// Overwrite the file
 			err = os.WriteFile(fileName, []byte(processedText), 0640)
 			if err != nil {
-				message.Fatal(err, lang.CmdPreparePatchGitFileWriteErr)
+				message.Fatal(err, lang.CmdDevPatchGitFileWriteErr)
 			}
 		}
 
@@ -114,7 +106,7 @@ var devTransformGitLinksCmd = &cobra.Command{
 var devSha256SumCmd = &cobra.Command{
 	Use:     "sha256sum { FILE | URL }",
 	Aliases: []string{"s"},
-	Short:   lang.CmdPrepareSha256sumShort,
+	Short:   lang.CmdDevSha256sumShort,
 	Args:    cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		fileName := args[0]
@@ -124,11 +116,11 @@ var devSha256SumCmd = &cobra.Command{
 		var err error
 
 		if helpers.IsURL(fileName) {
-			message.Warn(lang.CmdPrepareSha256sumRemoteWarning)
+			message.Warn(lang.CmdDevSha256sumRemoteWarning)
 
 			fileBase, err := helpers.ExtractBasePathFromURL(fileName)
 			if err != nil {
-				message.Fatalf(err, lang.CmdPrepareSha256sumHashErr, err.Error())
+				message.Fatalf(err, lang.CmdDevSha256sumHashErr, err.Error())
 			}
 
 			if fileBase == "" {
@@ -137,13 +129,13 @@ var devSha256SumCmd = &cobra.Command{
 
 			tmp, err = utils.MakeTempDir(config.CommonOptions.TempDirectory)
 			if err != nil {
-				message.Fatalf(err, lang.CmdPrepareSha256sumHashErr, err.Error())
+				message.Fatalf(err, lang.CmdDevSha256sumHashErr, err.Error())
 			}
 
 			downloadPath := filepath.Join(tmp, fileBase)
 			err = utils.DownloadToFile(fileName, downloadPath, "")
 			if err != nil {
-				message.Fatalf(err, lang.CmdPrepareSha256sumHashErr, err.Error())
+				message.Fatalf(err, lang.CmdDevSha256sumHashErr, err.Error())
 			}
 
 			fileName = downloadPath
@@ -155,7 +147,7 @@ var devSha256SumCmd = &cobra.Command{
 			if tmp == "" {
 				tmp, err = utils.MakeTempDir(config.CommonOptions.TempDirectory)
 				if err != nil {
-					message.Fatalf(err, lang.CmdPrepareSha256sumHashErr, err.Error())
+					message.Fatalf(err, lang.CmdDevSha256sumHashErr, err.Error())
 				}
 				defer os.RemoveAll(tmp)
 			}
@@ -164,22 +156,22 @@ var devSha256SumCmd = &cobra.Command{
 
 			err = archiver.Extract(fileName, extractPath, tmp)
 			if err != nil {
-				message.Fatalf(err, lang.CmdPrepareSha256sumHashErr, err.Error())
+				message.Fatalf(err, lang.CmdDevSha256sumHashErr, err.Error())
 			}
 
 			fileName = extractedFile
 		}
 
 		data, err = os.Open(fileName)
 		if err != nil {
-			message.Fatalf(err, lang.CmdPrepareSha256sumHashErr, err.Error())
+			message.Fatalf(err, lang.CmdDevSha256sumHashErr, err.Error())
 		}
 		defer data.Close()
 
 		var hash string
 		hash, err = helpers.GetSHA256Hash(data)
 		if err != nil {
-			message.Fatalf(err, lang.CmdPrepareSha256sumHashErr, err.Error())
+			message.Fatalf(err, lang.CmdDevSha256sumHashErr, err.Error())
 		} else {
 			fmt.Println(hash)
 		}
@@ -190,19 +182,11 @@ var devFindImagesCmd = &cobra.Command{
 	Use:     "find-images [ PACKAGE ]",
 	Aliases: []string{"f"},
 	Args:    cobra.MaximumNArgs(1),
-	Short:   lang.CmdPrepareFindImagesShort,
-	Long:    lang.CmdPrepareFindImagesLong,
+	Short:   lang.CmdDevFindImagesShort,
+	Long:    lang.CmdDevFindImagesLong,
 	Run: func(cmd *cobra.Command, args []string) {
 		// If a directory was provided, use that as the base directory
-		if len(args) > 0 {
-			pkgConfig.CreateOpts.BaseDir = args[0]
-		} else {
-			cwd, err := os.Getwd()
-			if err != nil {
-				message.Fatalf(err, lang.CmdPrepareFindImagesErr, err.Error())
-			}
-			pkgConfig.CreateOpts.BaseDir = cwd
-		}
+		common.SetBaseDirectory(args, &pkgConfig)
 
 		// Ensure uppercase keys from viper
 		v := common.GetViper()
@@ -215,7 +199,7 @@ var devFindImagesCmd = &cobra.Command{
 
 		// Find all the images the package might need
 		if _, err := pkgClient.FindImages(); err != nil {
-			message.Fatalf(err, lang.CmdPrepareFindImagesErr, err.Error())
+			message.Fatalf(err, lang.CmdDevFindImagesErr, err.Error())
 		}
 	},
 }
@@ -224,8 +208,8 @@ var devGenConfigFileCmd = &cobra.Command{
 	Use:     "generate-config [ FILENAME ]",
 	Aliases: []string{"gc"},
 	Args:    cobra.MaximumNArgs(1),
-	Short:   lang.CmdPrepareGenerateConfigShort,
-	Long:    lang.CmdPrepareGenerateConfigLong,
+	Short:   lang.CmdDevGenerateConfigShort,
+	Long:    lang.CmdDevGenerateConfigLong,
 	Run: func(cmd *cobra.Command, args []string) {
 		fileName := "zarf-config.toml"
 
@@ -236,7 +220,7 @@ var devGenConfigFileCmd = &cobra.Command{
 
 		v := common.GetViper()
 		if err := v.SafeWriteConfigAs(fileName); err != nil {
-			message.Fatalf(err, lang.CmdPrepareGenerateConfigErr, fileName)
+			message.Fatalf(err, lang.CmdDevGenerateConfigErr, fileName)
 		}
 	},
 }
@@ -245,20 +229,14 @@ var devLintCmd = &cobra.Command{
 	Use:     "lint [ DIRECTORY ]",
 	Args:    cobra.MaximumNArgs(1),
 	Aliases: []string{"l"},
-	Short:   lang.CmdPrepareLintShort,
-	Long:    lang.CmdPrepareLintLong,
+	Short:   lang.CmdDevLintShort,
+	Long:    lang.CmdDevLintLong,
 	Run: func(cmd *cobra.Command, args []string) {
-		baseDir := ""
-		if len(args) > 0 {
-			baseDir = args[0]
-		} else {
-			var err error
-			baseDir, err = os.Getwd()
-			if err != nil {
-				message.Fatalf(err, lang.CmdPrepareLintErr, err.Error())
-			}
-		}
-		validator, err := lint.ValidateZarfSchema(baseDir)
+		common.SetBaseDirectory(args, &pkgConfig)
+		v := common.GetViper()
+		pkgConfig.CreateOpts.SetVariables = helpers.TransformAndMergeMap(
+			v.GetStringMapString(common.VPkgCreateSet), pkgConfig.CreateOpts.SetVariables, strings.ToUpper)
+		validator, err := lint.Validate(pkgConfig.CreateOpts)
 		if err != nil {
 			message.Fatal(err, err.Error())
 		}
@@ -282,15 +260,17 @@ func init() {
 
 	bindDevDeployFlags(v)
 
-	devSha256SumCmd.Flags().StringVarP(&extractPath, "extract-path", "e", "", lang.CmdPrepareFlagExtractPath)
+	devSha256SumCmd.Flags().StringVarP(&extractPath, "extract-path", "e", "", lang.CmdDevFlagExtractPath)
 
-	devFindImagesCmd.Flags().StringVarP(&pkgConfig.FindImagesOpts.RepoHelmChartPath, "repo-chart-path", "p", "", lang.CmdPrepareFlagRepoChartPath)
+	devFindImagesCmd.Flags().StringVarP(&pkgConfig.FindImagesOpts.RepoHelmChartPath, "repo-chart-path", "p", "", lang.CmdDevFlagRepoChartPath)
 	// use the package create config for this and reset it here to avoid overwriting the config.CreateOptions.SetVariables
-	devFindImagesCmd.Flags().StringToStringVar(&pkgConfig.CreateOpts.SetVariables, "set", v.GetStringMapString(common.VPkgCreateSet), lang.CmdPrepareFlagSet)
+	devFindImagesCmd.Flags().StringToStringVar(&pkgConfig.CreateOpts.SetVariables, "set", v.GetStringMapString(common.VPkgCreateSet), lang.CmdDevFlagSet)
 	// allow for the override of the default helm KubeVersion
-	devFindImagesCmd.Flags().StringVar(&pkgConfig.FindImagesOpts.KubeVersionOverride, "kube-version", "", lang.CmdPrepareFlagKubeVersion)
+	devFindImagesCmd.Flags().StringVar(&pkgConfig.FindImagesOpts.KubeVersionOverride, "kube-version", "", lang.CmdDevFlagKubeVersion)
 
-	devTransformGitLinksCmd.Flags().StringVar(&pkgConfig.InitOpts.GitServer.PushUsername, "git-account", config.ZarfGitPushUser, lang.CmdPrepareFlagGitAccount)
+	devLintCmd.Flags().StringToStringVar(&pkgConfig.CreateOpts.SetVariables, "set", v.GetStringMapString(common.VPkgCreateSet), lang.CmdPackageCreateFlagSet)
+	devLintCmd.Flags().StringVarP(&pkgConfig.CreateOpts.Flavor, "flavor", "f", v.GetString(common.VPkgCreateFlavor), lang.CmdPackageCreateFlagFlavor)
+	devTransformGitLinksCmd.Flags().StringVar(&pkgConfig.InitOpts.GitServer.PushUsername, "git-account", config.ZarfGitPushUser, lang.CmdDevFlagGitAccount)
 }
 
 func bindDevDeployFlags(v *viper.Viper) {

src/cmd/package.go

@@ -6,7 +6,6 @@ package cmd
 
 import (
 	"fmt"
-	"os"
 	"path/filepath"
 	"regexp"
 	"strings"
@@ -41,17 +40,7 @@ var packageCreateCmd = &cobra.Command{
 	Short:   lang.CmdPackageCreateShort,
 	Long:    lang.CmdPackageCreateLong,
 	Run: func(cmd *cobra.Command, args []string) {
-
-		// If a directory was provided, use that as the base directory
-		if len(args) > 0 {
-			pkgConfig.CreateOpts.BaseDir = args[0]
-		} else {
-			var err error
-			pkgConfig.CreateOpts.BaseDir, err = os.Getwd()
-			if err != nil {
-				message.Fatalf(err, lang.CmdPackageCreateErr, err.Error())
-			}
-		}
+		common.SetBaseDirectory(args, &pkgConfig)
 
 		var isCleanPathRegex = regexp.MustCompile(`^[a-zA-Z0-9\_\-\/\.\~\\:]+$`)
 		if !isCleanPathRegex.MatchString(config.CommonOptions.CachePath) {