feat(api): validate required app config items

Author: emosbaugh

api/controllers/kubernetes/install/app.go

@@ -51,6 +51,11 @@ func (c *InstallController) SetAppConfigValues(ctx context.Context, values map[s
 		}
 	}()
 
+	err = c.appConfigManager.ValidateConfigValues(*c.releaseData.AppConfig, values)
+	if err != nil {
+		return fmt.Errorf("validate app config values: %w", err)
+	}
+
 	err = c.appConfigManager.SetConfigValues(*c.releaseData.AppConfig, values)
 	if err != nil {
 		return fmt.Errorf("set app config values: %w", err)

api/controllers/kubernetes/install/controller.go

@@ -2,6 +2,7 @@ package install
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"sync"
 
@@ -164,13 +165,6 @@ func NewInstallController(opts ...InstallControllerOption) (*InstallController,
 		opt(controller)
 	}
 
-	if controller.configValues != nil {
-		err := controller.store.AppConfigStore().SetConfigValues(controller.configValues)
-		if err != nil {
-			return nil, fmt.Errorf("set app config values: %w", err)
-		}
-	}
-
 	// If none is provided, use the default env settings from helm to create a RESTClientGetter
 	if controller.restClientGetter == nil {
 		controller.restClientGetter = helmcli.New().RESTClientGetter()
@@ -208,5 +202,19 @@ func NewInstallController(opts ...InstallControllerOption) (*InstallController,
 		)
 	}
 
+	if controller.configValues != nil {
+		if controller.releaseData == nil || controller.releaseData.AppConfig == nil {
+			return nil, errors.New("app config not found")
+		}
+		err := controller.appConfigManager.ValidateConfigValues(*controller.releaseData.AppConfig, controller.configValues)
+		if err != nil {
+			return nil, fmt.Errorf("validate app config values: %w", err)
+		}
+		err = controller.appConfigManager.SetConfigValues(*controller.releaseData.AppConfig, controller.configValues)
+		if err != nil {
+			return nil, fmt.Errorf("set app config values: %w", err)
+		}
+	}
+
 	return controller, nil
 }

api/controllers/linux/install/app.go

@@ -51,6 +51,11 @@ func (c *InstallController) SetAppConfigValues(ctx context.Context, values map[s
 		}
 	}()
 
+	err = c.appConfigManager.ValidateConfigValues(*c.releaseData.AppConfig, values)
+	if err != nil {
+		return fmt.Errorf("validate app config values: %w", err)
+	}
+
 	err = c.appConfigManager.SetConfigValues(*c.releaseData.AppConfig, values)
 	if err != nil {
 		return fmt.Errorf("set app config values: %w", err)

api/controllers/linux/install/controller.go

@@ -2,6 +2,7 @@ package install
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"sync"
 
@@ -201,13 +202,6 @@ func NewInstallController(opts ...InstallControllerOption) (*InstallController,
 		opt(controller)
 	}
 
-	if controller.configValues != nil {
-		err := controller.store.AppConfigStore().SetConfigValues(controller.configValues)
-		if err != nil {
-			return nil, fmt.Errorf("set app config values: %w", err)
-		}
-	}
-
 	if controller.stateMachine == nil {
 		controller.stateMachine = NewStateMachine(WithStateMachineLogger(controller.logger))
 	}
@@ -262,6 +256,20 @@ func NewInstallController(opts ...InstallControllerOption) (*InstallController,
 		)
 	}
 
+	if controller.configValues != nil {
+		if controller.releaseData == nil || controller.releaseData.AppConfig == nil {
+			return nil, errors.New("app config not found")
+		}
+		err := controller.appConfigManager.ValidateConfigValues(*controller.releaseData.AppConfig, controller.configValues)
+		if err != nil {
+			return nil, fmt.Errorf("validate app config values: %w", err)
+		}
+		err = controller.appConfigManager.SetConfigValues(*controller.releaseData.AppConfig, controller.configValues)
+		if err != nil {
+			return nil, fmt.Errorf("set app config values: %w", err)
+		}
+	}
+
 	controller.registerReportingHandlers()
 
 	return controller, nil

api/internal/managers/app/config/config.go

@@ -1,14 +1,21 @@
 package config
 
 import (
+	"errors"
 	"fmt"
 
+	"github.com/replicatedhq/embedded-cluster/api/types"
 	kotsv1beta1 "github.com/replicatedhq/kotskinds/apis/kots/v1beta1"
 	"github.com/replicatedhq/kotskinds/multitype"
 	"github.com/tiendc/go-deepcopy"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
+var (
+	ErrConfigItemRequired  = errors.New("item is required")
+	ErrConfigValueNotFound = errors.New("value not found")
+)
+
 func (m *appConfigManager) GetConfig(config kotsv1beta1.Config) (kotsv1beta1.Config, error) {
 	return filterAppConfig(config)
 }
@@ -17,6 +24,42 @@ func (m *appConfigManager) GetConfigValues() (map[string]string, error) {
 	return m.appConfigStore.GetConfigValues()
 }
 
+func (m *appConfigManager) ValidateConfigValues(config kotsv1beta1.Config, configValues map[string]string) error {
+	var ve *types.APIError
+
+	configItems := make(map[string]kotsv1beta1.ConfigItem)
+	configChildItems := make(map[string]kotsv1beta1.ConfigChildItem)
+
+	// first check required items
+	for _, group := range config.Spec.Groups {
+		for _, item := range group.Items {
+			configItems[item.Name] = item
+
+			configValue := getConfigValueFromItem(item, configValues)
+			if isRequiredItem(item) && isUnsetItem(configValue) {
+				ve = types.AppendFieldError(ve, item.Name, ErrConfigItemRequired)
+			}
+
+			for _, childItem := range item.Items {
+				configChildItems[childItem.Name] = childItem
+			}
+		}
+	}
+
+	// then check if all the config values are present
+	for name := range configValues {
+		if _, ok := configItems[name]; ok {
+			continue
+		}
+		if _, ok := configChildItems[name]; ok {
+			continue
+		}
+		ve = types.AppendFieldError(ve, name, ErrConfigValueNotFound)
+	}
+
+	return ve.ErrorOrNil()
+}
+
 func (m *appConfigManager) SetConfigValues(config kotsv1beta1.Config, configValues map[string]string) error {
 	filteredValues := make(map[string]string)
 
@@ -42,14 +85,18 @@ func (m *appConfigManager) SetConfigValues(config kotsv1beta1.Config, configValu
 }
 
 func (m *appConfigManager) GetKotsadmConfigValues(config kotsv1beta1.Config) (kotsv1beta1.ConfigValues, error) {
-	filteredConfig, err := m.GetConfig(config)
+	storedValues, err := m.GetConfigValues()
 	if err != nil {
-		return kotsv1beta1.ConfigValues{}, fmt.Errorf("get config: %w", err)
+		return kotsv1beta1.ConfigValues{}, fmt.Errorf("get config values: %w", err)
 	}
 
-	storedValues, err := m.GetConfigValues()
+	return m.getKotsadmConfigValues(config, storedValues)
+}
+
+func (m *appConfigManager) getKotsadmConfigValues(config kotsv1beta1.Config, configValues map[string]string) (kotsv1beta1.ConfigValues, error) {
+	filteredConfig, err := m.GetConfig(config)
 	if err != nil {
-		return kotsv1beta1.ConfigValues{}, fmt.Errorf("get config values: %w", err)
+		return kotsv1beta1.ConfigValues{}, fmt.Errorf("get config: %w", err)
 	}
 
 	kotsadmConfigValues := kotsv1beta1.ConfigValues{
@@ -68,33 +115,43 @@ func (m *appConfigManager) GetKotsadmConfigValues(config kotsv1beta1.Config) (ko
 	// add values from the filtered config
 	for _, group := range filteredConfig.Spec.Groups {
 		for _, item := range group.Items {
-			configValue := kotsv1beta1.ConfigValue{
-				Value:   item.Value.String(),
-				Default: item.Default.String(),
-			}
-			// override values from the config values store
-			if value, ok := storedValues[item.Name]; ok {
-				configValue.Value = value
-			}
-			kotsadmConfigValues.Spec.Values[item.Name] = configValue
+			kotsadmConfigValues.Spec.Values[item.Name] = getConfigValueFromItem(item, configValues)
 
-			for _, subItem := range item.Items {
-				subConfigValue := kotsv1beta1.ConfigValue{
-					Value:   subItem.Value.String(),
-					Default: subItem.Default.String(),
-				}
-				// override values from the config values store
-				if value, ok := storedValues[subItem.Name]; ok {
-					subConfigValue.Value = value
-				}
-				kotsadmConfigValues.Spec.Values[subItem.Name] = subConfigValue
+			for _, childItem := range item.Items {
+				kotsadmConfigValues.Spec.Values[childItem.Name] = getConfigValueFromChildItem(childItem, configValues)
 			}
 		}
 	}
 
 	return kotsadmConfigValues, nil
 }
 
+func getConfigValueFromItem(item kotsv1beta1.ConfigItem, configValues map[string]string) kotsv1beta1.ConfigValue {
+	configValue := kotsv1beta1.ConfigValue{
+		Value:   item.Value.String(),
+		Default: item.Default.String(),
+	}
+	// override values from the config values store
+	value, ok := configValues[item.Name]
+	if ok {
+		configValue.Value = value
+	}
+	return configValue
+}
+
+func getConfigValueFromChildItem(item kotsv1beta1.ConfigChildItem, configValues map[string]string) kotsv1beta1.ConfigValue {
+	configValue := kotsv1beta1.ConfigValue{
+		Value:   item.Value.String(),
+		Default: item.Default.String(),
+	}
+	// override values from the config values store
+	value, ok := configValues[item.Name]
+	if ok {
+		configValue.Value = value
+	}
+	return configValue
+}
+
 // filterAppConfig filters out disabled groups and items based on their 'when' condition
 func filterAppConfig(config kotsv1beta1.Config) (kotsv1beta1.Config, error) {
 	// deepcopy the config to avoid mutating the original config
@@ -129,3 +186,19 @@ func filterAppConfig(config kotsv1beta1.Config) (kotsv1beta1.Config, error) {
 func isItemEnabled(when multitype.QuotedBool) bool {
 	return when != "false"
 }
+
+func isRequiredItem(item kotsv1beta1.ConfigItem) bool {
+	if !item.Required {
+		return false
+	}
+	// TODO: should an item really not be required if it's hidden?
+	if item.Hidden || item.When == "false" {
+		return false
+	}
+	return true
+}
+
+func isUnsetItem(configValue kotsv1beta1.ConfigValue) bool {
+	// TODO: repeatable items
+	return configValue.Value == "" && configValue.Default == ""
+}