Implement printing published ports

cli/cmd/ps.go

@@ -9,6 +9,9 @@ import (
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 
+	"github.com/docker/docker/pkg/stringid"
+
+	"github.com/docker/api/cli/formatter"
 	"github.com/docker/api/client"
 )
 
@@ -50,11 +53,11 @@ func runPs(ctx context.Context, opts psOpts) error {
 		return nil
 	}
 
-	w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
-	fmt.Fprintf(w, "NAME\tIMAGE\tSTATUS\tCOMMAND\n")
-	format := "%s\t%s\t%s\t%s\n"
+	w := tabwriter.NewWriter(os.Stdout, 0, 0, 8, ' ', 0)
+	fmt.Fprintf(w, "CONTAINER ID\tIMAGE\tCOMMAND\tSTATUS\tPORTS\n")
+	format := "%s\t%s\t%s\t%s\t%s\n"
 	for _, c := range containers {
-		fmt.Fprintf(w, format, c.ID, c.Image, c.Status, c.Command)
+		fmt.Fprintf(w, format, stringid.TruncateID(c.ID), c.Image, c.Command, c.Status, formatter.PortsString(c.Ports))
 	}
 
 	return w.Flush()

cli/cmd/run/run.go

@@ -35,12 +35,13 @@ import (
 	"github.com/docker/docker/pkg/namesgenerator"
 	"github.com/spf13/cobra"
 
+	"github.com/docker/api/cli/options/run"
 	"github.com/docker/api/client"
 )
 
 // Command runs a container
 func Command() *cobra.Command {
-	var opts runOpts
+	var opts run.Opts
 	cmd := &cobra.Command{
 		Use:   "run",
 		Short: "Run a container",
@@ -50,19 +51,19 @@ func Command() *cobra.Command {
 		},
 	}
 
-	cmd.Flags().StringArrayVarP(&opts.publish, "publish", "p", []string{}, "Publish a container's port(s). [HOST_PORT:]CONTAINER_PORT")
-	cmd.Flags().StringVar(&opts.name, "name", getRandomName(), "Assign a name to the container")
+	cmd.Flags().StringArrayVarP(&opts.Publish, "publish", "p", []string{}, "Publish a container's port(s). [HOST_PORT:]CONTAINER_PORT")
+	cmd.Flags().StringVar(&opts.Name, "name", getRandomName(), "Assign a name to the container")
 
 	return cmd
 }
 
-func runRun(ctx context.Context, image string, opts runOpts) error {
+func runRun(ctx context.Context, image string, opts run.Opts) error {
 	c, err := client.New(ctx)
 	if err != nil {
 		return err
 	}
 
-	project, err := opts.toContainerConfig(image)
+	project, err := opts.ToContainerConfig(image)
 	if err != nil {
 		return err
 	}
@@ -70,7 +71,8 @@ func runRun(ctx context.Context, image string, opts runOpts) error {
 	if err = c.ContainerService().Run(ctx, project); err != nil {
 		return err
 	}
-	fmt.Println(opts.name)
+	fmt.Println(opts.Name)
+
 	return nil
 
 }

cli/cmd/testdata/ps-out.golden

@@ -1,3 +1,3 @@
-NAME  IMAGE   STATUS  COMMAND
-id    nginx           
-1234  alpine          
+CONTAINER ID        IMAGE         COMMAND        STATUS        PORTS
+id                  nginx                                      
+1234                alpine                                     

cli/formatter/container.go

@@ -0,0 +1,108 @@
+package formatter
+
+import (
+	"fmt"
+	"sort"
+	"strconv"
+	"strings"
+
+	"github.com/docker/api/containers"
+)
+
+type portGroup struct {
+	first uint32
+	last  uint32
+}
+
+// PortsString returns a human readable published ports
+func PortsString(ports []containers.Port) string {
+	groupMap := make(map[string]*portGroup)
+	var result []string
+	var hostMappings []string
+	var groupMapKeys []string
+
+	sort.Slice(ports, func(i int, j int) bool {
+		return comparePorts(ports[i], ports[j])
+	})
+
+	for _, port := range ports {
+		// Simple case: HOST_IP:PORT1:PORT2
+		hostIP := "0.0.0.0"
+		if port.HostIP != "" {
+			hostIP = port.HostIP
+		}
+
+		if port.HostPort != port.ContainerPort {
+			hostMappings = append(hostMappings, fmt.Sprintf("%s:%d->%d/%s", hostIP, port.HostPort, port.ContainerPort, port.Protocol))
+			continue
+		}
+
+		current := port.ContainerPort
+		portKey := fmt.Sprintf("%s/%s", hostIP, port.Protocol)
+		group := groupMap[portKey]
+
+		if group == nil {
+			groupMap[portKey] = &portGroup{first: current, last: current}
+			// record order that groupMap keys are created
+			groupMapKeys = append(groupMapKeys, portKey)
+			continue
+		}
+
+		if current == (group.last + 1) {
+			group.last = current
+			continue
+		}
+
+		result = append(result, formGroup(portKey, group.first, group.last))
+		groupMap[portKey] = &portGroup{first: current, last: current}
+	}
+
+	for _, portKey := range groupMapKeys {
+		g := groupMap[portKey]
+		result = append(result, formGroup(portKey, g.first, g.last))
+	}
+
+	result = append(result, hostMappings...)
+
+	return strings.Join(result, ", ")
+}
+
+func formGroup(key string, start uint32, last uint32) string {
+	parts := strings.Split(key, "/")
+	protocol := parts[0]
+	var ip string
+	if len(parts) > 1 {
+		ip = parts[0]
+		protocol = parts[1]
+	}
+	group := strconv.Itoa(int(start))
+
+	// add range
+	if start != last {
+		group = fmt.Sprintf("%s-%d", group, last)
+	}
+
+	// add host ip
+	if ip != "" {
+		group = fmt.Sprintf("%s:%s->%s", ip, group, group)
+	}
+
+	// add protocol
+	return fmt.Sprintf("%s/%s", group, protocol)
+}
+
+func comparePorts(i containers.Port, j containers.Port) bool {
+	if i.ContainerPort != j.ContainerPort {
+		return i.ContainerPort < j.ContainerPort
+	}
+
+	if i.HostIP != j.HostIP {
+		return i.HostIP < j.HostIP
+	}
+
+	if i.HostPort != j.HostPort {
+		return i.HostPort < j.HostPort
+	}
+
+	return i.Protocol < j.Protocol
+}

cli/formatter/container_test.go

@@ -0,0 +1,62 @@
+package formatter
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"gotest.tools/v3/assert"
+
+	"github.com/docker/api/cli/options/run"
+)
+
+func TestDisplayPorts(t *testing.T) {
+	testCases := []struct {
+		name     string
+		in       []string
+		expected string
+	}{
+		{
+			name:     "simple",
+			in:       []string{"80"},
+			expected: "0.0.0.0:80->80/tcp",
+		},
+		{
+			name:     "different ports",
+			in:       []string{"80:90"},
+			expected: "0.0.0.0:80->90/tcp",
+		},
+		{
+			name:     "host ip",
+			in:       []string{"192.168.0.1:80:90"},
+			expected: "192.168.0.1:80->90/tcp",
+		},
+		{
+			name:     "port range",
+			in:       []string{"80-90:80-90"},
+			expected: "0.0.0.0:80-90->80-90/tcp",
+		},
+		{
+			name:     "grouping",
+			in:       []string{"80:80", "81:81"},
+			expected: "0.0.0.0:80-81->80-81/tcp",
+		},
+		{
+			name:     "groups",
+			in:       []string{"80:80", "82:82"},
+			expected: "0.0.0.0:80->80/tcp, 0.0.0.0:82->82/tcp",
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.name, func(t *testing.T) {
+			runOpts := run.Opts{
+				Publish: testCase.in,
+			}
+			containerConfig, err := runOpts.ToContainerConfig("test")
+			require.Nil(t, err)
+
+			out := PortsString(containerConfig.Ports)
+			assert.Equal(t, testCase.expected, out)
+		})
+	}
+}

cli/options/run/opts.go

@@ -8,13 +8,28 @@ import (
 	"github.com/docker/api/containers"
 )
 
-type runOpts struct {
-	name    string
-	publish []string
+// Opts contain run command options
+type Opts struct {
+	Name    string
+	Publish []string
 }
 
-func toPorts(ports []string) ([]containers.Port, error) {
-	_, bindings, err := nat.ParsePortSpecs(ports)
+// ToContainerConfig convert run options to a container configuration
+func (r *Opts) ToContainerConfig(image string) (containers.ContainerConfig, error) {
+	publish, err := r.toPorts()
+	if err != nil {
+		return containers.ContainerConfig{}, err
+	}
+
+	return containers.ContainerConfig{
+		ID:    r.Name,
+		Image: image,
+		Ports: publish,
+	}, nil
+}
+
+func (r *Opts) toPorts() ([]containers.Port, error) {
+	_, bindings, err := nat.ParsePortSpecs(r.Publish)
 	if err != nil {
 		return nil, err
 	}
@@ -44,16 +59,3 @@ func toPorts(ports []string) ([]containers.Port, error) {
 
 	return result, nil
 }
-
-func (r *runOpts) toContainerConfig(image string) (containers.ContainerConfig, error) {
-	publish, err := toPorts(r.publish)
-	if err != nil {
-		return containers.ContainerConfig{}, err
-	}
-
-	return containers.ContainerConfig{
-		ID:    r.name,
-		Image: image,
-		Ports: publish,
-	}, nil
-}

cli/options/run/opts_test.go

@@ -88,7 +88,10 @@ func (s *RunOptsSuite) TestPortParse() {
 	}
 
 	for _, testCase := range testCases {
-		result, err := toPorts([]string{testCase.in})
+		opts := Opts{
+			Publish: []string{testCase.in},
+		}
+		result, err := opts.toPorts()
 		require.Nil(s.T(), err)
 		assert.ElementsMatch(s.T(), testCase.expected, result)
 	}