Add -spec flag to support specification file consisting of multiple d…

…esired state files state files, add priority override

docs/cmd_reference.md

@@ -77,6 +77,9 @@ This lists available CMD options in Helmsman:
   `--no-ssm-subst`
         turn off SSM parameter substitution globally.
 
+  `-spec string`
+        specification file name, contains locations of desired state files to be merged
+
   `--subst-ssm-values`
         turn on SSM parameter substitution in values files.
 

examples/example-spec.yaml

@@ -0,0 +1,6 @@
+---
+stateFiles:
+  - path: examples/example.yaml
+    priority: -10
+  - path: examples/minimal-example.yaml
+  - path: examples/minimal-example.toml

internal/app/cli.go

@@ -24,6 +24,29 @@ const (
 // Allow parsing of multiple string command line options into an array of strings
 type stringArray []string
 
+type fileOptionArray []fileOption
+
+type fileOption struct {
+	name     string
+	priority int
+}
+
+func (f *fileOptionArray) String() string {
+	var a []string
+	for _, v := range *f {
+		a = append(a, v.name)
+	}
+	return strings.Join(a, " ")
+}
+
+func (f *fileOptionArray) Set(value string) error {
+	var fo fileOption
+
+	fo.name = value
+	*f = append(*f, fo)
+	return nil
+}
+
 func (i *stringArray) String() string {
 	return strings.Join(*i, " ")
 }
@@ -35,7 +58,8 @@ func (i *stringArray) Set(value string) error {
 
 type cli struct {
 	debug                 bool
-	files                 stringArray
+	files                 fileOptionArray
+	spec                  string
 	envFiles              stringArray
 	target                stringArray
 	group                 stringArray
@@ -88,6 +112,7 @@ func (c *cli) parse() {
 	flag.Var(&c.group, "group", "limit execution to specific group of apps.")
 	flag.IntVar(&c.diffContext, "diff-context", -1, "number of lines of context to show around changes in helm diff output")
 	flag.IntVar(&c.parallel, "p", 1, "max number of concurrent helm releases to run")
+	flag.StringVar(&c.spec, "spec", "", "specification file name, contains locations of desired state files to be merged")
 	flag.StringVar(&c.kubeconfig, "kubeconfig", "", "path to the kubeconfig file to use for CLI requests")
 	flag.StringVar(&c.nsOverride, "ns-override", "", "override defined namespaces with this one")
 	flag.StringVar(&c.contextOverride, "context-override", "", "override releases context defined in release state with this one")
@@ -147,6 +172,10 @@ func (c *cli) parse() {
 		log.Fatal("--target and --group can't be used together.")
 	}
 
+	if len(flags.files) > 0 && len(flags.spec) > 0 {
+		log.Fatal("-f and -spec can't be used together.")
+	}
+
 	if c.parallel < 1 {
 		c.parallel = 1
 	}
@@ -159,7 +188,7 @@ func (c *cli) parse() {
 	kubectlVersion := getKubectlVersion()
 	log.Verbose("kubectl client version: " + kubectlVersion)
 
-	if len(c.files) == 0 {
+	if len(c.files) == 0 && len(c.spec) == 0 {
 		log.Info("No desired state files provided.")
 		os.Exit(0)
 	}
@@ -218,32 +247,51 @@ func (c *cli) readState(s *state) error {
 	os.RemoveAll(tempFilesDir)
 	_ = os.MkdirAll(tempFilesDir, 0o755)
 
+	if len(c.spec) > 0 {
+
+		sp := new(StateFiles)
+		sp.specFromYAML(c.spec)
+
+		for _, val := range sp.StateFiles {
+			fo := fileOption{}
+			fo.name = val.Path
+			fo.priority = val.Priority
+			checkSpecValid(fo.name)
+			c.files = append(c.files, fo)
+		}
+	}
+
 	// read the TOML/YAML desired state file
 	for _, f := range c.files {
 		var fileState state
 
-		if err := fileState.fromFile(f); err != nil {
+		if err := fileState.fromFile(f.name); err != nil {
 			return err
 		}
-		log.Infof("Parsed [[ %s ]] successfully and found [ %d ] apps", f, len(fileState.Apps))
+
+		if f.priority != 0 {
+			fileState.patchPriority(f.priority)
+		}
+
+		log.Infof("Parsed [[ %s ]] successfully and found [ %d ] apps", f.name, len(fileState.Apps))
 		// Merge Apps that already existed in the state
 		for appName, app := range fileState.Apps {
 			if _, ok := s.Apps[appName]; ok {
 				if err := mergo.Merge(s.Apps[appName], app, mergo.WithAppendSlice, mergo.WithOverride); err != nil {
-					return fmt.Errorf("failed to merge %s from desired state file %s: %w", appName, f, err)
+					return fmt.Errorf("failed to merge %s from desired state file %s: %w", appName, f.name, err)
 				}
 			}
 		}
 
 		// Merge the remaining Apps
 		if err := mergo.Merge(&s.Apps, &fileState.Apps); err != nil {
-			return fmt.Errorf("failed to merge desired state file %s: %w", f, err)
+			return fmt.Errorf("failed to merge desired state file %s: %w", f.name, err)
 		}
 		// All the apps are already merged, make fileState.Apps empty to avoid conflicts in the final merge
 		fileState.Apps = make(map[string]*release)
 
 		if err := mergo.Merge(s, &fileState, mergo.WithAppendSlice, mergo.WithOverride); err != nil {
-			return fmt.Errorf("failed to merge desired state file %s: %w", f, err)
+			return fmt.Errorf("failed to merge desired state file %s: %w", f.name, err)
 		}
 	}
 

internal/app/cli_test.go

@@ -22,7 +22,7 @@ func Test_readState(t *testing.T) {
 		{
 			name: "yaml minimal example; no validation",
 			flags: cli{
-				files:          stringArray([]string{"../../examples/minimal-example.yaml"}),
+				files:          fileOptionArray([]fileOption{fileOption{"../../examples/minimal-example.yaml", 0}}),
 				skipValidation: true,
 			},
 			want: result{
@@ -35,7 +35,7 @@ func Test_readState(t *testing.T) {
 		{
 			name: "toml minimal example; no validation",
 			flags: cli{
-				files:          stringArray([]string{"../../examples/minimal-example.toml"}),
+				files:          fileOptionArray([]fileOption{fileOption{"../../examples/minimal-example.toml", 0}}),
 				skipValidation: true,
 			},
 			want: result{
@@ -49,7 +49,7 @@ func Test_readState(t *testing.T) {
 			name: "yaml minimal example; no validation with bad target",
 			flags: cli{
 				target:         stringArray([]string{"foo"}),
-				files:          stringArray([]string{"../../examples/minimal-example.yaml"}),
+				files:          fileOptionArray([]fileOption{{"../../examples/minimal-example.yaml", 0}}),
 				skipValidation: true,
 			},
 			want: result{
@@ -63,7 +63,7 @@ func Test_readState(t *testing.T) {
 			name: "yaml minimal example; no validation; target jenkins",
 			flags: cli{
 				target:         stringArray([]string{"jenkins"}),
-				files:          stringArray([]string{"../../examples/minimal-example.yaml"}),
+				files:          fileOptionArray([]fileOption{{"../../examples/minimal-example.yaml", 0}}),
 				skipValidation: true,
 			},
 			want: result{
@@ -76,7 +76,7 @@ func Test_readState(t *testing.T) {
 		{
 			name: "yaml and toml minimal examples merged; no validation",
 			flags: cli{
-				files:          stringArray([]string{"../../examples/minimal-example.yaml", "../../examples/minimal-example.toml"}),
+				files:          fileOptionArray([]fileOption{{"../../examples/minimal-example.yaml", 0}, {"../../examples/minimal-example.toml", 0}}),
 				skipValidation: true,
 			},
 			want: result{

internal/app/spec_state.go

@@ -0,0 +1,52 @@
+package app
+
+import (
+	"io/ioutil"
+
+	"gopkg.in/yaml.v2"
+)
+
+type SpecConfig struct {
+	Path     string `yaml:"path"`
+	Priority int    `yaml:"priority"`
+}
+
+type StateFiles struct {
+	StateFiles []SpecConfig `yaml:"stateFiles"`
+}
+
+// fromYAML reads a yaml file and decodes it to a state type.
+// parser which throws an error if the YAML file is not valid.
+func (pc *StateFiles) specFromYAML(file string) error {
+	rawYamlFile, err := ioutil.ReadFile(file)
+	if err != nil {
+		log.Errorf("specFromYaml %v %v", file, err)
+		return err
+	}
+
+	yamlFile := string(rawYamlFile)
+
+	if err = yaml.UnmarshalStrict([]byte(yamlFile), pc); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func checkSpecValid(f string) error {
+	if err := isValidFile(f, []string{"yaml", "yml"}); err != nil {
+		// exit
+		return err
+	}
+
+	return nil
+}
+
+func (s *state) patchPriority(priority int) error {
+	for app, _ := range s.Apps {
+		if s.Apps[app].Priority > priority {
+			s.Apps[app].Priority = priority
+		}
+	}
+	return nil
+}

internal/app/spec_state_test.go

@@ -0,0 +1,50 @@
+package app
+
+import (
+	"testing"
+)
+
+func Test_specFromYAML(t *testing.T) {
+	type args struct {
+		file string
+		s    *StateFiles
+	}
+	tests := []struct {
+		name string
+		args args
+		want bool
+	}{
+		{
+			name: "test case 1 -- Valid YAML",
+			args: args{
+				file: "../../examples/example-spec.yaml",
+				s:    new(StateFiles),
+			},
+			want: true,
+		}, {
+			name: "test case 2 -- Invalid Yaml",
+			args: args{
+				file: "../../tests/Invalid_example_spec.yaml",
+				s:    new(StateFiles),
+			},
+			want: false,
+		},
+	}
+
+	teardownTestCase := setupStateFileTestCase(t)
+	defer teardownTestCase(t)
+	for _, tt := range tests {
+		// os.Args = append(os.Args, "-f ../../examples/example.yaml")
+		t.Run(tt.name, func(t *testing.T) {
+			err := tt.args.s.specFromYAML(tt.args.file)
+			if err != nil {
+				t.Log(err)
+			}
+
+			got := err == nil
+			if got != tt.want {
+				t.Errorf("specFromYaml() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}

tests/Invalid_example_spec.yaml

@@ -0,0 +1,4 @@
+---
+stateFiles:
+  name1: invalid/example.yaml
+  name2: invalid/minimal-example.yaml