Print all the published ports using port ranges.

Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com>

Author: silvin-lubecki

internal/inspect/inspect.go

@@ -36,7 +36,7 @@ func Inspect(out io.Writer, app *types.App, argSettings map[string]string) error
 	// Add Service section
 	addSection(&sections, len(config.Services), func(w io.Writer) {
 		for _, service := range config.Services {
-			fmt.Fprintf(w, "%s\t%d\t%s\t%s\n", service.Name, getReplicas(service), getPorts(service), service.Image)
+			fmt.Fprintf(w, "%s\t%d\t%s\t%s\n", service.Name, getReplicas(service), getPorts(service.Ports), service.Image)
 		}
 	}, "Service", "Replicas", "Ports", "Image")
 
@@ -126,16 +126,6 @@ func getReplicas(service composetypes.ServiceConfig) int {
 	return 1
 }
 
-func getPorts(service composetypes.ServiceConfig) string {
-	var ports []string
-	for _, port := range service.Ports {
-		if port.Published > 0 {
-			ports = append(ports, fmt.Sprintf("%d", port.Published))
-		}
-	}
-	return strings.Join(ports, ",")
-}
-
 func extractSettings(app *types.App, argSettings map[string]string) ([]string, map[string]string, error) {
 	allSettings, err := mergeAndFlattenSettings(app, argSettings)
 	if err != nil {

internal/inspect/inspect_test.go

@@ -70,7 +70,7 @@ services:
   web:
     image: nginx:latest
     ports:
-      - 8080:80
+      - 8080-8100:12300-12320
     deploy:
       replicas: 2
 networks:

internal/inspect/ports.go

@@ -0,0 +1,71 @@
+package inspect
+
+import (
+	"fmt"
+	"sort"
+	"strings"
+
+	composetypes "github.com/docker/cli/cli/compose/types"
+)
+
+type portRange struct {
+	start uint32
+	end   *uint32
+}
+
+func newPort(start uint32) *portRange {
+	return &portRange{start: start}
+}
+
+func (p *portRange) add(end uint32) bool {
+	if p.end == nil {
+		if p.start+1 == end {
+			p.end = &end
+			return true
+		}
+		return false
+	}
+	if *p.end+1 == end {
+		p.end = &end
+		return true
+
+	}
+	return false
+}
+
+func (p portRange) String() string {
+	res := fmt.Sprintf("%d", p.start)
+	if p.end != nil {
+		res += fmt.Sprintf("-%d", *p.end)
+	}
+	return res
+}
+
+// getPorts identifies all the published port ranges, merges them
+// if they are consecutive, and return a string with all the published
+// ports.
+func getPorts(ports []composetypes.ServicePortConfig) string {
+	var (
+		portRanges    []*portRange
+		lastPortRange *portRange
+	)
+	sort.Slice(ports, func(i int, j int) bool { return ports[i].Published < ports[j].Published })
+	for _, port := range ports {
+		if port.Published > 0 {
+			if lastPortRange == nil {
+				lastPortRange = newPort(port.Published)
+			} else if !lastPortRange.add(port.Published) {
+				portRanges = append(portRanges, lastPortRange)
+				lastPortRange = newPort(port.Published)
+			}
+		}
+	}
+	if lastPortRange != nil {
+		portRanges = append(portRanges, lastPortRange)
+	}
+	output := make([]string, len(portRanges))
+	for i, p := range portRanges {
+		output[i] = p.String()
+	}
+	return strings.Join(output, ",")
+}

internal/inspect/ports_test.go

@@ -0,0 +1,76 @@
+package inspect
+
+import (
+	"testing"
+
+	composetypes "github.com/docker/cli/cli/compose/types"
+	"gotest.tools/assert"
+)
+
+func TestGetPorts(t *testing.T) {
+	for _, testcase := range []struct {
+		name     string
+		ports    []composetypes.ServicePortConfig
+		expected string
+	}{
+		{
+			name:     "no-published-ports",
+			ports:    []composetypes.ServicePortConfig{target(80)},
+			expected: "",
+		},
+		{
+			name:     "published-port",
+			ports:    []composetypes.ServicePortConfig{published(8080)},
+			expected: "8080",
+		},
+		{
+			name:     "mix-published-target-ports",
+			ports:    []composetypes.ServicePortConfig{published(8080), target(80), published(9090)},
+			expected: "8080,9090",
+		},
+		{
+			name:     "simple-range",
+			ports:    publishedRange(8080, 8085),
+			expected: "8080-8085",
+		},
+		{
+			name:     "complex-range",
+			ports:    append(append(publishedRange(8080, 8081), target(80), published(8082)), publishedRange(8083, 8090)...),
+			expected: "8080-8090",
+		},
+		{
+			name:     "multi-range",
+			ports:    append(append(publishedRange(8080, 8081), published(8083)), publishedRange(8085, 8086)...),
+			expected: "8080-8081,8083,8085-8086",
+		},
+		{
+			name:     "ports-are-sorted",
+			ports:    []composetypes.ServicePortConfig{published(8080), published(8082), published(7979), published(8081)},
+			expected: "7979,8080-8082",
+		},
+	} {
+		t.Run(testcase.name, func(t *testing.T) {
+			assert.Equal(t, getPorts(testcase.ports), testcase.expected)
+		})
+	}
+}
+
+func published(port uint32) composetypes.ServicePortConfig {
+	return composetypes.ServicePortConfig{
+		Published: port,
+	}
+}
+
+func target(port uint32) composetypes.ServicePortConfig {
+	return composetypes.ServicePortConfig{
+		Target: port,
+	}
+}
+
+func publishedRange(start, end uint32) []composetypes.ServicePortConfig {
+	var ports []composetypes.ServicePortConfig
+	for i := start; i <= end; i++ {
+		ports = append(ports, published(i))
+	}
+	return ports
+}

internal/inspect/testdata/inspect-full.golden

@@ -4,9 +4,9 @@ Maintained by: foo <foo@bar.com>
 
 this is sparta !
 
-Service Replicas Ports Image
-------- -------- ----- -----
-web     2        8080  nginx:latest
+Service Replicas Ports     Image
+------- -------- -----     -----
+web     2        8080-8100 nginx:latest
 
 Network
 -------