[FAB-9592] Export private default keepalive options

Exported the private variable that was referenced by DefaultKeepaliveOptions().
Also, added simple tests for core/comm config.

Change-Id: I7c25b4c935b0a0c78fe6816c762609b5ffb33ff5
Signed-off-by: Brian Buchanan <bpbuch@gmail.com>

Author: Brian Buchanan

core/comm/client.go

@@ -51,8 +51,8 @@ func NewGRPCClient(config ClientConfig) (*GRPCClient, error) {
 	} else {
 		// use defaults
 		kap = keepalive.ClientParameters{
-			Time:    keepaliveOptions.ClientInterval,
-			Timeout: keepaliveOptions.ClientTimeout}
+			Time:    DefaultKeepaliveOptions.ClientInterval,
+			Timeout: DefaultKeepaliveOptions.ClientTimeout}
 	}
 	kap.PermitWithoutStream = true
 	// set keepalive and blocking

core/comm/config.go

@@ -19,7 +19,7 @@ var (
 	MaxRecvMsgSize = 100 * 1024 * 1024
 	MaxSendMsgSize = 100 * 1024 * 1024
 	// Default peer keepalive options
-	keepaliveOptions = &KeepaliveOptions{
+	DefaultKeepaliveOptions = &KeepaliveOptions{
 		ClientInterval:    time.Duration(1) * time.Minute,  // 1 min
 		ClientTimeout:     time.Duration(20) * time.Second, // 20 sec - gRPC default
 		ServerInterval:    time.Duration(2) * time.Hour,    // 2 hours - gRPC default
@@ -102,18 +102,12 @@ type KeepaliveOptions struct {
 	ServerMinInterval time.Duration
 }
 
-// DefaultKeepaliveOptions returns sane default keepalive settings for gRPC
-// servers and clients
-func DefaultKeepaliveOptions() *KeepaliveOptions {
-	return keepaliveOptions
-}
-
 // ServerKeepaliveOptions returns gRPC keepalive options for server.  If
 // opts is nil, the default keepalive options are returned
 func ServerKeepaliveOptions(ka *KeepaliveOptions) []grpc.ServerOption {
 	// use default keepalive options if nil
 	if ka == nil {
-		ka = keepaliveOptions
+		ka = DefaultKeepaliveOptions
 	}
 	var serverOpts []grpc.ServerOption
 	kap := keepalive.ServerParameters{
@@ -135,7 +129,7 @@ func ServerKeepaliveOptions(ka *KeepaliveOptions) []grpc.ServerOption {
 func ClientKeepaliveOptions(ka *KeepaliveOptions) []grpc.DialOption {
 	// use default keepalive options if nil
 	if ka == nil {
-		ka = keepaliveOptions
+		ka = DefaultKeepaliveOptions
 	}
 
 	var dialOpts []grpc.DialOption

core/comm/config_test.go

@@ -14,6 +14,10 @@ import (
 
 func TestConfig(t *testing.T) {
 	t.Parallel()
-	// check the defaults
-	assert.EqualValues(t, keepaliveOptions, DefaultKeepaliveOptions())
+
+	serverOptions := ServerKeepaliveOptions(nil)
+	assert.NotNil(t, serverOptions)
+
+	clientOptions := ClientKeepaliveOptions(nil)
+	assert.NotNil(t, clientOptions)
 }

core/comm/connection.go

@@ -194,7 +194,7 @@ func NewClientConnectionWithAddress(peerAddress string, block bool, tslEnabled b
 		opts = ClientKeepaliveOptions(ka)
 	} else {
 		// set to the default options
-		opts = ClientKeepaliveOptions(DefaultKeepaliveOptions())
+		opts = ClientKeepaliveOptions(DefaultKeepaliveOptions)
 	}
 
 	if tslEnabled {

core/deliverservice/deliveryclient.go

@@ -242,7 +242,7 @@ func DefaultConnectionFactory(channelID string) func(endpoint string) (*grpc.Cli
 		dialOpts = append(dialOpts, grpc.WithDefaultCallOptions(grpc.MaxCallRecvMsgSize(comm.MaxRecvMsgSize),
 			grpc.MaxCallSendMsgSize(comm.MaxSendMsgSize)))
 		// set the keepalive options
-		kaOpts := comm.DefaultKeepaliveOptions()
+		kaOpts := comm.DefaultKeepaliveOptions
 		if viper.IsSet("peer.keepalive.deliveryClient.interval") {
 			kaOpts.ClientInterval = viper.GetDuration(
 				"peer.keepalive.deliveryClient.interval")

core/peer/config.go

@@ -166,7 +166,7 @@ func GetServerConfig() (comm.ServerConfig, error) {
 		}
 	}
 	// get the default keepalive options
-	serverConfig.KaOpts = comm.DefaultKeepaliveOptions()
+	serverConfig.KaOpts = comm.DefaultKeepaliveOptions
 	// check to see if minInterval is set for the env
 	if viper.IsSet("peer.keepalive.minInterval") {
 		serverConfig.KaOpts.ServerMinInterval = viper.GetDuration("peer.keepalive.minInterval")

core/peer/config_test.go

@@ -138,7 +138,7 @@ func TestGetServerConfig(t *testing.T) {
 		"ServerConfig.SecOpts.UseTLS should be false")
 
 	// keepalive options
-	assert.Equal(t, comm.DefaultKeepaliveOptions(), sc.KaOpts,
+	assert.Equal(t, comm.DefaultKeepaliveOptions, sc.KaOpts,
 		"ServerConfig.KaOpts should be set to default values")
 	viper.Set("peer.keepalive.minInterval", "2m")
 	sc, _ = GetServerConfig()

examples/events/eventsclient/eventsclient.go

@@ -160,7 +160,7 @@ func main() {
 	}
 
 	clientConfig := comm.ClientConfig{
-		KaOpts:  comm.DefaultKeepaliveOptions(),
+		KaOpts:  comm.DefaultKeepaliveOptions,
 		SecOpts: &comm.SecureOptions{},
 		Timeout: 5 * time.Minute,
 	}

orderer/common/server/main.go

@@ -182,7 +182,7 @@ func initializeServerConfig(conf *config.TopLevel) comm.ServerConfig {
 		secureOpts.ClientRootCAs = clientRootCAs
 		logger.Infof("Starting orderer with %s enabled", msg)
 	}
-	kaOpts := comm.DefaultKeepaliveOptions()
+	kaOpts := comm.DefaultKeepaliveOptions
 	// keepalive settings
 	// ServerMinInterval must be greater than 0
 	if conf.General.Keepalive.ServerMinInterval > time.Duration(0) {

orderer/common/server/main_test.go

@@ -89,7 +89,7 @@ func TestInitializeServerConfig(t *testing.T) {
 		},
 	}
 	sc := initializeServerConfig(conf)
-	defaultOpts := comm.DefaultKeepaliveOptions()
+	defaultOpts := comm.DefaultKeepaliveOptions
 	assert.Equal(t, defaultOpts.ServerMinInterval, sc.KaOpts.ServerMinInterval)
 	assert.Equal(t, time.Duration(0), sc.KaOpts.ServerInterval)
 	assert.Equal(t, time.Duration(0), sc.KaOpts.ServerTimeout)

peer/node/start.go

@@ -276,7 +276,7 @@ func serve(args []string) error {
 				grpc.MaxCallRecvMsgSize(comm.MaxRecvMsgSize),
 				grpc.MaxCallSendMsgSize(comm.MaxSendMsgSize)))
 		// set the keepalive options
-		kaOpts := comm.DefaultKeepaliveOptions()
+		kaOpts := comm.DefaultKeepaliveOptions
 		if viper.IsSet("peer.keepalive.client.interval") {
 			kaOpts.ClientInterval = viper.GetDuration("peer.keepalive.client.interval")
 		}
@@ -608,7 +608,7 @@ func createEventHubServer(serverConfig comm.ServerConfig) (*comm.GRPCServer, err
 	}
 
 	// set the keepalive options
-	serverConfig.KaOpts = comm.DefaultKeepaliveOptions()
+	serverConfig.KaOpts = comm.DefaultKeepaliveOptions
 	if viper.IsSet("peer.events.keepalive.minInterval") {
 		serverConfig.KaOpts.ServerMinInterval = viper.GetDuration("peer.events.keepalive.minInterval")
 	}