[baseserver] Make consuing ServerConfiguration easier

Author: csweichel

components/common-go/baseserver/options.go

@@ -77,23 +77,17 @@ func WithUnderTest() Option {
 }
 
 // WithHTTP configures and enables the HTTP server.
-func WithHTTP(addr string, tls *TLSConfiguration) Option {
+func WithHTTP(cfg *ServerConfiguration) Option {
 	return func(opts *options) error {
-		opts.config.Services.HTTP = &ServerConfiguration{
-			Address: addr,
-			TLS:     tls,
-		}
+		opts.config.Services.HTTP = cfg
 		return nil
 	}
 }
 
 // WithGRPC configures and enables the GRPC server.
-func WithGRPC(addr string, tls *TLSConfiguration) Option {
+func WithGRPC(cfg *ServerConfiguration) Option {
 	return func(opts *options) error {
-		opts.config.Services.GRPC = &ServerConfiguration{
-			Address: addr,
-			TLS:     tls,
-		}
+		opts.config.Services.GRPC = cfg
 		return nil
 	}
 }

components/common-go/baseserver/options_test.go

@@ -25,8 +25,8 @@ func TestOptions(t *testing.T) {
 	grpcCfg := ServerConfiguration{Address: "localhost:8081"}
 
 	var opts = []Option{
-		WithHTTP(httpCfg.Address, httpCfg.TLS),
-		WithGRPC(grpcCfg.Address, grpcCfg.TLS),
+		WithHTTP(&httpCfg),
+		WithGRPC(&grpcCfg),
 		WithLogger(logger),
 		WithCloseTimeout(timeout),
 		WithMetricsRegistry(registry),

components/common-go/baseserver/server_test.go

@@ -21,8 +21,8 @@ func TestServer_StartStop(t *testing.T) {
 	// We don't use the helper NewForTests, because we want to control stopping ourselves.
 	srv, err := baseserver.New("server_test",
 		baseserver.WithUnderTest(),
-		baseserver.WithHTTP("localhost:8765", nil),
-		baseserver.WithGRPC("localhost:8766", nil),
+		baseserver.WithHTTP(&baseserver.ServerConfiguration{Address: "localhost:8765"}),
+		baseserver.WithGRPC(&baseserver.ServerConfiguration{Address: "localhost:8766"}),
 	)
 	require.NoError(t, err)
 	baseserver.StartServerForTests(t, srv)
@@ -48,11 +48,15 @@ func TestServer_ServerCombinations_StartsAndStops(t *testing.T) {
 			var opts []baseserver.Option
 			opts = append(opts, baseserver.WithUnderTest())
 			if test.StartHTTP {
-				opts = append(opts, baseserver.WithHTTP(fmt.Sprintf("localhost:%d", baseserver.MustFindFreePort(t)), nil))
+				opts = append(opts, baseserver.WithHTTP(&baseserver.ServerConfiguration{
+					Address: fmt.Sprintf("localhost:%d", baseserver.MustFindFreePort(t)),
+				}))
 			}
 
 			if test.StartGRPC {
-				opts = append(opts, baseserver.WithGRPC(fmt.Sprintf("localhost:%d", baseserver.MustFindFreePort(t)), nil))
+				opts = append(opts, baseserver.WithGRPC(&baseserver.ServerConfiguration{
+					Address: fmt.Sprintf("localhost:%d", baseserver.MustFindFreePort(t)),
+				}))
 			}
 
 			srv, err := baseserver.New("test_server", opts...)
@@ -79,7 +83,9 @@ func TestServer_ServerCombinations_StartsAndStops(t *testing.T) {
 
 func TestServer_Metrics_gRPC(t *testing.T) {
 	ctx := context.Background()
-	srv := baseserver.NewForTests(t)
+	srv := baseserver.NewForTests(t, baseserver.WithGRPC(&baseserver.ServerConfiguration{
+		Address: fmt.Sprintf("localhost:%d", baseserver.MustFindFreePort(t)),
+	}))
 
 	// At this point, there must be metrics registry available for use
 	require.NotNil(t, srv.MetricsRegistry())

components/common-go/baseserver/testing.go

@@ -21,8 +21,6 @@ func NewForTests(t *testing.T, opts ...Option) *Server {
 
 	defaultTestOpts := []Option{
 		WithUnderTest(),
-		WithGRPC(fmt.Sprintf("localhost:%d", MustFindFreePort(t)), nil),
-		WithHTTP(fmt.Sprintf("localhost:%d", MustFindFreePort(t)), nil),
 		WithCloseTimeout(1 * time.Second),
 	}
 

components/public-api-server/pkg/server/server.go

@@ -20,7 +20,7 @@ func Start(logger *logrus.Entry, cfg Config) error {
 
 	srv, err := baseserver.New("public_api_server",
 		baseserver.WithLogger(logger),
-		baseserver.WithGRPC(fmt.Sprintf("localhost:%d", cfg.GRPCPort), nil),
+		baseserver.WithGRPC(&baseserver.ServerConfiguration{Address: fmt.Sprintf("localhost:%d", cfg.GRPCPort)}),
 		baseserver.WithMetricsRegistry(registry),
 	)
 	if err != nil {