ref(cmd): export useful functions for vendoring

Author: Josh Newman

cmd/common.go

@@ -38,8 +38,8 @@ func getStringChunks(items []string, chunkSize int) (chunks [][]string) {
 	return append(chunks, items)
 }
 
-// sortParams sorts parameters by name.
-func sortParams(params []types.Parameter) {
+// sortParameters sorts parameters by name.
+func sortParameters(params []types.Parameter) {
 	sort.Slice(params, func(i, j int) bool {
 		return strings.ToLower(*params[i].Name) < strings.ToLower(*params[j].Name)
 	})

cmd/diff.go

@@ -50,10 +50,10 @@ func runDiffCmd(cmd *cobra.Command, args []string) {
 		Decrypt:   decrypt,
 	}
 
-	params1 := getParams(options, []types.Parameter{}, nil)
+	params1 := GetParameters(options, []types.Parameter{}, nil)
 
 	options.Path = &path2
-	params2 := getParams(options, []types.Parameter{}, nil)
+	params2 := GetParameters(options, []types.Parameter{}, nil)
 
 	tw := table.NewWriter()
 	tw.Style().Format.Header = text.FormatLower

cmd/get.go

@@ -31,30 +31,47 @@ func runGetCmd(cmd *cobra.Command, args []string) {
 
 	client := ssm.NewFromConfig(awsConfig)
 
-	out, err := client.GetParameter(context.TODO(), &ssm.GetParameterInput{
-		Name:           &path,
-		WithDecryption: decrypt,
+	val, err := GetParameter(&GetParameterOptions{
+		Client:  client,
+		Name:    path,
+		Decrypt: decrypt,
 	})
 	if err != nil {
 		panic(err)
 	}
 
-	val := *out.Parameter.Value
-
-	if strings.HasSuffix(val, "\n") {
-		val = strings.TrimSuffix(val, "\n")
-	}
-
 	if copy {
 		if err := clipboard.WriteAll(val); err != nil {
 			panic(err)
 		}
+
 		fmt.Println("Value copied to clipboard!")
 	} else {
 		fmt.Println(val)
 	}
 }
 
+// GetParameterOptions represents options for GetParameter
+type GetParameterOptions struct {
+	Client  *ssm.Client
+	Name    string
+	Decrypt bool
+}
+
+// GetParamter returns a parameter by name while removing any trailing new-line
+func GetParameter(options *GetParameterOptions) (string, error) {
+	out, err := options.Client.GetParameter(context.TODO(), &ssm.GetParameterInput{
+		Name:           &options.Name,
+		WithDecryption: options.Decrypt,
+	})
+	if err != nil {
+		return "", err
+	}
+
+	// return val, nil
+	return strings.TrimSuffix(*out.Parameter.Value, "\n"), nil
+}
+
 func init() {
 	getCmd.Flags().BoolP("decrypt", "d", true, "decrypt \"SecureString\" value")
 	getCmd.Flags().BoolP("copy", "c", false, "copy to clipboard")

cmd/ls.go

@@ -44,9 +44,7 @@ func runLsCmd(cmd *cobra.Command, args []string) {
 		Decrypt:   decrypt,
 	}
 
-	params := getParams(options, []types.Parameter{}, nil)
-
-	sortParams(params)
+	params := GetParameters(options, []types.Parameter{}, nil)
 
 	tw := table.NewWriter()
 
@@ -107,7 +105,7 @@ type getParamsOptions struct {
 	Decrypt   bool
 }
 
-func getParams(options *getParamsOptions, params []types.Parameter, nextToken *string) []types.Parameter {
+func GetParameters(options *getParamsOptions, params []types.Parameter, nextToken *string) []types.Parameter {
 	cfg := &ssm.GetParametersByPathInput{
 		Path:           options.Path,
 		Recursive:      options.Recursive,
@@ -124,21 +122,19 @@ func getParams(options *getParamsOptions, params []types.Parameter, nextToken *s
 	}
 
 	for i := 0; i < len(out.Parameters); i++ {
-		val := *out.Parameters[i].Value
+		val := strings.TrimSuffix(*out.Parameters[i].Value, "\n")
 
-		// seems like the upgrade to v2 of the aws-sdk sends back a new line on values :shrug:
-		if strings.HasSuffix(val, "\n") {
-			trimmed := strings.TrimSuffix(val, "\n")
-			out.Parameters[i].Value = &trimmed
-		}
+		out.Parameters[i].Value = &val
 	}
 
 	params = append(params, out.Parameters...)
 
 	if out.NextToken != nil {
-		return getParams(options, params, out.NextToken)
+		return GetParameters(options, params, out.NextToken)
 	}
 
+	sortParameters(params)
+
 	return params
 }
 

cmd/migrate.go

@@ -64,7 +64,7 @@ func runMigrateCmd(cmd *cobra.Command, args []string) {
 		Decrypt:   true,
 	}
 
-	params := getParams(options, []types.Parameter{}, nil)
+	params := GetParameters(options, []types.Parameter{}, nil)
 
 	fmt.Println(text.FgBlue.Sprintf("Found %d parameters to migrate...", len(params)))
 
@@ -104,7 +104,9 @@ func init() {
 	migrateCmd.Flags().StringP("region-to", "t", "", "the region to migrate to")
 	migrateCmd.Flags().Bool("overwrite", false, "overwrite destination params")
 
-	migrateCmd.MarkFlagRequired("region-from")
+	if err := migrateCmd.MarkFlagRequired("region-from"); err != nil {
+		panic(err)
+	}
 
 	rootCmd.AddCommand(migrateCmd)
 }

cmd/rm.go

@@ -42,15 +42,13 @@ func runRmCmd(cmd *cobra.Command, args []string) {
 			Decrypt:   false,
 		}
 
-		params := getParams(opts, []types.Parameter{}, nil)
+		params := GetParameters(opts, []types.Parameter{}, nil)
 
 		if len(params) == 0 {
 			fmt.Println("No parameters to delete at the specified path.")
 			os.Exit(0)
 		}
 
-		sortParams(params)
-
 		fmt.Println(text.FgYellow.Sprint("The following parameters will be removed..."))
 
 		for _, param := range params {