refactor: move validate to lint

main.go

@@ -13,7 +13,7 @@ import (
 
 	"github.com/zarf-dev/zarf/src/cmd"
 	"github.com/zarf-dev/zarf/src/config"
-	"github.com/zarf-dev/zarf/src/pkg/lint"
+	"github.com/zarf-dev/zarf/src/pkg/rules"
 )
 
 //go:embed cosign.pub
@@ -41,6 +41,6 @@ func main() {
 	}()
 
 	config.CosignPublicKey = cosignPublicKey
-	lint.ZarfSchema = zarfSchema
+	rules.ZarfSchema = zarfSchema
 	cmd.Execute(ctx)
 }

src/api/v1alpha1/package.go

@@ -8,6 +8,14 @@ import (
 	"github.com/zarf-dev/zarf/src/pkg/variables"
 )
 
+// Zarf looks for these strings in zarf.yaml to make dynamic changes
+const (
+	ZarfPackageTemplatePrefix = "###ZARF_PKG_TMPL_"
+	ZarfPackageVariablePrefix = "###ZARF_PKG_VAR_"
+	ZarfPackageArch           = "###ZARF_PKG_ARCH###"
+	ZarfComponentName         = "###ZARF_COMPONENT_NAME###"
+)
+
 // ZarfPackageKind is an enum of the different kinds of Zarf packages.
 type ZarfPackageKind string
 

src/pkg/lint/lint.go

@@ -16,13 +16,14 @@ import (
 	"github.com/zarf-dev/zarf/src/pkg/layout"
 	"github.com/zarf-dev/zarf/src/pkg/message"
 	"github.com/zarf-dev/zarf/src/pkg/packager/composer"
+	"github.com/zarf-dev/zarf/src/pkg/rules"
 	"github.com/zarf-dev/zarf/src/pkg/utils"
 	"github.com/zarf-dev/zarf/src/types"
 )
 
 // Validate lints the given Zarf package
 func Validate(ctx context.Context, createOpts types.ZarfCreateOptions) error {
-	var findings []PackageFinding
+	var findings []rules.PackageFinding
 	if err := os.Chdir(createOpts.BaseDir); err != nil {
 		return fmt.Errorf("unable to access directory %q: %w", createOpts.BaseDir, err)
 	}
@@ -36,7 +37,7 @@ func Validate(ctx context.Context, createOpts types.ZarfCreateOptions) error {
 		return err
 	}
 	findings = append(findings, compFindings...)
-	schemaFindings, err := ValidatePackageSchema()
+	schemaFindings, err := rules.ValidatePackageSchema()
 	if err != nil {
 		return err
 	}
@@ -46,15 +47,15 @@ func Validate(ctx context.Context, createOpts types.ZarfCreateOptions) error {
 		message.Successf("0 findings for %q", pkg.Metadata.Name)
 		return nil
 	}
-	PrintFindings(findings, SevWarn, createOpts.BaseDir, pkg.Metadata.Name)
-	if HasSevOrHigher(findings, SevErr) {
+	rules.PrintFindings(findings, rules.SevWarn, createOpts.BaseDir, pkg.Metadata.Name)
+	if rules.HasSevOrHigher(findings, rules.SevErr) {
 		return errors.New("errors during lint")
 	}
 	return nil
 }
 
-func lintComponents(ctx context.Context, pkg v1alpha1.ZarfPackage, createOpts types.ZarfCreateOptions) ([]PackageFinding, error) {
-	var findings []PackageFinding
+func lintComponents(ctx context.Context, pkg v1alpha1.ZarfPackage, createOpts types.ZarfCreateOptions) ([]rules.PackageFinding, error) {
+	var findings []rules.PackageFinding
 
 	for i, component := range pkg.Components {
 		arch := config.GetArch(pkg.Metadata.Architecture)
@@ -75,7 +76,7 @@ func lintComponents(ctx context.Context, pkg v1alpha1.ZarfPackage, createOpts ty
 			if err != nil {
 				return nil, err
 			}
-			compFindings = append(compFindings, CheckComponentValues(component, node.Index())...)
+			compFindings = append(compFindings, rules.CheckComponentValues(component, node.Index())...)
 			for i := range compFindings {
 				compFindings[i].PackagePathOverride = node.ImportLocation()
 				compFindings[i].PackageNameOverride = node.OriginalPackageName()
@@ -87,8 +88,8 @@ func lintComponents(ctx context.Context, pkg v1alpha1.ZarfPackage, createOpts ty
 	return findings, nil
 }
 
-func fillComponentTemplate(c *v1alpha1.ZarfComponent, createOpts types.ZarfCreateOptions) ([]PackageFinding, error) {
-	var findings []PackageFinding
+func fillComponentTemplate(c *v1alpha1.ZarfComponent, createOpts types.ZarfCreateOptions) ([]rules.PackageFinding, error) {
+	var findings []rules.PackageFinding
 	templateMap := map[string]string{}
 
 	setVarsAndWarn := func(templatePrefix string, deprecated bool) error {
@@ -100,19 +101,19 @@ func fillComponentTemplate(c *v1alpha1.ZarfComponent, createOpts types.ZarfCreat
 		var unSetTemplates bool
 		for key := range yamlTemplates {
 			if deprecated {
-				findings = append(findings, PackageFinding{
+				findings = append(findings, rules.PackageFinding{
 					Description: fmt.Sprintf(lang.PkgValidateTemplateDeprecation, key, key, key),
-					Severity:    SevWarn,
+					Severity:    rules.SevWarn,
 				})
 			}
 			if _, present := createOpts.SetVariables[key]; !present {
 				unSetTemplates = true
 			}
 		}
 		if unSetTemplates {
-			findings = append(findings, PackageFinding{
+			findings = append(findings, rules.PackageFinding{
 				Description: lang.UnsetVarLintWarning,
-				Severity:    SevWarn,
+				Severity:    rules.SevWarn,
 			})
 		}
 		for key, value := range createOpts.SetVariables {

src/pkg/lint/lint_test.go

@@ -12,6 +12,7 @@ import (
 	"github.com/stretchr/testify/require"
 	"github.com/zarf-dev/zarf/src/api/v1alpha1"
 	"github.com/zarf-dev/zarf/src/config/lang"
+	"github.com/zarf-dev/zarf/src/pkg/rules"
 	"github.com/zarf-dev/zarf/src/types"
 )
 
@@ -50,13 +51,13 @@ func TestFillComponentTemplate(t *testing.T) {
 
 	findings, err := fillComponentTemplate(&component, createOpts)
 	require.NoError(t, err)
-	expectedFindings := []PackageFinding{
+	expectedFindings := []rules.PackageFinding{
 		{
-			Severity:    SevWarn,
+			Severity:    rules.SevWarn,
 			Description: "There are templates that are not set and won't be evaluated during lint",
 		},
 		{
-			Severity:    SevWarn,
+			Severity:    rules.SevWarn,
 			Description: fmt.Sprintf(lang.PkgValidateTemplateDeprecation, "KEY2", "KEY2", "KEY2"),
 		},
 	}

src/pkg/packager/composer/list.go

@@ -15,6 +15,7 @@ import (
 	"github.com/zarf-dev/zarf/src/extensions/bigbang"
 	"github.com/zarf-dev/zarf/src/pkg/layout"
 	"github.com/zarf-dev/zarf/src/pkg/packager/deprecated"
+	"github.com/zarf-dev/zarf/src/pkg/rules"
 	"github.com/zarf-dev/zarf/src/pkg/utils"
 	"github.com/zarf-dev/zarf/src/pkg/variables"
 	"github.com/zarf-dev/zarf/src/pkg/zoci"
@@ -141,8 +142,7 @@ func NewImportChain(ctx context.Context, head v1alpha1.ZarfComponent, index int,
 			return ic, nil
 		}
 
-		// TODO: stuff like this should also happen in linting
-		if err := node.ZarfComponent.Validate(); err != nil {
+		if err := rules.ValidateComponent(node.ZarfComponent); err != nil {
 			return ic, err
 		}
 

src/pkg/packager/creator/creator_test.go

@@ -13,7 +13,7 @@ import (
 
 	"github.com/stretchr/testify/require"
 	"github.com/zarf-dev/zarf/src/pkg/layout"
-	"github.com/zarf-dev/zarf/src/pkg/lint"
+	"github.com/zarf-dev/zarf/src/pkg/rules"
 	"github.com/zarf-dev/zarf/src/types"
 )
 
@@ -66,7 +66,7 @@ func TestLoadPackageDefinition(t *testing.T) {
 	}
 	b, err := os.ReadFile("../../../../zarf.schema.json")
 	require.NoError(t, err)
-	lint.ZarfSchema = &mockSchemaLoader{b: b}
+	rules.ZarfSchema = &mockSchemaLoader{b: b}
 
 	for _, tt := range tests {
 		tt := tt

src/pkg/packager/creator/utils.go

@@ -12,25 +12,25 @@ import (
 
 	"github.com/zarf-dev/zarf/src/api/v1alpha1"
 	"github.com/zarf-dev/zarf/src/config"
-	"github.com/zarf-dev/zarf/src/pkg/lint"
 	"github.com/zarf-dev/zarf/src/pkg/packager/deprecated"
+	"github.com/zarf-dev/zarf/src/pkg/rules"
 	"github.com/zarf-dev/zarf/src/types"
 )
 
 // Validate errors if a package violates the schema or any runtime validations
 // This must be run while in the parent directory of the zarf.yaml being validated
 func Validate(pkg v1alpha1.ZarfPackage, baseDir string) error {
-	if err := pkg.Validate(); err != nil {
+	if err := rules.ValidatePackage(pkg); err != nil {
 		return fmt.Errorf("package validation failed: %w", err)
 	}
 
-	findings, err := lint.ValidatePackageSchema()
+	findings, err := rules.ValidatePackageSchema()
 	if err != nil {
 		return fmt.Errorf("unable to check schema: %w", err)
 	}
 
-	if lint.HasSevOrHigher(findings, lint.SevErr) {
-		lint.PrintFindings(findings, lint.SevErr, baseDir, pkg.Metadata.Name)
+	if rules.HasSevOrHigher(findings, rules.SevErr) {
+		rules.PrintFindings(findings, rules.SevErr, baseDir, pkg.Metadata.Name)
 		return fmt.Errorf("found errors in schema")
 	}
 

src/pkg/packager/filters/os_test.go

@@ -9,19 +9,20 @@ import (
 
 	"github.com/stretchr/testify/require"
 	"github.com/zarf-dev/zarf/src/api/v1alpha1"
+	"github.com/zarf-dev/zarf/src/pkg/rules"
 )
 
 func TestLocalOSFilter(t *testing.T) {
 	pkg := v1alpha1.ZarfPackage{}
-	for _, os := range v1alpha1.SupportedOS() {
+	for _, os := range rules.SupportedOS() {
 		pkg.Components = append(pkg.Components, v1alpha1.ZarfComponent{
 			Only: v1alpha1.ZarfComponentOnlyTarget{
 				LocalOS: os,
 			},
 		})
 	}
 
-	for _, os := range v1alpha1.SupportedOS() {
+	for _, os := range rules.SupportedOS() {
 		filter := ByLocalOS(os)
 		result, err := filter.Apply(pkg)
 		if os == "" {

src/pkg/packager/generate.go

@@ -17,6 +17,7 @@ import (
 	"github.com/zarf-dev/zarf/src/config"
 	"github.com/zarf-dev/zarf/src/pkg/layout"
 	"github.com/zarf-dev/zarf/src/pkg/message"
+	"github.com/zarf-dev/zarf/src/pkg/rules"
 )
 
 // Generate generates a Zarf package definition.
@@ -73,7 +74,7 @@ func (p *Packager) Generate(ctx context.Context) (err error) {
 		p.cfg.Pkg.Components[i].Images = images[name]
 	}
 
-	if err := p.cfg.Pkg.Validate(); err != nil {
+	if err := rules.ValidatePackage(p.cfg.Pkg); err != nil {
 		return err
 	}
 

src/pkg/packager/sources/cluster.go

@@ -13,6 +13,7 @@ import (
 	"github.com/zarf-dev/zarf/src/pkg/cluster"
 	"github.com/zarf-dev/zarf/src/pkg/layout"
 	"github.com/zarf-dev/zarf/src/pkg/packager/filters"
+	"github.com/zarf-dev/zarf/src/pkg/rules"
 	"github.com/zarf-dev/zarf/src/pkg/utils"
 	"github.com/zarf-dev/zarf/src/types"
 )
@@ -24,7 +25,7 @@ var (
 
 // NewClusterSource creates a new cluster source.
 func NewClusterSource(pkgOpts *types.ZarfPackageOptions) (PackageSource, error) {
-	if !v1alpha1.IsLowercaseNumberHyphenNoStartHyphen(pkgOpts.PackageSource) {
+	if !rules.IsLowercaseNumberHyphenNoStartHyphen(pkgOpts.PackageSource) {
 		return nil, fmt.Errorf("invalid package name %q", pkgOpts.PackageSource)
 	}
 

src/pkg/lint/findings.go → src/pkg/rules/findings.go

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2021-Present The Zarf Authors
 
-// Package lint contains functions for verifying zarf yaml files are valid
-package lint
+// Package rules checks Zarf packages and reports any findings or errors
+package rules
 
 import (
 	"fmt"

src/pkg/lint/findings_test.go → src/pkg/rules/findings_test.go

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2021-Present The Zarf Authors
 
-// Package lint contains functions for verifying zarf yaml files are valid
-package lint
+// Package rules checks Zarf packages and reports any findings or errors
+package rules
 
 import (
 	"testing"

src/pkg/lint/rules.go → src/pkg/rules/rules.go

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2021-Present The Zarf Authors
 
-// Package lint contains functions for verifying zarf yaml files are valid
-package lint
+// Package rules checks Zarf packages and reports any findings or errors
+package rules
 
 import (
 	"fmt"

src/pkg/lint/rules_test.go → src/pkg/rules/rules_test.go

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2021-Present The Zarf Authors
 
-// Package lint contains functions for verifying zarf yaml files are valid
-package lint
+// Package rules checks Zarf packages and reports any findings or errors
+package rules
 
 import (
 	"errors"

src/pkg/lint/schema.go → src/pkg/rules/schema.go

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2021-Present The Zarf Authors
 
-// Package lint contains functions for verifying zarf yaml files are valid
-package lint
+// Package rules checks Zarf packages and reports any findings or errors
+package rules
 
 import (
 	"fmt"

src/pkg/lint/schema_test.go → src/pkg/rules/schema_test.go

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2021-Present The Zarf Authors
 
-// Package lint contains functions for verifying zarf yaml files are valid
-package lint
+// Package rules checks Zarf packages and reports any findings or errors
+package rules
 
 import (
 	"fmt"