[FAB-2172] Remove '*Next' from Config

https://jira.hyperledger.org/browse/FAB-2172 This CR removes the 'Next' suffix which was used to qualify the newer Config structures while in development. Now that the old structures have been removed, the Next suffix can be removed as the newer protos are now the only ones used. Change-Id: Ie3cd138fd905bc5b330d8c6372c0dea108a29c7d Signed-off-by: Jason Yellick <jyellick@us.ibm.com>
hyperledger · Feb 14, 2017 · 28e0d18 · 28e0d18
1 parent 6434844
commit 28e0d18
Show file tree

Hide file tree

Showing 14 changed files with 81 additions and 83 deletions.
diff --git a/common/configtx/manager.go b/common/configtx/manager.go
@@ -79,7 +79,7 @@ func computeSequence(configGroup *cb.ConfigGroup) uint64 {
 
 // computeChannelIdAndSequence returns the chain id and the sequence number for a config envelope
 // or an error if there is a problem with the config envelope
-func computeChannelIdAndSequence(config *cb.ConfigNext) (string, uint64, error) {
+func computeChannelIdAndSequence(config *cb.Config) (string, uint64, error) {
  if config.Channel == nil {
  return "", 0, errors.New("Empty envelope unsupported")
  }
@@ -134,7 +134,7 @@ func validateChainID(chainID string) error {
 }
 
 func NewManagerImpl(configtx *cb.ConfigEnvelope, initializer api.Initializer, callOnUpdate []func(api.Manager)) (api.Manager, error) {
- config, err := UnmarshalConfigNext(configtx.Config)
+ config, err := UnmarshalConfig(configtx.Config)
  if err != nil {
  return nil, err
  }
@@ -240,7 +240,7 @@ func (cm *configManager) recurseConfig(result map[string]comparable, path []stri
 }
 
 func (cm *configManager) processConfig(configtx *cb.ConfigEnvelope) (configMap map[string]comparable, err error) {
- config, err := UnmarshalConfigNext(configtx.Config)
+ config, err := UnmarshalConfig(configtx.Config)
  if err != nil {
  return nil, err
  }

diff --git a/common/configtx/manager_test.go b/common/configtx/manager_test.go
@@ -62,7 +62,7 @@ func makeMarshaledConfig(chainID string, configPairs ...*configPair) []byte {
  values[pair.key] = pair.value
  }
 
- config := &cb.ConfigNext{
+ config := &cb.Config{
  Header: &cb.ChannelHeader{ChannelId: chainID},
  Channel: &cb.ConfigGroup{
  Values: values,
@@ -438,7 +438,7 @@ func TestInvalidProposal(t *testing.T) {
 func TestMissingHeader(t *testing.T) {
  group := cb.NewConfigGroup()
  group.Values["foo"] = &cb.ConfigValue{}
- data := utils.MarshalOrPanic(&cb.ConfigNext{Channel: group})
+ data := utils.MarshalOrPanic(&cb.Config{Channel: group})
  _, err := NewManagerImpl(&cb.ConfigEnvelope{
  Config: data,
  }, defaultInitializer(), nil)

diff --git a/common/configtx/template.go b/common/configtx/template.go
@@ -45,24 +45,24 @@ type Template interface {
  Envelope(chainID string) (*cb.ConfigEnvelope, error)
 }
 
-type simpleTemplateNext struct {
+type simpleTemplate struct {
  configGroup *cb.ConfigGroup
 }
 
-// NewSimpleTemplateNext creates a Template using the supplied ConfigGroup
-func NewSimpleTemplateNext(configGroups ...*cb.ConfigGroup) Template {
+// NewSimpleTemplate creates a Template using the supplied ConfigGroup
+func NewSimpleTemplate(configGroups ...*cb.ConfigGroup) Template {
  sts := make([]Template, len(configGroups))
  for i, group := range configGroups {
- sts[i] = &simpleTemplateNext{
+ sts[i] = &simpleTemplate{
  configGroup: group,
  }
  }
  return NewCompositeTemplate(sts...)
 }
 
 // Envelope returns a ConfigEnvelopes for the given chainID
-func (st *simpleTemplateNext) Envelope(chainID string) (*cb.ConfigEnvelope, error) {
- config, err := proto.Marshal(&cb.ConfigNext{
+func (st *simpleTemplate) Envelope(chainID string) (*cb.ConfigEnvelope, error) {
+ config, err := proto.Marshal(&cb.Config{
  Header: &cb.ChannelHeader{
  ChannelId: chainID,
  Type: int32(cb.HeaderType_CONFIGURATION_ITEM),
@@ -128,7 +128,7 @@ func (ct *compositeTemplate) Envelope(chainID string) (*cb.ConfigEnvelope, error
  if err != nil {
  return nil, err
  }
- config, err := UnmarshalConfigNext(configEnv.Config)
+ config, err := UnmarshalConfig(configEnv.Config)
  if err != nil {
  return nil, err
  }
@@ -138,7 +138,7 @@ func (ct *compositeTemplate) Envelope(chainID string) (*cb.ConfigEnvelope, error
  }
  }
 
- marshaledConfig, err := proto.Marshal(&cb.ConfigNext{
+ marshaledConfig, err := proto.Marshal(&cb.Config{
  Header: &cb.ChannelHeader{
  ChannelId: chainID,
  Type: int32(cb.HeaderType_CONFIGURATION_ITEM),
@@ -164,7 +164,7 @@ func NewChainCreationTemplate(creationPolicy string, template Template) Template
  }),
  }
 
- return NewCompositeTemplate(NewSimpleTemplateNext(result), template)
+ return NewCompositeTemplate(NewSimpleTemplate(result), template)
 }
 
 // MakeChainCreationTransaction is a handy utility function for creating new chain transactions using the underlying Template framework

diff --git a/common/configtx/template_test.go b/common/configtx/template_test.go
@@ -34,7 +34,7 @@ func verifyItemsResult(t *testing.T, template Template, count int) {
  t.Fatalf("Should not have errored: %s", err)
  }
 
- configNext, err := UnmarshalConfigNext(configEnv.Config)
+ configNext, err := UnmarshalConfig(configEnv.Config)
  if err != nil {
  t.Fatalf("Should not have errored: %s", err)
  }
@@ -54,7 +54,7 @@ func simpleGroup(index int) *cb.ConfigGroup {
 }
 
 func TestSimpleTemplate(t *testing.T) {
- simple := NewSimpleTemplateNext(
+ simple := NewSimpleTemplate(
  simpleGroup(0),
  simpleGroup(1),
  )
@@ -63,11 +63,11 @@ func TestSimpleTemplate(t *testing.T) {
 
 func TestCompositeTemplate(t *testing.T) {
  composite := NewCompositeTemplate(
- NewSimpleTemplateNext(
+ NewSimpleTemplate(
  simpleGroup(0),
  simpleGroup(1),
  ),
- NewSimpleTemplateNext(
+ NewSimpleTemplate(
  simpleGroup(2),
  ),
  )
@@ -76,7 +76,7 @@ func TestCompositeTemplate(t *testing.T) {
 }
 
 func TestNewChainTemplate(t *testing.T) {
- simple := NewSimpleTemplateNext(
+ simple := NewSimpleTemplate(
  simpleGroup(0),
  simpleGroup(1),
  )
@@ -90,7 +90,7 @@ func TestNewChainTemplate(t *testing.T) {
  t.Fatalf("Error creation a chain creation config")
  }
 
- configNext, err := UnmarshalConfigNext(configEnv.Config)
+ configNext, err := UnmarshalConfig(configEnv.Config)
  if err != nil {
  t.Fatalf("Should not have errored: %s", err)
  }

diff --git a/common/configtx/test/helper.go b/common/configtx/test/helper.go
@@ -90,12 +90,12 @@ func MSPTemplate() configtx.Template {
  if err != nil {
  logger.Panicf("Could not load sample MSP config: %s", err)
  }
- return configtx.NewSimpleTemplateNext(configtxmsp.TemplateGroupMSP([]string{configtxapplication.GroupKey}, mspConf))
+ return configtx.NewSimpleTemplate(configtxmsp.TemplateGroupMSP([]string{configtxapplication.GroupKey}, mspConf))
 }
 
 // ApplicationTemplate returns the test application template
 func ApplicationTemplate() configtx.Template {
- return configtx.NewSimpleTemplateNext(configtxapplication.DefaultAnchorPeers())
+ return configtx.NewSimpleTemplate(configtxapplication.DefaultAnchorPeers())
 }
 
 // CompositeTemplate returns the composite template of peer, orderer, and MSP

diff --git a/common/configtx/tool/provisional/provisional.go b/common/configtx/tool/provisional/provisional.go
@@ -106,13 +106,13 @@ func New(conf *genesisconfig.TopLevel) Generator {
 }
 
 func (bs *bootstrapper) ChannelTemplate() configtx.Template {
- return configtx.NewSimpleTemplateNext(bs.minimalGroups...)
+ return configtx.NewSimpleTemplate(bs.minimalGroups...)
 }
 
 func (bs *bootstrapper) GenesisBlock() *cb.Block {
  block, err := genesis.NewFactoryImpl(
  configtx.NewCompositeTemplate(
- configtx.NewSimpleTemplateNext(bs.systemChainGroups...),
+ configtx.NewSimpleTemplate(bs.systemChainGroups...),
  bs.ChannelTemplate(),
  ),
  ).Block(TestChainID)

diff --git a/common/configtx/util.go b/common/configtx/util.go
@@ -25,9 +25,9 @@ import (
  "github.com/golang/protobuf/proto"
 )
 
-// UnmarshalConfigNext attempts to unmarshal bytes to a *cb.ConfigNext
-func UnmarshalConfigNext(data []byte) (*cb.ConfigNext, error) {
- config := &cb.ConfigNext{}
+// UnmarshalConfig attempts to unmarshal bytes to a *cb.Config
+func UnmarshalConfig(data []byte) (*cb.Config, error) {
+ config := &cb.Config{}
  err := proto.Unmarshal(data, config)
  if err != nil {
  return nil, err

diff --git a/common/genesis/genesis_test.go b/common/genesis/genesis_test.go
@@ -23,7 +23,7 @@ import (
 )
 
 func TestSanity(t *testing.T) {
- impl := NewFactoryImpl(configtx.NewSimpleTemplateNext())
+ impl := NewFactoryImpl(configtx.NewSimpleTemplate())
  _, err := impl.Block("TestChainID")
  if err != nil {
  t.Fatalf("Basic sanity fails")

diff --git a/orderer/multichain/systemchain.go b/orderer/multichain/systemchain.go
@@ -148,7 +148,7 @@ func (sc *systemChain) proposeChain(configTx *cb.Envelope) cb.Status {
 }
 
 func (sc *systemChain) authorize(configEnvelope *cb.ConfigEnvelope) cb.Status {
- configNext := &cb.ConfigNext{}
+ configNext := &cb.Config{}
  err := proto.Unmarshal(configEnvelope.Config, configNext)
  if err != nil {
  logger.Debugf("Failing to validate chain creation because of unmarshaling error: %s", err)

diff --git a/orderer/multichain/util_test.go b/orderer/multichain/util_test.go
@@ -87,7 +87,7 @@ func makeConfigTx(chainID string, i int) *cb.Envelope {
  group.Groups[configtxorderer.GroupKey].Values[fmt.Sprintf("%d", i)] = &cb.ConfigValue{
  Value: []byte(fmt.Sprintf("%d", i)),
  }
- configTemplate := configtx.NewSimpleTemplateNext(group)
+ configTemplate := configtx.NewSimpleTemplate(group)
  configEnv, err := configTemplate.Envelope(chainID)
  if err != nil {
  panic(err)

diff --git a/peer/channel/create.go b/peer/channel/create.go
@@ -55,7 +55,7 @@ func sendCreateChainTransaction(cf *ChannelCmdFactory) error {
  //TODO this is a temporary hack until `orderer.template` and 'msp.template' is supplied from the CLI
  oTemplate := configtxtest.OrdererTemplate()
  mspTemplate := configtxtest.MSPTemplate()
- gossTemplate := configtx.NewSimpleTemplateNext(configtxapplication.TemplateAnchorPeers(anchorPeers))
+ gossTemplate := configtx.NewSimpleTemplate(configtxapplication.TemplateAnchorPeers(anchorPeers))
  chCrtTemp := configtx.NewCompositeTemplate(oTemplate, mspTemplate, gossTemplate)
 
  signer, err := mspmgmt.GetLocalMSP().GetDefaultSigningIdentity()

diff --git a/protos/common/common.pb.go b/protos/common/common.pb.go
diff --git a/protos/common/configtx.pb.go b/protos/common/configtx.pb.go
diff --git a/protos/common/configtx.proto b/protos/common/configtx.proto
@@ -48,7 +48,7 @@ package common;
 // 4. All configuration changes have a LastModification of one more than the last configuration's highest LastModification number
 // 5. All configuration changes satisfy the corresponding modification policy
 message ConfigEnvelope {
- bytes config = 1; // A marshaled ConfigNext structure
+ bytes config = 1; // A marshaled Config structure
  repeated ConfigSignature signatures = 2; // Signatures over the config
 }
 
@@ -62,9 +62,8 @@ message ConfigValueSchema {}
 
 message ConfigPolicySchema {}
 
-// XXX this structure is to allow us to minimize the diffs in this change series
-// it will be renamed Config once the original is ready to be removed
-message ConfigNext {
+// Config represents the config for a particular channel
+message Config {
  ChannelHeader header = 1;
  ConfigGroup channel = 2;
 }