test: use a queue of open ports for tests

server/api/server.go

@@ -40,6 +40,8 @@ type Server struct {
 	// this mutex to avoid data races.
 	mtx      sync.Mutex
 	listener net.Listener
+
+	ListenerAddr string
 }
 
 // CustomGRPCHeaderMatcher for mapping request headers to
@@ -105,6 +107,7 @@ func (s *Server) Start(cfg config.Config) error {
 		return err
 	}
 
+	s.ListenerAddr = strings.Replace(listener.Addr().Network()+"://"+listener.Addr().String(), "[::]", "0.0.0.0", 1)
 	s.listener = listener
 	s.mtx.Unlock()
 

server/grpc/server.go

@@ -3,6 +3,7 @@ package grpc
 import (
 	"fmt"
 	"net"
+	"strings"
 	"time"
 
 	"google.golang.org/grpc"
@@ -18,7 +19,7 @@ import (
 )
 
 // StartGRPCServer starts a gRPC server on the given address.
-func StartGRPCServer(clientCtx client.Context, app types.Application, cfg config.GRPCConfig) (*grpc.Server, error) {
+func StartGRPCServer(clientCtx client.Context, app types.Application, cfg config.GRPCConfig) (*grpc.Server, string, error) {
 	maxSendMsgSize := cfg.MaxSendMsgSize
 	if maxSendMsgSize == 0 {
 		maxSendMsgSize = config.DefaultGRPCMaxSendMsgSize
@@ -53,7 +54,7 @@ func StartGRPCServer(clientCtx client.Context, app types.Application, cfg config
 		InterfaceRegistry: clientCtx.InterfaceRegistry,
 	})
 	if err != nil {
-		return nil, err
+		return nil, "", err
 	}
 
 	// Reflection allows external clients to see what services and methods
@@ -62,7 +63,7 @@ func StartGRPCServer(clientCtx client.Context, app types.Application, cfg config
 
 	listener, err := net.Listen("tcp", cfg.Address)
 	if err != nil {
-		return nil, err
+		return nil, "", err
 	}
 
 	errCh := make(chan error)
@@ -75,10 +76,11 @@ func StartGRPCServer(clientCtx client.Context, app types.Application, cfg config
 
 	select {
 	case err := <-errCh:
-		return nil, err
+		return nil, "", err
 
 	case <-time.After(types.ServerStartTime):
 		// assume server started successfully
-		return grpcSrv, nil
+		addr := strings.Replace(listener.Addr().String(), "[::]", "0.0.0.0", 1)
+		return grpcSrv, addr, nil
 	}
 }

server/start.go

@@ -412,7 +412,7 @@ func startInProcess(ctx *Context, clientCtx client.Context, appCreator types.App
 			ctx.Logger.Debug("grpc client assigned to client context", "target", grpcAddress)
 
 			// start grpc server
-			grpcSrv, err = servergrpc.StartGRPCServer(clientCtx, app, config.GRPC)
+			grpcSrv, _, err = servergrpc.StartGRPCServer(clientCtx, app, config.GRPC)
 			if err != nil {
 				return err
 			}

tests/e2e/gov/grpc.go

@@ -3,11 +3,12 @@ package gov
 import (
 	"fmt"
 
+	"github.com/cosmos/gogoproto/proto"
+
 	"github.com/cosmos/cosmos-sdk/testutil"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	grpctypes "github.com/cosmos/cosmos-sdk/types/grpc"
 	v1 "github.com/cosmos/cosmos-sdk/x/gov/types/v1"
-	"github.com/cosmos/gogoproto/proto"
 )
 
 func (s *E2ETestSuite) TestGetProposalGRPC() {

testutil/network/network.go

@@ -342,11 +342,8 @@ func New(l Logger, baseDir string, cfg Config) (*Network, error) {
 			if cfg.APIAddress != "" {
 				apiListenAddr = cfg.APIAddress
 			} else {
-				var err error
-				apiListenAddr, _, err = FreeTCPAddr()
-				if err != nil {
-					return nil, err
-				}
+				// use a random free tcp port
+				apiListenAddr = "tcp://0.0.0.0:0"
 			}
 
 			appCfg.API.Address = apiListenAddr
@@ -364,16 +361,14 @@ func New(l Logger, baseDir string, cfg Config) (*Network, error) {
 					return nil, err
 				}
 				tmCfg.RPC.ListenAddress = rpcAddr
+				// tmCfg.RPC.ListenAddress = "tcp://0.0.0.0:0"
 			}
 
 			if cfg.GRPCAddress != "" {
 				appCfg.GRPC.Address = cfg.GRPCAddress
 			} else {
-				_, grpcPort, err := FreeTCPAddr()
-				if err != nil {
-					return nil, err
-				}
-				appCfg.GRPC.Address = fmt.Sprintf("0.0.0.0:%s", grpcPort)
+				// use a random free tcp port
+				appCfg.GRPC.Address = "0.0.0.0:0"
 			}
 			appCfg.GRPC.Enable = true
 			appCfg.GRPCWeb.Enable = true

testutil/network/util.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"net"
+	"net/url"
 	"os"
 	"path/filepath"
 	"time"
@@ -77,12 +78,13 @@ func startInProcess(cfg Config, val *Validator) error {
 	}
 
 	if val.AppConfig.GRPC.Enable {
-		grpcSrv, err := servergrpc.StartGRPCServer(val.ClientCtx, app, val.AppConfig.GRPC)
+		grpcSrv, addr, err := servergrpc.StartGRPCServer(val.ClientCtx, app, val.AppConfig.GRPC)
 		if err != nil {
 			return err
 		}
 
 		val.grpc = grpcSrv
+		val.AppConfig.GRPC.Address = addr
 	}
 
 	if val.APIAddress != "" {
@@ -104,6 +106,14 @@ func startInProcess(cfg Config, val *Validator) error {
 		}
 
 		val.api = apiSrv
+
+		// Update the APIAddress in case the port was set to 0 (random port).
+		apiURL, err := url.Parse(apiSrv.ListenerAddr)
+		if err != nil {
+			return err
+		}
+		val.APIAddress = fmt.Sprintf("http://%s:%s", apiURL.Hostname(), apiURL.Port())
+		val.AppConfig.API.Address = apiSrv.ListenerAddr
 	}
 
 	return nil