Port mapping does not show external IP when using static IP (#8416)

When using static IP for container network, the port mapping will
not be shown when the gateway is not set.
If container network is from DHCP, so everything is working well
because we can get gateway, netmask from DHCP ask packet. But if
we set a static IP, the DHCP request will not be sent for container
network, so gateway will be missed.

Author: yuyangbj

lib/apiservers/portlayer/restapi/handlers/containers_handlers.go

@@ -646,12 +646,18 @@ func convertContainerToContainerInfo(c *exec.Container) *models.ContainerInfo {
 			Direct:      endpoint.Network.Type == constants.ExternalScopeType,
 		}
 
+		// for static endpoints we may not have forced a state refresh and therefore not have the address copied into the Assigned fields.
+		// In this case we used the configured data directly.
 		if !ip.IsUnspecifiedIP(endpoint.Network.Assigned.Gateway.IP) {
 			ep.Gateway = endpoint.Network.Assigned.Gateway.IP.String()
+		} else if endpoint.Static {
+			ep.Gateway = endpoint.Network.Gateway.IP.String()
 		}
 
 		if !ip.IsUnspecifiedIP(endpoint.Assigned.IP) {
 			ep.Address = endpoint.Assigned.String()
+		} else if endpoint.Static {
+			ep.Address = endpoint.IP.String()
 		}
 
 		if len(endpoint.Ports) > 0 {

lib/portlayer/network/context.go

@@ -1115,6 +1115,15 @@ func (c *Context) AddContainer(h *exec.Handle, options *AddContainerOptions) err
 	}
 
 	if s.Type() == constants.ExternalScopeType {
+		// Check that specified static IP address for container network should only be
+		// allow when gateway is set
+		if len(options.IP) > 0 && !ip.IsUnspecifiedIP(options.IP) {
+			if ip.IsUnspecifiedIP(s.Gateway()) {
+				err = fmt.Errorf("Cannot set static IP (%s) when default gateway is not set for network %s", options.IP.String(), s.Name())
+				log.Errorln(err)
+				return err
+			}
+		}
 		// Check that ports are only opened on published network firewall configuration.
 		// Redirects are allow for all network types other than Closed and Outbound
 		if len(options.Ports) > 0 {
@@ -1209,14 +1218,14 @@ func (c *Context) AddContainer(h *exec.Handle, options *AddContainerOptions) err
 	}
 
 	ne.Static = false
+
 	if len(options.IP) > 0 && !ip.IsUnspecifiedIP(options.IP) {
 		ne.Static = true
 		ne.IP = &net.IPNet{
 			IP:   options.IP,
 			Mask: s.Subnet().Mask,
 		}
 	}
-
 	h.ExecConfig.Networks[s.Name()] = ne
 	return nil
 }

tests/test-cases/Group1-Docker-Commands/1-10-Docker-PS.robot

@@ -362,3 +362,34 @@ Docker ps with volume and network filters
     Should Contain  ${output}  buzFooContainer
     ${output}=  Split To Lines  ${output}
     Length Should Be  ${output}  2
+
+
+Docker ps container with specified static IP
+    ${rc}=  Run And Return Rc  docker %{VCH-PARAMS} pull ${nginx}
+    Should Be Equal As Integers  ${rc}  0
+
+    # published via the container-network with specified static ip
+    ${rc}  ${output}=  Run And Return Rc And Output  docker %{VCH-PARAMS} create -p 8080:80 --net=public --ip 60.0.9.150 ${nginx}
+    Should Contain  ${output}  Cannot set static IP (60.0.9.150) when default gateway is not set for network public
+
+    Set Suite Variable  ${old-vch}  %{VCH-NAME}
+    Set Suite Variable  ${old-vch-params}  %{VCH-PARAMS}
+    Set Suite Variable  ${old-vch-bridge}  %{BRIDGE_NETWORK}
+    Set Suite Variable  ${old-vic-admin}  %{VIC-ADMIN}
+    Install VIC Appliance To Test Server  additional-args=--container-network-gateway %{CONTAINER_NETWORK}:50.0.9.1/24 --container-network-firewall=%{CONTAINER_NETWORK}:open
+    ${rc}=  Run And Return Rc  docker %{VCH-PARAMS} pull ${nginx}
+    Should Be Equal As Integers  ${rc}  0
+
+    ${rc}  ${output}=  Run And Return Rc And Output  docker %{VCH-PARAMS} run -d -p 8080:80 --net=public --ip 50.0.9.150 ${nginx}
+    Should Be Equal As Integers  ${rc}  0
+
+    ${rc}  ${output}=  Run And Return Rc And Output  docker %{VCH-PARAMS} ps
+    Log To Console  ${output}
+    Should Be Equal As Integers  ${rc}  0
+    Should Contain  ${output}  50.0.9.150:8080->80/tcp
+
+    Cleanup VIC Appliance On Test Server
+    Set Environment Variable  VCH-NAME  ${old-vch}
+    Set Environment Variable  BRIDGE_NETWORK  ${old-vch-bridge}
+    Set Environment Variable  VCH-PARAMS  ${old-vch-params}
+    Set Environment Variable  VIC-ADMIN  ${old-vic-admin}