feat(docker): fixed external ports

Determine free port and set it in Terraform file
to be more consistent with ports and avoid downtimes
when Terraform decides to change port numbers.

Author: saitho

go.mod

@@ -17,6 +17,7 @@ require (
 	github.com/google/go-cmp v0.5.8
 	github.com/gookit/event v1.0.6
 	github.com/hairyhenderson/gomplate/v3 v3.11.2
+	github.com/phayes/freeport v0.0.0-20220201140144-74d24b5ae9f5
 	github.com/saitho/golang-extended-fs/v2 v2.0.1
 	github.com/shibukawa/configdir v0.0.0-20170330084843-e180dbdc8da0
 	github.com/sirupsen/logrus v1.8.1

go.sum

@@ -767,6 +767,8 @@ github.com/pascaldekloe/goe v0.1.0/go.mod h1:lzWF7FIEvWOWxwDKqyGYQf6ZUaNfKdP144T
 github.com/pelletier/go-toml v1.9.3 h1:zeC5b1GviRUyKYd6OJPvBU/mcVDVoL1OhT17FCt5dSQ=
 github.com/pelletier/go-toml v1.9.3/go.mod h1:u1nR/EPcESfeI/szUZKdtJ0xRNbUoANCkoOuaOx1Y+c=
 github.com/peterbourgon/diskv v2.0.1+incompatible/go.mod h1:uqqh8zWWbv1HBMNONnaR/tNboyR3/BZd58JJSHlUSCU=
+github.com/phayes/freeport v0.0.0-20220201140144-74d24b5ae9f5 h1:Ii+DKncOVM8Cu1Hc+ETb5K+23HdAMvESYE3ZJ5b5cMI=
+github.com/phayes/freeport v0.0.0-20220201140144-74d24b5ae9f5/go.mod h1:iIss55rKnNBTvrwdmkUpLnDpZoAHvWaiq5+iMmen4AE=
 github.com/pierrec/lz4 v2.5.2+incompatible/go.mod h1:pdkljMzZIN41W+lC3N2tnIh5sFi+IEE17M5jbnwPHcY=
 github.com/pierrec/lz4 v2.6.1+incompatible h1:9UY3+iC23yxF0UfGaYrGplQ+79Rg+h/q9FV9ix19jjM=
 github.com/pierrec/lz4 v2.6.1+incompatible/go.mod h1:pdkljMzZIN41W+lC3N2tnIh5sFi+IEE17M5jbnwPHcY=

modules/container/docker/deploy.go

@@ -8,9 +8,11 @@ import (
 	"strconv"
 	"text/template"
 
+	"github.com/phayes/freeport"
 	xfs "github.com/saitho/golang-extended-fs/v2"
 
 	container_docker_definitions "github.com/getstackhead/stackhead/modules/container/docker/definitions"
+	"github.com/getstackhead/stackhead/project"
 	"github.com/getstackhead/stackhead/system"
 )
 
@@ -56,6 +58,43 @@ func resolveUserNameWithCache(userName string) (int, error) {
 	return resolvedUserId, err
 }
 
+func getPortMap(project *project.Project) (map[string]int, error) {
+	dockerPortMap := map[string]int{}
+
+	// find ports for running containers
+	for _, service := range project.Container.Services {
+		res, _, err := system.RemoteRun("docker", "port", "stackhead-"+project.Name+"-"+service.Name)
+		if err == nil { // ignore error (container not running)
+			// e.g. 80/tcp -> 0.0.0.0:49155
+			re := regexp.MustCompile(`(?P<Internal>\d+)\/tcp -> 0\.0\.0\.0:(?P<External>\d+)`)
+			matches := re.FindAllStringSubmatch(res.String(), -1)
+			for _, match := range matches {
+				externalPort, _ := strconv.Atoi(match[re.SubexpIndex("External")])
+				dockerPortMap[service.Name+"-"+match[re.SubexpIndex("Internal")]] = externalPort
+			}
+		}
+	}
+
+	// determine ports for missing containers
+	missingPortServices := []string{}
+	for _, domain := range project.Domains {
+		for _, expose := range domain.Expose {
+			mapKey := expose.Service + "-" + strconv.Itoa(expose.InternalPort)
+			if _, ok := dockerPortMap[mapKey]; !ok {
+				missingPortServices = append(missingPortServices, mapKey)
+			}
+		}
+	}
+	ports, err := freeport.GetFreePorts(len(missingPortServices))
+	if err != nil {
+		return nil, fmt.Errorf("unable to determine free ports: " + err.Error())
+	}
+	for i := range missingPortServices {
+		dockerPortMap[missingPortServices[i]] = ports[i]
+	}
+	return dockerPortMap, nil
+}
+
 func (m Module) Deploy(modulesSettings interface{}) error {
 	project := system.Context.Project
 
@@ -146,9 +185,15 @@ func (m Module) Deploy(modulesSettings interface{}) error {
 		},
 	}
 
+	dockerPortMap, err := getPortMap(project)
+	if err != nil {
+		return fmt.Errorf("unable to determine free ports: " + err.Error())
+	}
+
 	data := map[string]interface{}{
-		"Context":     system.Context,
-		"DockerPaths": GetDockerPaths(),
+		"Context":       system.Context,
+		"DockerPaths":   GetDockerPaths(),
+		"DockerPortMap": dockerPortMap,
 	}
 	dockerTf, err := system.RenderModuleTemplate(
 		templates,
@@ -158,5 +203,7 @@ func (m Module) Deploy(modulesSettings interface{}) error {
 	if err != nil {
 		return err
 	}
+
+	_ = xfs.WriteFile("ssh://"+project.GetTerraformDirectoryPath()+"/docker.tf", dockerTf)
 	return xfs.WriteFile("ssh://"+project.GetTerraformDirectoryPath()+"/docker.tf", dockerTf)
 }

modules/container/docker/templates/project.tf.tmpl

@@ -51,6 +51,7 @@ resource "docker_container" "stackhead-{{ $.Context.Project.Name }}-{{ $service.
     {{ if and $expose.InternalPort (eq $expose.Service $service.Name) }}
     ports {
       internal = {{ $expose.InternalPort }}
+      external = {{ index $.DockerPortMap (printf "%s-%d" $expose.Service $expose.InternalPort) }}
     }
     {{ end }}
   {{- end }}
@@ -109,7 +110,7 @@ resource "docker_volume" "local-{{ $.Context.Project.Name }}-{{ $service.Name }}
 {{ end }}
 
 {{ range $key := keys $globalVolumesDict }}
- {{ $value := get $globalVolumesDict $key }}
+{{ $value := get $globalVolumesDict $key }}
 resource "docker_volume" "global-{{ $.Context.Project.Name }}-{{ $key }}" {
   provider = docker.{{ $.Context.Project.Name }}
   name = "global-{{ $.Context.Project.Name }}-{{ $key }}"