Merge pull request #527 from ijc/sort-docker-app-inspect-output

inspect: sort services, networks, volumes and secrets by name

Author: silvin-lubecki

internal/inspect/inspect.go

@@ -34,28 +34,46 @@ func Inspect(out io.Writer, app *types.App, argParameters map[string]string, ima
 
 	// Add Service section
 	printSection(out, len(config.Services), func(w io.Writer) {
+		sort.Slice(config.Services, func(i, j int) bool {
+			return config.Services[i].Name < config.Services[j].Name
+		})
 		for _, service := range config.Services {
 			fmt.Fprintf(w, "%s\t%d\t%s\t%s\n", service.Name, getReplicas(service), getPorts(service.Ports), service.Image)
 		}
 	}, "Service", "Replicas", "Ports", "Image")
 
 	// Add Network section
 	printSection(out, len(config.Networks), func(w io.Writer) {
+		names := make([]string, 0, len(config.Networks))
 		for name := range config.Networks {
+			names = append(names, name)
+		}
+		sort.Strings(names)
+		for _, name := range names {
 			fmt.Fprintln(w, name)
 		}
 	}, "Network")
 
 	// Add Volume section
 	printSection(out, len(config.Volumes), func(w io.Writer) {
+		names := make([]string, 0, len(config.Volumes))
 		for name := range config.Volumes {
+			names = append(names, name)
+		}
+		sort.Strings(names)
+		for _, name := range names {
 			fmt.Fprintln(w, name)
 		}
 	}, "Volume")
 
 	// Add Secret section
 	printSection(out, len(config.Secrets), func(w io.Writer) {
+		names := make([]string, 0, len(config.Secrets))
 		for name := range config.Secrets {
+			names = append(names, name)
+		}
+		sort.Strings(names)
+		for _, name := range names {
 			fmt.Fprintln(w, name)
 		}
 	}, "Secret")

internal/inspect/inspect_test.go

@@ -67,19 +67,29 @@ name: myapp
 version: "3.1"
 
 services:
-  web:
+  web1:
     image: nginx:latest
     ports:
       - 8080-8100:12300-12320
     deploy:
       replicas: 2
+  web2:
+    image: nginx:latest
+    ports:
+      - 9080-9100:22300-22320
+    deploy:
+      replicas: 2
 networks:
-  my-network:
+  my-network1:
+  my-network2:
 volumes:
-  my-volume:
+  my-volume1:
+  my-volume2:
 secrets:
-  my-secret:
-    file: ./my_secret.txt
+  my-secret1:
+    file: ./my_secret1.txt
+  my-secret2:
+    file: ./my_secret2.txt
 `),
 			fs.WithFile(internal.MetadataFileName, `
 version: 0.1.0
@@ -107,12 +117,18 @@ text: hello`),
 		{name: "full"},
 	} {
 		t.Run(testcase.name, func(t *testing.T) {
-			outBuffer := new(bytes.Buffer)
 			app, err := types.NewAppFromDefaultFiles(dir.Join(testcase.name))
 			assert.NilError(t, err)
-			err = Inspect(outBuffer, app, testcase.args, nil)
-			assert.NilError(t, err)
-			golden.Assert(t, outBuffer.String(), fmt.Sprintf("inspect-%s.golden", testcase.name))
+			// Inspect twice to ensure output is stable (e.g. sorting of maps)
+			for i := 0; i < 2; i++ {
+				t.Run(fmt.Sprintf("%d", i), func(t *testing.T) {
+					outBuffer := new(bytes.Buffer)
+					err = Inspect(outBuffer, app, testcase.args, nil)
+					assert.NilError(t, err)
+					golden.Assert(t, outBuffer.String(), fmt.Sprintf("inspect-%s.golden", testcase.name))
+				})
+			}
+
 		})
 	}
 }

internal/inspect/testdata/inspect-full.golden

@@ -4,21 +4,25 @@ Maintained by: dev <dev@example.com>
 
 some description
 
-Service (1) Replicas Ports     Image
------------ -------- -----     -----
-web         2        8080-8100 nginx:latest
+Services (2) Replicas Ports     Image
+------------ -------- -----     -----
+web1         2        8080-8100 nginx:latest
+web2         2        9080-9100 nginx:latest
 
-Network (1)
------------
-my-network
+Networks (2)
+------------
+my-network1
+my-network2
 
-Volume (1)
-----------
-my-volume
+Volumes (2)
+-----------
+my-volume1
+my-volume2
 
-Secret (1)
-----------
-my-secret
+Secrets (2)
+-----------
+my-secret1
+my-secret2
 
 Parameters (2) Value
 -------------- -----