fix(client-go,pkg): sort config and pretty-printed keys

Author: mboersma

client-go/cmd/config.go

@@ -6,6 +6,7 @@ import (
 	"io/ioutil"
 	"os"
 	"regexp"
+	"sort"
 	"strings"
 
 	"github.com/deis/deis/pkg/prettyprint"
@@ -28,9 +29,15 @@ func ConfigList(appID string, oneLine bool) error {
 		return err
 	}
 
+	var keys []string
+	for k := range config.Values {
+		keys = append(keys, k)
+	}
+	sort.Strings(keys)
+
 	if oneLine {
-		for key, value := range config.Values {
-			fmt.Printf("%s=%s ", key, value)
+		for _, key := range keys {
+			fmt.Printf("%s=%s ", key, config.Values[key])
 		}
 		fmt.Println()
 	} else {
@@ -39,11 +46,11 @@ func ConfigList(appID string, oneLine bool) error {
 		configMap := make(map[string]string)
 
 		// config.Values is type interface, so it needs to be converted to a string
-		for key, value := range config.Values {
-			configMap[key] = value.(string)
+		for _, key := range keys {
+			configMap[key] = config.Values[key].(string)
 		}
 
-		fmt.Print(prettyprint.PrettyTabs(configMap, 5))
+		fmt.Print(prettyprint.PrettyTabs(configMap, 6))
 	}
 
 	return nil

pkg/prettyprint/colorizer.go

@@ -4,6 +4,7 @@ package prettyprint
 import (
 	"bytes"
 	"fmt"
+	"sort"
 	"strings"
 	"text/template"
 )
@@ -174,24 +175,28 @@ func Overwritef(msg string, args ...interface{}) string {
 //
 // This will return a formatted string.
 // The previous example would return:
-// test     testing
 // foo      bar
+// test     testing
 func PrettyTabs(msg map[string]string, spaces int) string {
+	// find the longest key so we know how much padding to use
 	max := 0
-
 	for key := range msg {
 		if len(key) > max {
 			max = len(key)
 		}
 	}
-
 	max += spaces
 
-	var output string
-
-	for key, value := range msg {
-		output += fmt.Sprintf("%s%s%s\n", key, strings.Repeat(" ", max-len(key)), value)
+	// sort the map keys so we can print them alphabetically
+	var keys []string
+	for k := range msg {
+		keys = append(keys, k)
 	}
+	sort.Strings(keys)
 
+	var output string
+	for _, k := range keys {
+		output += fmt.Sprintf("%s%s%s\n", k, strings.Repeat(" ", max-len(k)), msg[k])
+	}
 	return output
 }

pkg/prettyprint/colorizer_test.go

@@ -37,6 +37,7 @@ func ExampleColorize() {
 	out := Colorize("{{.Red}}Hello {{.Default}}World{{.UnderGreen}}!{{.Default}}")
 	fmt.Println(out)
 }
+
 func ExampleColorizeVars() {
 	vars := map[string]string{"Who": "World"}
 	tpl := "{{.C.Red}}Hello {{.C.Default}}{{.V.Who}}!"
@@ -67,16 +68,13 @@ func TestPrettyTabs(t *testing.T) {
 		"foo":  "bar",
 	}
 
-	expected := `test testing
-foo  bar
-`
-	otherExpected := `foo  bar
+	expected := `foo  bar
 test testing
 `
 
 	output := PrettyTabs(test, 1)
 
-	if !(output == expected || output == otherExpected) {
+	if output != expected {
 		t.Errorf("Expected '%s', Got '%s'", expected, output)
 	}
 }