support: template --output-dir some_dir (#587)

* support: template --output-dir some_dir

* update docs for output-dir support

* go mod tidy

* whoops :)

* skip empty objects

* use yaml encoder to set indentation

* handle namespace; lowercase; .yaml in --output-dir

* .yaml everywhere

* more .yml -> .yaml :)

Author: intrand

cmd/root.go

@@ -39,7 +39,7 @@ var (
 	runAll bool
 	// dryRun contains the boolean flag to run as dry run
 	dryRun bool
-	// courseFile is the name and path of the course.yml file
+	// courseFile is the name and path of the course.yaml file
 	courseFile string
 	// onlyRun contains the list of releases to install
 	onlyRun []string
@@ -59,6 +59,8 @@ var (
 	importRepository string
 	// additionalHelmArgs is a list of arguments to add to all helm commands
 	additionalHelmArgs []string
+	// templateOutputDir
+	templateOutputDir string
 )
 
 func init() {
@@ -69,16 +71,19 @@ func init() {
 	rootCmd.PersistentFlags().BoolVar(&noColor, "no-color", false, "If true, don't colorize output.")
 	rootCmd.PersistentFlags().StringSliceVar(&additionalHelmArgs, "helm-args", nil, "Additional arguments to pass to helm commands. Can be passed multiple times. used more than once. WARNING: Setting this will completely override any helm_args in the course.")
 
-	plotCmd.PersistentFlags().BoolVar(&continueOnError, "continue-on-error", false, "If true, continue plotting releases even if one or more has errors.")
-	updateCmd.PersistentFlags().BoolVar(&continueOnError, "continue-on-error", false, "If true, continue plotting releases even if one or more has errors.")
-	diffCmd.PersistentFlags().BoolVar(&continueOnError, "continue-on-error", false, "If true, continue plotting releases even if one or more has errors.")
+	plotCmd.PersistentFlags().BoolVar(&continueOnError, "continue-on-error", false, "If true, continue to plot releases even if one or more has errors.")
+	updateCmd.PersistentFlags().BoolVar(&continueOnError, "continue-on-error", false, "If true, continue to update releases even if one or more has errors.")
+	diffCmd.PersistentFlags().BoolVar(&continueOnError, "continue-on-error", false, "If true, continue to diff releases even if one or more has errors.")
 
 	convertCmd.Flags().BoolVarP(&inPlaceConvert, "in-place", "i", false, "If specified, will update the file in place, otherwise outputs to stdout.")
 
 	importCmd.Flags().StringVar(&importNamespace, "namespace", "", "Namespace that contains the release to be imported.")
 	importCmd.Flags().StringVar(&importRelease, "release_name", "", "The name of the release to import.")
 	importCmd.Flags().StringVar(&importRepository, "repository", "", "The helm repository for the imported release.")
 
+	templateCmd.Flags().StringVar(&templateOutputDir, "output-dir", "", "path to the base output directory (eg, ~/myproject/manifests)")
+	// templateCmd.PersistentFlags().BoolVar(&continueOnError, "continue-on-error", false, "If true, continue to template releases even if one or more has errors.")
+
 	rootCmd.AddCommand(
 		plotCmd,
 		convertCmd,
@@ -164,12 +169,15 @@ var templateCmd = &cobra.Command{
 			color.Red(err.Error())
 			os.Exit(1)
 		}
-		tmpl, err := client.TemplateAll()
+		tmpl, err := client.TemplateAll(templateOutputDir)
 		if err != nil {
 			color.Red(err.Error())
 			os.Exit(1)
 		}
-		fmt.Println(tmpl)
+
+		if len(templateOutputDir) < 1 {
+			fmt.Println(tmpl)
+		}
 	},
 }
 
@@ -372,9 +380,9 @@ func getCourseFilePath(args []string) string {
 	courseFile = os.Getenv("RECKONER_COURSE_FILE") // environment variable override
 
 	// if the environment variable was unset or zero-length,
-	// try default value of 'course.yml'
+	// try default value of 'course.yaml'
 	if len(courseFile) == 0 {
-		courseFile = "course.yml" // default course file
+		courseFile = "course.yaml" // default course file
 	}
 
 	// allow cli argument to override everything else

cmd/root_test.go

@@ -29,17 +29,17 @@ func TestGetCourseFilePath(t *testing.T) {
 		{
 			name: "empty path, expect default",
 			path: []string{},
-			want: "course.yml",
+			want: "course.yaml",
 		},
 		{
-			name: "single course.yml specified, expect mirror",
-			path: []string{"testdata/course.yml"},
-			want: "testdata/course.yml",
+			name: "single course.yaml specified, expect mirror",
+			path: []string{"testdata/course.yaml"},
+			want: "testdata/course.yaml",
 		},
 		{
-			name: "multiple course.yml specified, expect first",
-			path: []string{"testdata/course.yml", "second_course.yml"},
-			want: "testdata/course.yml",
+			name: "multiple course.yaml specified, expect first",
+			path: []string{"testdata/course.yaml", "second_course.yaml"},
+			want: "testdata/course.yaml",
 		},
 	}
 	for _, tt := range tests {

cmd/testdata/course.yml cmd/testdata/course.yaml

@@ -54,7 +54,7 @@ func TestValidateArgs(t *testing.T) {
 				runAll:  false,
 				onlyRun: []string{"rbac-manager"},
 			},
-			want:    "testdata/course.yml",
+			want:    "testdata/course.yaml",
 			wantErr: false,
 		},
 		{
@@ -63,13 +63,13 @@ func TestValidateArgs(t *testing.T) {
 				args:   []string{},
 				runAll: true,
 			},
-			want:    "testdata/course.yml",
+			want:    "testdata/course.yaml",
 			wantErr: false,
 		},
 		{
 			name: "length of args = 2",
 			args: args{
-				args:    []string{"testdata/course.yml", "course.yml"},
+				args:    []string{"testdata/course.yaml", "course.yaml"},
 				runAll:  false,
 				onlyRun: []string{"rbac-manager"},
 			},
@@ -107,22 +107,22 @@ func TestValidateCourseFilePath(t *testing.T) {
 			wantErr: true,
 		},
 		{
-			name: "course.yml does not exist",
+			name: "course.yaml does not exist",
 			args: args{
-				args:   []string{"course.yml"},
+				args:   []string{"course.yaml"},
 				runAll: true,
 			},
 			want:    "",
 			wantErr: true,
 		},
 		{
-			name: "course.yml exists, pass onlyrun with success",
+			name: "course.yaml exists, pass onlyrun with success",
 			args: args{
-				args:    []string{"testdata/course.yml"},
+				args:    []string{"testdata/course.yaml"},
 				runAll:  false,
 				onlyRun: []string{"rbac-manager"},
 			},
-			want:    "testdata/course.yml",
+			want:    "testdata/course.yaml",
 			wantErr: false,
 		},
 	}

cmd/testdata/coursev2.yml cmd/testdata/coursev2.yaml

@@ -10,4 +10,4 @@ charts:
     repository: fairwinds-incubator
     chart: basic-demo
     files:
-      - subfolder/yaml_values.yml
+      - subfolder/yaml_values.yaml

cmd/validation_test.go

@@ -11,4 +11,4 @@ charts:
     chart: basic-demo
     hooks:
       pre_install:
-      - kubectl apply -f ../subfolder/relative_hook_namespace.yml
+      - kubectl apply -f ../subfolder/relative_hook_namespace.yaml

docs/README.md

@@ -1,7 +1,7 @@
 version: "2"
 name: Basic Functionality
 vars:
-  course: ../course_files/01_test_basic.yml
+  course: ../course_files/01_test_basic.yaml
   namespace: 01-infra
   release: first-chart
 testcases:

docs/usage.md

@@ -1,7 +1,7 @@
 version: "2"
 name: Namespace Creation
 vars:
-  course: ../course_files/02_test_create_namespace.yml
+  course: ../course_files/02_test_create_namespace.yaml
   namespace: 02-farglebargle
   release: namespace-test
 testcases:

end_to_end_testing/course_files/01_test_basic.yml end_to_end_testing/course_files/01_test_basic.yaml

@@ -1,7 +1,7 @@
 version: "2"
 name: Environment Variable Interpolation
 vars:
-  course: ../course_files/03_test_env_var.yml
+  course: ../course_files/03_test_env_var.yaml
   namespace: 03-infra
 testcases:
 - name: 03 - plot without var

end_to_end_testing/course_files/02_test_create_namespace.yml end_to_end_testing/course_files/02_test_create_namespace.yaml

@@ -1,7 +1,7 @@
 version: "2"
 name: Bad Chart
 vars:
-  course: ../course_files/04_test_failed_chart.yml
+  course: ../course_files/04_test_failed_chart.yaml
   namespace: 04-test
   release: bad-chart
 testcases:

end_to_end_testing/course_files/03_test_env_var.yml end_to_end_testing/course_files/03_test_env_var.yaml

@@ -1,7 +1,7 @@
 version: "2"
 name: Exit on Failed Post Install
 vars:
-  course: ../course_files/05_test_exit_on_post_install_hook.yml
+  course: ../course_files/05_test_exit_on_post_install_hook.yaml
   namespace: 05-infra
   release: basic-demo
 testcases:

end_to_end_testing/course_files/04_test_failed_chart.yml end_to_end_testing/course_files/04_test_failed_chart.yaml

@@ -1,7 +1,7 @@
 version: "2"
 name: Exit on Failed Pre Install
 vars:
-  course: ../course_files/06_test_exit_on_pre_install_hook.yml
+  course: ../course_files/06_test_exit_on_pre_install_hook.yaml
   namespace: 06-infra
   release: basic-demo
 testcases:

end_to_end_testing/course_files/05_test_exit_on_post_install_hook.yml end_to_end_testing/course_files/05_test_exit_on_post_install_hook.yaml

@@ -1,7 +1,7 @@
 version: "2"
 name: Successful Hooks
 vars:
-  course: ../course_files/07_test_good_hooks.yml
+  course: ../course_files/07_test_good_hooks.yaml
   namespace: 07-redis-test-namespace
   release: should-install
 testcases:

end_to_end_testing/course_files/06_test_exit_on_pre_install_hook.yml end_to_end_testing/course_files/06_test_exit_on_pre_install_hook.yaml

@@ -1,7 +1,7 @@
 version: "2"
 name: Multiple Charts in Multiple Namespaces
 vars:
-  course: ../course_files/08_test_multi_chart.yml
+  course: ../course_files/08_test_multi_chart.yaml
 testcases:
 - name: 08 - plot course
   steps:

end_to_end_testing/course_files/07_test_good_hooks.yml end_to_end_testing/course_files/07_test_good_hooks.yaml

@@ -1,7 +1,7 @@
 version: "2"
 name: One of Multiple Charts
 vars:
-  course: ../course_files/09_test_multi_chart.yml
+  course: ../course_files/09_test_multi_chart.yaml
 testcases:
 - name: 09 - plot course -o first-chart-09
   steps:

end_to_end_testing/course_files/08_test_multi_chart.yml end_to_end_testing/course_files/08_test_multi_chart.yaml

@@ -1,7 +1,7 @@
 version: "2"
 name: Charts from Git Repos
 vars:
-  course: ../course_files/10_test_git_chart.yml
+  course: ../course_files/10_test_git_chart.yaml
 testcases:
 - name: 10 - plot course
   steps:

end_to_end_testing/course_files/09_test_multi_chart.yml end_to_end_testing/course_files/09_test_multi_chart.yaml

@@ -1,7 +1,7 @@
 version: "2"
 name: Stop After First Failure
 vars:
-  course: ../course_files/11_test_after_first_failure.yml
+  course: ../course_files/11_test_after_first_failure.yaml
   namespace: 11-test
 testcases:
 - name: 11 - test stop after first failure