grpctest

grpctest.go

import (
	"net"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"google.golang.org/grpc"
)

// NewGRPCTestServer starts a gRPC server for testing purposes.
// The gRPC server is stopped at the end of the test during Cleanup.
// Use the register callback to setup custom gRPC method handlers.
func NewGRPCTestServer(t *testing.T, register func(*grpc.Server), opts ...grpc.ServerOption) net.Listener {
	t.Helper()

	l, err := net.Listen("tcp", "127.0.0.1:0")
	require.NoError(t, err, "failed to open port")

	srv := grpc.NewServer(opts...)
	register(srv)
	errCh := make(chan error, 1)
	go func() {
		errCh <- srv.Serve(l)
	}()
	t.Cleanup(func() {
		srv.Stop()
		assert.NoError(t, <-errCh, "grpcServer.Serve errored")
	})
	return l
}