Merge pull request #219 from nkubala/test_flake

Sort maps before diffing to prevent flaky results

Author: nkubala

pkg/util/image_prep_utils.go

@@ -23,6 +23,7 @@ import (
 	"fmt"
 	"io/ioutil"
 	"os"
+	"sort"
 	"strings"
 
 	"github.com/GoogleCloudPlatform/container-diff/cmd/util/output"
@@ -99,9 +100,9 @@ func (c ConfigObject) AsList() []string {
 	return []string{
 		fmt.Sprintf("Env: %s", strings.Join(c.Env, ",")),
 		fmt.Sprintf("Entrypoint: %s", strings.Join(c.Entrypoint, ",")),
-		fmt.Sprintf("ExposedPorts: %v", c.ExposedPorts),
+		fmt.Sprintf("ExposedPorts: %v", sortMap(c.ExposedPorts)),
 		fmt.Sprintf("Cmd: %s", strings.Join(c.Cmd, ",")),
-		fmt.Sprintf("Volumes: %v", c.Volumes),
+		fmt.Sprintf("Volumes: %v", sortMap(c.Volumes)),
 		fmt.Sprintf("Workdir: %s", c.Workdir),
 		fmt.Sprintf("Labels: %v", c.Labels),
 	}
@@ -241,3 +242,12 @@ func CleanupImage(image Image) {
 		}
 	}
 }
+
+func sortMap(m map[string]struct{}) string {
+	pairs := make([]string, 0)
+	for key := range m {
+		pairs = append(pairs, fmt.Sprintf("%s:%s", key, m[key]))
+	}
+	sort.Strings(pairs)
+	return strings.Join(pairs, " ")
+}

tests/metadata_diff_expected.json

@@ -6,11 +6,11 @@
     "Diff": {
       "Adds": [
         "Entrypoint: /entrypoint",
-        "ExposedPorts: map[1234/tcp:{}]"
+        "ExposedPorts: 1234/tcp:{}"
       ],
       "Dels": [
         "Entrypoint: ",
-        "ExposedPorts: map[1234/tcp:{} 4321/tcp:{}]"
+        "ExposedPorts: 1234/tcp:{} 4321/tcp:{}"
       ]
     }
   }