feat: support listening on custom host (testutil/server) (#11586)

Co-authored-by: Alex Hong <9397363+hongalex@users.noreply.github.com>

Author: larryanz

internal/testutil/server.go

@@ -52,16 +52,24 @@ type Server struct {
 	Gsrv *grpc.Server
 }
 
-// NewServer creates a new Server. The Server will be listening for gRPC connections
-// at the address named by the Addr field, without TLS.
+// NewServer creates a new Server on localhost. The Server will be listening for
+// gRPC connections at the address named by the Addr field, without TLS.
 func NewServer(opts ...grpc.ServerOption) (*Server, error) {
 	return NewServerWithPort(0, opts...)
 }
 
-// NewServerWithPort creates a new Server at a specific port. The Server will be listening
-// for gRPC connections at the address named by the Addr field, without TLS.
+// NewServerWithPort creates a new Server on localhost at a specific port. The
+// Server will be listening for gRPC connections at the address named by the
+// Addr field, without TLS.
 func NewServerWithPort(port int, opts ...grpc.ServerOption) (*Server, error) {
-	l, err := net.Listen("tcp", fmt.Sprintf("localhost:%d", port))
+	return NewServerWithAddress(fmt.Sprintf("localhost:%d", port))
+}
+
+// NewServerWithAddress creates a new Server with a specific address (host and
+// port). The Server will be listening for gRPC connections at the address named
+// by the Addr field, without TLS.
+func NewServerWithAddress(addr string, opts ...grpc.ServerOption) (*Server, error) {
+	l, err := net.Listen("tcp", addr)
 	if err != nil {
 		return nil, err
 	}

internal/testutil/server_test.go

@@ -15,10 +15,12 @@
 package testutil
 
 import (
+	"fmt"
 	"testing"
 
 	grpc "google.golang.org/grpc"
 	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/credentials/insecure"
 	"google.golang.org/grpc/status"
 )
 
@@ -27,13 +29,46 @@ func TestNewServer(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	defer srv.Close()
 	srv.Start()
-	conn, err := grpc.Dial(srv.Addr, grpc.WithInsecure())
+
+	conn, err := grpc.NewClient(srv.Addr, grpc.WithTransportCredentials(insecure.NewCredentials()))
 	if err != nil {
 		t.Fatal(err)
 	}
-	defer conn.Close()
+
+	t.Cleanup(func() {
+		conn.Close()
+		srv.Close()
+	})
+}
+
+func TestNewServerWithAddress(t *testing.T) {
+	addresses := []string{
+		":8181",
+		"0.0.0.0:8181",
+		"127.0.0.1:8181",
+		"localhost:8181",
+	}
+
+	for _, a := range addresses {
+		t.Run(fmt.Sprintf("GIVEN host %s THEN succeed to init new server", a), func(t *testing.T) {
+			srv, err := NewServerWithAddress(a)
+			if err != nil {
+				t.Fatal(err)
+			}
+			srv.Start()
+
+			conn, err := grpc.NewClient(srv.Addr, grpc.WithTransportCredentials(insecure.NewCredentials()))
+			if err != nil {
+				t.Fatal(err)
+			}
+
+			t.Cleanup(func() {
+				conn.Close()
+				srv.Close()
+			})
+		})
+	}
 }
 
 func TestPageBounds(t *testing.T) {