Refactor reading params into a separate module

AbhineetJain · AbhineetJain · commit dc805430cdf6 · 2022-05-19T04:57:58.000Z
diff --git a/cli/create.go b/cli/create.go
@@ -2,13 +2,11 @@ package cli
 
 import (
 	"fmt"
-	"os"
 	"time"
 
 	"github.com/spf13/cobra"
 	"golang.org/x/exp/slices"
 	"golang.org/x/xerrors"
-	"gopkg.in/yaml.v3"
 
 	"github.com/coder/coder/cli/cliflag"
 	"github.com/coder/coder/cli/cliui"
@@ -120,17 +118,10 @@ func create() *cobra.Command {
 				return err
 			}
 
-			parameterValues := make(map[string]string)
-
+			var parameterMap map[string]string
 			if parameterFile != "" {
-				parameterFileContents, err := os.ReadFile(parameterFile)
-
-				if err != nil {
-					return err
-				}
-
-				err = yaml.Unmarshal(parameterFileContents, &parameterValues)
-
+				_, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Paragraph.Render("Attempting to read the variables from the parameter file.")+"\r\n")
+				parameterMap, err = createParameterMapFromFile(parameterFile)
 				if err != nil {
 					return err
 				}
@@ -146,17 +137,7 @@ func create() *cobra.Command {
 					_, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Paragraph.Render("This template has customizable parameters. Values can be changed after create, but may have unintended side effects (like data loss).")+"\r\n")
 					disclaimerPrinted = true
 				}
-
-				var parameterValue string
-				if parameterFile != "" {
-					if parameterValues[parameterSchema.Name] == "" {
-						return xerrors.Errorf("Parameter value absent in parameter file for %q!", parameterSchema.Name)
-					}
-					parameterValue = parameterValues[parameterSchema.Name]
-				} else {
-					parameterValue, err = cliui.ParameterSchema(cmd, parameterSchema)
-				}
-
+				parameterValue, err := getParameterValueFromMapOrInput(cmd, parameterMap, parameterSchema)
 				if err != nil {
 					return err
 				}
diff --git a/cli/parameter.go b/cli/parameter.go
@@ -0,0 +1,56 @@
+package cli
+
+import (
+	"os"
+
+	"golang.org/x/xerrors"
+	"gopkg.in/yaml.v3"
+
+	"github.com/coder/coder/cli/cliui"
+	"github.com/coder/coder/codersdk"
+	"github.com/spf13/cobra"
+)
+
+// Reads a YAML file and populates a string -> string map.
+// Throws an error if the file name is empty.
+func createParameterMapFromFile(parameterFile string) (map[string]string, error) {
+	if parameterFile != "" {
+		parameterMap := make(map[string]string)
+
+		parameterFileContents, err := os.ReadFile(parameterFile)
+
+		if err != nil {
+			return nil, err
+		}
+
+		err = yaml.Unmarshal(parameterFileContents, &parameterMap)
+
+		if err != nil {
+			return nil, err
+		}
+
+		return parameterMap, nil
+	}
+
+	return nil, xerrors.Errorf("Parameter file name is not specified")
+}
+
+// Returns a parameter value from a given map, if the map exists, else takes input from the user.
+// Throws an error if the map exists but does not include a value for the parameter.
+func getParameterValueFromMapOrInput(cmd *cobra.Command, parameterMap map[string]string, parameterSchema codersdk.TemplateVersionParameterSchema) (string, error) {
+	var parameterValue string
+	if parameterMap != nil {
+		var ok bool
+		parameterValue, ok = parameterMap[parameterSchema.Name]
+		if !ok {
+			return "", xerrors.Errorf("Parameter value absent in parameter file for %q!", parameterSchema.Name)
+		}
+	} else {
+		var err error
+		parameterValue, err = cliui.ParameterSchema(cmd, parameterSchema)
+		if err != nil {
+			return "", err
+		}
+	}
+	return parameterValue, nil
+}
diff --git a/cli/templatecreate.go b/cli/templatecreate.go
@@ -11,7 +11,6 @@ import (
 	"github.com/briandowns/spinner"
 	"github.com/spf13/cobra"
 	"golang.org/x/xerrors"
-	"gopkg.in/yaml.v3"
 
 	"github.com/coder/coder/cli/cliui"
 	"github.com/coder/coder/coderd/database"
@@ -188,31 +187,16 @@ func createValidTemplateVersion(cmd *cobra.Command, client *codersdk.Client, org
 		}
 		_, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Paragraph.Render("This template has required variables! They are scoped to the template, and not viewable after being set.")+"\r\n")
 
-		parameterValuesFromFile := make(map[string]string)
+		var parameterMap map[string]string
 		if parameterFile != "" {
 			_, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Paragraph.Render("Attempting to read the variables from the parameter file.")+"\r\n")
-			parameterFileContents, err := os.ReadFile(parameterFile)
-
-			if err != nil {
-				return nil, nil, err
-			}
-
-			err = yaml.Unmarshal(parameterFileContents, &parameterValuesFromFile)
-
+			parameterMap, err = createParameterMapFromFile(parameterFile)
 			if err != nil {
 				return nil, nil, err
 			}
 		}
 		for _, parameterSchema := range missingSchemas {
-			var parameterValue string
-			if parameterFile != "" {
-				if parameterValuesFromFile[parameterSchema.Name] == "" {
-					return nil, nil, xerrors.Errorf("Required parameter value absent in parameter file for %q!", parameterSchema.Name)
-				}
-				parameterValue = parameterValuesFromFile[parameterSchema.Name]
-			} else {
-				parameterValue, err = cliui.ParameterSchema(cmd, parameterSchema)
-			}
+			parameterValue, err := getParameterValueFromMapOrInput(cmd, parameterMap, parameterSchema)
 			if err != nil {
 				return nil, nil, err
 			}
diff --git a/go.mod b/go.mod
@@ -120,6 +120,7 @@ require (
 	google.golang.org/protobuf v1.28.0
 	gopkg.in/DataDog/dd-trace-go.v1 v1.38.1
 	gopkg.in/natefinch/lumberjack.v2 v2.0.0
+	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
 	k8s.io/utils v0.0.0-20220210201930-3a6ce19ff2f9
 	nhooyr.io/websocket v1.8.7
 	storj.io/drpc v0.0.30
@@ -250,5 +251,4 @@ require (
 	gopkg.in/ini.v1 v1.62.0 // indirect
 	gopkg.in/square/go-jose.v2 v2.6.0 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
-	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
 )
