integration-cli/docker_cli_port_test.go
4e340ced
 package main
 
 import (
7b9ae696
 	"fmt"
68c7d24a
 	"net"
7b9ae696
 	"regexp"
4e340ced
 	"sort"
dc6ddfa8
 	"strconv"
4e340ced
 	"strings"
dc944ea7
 
33968e6c
 	"github.com/docker/docker/integration-cli/checker"
dc944ea7
 	"github.com/go-check/check"
4e340ced
 )
 
dc944ea7
 func (s *DockerSuite) TestPortList(c *check.C) {
f9a3558a
 	testRequires(c, DaemonIsLinux)
4e340ced
 	// one port
5c295460
 	out, _ := dockerCmd(c, "run", "-d", "-p", "9876:80", "busybox", "top")
475c6531
 	firstID := strings.TrimSpace(out)
4e340ced
 
5c295460
 	out, _ = dockerCmd(c, "port", firstID, "80")
4e340ced
 
1ae4eeb8
 	err := assertPortList(c, out, []string{"0.0.0.0:9876"})
 	// Port list is not correct
 	c.Assert(err, checker.IsNil)
4e340ced
 
5c295460
 	out, _ = dockerCmd(c, "port", firstID)
4e340ced
 
1ae4eeb8
 	err = assertPortList(c, out, []string{"80/tcp -> 0.0.0.0:9876"})
 	// Port list is not correct
 	c.Assert(err, checker.IsNil)
 
5c295460
 	dockerCmd(c, "rm", "-f", firstID)
4e340ced
 
 	// three port
5c295460
 	out, _ = dockerCmd(c, "run", "-d",
4e340ced
 		"-p", "9876:80",
 		"-p", "9877:81",
 		"-p", "9878:82",
 		"busybox", "top")
475c6531
 	ID := strings.TrimSpace(out)
4e340ced
 
5c295460
 	out, _ = dockerCmd(c, "port", ID, "80")
4e340ced
 
1ae4eeb8
 	err = assertPortList(c, out, []string{"0.0.0.0:9876"})
 	// Port list is not correct
 	c.Assert(err, checker.IsNil)
4e340ced
 
5c295460
 	out, _ = dockerCmd(c, "port", ID)
4e340ced
 
1ae4eeb8
 	err = assertPortList(c, out, []string{
4e340ced
 		"80/tcp -> 0.0.0.0:9876",
 		"81/tcp -> 0.0.0.0:9877",
1ae4eeb8
 		"82/tcp -> 0.0.0.0:9878"})
 	// Port list is not correct
 	c.Assert(err, checker.IsNil)
 
5c295460
 	dockerCmd(c, "rm", "-f", ID)
4e340ced
 
 	// more and one port mapped to the same container port
5c295460
 	out, _ = dockerCmd(c, "run", "-d",
4e340ced
 		"-p", "9876:80",
 		"-p", "9999:80",
 		"-p", "9877:81",
 		"-p", "9878:82",
 		"busybox", "top")
475c6531
 	ID = strings.TrimSpace(out)
4e340ced
 
5c295460
 	out, _ = dockerCmd(c, "port", ID, "80")
4e340ced
 
1ae4eeb8
 	err = assertPortList(c, out, []string{"0.0.0.0:9876", "0.0.0.0:9999"})
 	// Port list is not correct
 	c.Assert(err, checker.IsNil)
4e340ced
 
5c295460
 	out, _ = dockerCmd(c, "port", ID)
4e340ced
 
1ae4eeb8
 	err = assertPortList(c, out, []string{
4e340ced
 		"80/tcp -> 0.0.0.0:9876",
 		"80/tcp -> 0.0.0.0:9999",
 		"81/tcp -> 0.0.0.0:9877",
1ae4eeb8
 		"82/tcp -> 0.0.0.0:9878"})
 	// Port list is not correct
 	c.Assert(err, checker.IsNil)
5c295460
 	dockerCmd(c, "rm", "-f", ID)
4e340ced
 
47272f9c
 	testRange := func() {
 		// host port ranges used
 		IDs := make([]string, 3)
 		for i := 0; i < 3; i++ {
 			out, _ = dockerCmd(c, "run", "-d",
 				"-p", "9090-9092:80",
 				"busybox", "top")
 			IDs[i] = strings.TrimSpace(out)
 
 			out, _ = dockerCmd(c, "port", IDs[i])
 
1ae4eeb8
 			err = assertPortList(c, out, []string{fmt.Sprintf("80/tcp -> 0.0.0.0:%d", 9090+i)})
 			// Port list is not correct
 			c.Assert(err, checker.IsNil)
47272f9c
 		}
 
 		// test port range exhaustion
1ae4eeb8
 		out, _, err = dockerCmdWithError("run", "-d",
47272f9c
 			"-p", "9090-9092:80",
 			"busybox", "top")
1ae4eeb8
 		// Exhausted port range did not return an error
 		c.Assert(err, checker.NotNil, check.Commentf("out: %s", out))
47272f9c
 
 		for i := 0; i < 3; i++ {
 			dockerCmd(c, "rm", "-f", IDs[i])
 		}
 	}
 	testRange()
 	// Verify we ran re-use port ranges after they are no longer in use.
 	testRange()
 
 	// test invalid port ranges
 	for _, invalidRange := range []string{"9090-9089:80", "9090-:80", "-9090:80"} {
1ae4eeb8
 		out, _, err = dockerCmdWithError("run", "-d",
47272f9c
 			"-p", invalidRange,
 			"busybox", "top")
1ae4eeb8
 		// Port range should have returned an error
 		c.Assert(err, checker.NotNil, check.Commentf("out: %s", out))
47272f9c
 	}
 
 	// test host range:container range spec.
 	out, _ = dockerCmd(c, "run", "-d",
 		"-p", "9800-9803:80-83",
 		"busybox", "top")
 	ID = strings.TrimSpace(out)
 
 	out, _ = dockerCmd(c, "port", ID)
 
1ae4eeb8
 	err = assertPortList(c, out, []string{
47272f9c
 		"80/tcp -> 0.0.0.0:9800",
 		"81/tcp -> 0.0.0.0:9801",
 		"82/tcp -> 0.0.0.0:9802",
1ae4eeb8
 		"83/tcp -> 0.0.0.0:9803"})
 	// Port list is not correct
 	c.Assert(err, checker.IsNil)
47272f9c
 	dockerCmd(c, "rm", "-f", ID)
 
 	// test mixing protocols in same port range
 	out, _ = dockerCmd(c, "run", "-d",
 		"-p", "8000-8080:80",
 		"-p", "8000-8080:80/udp",
 		"busybox", "top")
 	ID = strings.TrimSpace(out)
 
 	out, _ = dockerCmd(c, "port", ID)
 
86f9eb4a
 	// Running this test multiple times causes the TCP port to increment.
dc6ddfa8
 	err = assertPortRange(c, out, []int{8000, 8080}, []int{8000, 8080})
1ae4eeb8
 	// Port list is not correct
 	c.Assert(err, checker.IsNil)
47272f9c
 	dockerCmd(c, "rm", "-f", ID)
4e340ced
 }
 
1ae4eeb8
 func assertPortList(c *check.C, out string, expected []string) error {
4e340ced
 	lines := strings.Split(strings.Trim(out, "\n "), "\n")
 	if len(lines) != len(expected) {
1ae4eeb8
 		return fmt.Errorf("different size lists %s, %d, %d", out, len(lines), len(expected))
4e340ced
 	}
 	sort.Strings(lines)
 	sort.Strings(expected)
 
 	for i := 0; i < len(expected); i++ {
 		if lines[i] != expected[i] {
1ae4eeb8
 			return fmt.Errorf("|" + lines[i] + "!=" + expected[i] + "|")
4e340ced
 		}
 	}
 
1ae4eeb8
 	return nil
4e340ced
 }
448a1a71
 
dc6ddfa8
 func assertPortRange(c *check.C, out string, expectedTcp, expectedUdp []int) error {
 	lines := strings.Split(strings.Trim(out, "\n "), "\n")
 
 	var validTcp, validUdp bool
 	for _, l := range lines {
 		// 80/tcp -> 0.0.0.0:8015
 		port, err := strconv.Atoi(strings.Split(l, ":")[1])
 		if err != nil {
 			return err
 		}
 		if strings.Contains(l, "tcp") && expectedTcp != nil {
 			if port < expectedTcp[0] || port > expectedTcp[1] {
 				return fmt.Errorf("tcp port (%d) not in range expected range %d-%d", port, expectedTcp[0], expectedTcp[1])
 			}
 			validTcp = true
 		}
 		if strings.Contains(l, "udp") && expectedUdp != nil {
 			if port < expectedUdp[0] || port > expectedUdp[1] {
 				return fmt.Errorf("udp port (%d) not in range expected range %d-%d", port, expectedUdp[0], expectedUdp[1])
 			}
 			validUdp = true
 		}
 	}
 	if !validTcp {
 		return fmt.Errorf("tcp port not found")
 	}
 	if !validUdp {
 		return fmt.Errorf("udp port not found")
 	}
 	return nil
 }
 
7b9ae696
 func stopRemoveContainer(id string, c *check.C) {
5c295460
 	dockerCmd(c, "rm", "-f", id)
7b9ae696
 }
 
 func (s *DockerSuite) TestUnpublishedPortsInPsOutput(c *check.C) {
f9a3558a
 	testRequires(c, DaemonIsLinux)
7b9ae696
 	// Run busybox with command line expose (equivalent to EXPOSE in image's Dockerfile) for the following ports
 	port1 := 80
 	port2 := 443
 	expose1 := fmt.Sprintf("--expose=%d", port1)
 	expose2 := fmt.Sprintf("--expose=%d", port2)
5c295460
 	dockerCmd(c, "run", "-d", expose1, expose2, "busybox", "sleep", "5")
7b9ae696
 
 	// Check docker ps o/p for last created container reports the unpublished ports
 	unpPort1 := fmt.Sprintf("%d/tcp", port1)
 	unpPort2 := fmt.Sprintf("%d/tcp", port2)
5c295460
 	out, _ := dockerCmd(c, "ps", "-n=1")
1ae4eeb8
 	// Missing unpublished ports in docker ps output
 	c.Assert(out, checker.Contains, unpPort1)
 	// Missing unpublished ports in docker ps output
 	c.Assert(out, checker.Contains, unpPort2)
7b9ae696
 
 	// Run the container forcing to publish the exposed ports
5c295460
 	dockerCmd(c, "run", "-d", "-P", expose1, expose2, "busybox", "sleep", "5")
7b9ae696
 
 	// Check docker ps o/p for last created container reports the exposed ports in the port bindings
 	expBndRegx1 := regexp.MustCompile(`0.0.0.0:\d\d\d\d\d->` + unpPort1)
 	expBndRegx2 := regexp.MustCompile(`0.0.0.0:\d\d\d\d\d->` + unpPort2)
5c295460
 	out, _ = dockerCmd(c, "ps", "-n=1")
1ae4eeb8
 	// Cannot find expected port binding port (0.0.0.0:xxxxx->unpPort1) in docker ps output
 	c.Assert(expBndRegx1.MatchString(out), checker.Equals, true, check.Commentf("out: %s; unpPort1: %s", out, unpPort1))
 	// Cannot find expected port binding port (0.0.0.0:xxxxx->unpPort2) in docker ps output
 	c.Assert(expBndRegx2.MatchString(out), checker.Equals, true, check.Commentf("out: %s; unpPort2: %s", out, unpPort2))
7b9ae696
 
 	// Run the container specifying explicit port bindings for the exposed ports
 	offset := 10000
 	pFlag1 := fmt.Sprintf("%d:%d", offset+port1, port1)
 	pFlag2 := fmt.Sprintf("%d:%d", offset+port2, port2)
5c295460
 	out, _ = dockerCmd(c, "run", "-d", "-p", pFlag1, "-p", pFlag2, expose1, expose2, "busybox", "sleep", "5")
7b9ae696
 	id := strings.TrimSpace(out)
 
 	// Check docker ps o/p for last created container reports the specified port mappings
 	expBnd1 := fmt.Sprintf("0.0.0.0:%d->%s", offset+port1, unpPort1)
 	expBnd2 := fmt.Sprintf("0.0.0.0:%d->%s", offset+port2, unpPort2)
5c295460
 	out, _ = dockerCmd(c, "ps", "-n=1")
1ae4eeb8
 	// Cannot find expected port binding (expBnd1) in docker ps output
 	c.Assert(out, checker.Contains, expBnd1)
 	// Cannot find expected port binding (expBnd2) in docker ps output
 	c.Assert(out, checker.Contains, expBnd2)
 
927b334e
 	// Remove container now otherwise it will interfere with next test
7b9ae696
 	stopRemoveContainer(id, c)
 
 	// Run the container with explicit port bindings and no exposed ports
5c295460
 	out, _ = dockerCmd(c, "run", "-d", "-p", pFlag1, "-p", pFlag2, "busybox", "sleep", "5")
7b9ae696
 	id = strings.TrimSpace(out)
 
 	// Check docker ps o/p for last created container reports the specified port mappings
5c295460
 	out, _ = dockerCmd(c, "ps", "-n=1")
1ae4eeb8
 	// Cannot find expected port binding (expBnd1) in docker ps output
 	c.Assert(out, checker.Contains, expBnd1)
 	// Cannot find expected port binding (expBnd2) in docker ps output
 	c.Assert(out, checker.Contains, expBnd2)
927b334e
 	// Remove container now otherwise it will interfere with next test
7b9ae696
 	stopRemoveContainer(id, c)
 
 	// Run the container with one unpublished exposed port and one explicit port binding
5c295460
 	dockerCmd(c, "run", "-d", expose1, "-p", pFlag2, "busybox", "sleep", "5")
7b9ae696
 
 	// Check docker ps o/p for last created container reports the specified unpublished port and port mapping
5c295460
 	out, _ = dockerCmd(c, "ps", "-n=1")
1ae4eeb8
 	// Missing unpublished exposed ports (unpPort1) in docker ps output
 	c.Assert(out, checker.Contains, unpPort1)
 	// Missing port binding (expBnd2) in docker ps output
 	c.Assert(out, checker.Contains, expBnd2)
7b9ae696
 }
68c7d24a
 
 func (s *DockerSuite) TestPortHostBinding(c *check.C) {
ea3afdad
 	testRequires(c, DaemonIsLinux, NotUserNamespace)
68c7d24a
 	out, _ := dockerCmd(c, "run", "-d", "-p", "9876:80", "busybox",
 		"nc", "-l", "-p", "80")
 	firstID := strings.TrimSpace(out)
 
 	out, _ = dockerCmd(c, "port", firstID, "80")
 
1ae4eeb8
 	err := assertPortList(c, out, []string{"0.0.0.0:9876"})
 	// Port list is not correct
 	c.Assert(err, checker.IsNil)
68c7d24a
 
 	dockerCmd(c, "run", "--net=host", "busybox",
 		"nc", "localhost", "9876")
 
 	dockerCmd(c, "rm", "-f", firstID)
 
1ae4eeb8
 	out, _, err = dockerCmdWithError("run", "--net=host", "busybox", "nc", "localhost", "9876")
 	// Port is still bound after the Container is removed
 	c.Assert(err, checker.NotNil, check.Commentf("out: %s", out))
68c7d24a
 }
 
 func (s *DockerSuite) TestPortExposeHostBinding(c *check.C) {
ea3afdad
 	testRequires(c, DaemonIsLinux, NotUserNamespace)
68c7d24a
 	out, _ := dockerCmd(c, "run", "-d", "-P", "--expose", "80", "busybox",
 		"nc", "-l", "-p", "80")
 	firstID := strings.TrimSpace(out)
 
 	out, _ = dockerCmd(c, "port", firstID, "80")
 
 	_, exposedPort, err := net.SplitHostPort(out)
1ae4eeb8
 	c.Assert(err, checker.IsNil, check.Commentf("out: %s", out))
68c7d24a
 
 	dockerCmd(c, "run", "--net=host", "busybox",
 		"nc", "localhost", strings.TrimSpace(exposedPort))
 
 	dockerCmd(c, "rm", "-f", firstID)
 
1ae4eeb8
 	out, _, err = dockerCmdWithError("run", "--net=host", "busybox",
 		"nc", "localhost", strings.TrimSpace(exposedPort))
 	// Port is still bound after the Container is removed
 	c.Assert(err, checker.NotNil, check.Commentf("out: %s", out))
68c7d24a
 }
e38463b2
 
 func (s *DockerSuite) TestPortBindingOnSandbox(c *check.C) {
 	testRequires(c, DaemonIsLinux, NotUserNamespace)
 	dockerCmd(c, "network", "create", "--internal", "-d", "bridge", "internal-net")
dfb00652
 	nr := getNetworkResource(c, "internal-net")
 	c.Assert(nr.Internal, checker.Equals, true)
 
e38463b2
 	dockerCmd(c, "run", "--net", "internal-net", "-d", "--name", "c1",
 		"-p", "8080:8080", "busybox", "nc", "-l", "-p", "8080")
 	c.Assert(waitRun("c1"), check.IsNil)
 
 	_, _, err := dockerCmdWithError("run", "--net=host", "busybox", "nc", "localhost", "8080")
 	c.Assert(err, check.NotNil,
 		check.Commentf("Port mapping on internal network is expected to fail"))
 
 	// Connect container to another normal bridge network
 	dockerCmd(c, "network", "create", "-d", "bridge", "foo-net")
 	dockerCmd(c, "network", "connect", "foo-net", "c1")
 
 	_, _, err = dockerCmdWithError("run", "--net=host", "busybox", "nc", "localhost", "8080")
 	c.Assert(err, check.IsNil,
 		check.Commentf("Port mapping on the new network is expected to succeed"))
 
 }