[FAB-11861] Add etcdraft config defaults

This CR adds configuration defaults to the etcdraft plugin Metadata
definition under the Options namespace.

Change-Id: I37214d6ff3da9e7f5a26820feaea882d49e79736
Signed-off-by: Adarsh Saraf <adarshsaraf123@gmail.com>

Author: adarshsaraf123

common/tools/configtxgen/localconfig/config.go

@@ -199,6 +199,15 @@ var genesisDefaults = TopLevel{
 		Kafka: Kafka{
 			Brokers: []string{"127.0.0.1:9092"},
 		},
+		EtcdRaft: &etcdraft.Metadata{
+			Options: &etcdraft.Options{
+				TickInterval:    100,
+				ElectionTick:    10,
+				HeartbeatTick:   1,
+				MaxInflightMsgs: 256,
+				MaxSizePerMsg:   1048576,
+			},
+		},
 	},
 }
 
@@ -379,8 +388,12 @@ loop:
 		}
 	}
 
+	logger.Infof("orderer type: %s", ord.OrdererType)
 	// Additional, consensus type-dependent initialization goes here
+	// Also using this to panic on unknown orderer type.
 	switch ord.OrdererType {
+	case "solo":
+		// nothing to be done here
 	case "kafka":
 		if ord.Kafka.Brokers == nil {
 			logger.Infof("Orderer.Kafka unset, setting to %v", genesisDefaults.Orderer.Kafka.Brokers)
@@ -390,14 +403,68 @@ loop:
 		if ord.EtcdRaft == nil {
 			logger.Panicf("%s raft configuration missing", etcdraft.TypeKey)
 		}
+		if ord.EtcdRaft.Options == nil {
+			logger.Infof("Orderer.EtcdRaft.Options unset, setting to %v", genesisDefaults.Orderer.EtcdRaft.Options)
+			ord.EtcdRaft.Options = genesisDefaults.Orderer.EtcdRaft.Options
+		}
+	second_loop:
+		for {
+			switch {
+			case ord.EtcdRaft.Options.TickInterval == 0:
+				logger.Infof("Orderer.EtcdRaft.Options.TickInterval unset, setting to %v", genesisDefaults.Orderer.EtcdRaft.Options.TickInterval)
+				ord.EtcdRaft.Options.TickInterval = genesisDefaults.Orderer.EtcdRaft.Options.TickInterval
+
+			case ord.EtcdRaft.Options.ElectionTick == 0:
+				logger.Infof("Orderer.EtcdRaft.Options.ElectionTick unset, setting to %v", genesisDefaults.Orderer.EtcdRaft.Options.ElectionTick)
+				ord.EtcdRaft.Options.ElectionTick = genesisDefaults.Orderer.EtcdRaft.Options.ElectionTick
+
+			case ord.EtcdRaft.Options.HeartbeatTick == 0:
+				logger.Infof("Orderer.EtcdRaft.Options.HeartbeatTick unset, setting to %v", genesisDefaults.Orderer.EtcdRaft.Options.HeartbeatTick)
+				ord.EtcdRaft.Options.HeartbeatTick = genesisDefaults.Orderer.EtcdRaft.Options.HeartbeatTick
+
+			case ord.EtcdRaft.Options.MaxInflightMsgs == 0:
+				logger.Infof("Orderer.EtcdRaft.Options.MaxInflightMsgs unset, setting to %v", genesisDefaults.Orderer.EtcdRaft.Options.MaxInflightMsgs)
+				ord.EtcdRaft.Options.MaxInflightMsgs = genesisDefaults.Orderer.EtcdRaft.Options.MaxInflightMsgs
+
+			case ord.EtcdRaft.Options.MaxSizePerMsg == 0:
+				logger.Infof("Orderer.EtcdRaft.Options.MaxSizePerMsg unset, setting to %v", genesisDefaults.Orderer.EtcdRaft.Options.MaxSizePerMsg)
+				ord.EtcdRaft.Options.MaxSizePerMsg = genesisDefaults.Orderer.EtcdRaft.Options.MaxSizePerMsg
+
+			case len(ord.EtcdRaft.Consenters) == 0:
+				logger.Panicf("%s configuration did not specify any consenter", etcdraft.TypeKey)
+
+			default:
+				break second_loop
+			}
+		}
+
+		// validate the specified members for Options
+		if ord.EtcdRaft.Options.ElectionTick <= ord.EtcdRaft.Options.HeartbeatTick {
+			logger.Panicf("election tick must be greater than heartbeat tick")
+		}
+
 		for _, c := range ord.EtcdRaft.GetConsenters() {
+			if c.Host == "" {
+				logger.Panicf("consenter info in %s configuration did not specify host", etcdraft.TypeKey)
+			}
+			if c.Port == 0 {
+				logger.Panicf("consenter info in %s configuration did not specify port", etcdraft.TypeKey)
+			}
+			if c.ClientTlsCert == nil {
+				logger.Panicf("consenter info in %s configuration did not specify client TLS cert", etcdraft.TypeKey)
+			}
+			if c.ServerTlsCert == nil {
+				logger.Panicf("consenter info in %s configuration did not specify server TLS cert", etcdraft.TypeKey)
+			}
 			clientCertPath := string(c.GetClientTlsCert())
 			cf.TranslatePathInPlace(configDir, &clientCertPath)
 			c.ClientTlsCert = []byte(clientCertPath)
 			serverCertPath := string(c.GetServerTlsCert())
 			cf.TranslatePathInPlace(configDir, &serverCertPath)
 			c.ServerTlsCert = []byte(serverCertPath)
 		}
+	default:
+		logger.Panicf("unknown orderer type: %s", ord.OrdererType)
 	}
 }
 

common/tools/configtxgen/localconfig/config_test.go

@@ -10,6 +10,8 @@ import (
 	"testing"
 
 	"github.com/hyperledger/fabric/core/config/configtest"
+	"github.com/hyperledger/fabric/protos/orderer/etcdraft"
+
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -83,6 +85,29 @@ func TestConsensusSpecificInit(t *testing.T) {
 	devConfigDir, err := configtest.GetDevConfigDir()
 	require.NoError(t, err)
 
+	t.Run("nil orderer type", func(t *testing.T) {
+		profile := &Profile{
+			Orderer: &Orderer{
+				OrdererType: "",
+			},
+		}
+		profile.completeInitialization(devConfigDir)
+
+		assert.Equal(t, profile.Orderer.OrdererType, genesisDefaults.Orderer.OrdererType)
+	})
+
+	t.Run("unknown orderer type", func(t *testing.T) {
+		profile := &Profile{
+			Orderer: &Orderer{
+				OrdererType: "unknown",
+			},
+		}
+
+		assert.Panics(t, func() {
+			profile.completeInitialization(devConfigDir)
+		})
+	})
+
 	t.Run("solo", func(t *testing.T) {
 		profile := &Profile{
 			Orderer: &Orderer{
@@ -102,4 +127,137 @@ func TestConsensusSpecificInit(t *testing.T) {
 		profile.completeInitialization(devConfigDir)
 		assert.NotNil(t, profile.Orderer.Kafka.Brokers, "Kafka config settings should be set")
 	})
+
+	t.Run("raft", func(t *testing.T) {
+		makeProfile := func(consenters []*etcdraft.Consenter, options *etcdraft.Options) *Profile {
+			return &Profile{
+				Orderer: &Orderer{
+					OrdererType: "etcdraft",
+					EtcdRaft: &etcdraft.Metadata{
+						Consenters: consenters,
+						Options:    options,
+					},
+				},
+			}
+		}
+		t.Run("EtcdRaft section not specified in profile", func(t *testing.T) {
+			profile := &Profile{
+				Orderer: &Orderer{
+					OrdererType: "etcdraft",
+				},
+			}
+
+			assert.Panics(t, func() {
+				profile.completeInitialization(devConfigDir)
+			})
+		})
+
+		t.Run("nil consenter set", func(t *testing.T) { // should panic
+			profile := makeProfile(nil, nil)
+
+			assert.Panics(t, func() {
+				profile.completeInitialization(devConfigDir)
+			})
+		})
+
+		t.Run("single consenter", func(t *testing.T) {
+			consenters := []*etcdraft.Consenter{
+				{
+					Host:          "node-1.example.com",
+					Port:          7050,
+					ClientTlsCert: []byte("path/to/client/cert"),
+					ServerTlsCert: []byte("path/to/server/cert"),
+				},
+			}
+
+			t.Run("invalid consenters specification", func(t *testing.T) {
+				failingConsenterSpecifications := []*etcdraft.Consenter{
+					{ // missing Host
+						Port:          7050,
+						ClientTlsCert: []byte("path/to/client/cert"),
+						ServerTlsCert: []byte("path/to/server/cert"),
+					},
+					{ // missing Port
+						Host:          "node-1.example.com",
+						ClientTlsCert: []byte("path/to/client/cert"),
+						ServerTlsCert: []byte("path/to/server/cert"),
+					},
+					{ // missing ClientTlsCert
+						Host:          "node-1.example.com",
+						Port:          7050,
+						ServerTlsCert: []byte("path/to/server/cert"),
+					},
+					{ // missing ServerTlsCert
+						Host:          "node-1.example.com",
+						Port:          7050,
+						ClientTlsCert: []byte("path/to/client/cert"),
+					},
+				}
+
+				for _, consenter := range failingConsenterSpecifications {
+					profile := makeProfile([]*etcdraft.Consenter{consenter}, nil)
+
+					assert.Panics(t, func() {
+						profile.completeInitialization(devConfigDir)
+					})
+				}
+			})
+
+			t.Run("nil Options", func(t *testing.T) {
+				profile := makeProfile(consenters, nil)
+				profile.completeInitialization(devConfigDir)
+
+				// need not be tested in subsequent tests
+				assert.NotNil(t, profile.Orderer.EtcdRaft, "EtcdRaft config settings should be set")
+				assert.Equal(t, profile.Orderer.EtcdRaft.Consenters[0].ClientTlsCert, consenters[0].ClientTlsCert,
+					"Client TLS cert path should be correctly set")
+
+				// specific assertion for this test context
+				assert.Equal(t, profile.Orderer.EtcdRaft.Options, genesisDefaults.Orderer.EtcdRaft.Options,
+					"Options should be set to the default value")
+			})
+
+			t.Run("heartbeat tick specified in Options", func(t *testing.T) {
+				heartbeatTick := uint32(2)
+				options := &etcdraft.Options{ // partially set so that we can check that the other members are set to defaults
+					HeartbeatTick: heartbeatTick,
+				}
+				profile := makeProfile(consenters, options)
+				profile.completeInitialization(devConfigDir)
+
+				// specific assertions for this test context
+				assert.Equal(t, profile.Orderer.EtcdRaft.Options.HeartbeatTick, heartbeatTick,
+					"HeartbeatTick should be set to the specified value")
+				assert.Equal(t, profile.Orderer.EtcdRaft.Options.ElectionTick, genesisDefaults.Orderer.EtcdRaft.Options.ElectionTick,
+					"ElectionTick should be set to the default value")
+			})
+
+			t.Run("election tick specified in Options", func(t *testing.T) {
+				electionTick := uint32(20)
+				options := &etcdraft.Options{ // partially set so that we can check that the other members are set to defaults
+					ElectionTick: electionTick,
+				}
+				profile := makeProfile(consenters, options)
+				profile.completeInitialization(devConfigDir)
+
+				// specific assertions for this test context
+				assert.Equal(t, profile.Orderer.EtcdRaft.Options.ElectionTick, electionTick,
+					"ElectionTick should be set to the specified value")
+				assert.Equal(t, profile.Orderer.EtcdRaft.Options.HeartbeatTick, genesisDefaults.Orderer.EtcdRaft.Options.HeartbeatTick,
+					"HeartbeatTick should be set to the default value")
+			})
+
+			t.Run("panic on invalid options", func(t *testing.T) {
+				options := &etcdraft.Options{
+					HeartbeatTick: 2,
+					ElectionTick:  1,
+				}
+				profile := makeProfile(consenters, options)
+
+				assert.Panics(t, func() {
+					profile.completeInitialization(devConfigDir)
+				})
+			})
+		})
+	})
 }

protos/orderer/etcdraft/configuration.go

@@ -7,7 +7,7 @@ SPDX-License-Identifier: Apache-2.0
 package etcdraft
 
 import (
-	fmt "fmt"
+	"fmt"
 	"io/ioutil"
 
 	"github.com/hyperledger/fabric/protos/orderer"