Bind UDP ports (#107)

* UDP Port

* Add udp port

Author: ferranbt

internal/components.go

@@ -87,7 +87,7 @@ func (o *OpNode) Run(service *service, ctx *ExContext) {
 			"--rpc.port", `{{Port "http" 8549}}`,
 			"--p2p.listen.ip", "0.0.0.0",
 			"--p2p.listen.tcp", `{{Port "p2p" 9003}}`,
-			"--p2p.listen.udp", `{{Port "p2p" 9003}}`,
+			"--p2p.listen.udp", `{{PortUDP "p2p" 9003}}`,
 			"--p2p.scoring.peers", "light",
 			"--p2p.ban.peers", "true",
 			"--metrics.enabled",
@@ -302,7 +302,7 @@ func (l *LighthouseBeaconNode) Run(svc *service, ctx *ExContext) {
 			"--disable-peer-scoring",
 			"--staking",
 			"--enr-address", "127.0.0.1",
-			"--enr-udp-port", `{{Port "p2p" 9000}}`,
+			"--enr-udp-port", `{{PortUDP "p2p" 9000}}`,
 			"--enr-tcp-port", `{{Port "p2p" 9000}}`,
 			"--enr-quic-port", `{{Port "quic-p2p" 9100}}`,
 			"--port", `{{Port "p2p" 9000}}`,

internal/local_runner.go

@@ -386,6 +386,16 @@ func (d *LocalRunner) applyTemplate(s *service) ([]string, map[string]string, er
 		}
 	}
 
+	resolvePort := func(name string, defaultPort int, protocol string) int {
+		// For {{Port "name" "defaultPort"}}:
+		// - Service runs on host: return the host port
+		// - Service runs inside docker: return the docker port
+		if d.isHostService(s.Name) {
+			return s.MustGetPort(name).HostPort
+		}
+		return defaultPort
+	}
+
 	funcs := template.FuncMap{
 		"Service": func(name string, portLabel, protocol string) string {
 			protocolPrefix := ""
@@ -418,13 +428,10 @@ func (d *LocalRunner) applyTemplate(s *service) ([]string, map[string]string, er
 			}
 		},
 		"Port": func(name string, defaultPort int) int {
-			// For {{Port "name" "defaultPort"}}:
-			// - Service runs on host: return the host port
-			// - Service runs inside docker: return the docker port
-			if d.isHostService(s.Name) {
-				return s.MustGetPort(name).HostPort
-			}
-			return defaultPort
+			return resolvePort(name, defaultPort, ProtocolTCP)
+		},
+		"PortUDP": func(name string, defaultPort int) int {
+			return resolvePort(name, defaultPort, ProtocolUDP)
 		},
 	}
 
@@ -586,17 +593,18 @@ func (d *LocalRunner) toDockerComposeService(s *service) (map[string]interface{}
 		service["entrypoint"] = s.entrypoint
 	}
 
-	fmt.Println("XXX")
-
 	if len(s.ports) > 0 {
 		ports := []string{}
-		fmt.Println("x", d.bindHostPortsLocally)
-
 		for _, p := range s.ports {
+			protocol := ""
+			if p.Protocol == ProtocolUDP {
+				protocol = "/udp"
+			}
+
 			if d.bindHostPortsLocally {
-				ports = append(ports, fmt.Sprintf("127.0.0.1:%d:%d", p.HostPort, p.Port))
+				ports = append(ports, fmt.Sprintf("127.0.0.1:%d:%d%s", p.HostPort, p.Port, protocol))
 			} else {
-				ports = append(ports, fmt.Sprintf("%d:%d", p.HostPort, p.Port))
+				ports = append(ports, fmt.Sprintf("%d:%d%s", p.HostPort, p.Port, protocol))
 			}
 		}
 		service["ports"] = ports

internal/manifest.go

@@ -210,6 +210,11 @@ func (s *Manifest) Validate() error {
 	return nil
 }
 
+const (
+	ProtocolUDP = "udp"
+	ProtocolTCP = "tcp"
+)
+
 // Port describes a port that a service exposes
 type Port struct {
 	// Name is the name of the port
@@ -218,6 +223,9 @@ type Port struct {
 	// Port is the port number
 	Port int
 
+	// Protocol (tcp or udp)
+	Protocol string
+
 	// HostPort is the port number assigned on the host machine for this
 	// container port. It is populated by the local runner
 	// TODO: We might want to move this to the runner itself.
@@ -356,18 +364,30 @@ func (s *service) WithTag(tag string) *service {
 	return s
 }
 
-func (s *service) WithPort(name string, portNumber int) *service {
+func (s *service) WithPort(name string, portNumber int, protocolVar ...string) *service {
+	protocol := ProtocolTCP
+	if len(protocol) > 0 {
+		if protocolVar[0] != ProtocolTCP && protocolVar[0] != ProtocolUDP {
+			panic(fmt.Sprintf("protocol %s not supported", protocolVar[0]))
+		}
+		protocol = protocolVar[0]
+	}
+
 	// add the port if not already present with the same name.
 	// if preset with the same name, they must have same port number
 	for _, p := range s.ports {
 		if p.Name == name {
 			if p.Port != portNumber {
 				panic(fmt.Sprintf("port %s already defined with different port number", name))
 			}
+			if p.Protocol != protocol {
+				// If they have different protocols they are different ports
+				continue
+			}
 			return s
 		}
 	}
-	s.ports = append(s.ports, &Port{Name: name, Port: portNumber})
+	s.ports = append(s.ports, &Port{Name: name, Port: portNumber, Protocol: protocol})
 	return s
 }
 
@@ -376,7 +396,7 @@ func (s *service) applyTemplate(arg string) {
 	var nodeRef []NodeRef
 	_, port, nodeRef = applyTemplate(arg)
 	for _, p := range port {
-		s.WithPort(p.Name, p.Port)
+		s.WithPort(p.Name, p.Port, p.Protocol)
 	}
 	for _, n := range nodeRef {
 		s.nodeRefs = append(s.nodeRefs, &n)
@@ -445,9 +465,13 @@ func applyTemplate(templateStr string) (string, []Port, []NodeRef) {
 			return fmt.Sprintf(`{{Service "%s" "%s"}}`, name, portLabel)
 		},
 		"Port": func(name string, defaultPort int) string {
-			portRef = append(portRef, Port{Name: name, Port: defaultPort})
+			portRef = append(portRef, Port{Name: name, Port: defaultPort, Protocol: ProtocolTCP})
 			return fmt.Sprintf(`{{Port "%s" %d}}`, name, defaultPort)
 		},
+		"PortUDP": func(name string, defaultPort int) string {
+			portRef = append(portRef, Port{Name: name, Port: defaultPort, Protocol: ProtocolUDP})
+			return fmt.Sprintf(`{{PortUDP "%s" %d}}`, name, defaultPort)
+		},
 	}
 
 	tpl, err := template.New("").Funcs(funcs).Parse(templateStr)

main.go

@@ -266,7 +266,11 @@ func runIt(recipe internal.Recipe) error {
 
 			portsStr := []string{}
 			for _, p := range ports {
-				portsStr = append(portsStr, fmt.Sprintf("%s: %d/%d", p.Name, p.Port, p.HostPort))
+				protocol := ""
+				if p.Protocol == internal.ProtocolUDP {
+					protocol = "/udp"
+				}
+				portsStr = append(portsStr, fmt.Sprintf("%s: %d/%d%s", p.Name, p.Port, p.HostPort, protocol))
 			}
 			fmt.Printf("- %s (%s)\n", ss.Name, strings.Join(portsStr, ", "))
 		}