Merge pull request #100 from onepanelio/feat/validating.params

feat: additional validation of parameters to prevent placeholders

Author: Vafilor

cmd/apply.go

@@ -75,7 +75,6 @@ var applyCmd = &cobra.Command{
 		resApp := ""
 		errResApp := ""
 
-
 		resApp, errResApp, err = applyKubernetesFile(applicationKubernetesYamlFilePath)
 		if err != nil {
 			yamlFile, yamlErr := util.LoadDynamicYamlFromFile(config.Spec.Params)

cmd/build.go

@@ -67,7 +67,7 @@ func init() {
 	generateCmd.Flags().BoolVarP(&Dev, "latest", "", false, "Sets conditions to allow development testing.")
 }
 
-// Given the path to the manifests, and a kustomize config, creates the final kustomization file.
+// GenerateKustomizeResult Given the path to the manifests, and a kustomize config, creates the final kustomization file.
 // It does this by copying the manifests into a temporary directory, inserting the kustomize template
 // and running the kustomize command
 func GenerateKustomizeResult(config opConfig.Config, kustomizeTemplate template.Kustomize) (string, error) {
@@ -640,11 +640,11 @@ func HumanizeKustomizeError(err error) string {
 		case "missing":
 			return fmt.Sprintf("%s is missing in your params.yaml", paramsError.Key)
 		case "parameter":
-			return fmt.Sprintf("%s can not be '%s', please enter a namespace", paramsError.Key, *paramsError.Value)
+			return fmt.Sprintf("%s can not be '%s', please enter a different value for %v. %v", paramsError.Key, *paramsError.Value, paramsError.ShortKey, paramsError.ValidationMessage)
 		case "blank":
-			return fmt.Sprintf("%s can not be blank, please use a different namespace in your params.yaml", paramsError.Key)
+			return fmt.Sprintf("%s can not be blank, please use a different %v in your params.yaml", paramsError.Key, paramsError.ShortKey)
 		case "reserved":
-			return fmt.Sprintf("%s can not be '%v' please use a different namespace in your params.yaml", paramsError.Key, *paramsError.Value)
+			return fmt.Sprintf("%s can not be '%v' please use a different %v in your params.yaml", paramsError.Key, *paramsError.Value, paramsError.ShortKey)
 		}
 	}
 

manifest/manifest.go

@@ -6,6 +6,8 @@ import (
 	"log"
 	"os"
 	"path/filepath"
+	"regexp"
+	"sort"
 	"strings"
 )
 
@@ -17,9 +19,11 @@ type Manifest struct {
 
 // ParamsError represents an error encountered in the params.yaml file
 type ParamsError struct {
-	Key       string
-	Value     *string
-	ErrorType string
+	Key               string // The full key, as in 'application.domain'
+	ShortKey          string // The short key, as in 'domain'
+	Value             *string
+	ErrorType         string
+	ValidationMessage string // empty space means none
 }
 
 // Error returns an error string indicating what key/value is invalid
@@ -130,16 +134,74 @@ func Validate(manifest *util.DynamicYaml) error {
 
 	defaultNamespace := manifest.GetValue("application.defaultNamespace")
 	if defaultNamespace == nil {
-		return &ParamsError{Key: "application.defaultNamespace", ErrorType: "missing"}
+		return &ParamsError{Key: "application.defaultNamespace", ShortKey: "defaultNamespace", ErrorType: "missing"}
 	}
 	if defaultNamespace.Value == "" {
-		return &ParamsError{Key: "application.defaultNamespace", ErrorType: "blank"}
+		return &ParamsError{Key: "application.defaultNamespace", ShortKey: "defaultNamespace", ErrorType: "blank"}
 	}
 	if defaultNamespace.Value == "<namespace>" {
-		return &ParamsError{Key: "application.defaultNamespace", Value: &defaultNamespace.Value, ErrorType: "parameter"}
+		return &ParamsError{
+			Key:               "application.defaultNamespace",
+			ShortKey:          "defaultNamespace",
+			Value:             &defaultNamespace.Value,
+			ErrorType:         "parameter",
+			ValidationMessage: "Namespace can not be <namespace> please provide a value like 'example'",
+		}
 	}
 	if _, ok := reservedNamespaces[defaultNamespace.Value]; ok {
-		return &ParamsError{Key: "application.defaultNamespace", Value: &defaultNamespace.Value, ErrorType: "reserved"}
+		return &ParamsError{Key: "application.defaultNamespace", ShortKey: "defaultNamespace", Value: &defaultNamespace.Value, ErrorType: "reserved"}
+	}
+
+	if len(defaultNamespace.Value) > 63 {
+		return &ParamsError{
+			Key:               "application.defaultNamespace",
+			ShortKey:          "defaultNamespace",
+			Value:             &defaultNamespace.Value,
+			ErrorType:         "parameter",
+			ValidationMessage: "Namespace must be less than 63 characters",
+		}
+	}
+
+	if strings.HasPrefix(defaultNamespace.Value, "kube-") {
+		return &ParamsError{
+			Key:               "application.defaultNamespace",
+			ShortKey:          "defaultNamespace",
+			Value:             &defaultNamespace.Value,
+			ErrorType:         "parameter",
+			ValidationMessage: "A namespace can not start with 'kube-'",
+		}
+	}
+
+	namespaceRegex := regexp.MustCompile(`^[a-z0-9]([-a-z0-9]*[a-z0-9])$`)
+	if !namespaceRegex.MatchString(defaultNamespace.Value) {
+		return &ParamsError{
+			Key:               "application.defaultNamespace",
+			ShortKey:          "defaultNamespace",
+			Value:             &defaultNamespace.Value,
+			ErrorType:         "parameter",
+			ValidationMessage: "A namespace can not start with 'kube-', must be lowercase, and can not start or end with dashes '-'",
+		}
+	}
+
+	flatMap := manifest.FlattenToKeyValue(util.AppendDotFlatMapKeyFormatter)
+	mapKeys := []string{}
+	for key := range flatMap {
+		mapKeys = append(mapKeys, key)
+	}
+	sort.Strings(mapKeys)
+
+	for _, key := range mapKeys {
+		value := flatMap[key]
+		valueString, ok := value.(string)
+		if !ok {
+			continue
+		}
+
+		if strings.HasPrefix(valueString, "<") {
+			lastDotIndex := strings.LastIndex(key, ".")
+			shortKey := key[lastDotIndex+1:]
+			return &ParamsError{Key: key, ShortKey: shortKey, Value: &valueString, ErrorType: "parameter"}
+		}
 	}
 
 	return nil

util/dynamic_yaml.go

@@ -729,6 +729,12 @@ func flattenMap(path string, keyFormatter FlatMapKeyFormatter, node *yaml.Node,
 		} else if childNode.Kind == yaml.MappingNode {
 			flattenMap(path, keyFormatter, childNode, results)
 			continue
+		} else if childNode.Kind == yaml.SequenceNode {
+			for i, sequenceNode := range childNode.Content {
+				newPath := keyFormatter(path, fmt.Sprintf("[%v]", i))
+				flattenMap(newPath, keyFormatter, sequenceNode, results)
+			}
+			continue
 		}
 	}
 }
@@ -763,4 +769,4 @@ func GetYamlStringValue(mapping map[string]interface{}, key string) (*string, er
 	result := strings.ToLower(valueString)
 
 	return &result, nil
-}
+}