feat: uds config validation

src/cmd/uds.go

@@ -16,6 +16,7 @@ import (
 	"github.com/defenseunicorns/uds-cli/src/config"
 	"github.com/defenseunicorns/uds-cli/src/config/lang"
 	"github.com/defenseunicorns/uds-cli/src/pkg/bundle"
+	"github.com/defenseunicorns/uds-cli/src/types"
 	"github.com/defenseunicorns/zarf/src/pkg/message"
 	goyaml "github.com/goccy/go-yaml"
 	"github.com/spf13/cobra"
@@ -193,9 +194,7 @@ func loadViperConfig() error {
 		return err
 	}
 
-	// read relevant config into DeployOpts.Variables
-	// need to use goyaml because Viper doesn't preserve case: https://github.com/spf13/viper/issues/1014
-	err = goyaml.UnmarshalWithOptions(configFile, &bundleCfg.DeployOpts, goyaml.Strict())
+	err = UnmarshalAndValidateConfig(configFile, &bundleCfg)
 	if err != nil {
 		return err
 	}
@@ -287,3 +286,19 @@ func chooseBundle(args []string) string {
 
 	return path
 }
+
+func UnmarshalAndValidateConfig(configFile []byte, bundleCfg *types.BundleConfig) error {
+	// read relevant config into DeployOpts.Variables
+	// need to use goyaml because Viper doesn't preserve case: https://github.com/spf13/viper/issues/1014
+	err := goyaml.UnmarshalWithOptions(configFile, &bundleCfg.DeployOpts, goyaml.Strict())
+	if err != nil {
+		return err
+	}
+	// validate config options
+	for optionName := range bundleCfg.DeployOpts.Options {
+		if !types.IsValidConfigOption(optionName) {
+			return fmt.Errorf("invalid config option: %s", optionName)
+		}
+	}
+	return nil
+}

src/cmd/uds_test.go

@@ -0,0 +1,61 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The UDS Authors
+
+// Package cmd contains the CLI commands for UDS.
+package cmd
+
+import (
+	"testing"
+
+	"github.com/defenseunicorns/uds-cli/src/types"
+	"github.com/stretchr/testify/require"
+)
+
+func TestUnmarshalAndValidateConfig(t *testing.T) {
+	type args struct {
+		configFile []byte
+		bundleCfg  *types.BundleConfig
+	}
+	tests := []struct {
+		name        string
+		args        args
+		wantErr     bool
+		errContains string
+	}{
+		{
+			name: "Invalid option key",
+			args: args{
+				configFile: []byte(`
+options:
+  log_levelx: debug
+`),
+				bundleCfg: &types.BundleConfig{},
+			},
+			wantErr:     true,
+			errContains: "invalid config option: log_levelx",
+		},
+		{
+			name: "Option typo",
+			args: args{
+				configFile: []byte(`
+optionx:
+  log_level: debug
+`),
+				bundleCfg: &types.BundleConfig{},
+			},
+			wantErr: true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			err := UnmarshalAndValidateConfig(tt.args.configFile, tt.args.bundleCfg)
+			if tt.wantErr {
+				require.NotNil(t, err, "Expected error")
+				require.Contains(t, err.Error(), tt.errContains, "Error message should contain the expected string")
+			} else {
+				require.Nil(t, err, "Expected no error")
+			}
+		})
+	}
+}

src/test/bundles/07-helm-overrides/uds-config-invalid.yaml

@@ -1,6 +1,7 @@
 options:
-  log_level: debug
+  log_levelx: debug
 
 # helm-overrides is an invalid top level key. Missing `variables` parent key.
-helm-overrides:
-  ui_color: "orange"
+variables:
+  helm-overrides:
+    ui_color: "orange"

src/test/e2e/bundle_test.go

@@ -604,14 +604,13 @@ func TestBundleTmpDir(t *testing.T) {
 
 func TestInvalidConfig(t *testing.T) {
 	os.Setenv("UDS_CONFIG", filepath.Join("src/test/bundles/07-helm-overrides", "uds-config-invalid.yaml"))
-	deployZarfInit(t)
 	zarfPkgPath := "src/test/packages/helm"
 	e2e.HelmDepUpdate(t, fmt.Sprintf("%s/unicorn-podinfo", zarfPkgPath))
 	e2e.CreateZarfPkg(t, zarfPkgPath, false)
 	bundleDir := "src/test/bundles/07-helm-overrides"
 	createLocal(t, bundleDir, e2e.Arch)
 	bundlePath := filepath.Join(bundleDir, fmt.Sprintf("uds-bundle-helm-overrides-%s-0.0.1.tar.zst", e2e.Arch))
 	_, stderr := deployWithError(t, bundlePath)
-	require.Contains(t, stderr, "unknown field")
+	require.Contains(t, stderr, "invalid config option: log_levelx")
 	os.Unsetenv("UDS_CONFIG")
 }

src/types/options.go

@@ -37,6 +37,28 @@ type BundleDeployOptions struct {
 	Options         map[string]interface{}            `yaml:"options,omitempty"`
 }
 
+type ConfigOption string
+
+const (
+	Confirm       ConfigOption = "confirm"
+	Insecure      ConfigOption = "insecure"
+	CachePath     ConfigOption = "uds_cache"
+	TempDirectory ConfigOption = "tmp_dir"
+	LogLevel      ConfigOption = "log_level"
+	Architecture  ConfigOption = "architecture"
+	NoLogFile     ConfigOption = "no_log_file"
+	NoProgress    ConfigOption = "no_progress"
+)
+
+func IsValidConfigOption(str string) bool {
+	switch ConfigOption(str) {
+	case Confirm, Insecure, CachePath, TempDirectory, LogLevel, Architecture, NoLogFile, NoProgress:
+		return true
+	default:
+		return false
+	}
+}
+
 // BundleInspectOptions is the options for the bundler.Inspect() function
 type BundleInspectOptions struct {
 	PublicKeyPath string