Skip to content

Commit

Permalink
[FAB-4265] Fix overloaded peer channel create cmd
Browse files Browse the repository at this point in the history
The peer channel create command is currently being used in the e2e tests
to perform a configuration update.  This is very unintuitive and gives
the wrong impression to anyone looking at the e2e example.

This CR simply adds an 'update' command to peer channel to make the
operation more clear.

Change-Id: I33244affb5cd013ca878123b2bd7c8b2c00690b6
Signed-off-by: Jason Yellick <[email protected]>
  • Loading branch information
Jason Yellick committed Jun 1, 2017
1 parent 389ff3e commit 531de02
Show file tree
Hide file tree
Showing 6 changed files with 249 additions and 10 deletions.
4 changes: 2 additions & 2 deletions examples/e2e_cli/scripts/script.sh
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ updateAnchorPeers() {
setGlobals $PEER

if [ -z "$CORE_PEER_TLS_ENABLED" -o "$CORE_PEER_TLS_ENABLED" = "false" ]; then
peer channel create -o orderer.example.com:7050 -c $CHANNEL_NAME -f ./channel-artifacts/${CORE_PEER_LOCALMSPID}anchors.tx >&log.txt
peer channel update -o orderer.example.com:7050 -c $CHANNEL_NAME -f ./channel-artifacts/${CORE_PEER_LOCALMSPID}anchors.tx >&log.txt
else
peer channel create -o orderer.example.com:7050 -c $CHANNEL_NAME -f ./channel-artifacts/${CORE_PEER_LOCALMSPID}anchors.tx --tls $CORE_PEER_TLS_ENABLED --cafile $ORDERER_CA >&log.txt
peer channel update -o orderer.example.com:7050 -c $CHANNEL_NAME -f ./channel-artifacts/${CORE_PEER_LOCALMSPID}anchors.tx --tls $CORE_PEER_TLS_ENABLED --cafile $ORDERER_CA >&log.txt
fi
res=$?
cat log.txt
Expand Down
5 changes: 3 additions & 2 deletions peer/channel/channel.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ import (

const (
channelFuncName = "channel"
shortDes = "Operate a channel: create|fetch|join|list."
longDes = "Operate a channel: create|fetch|join|list."
shortDes = "Operate a channel: create|fetch|update|join|list."
longDes = "Operate a channel: create|fetch|update|join|list."
)

type OrdererRequirement bool
Expand Down Expand Up @@ -65,6 +65,7 @@ func Cmd(cf *ChannelCmdFactory) *cobra.Command {
AddFlags(channelCmd)
channelCmd.AddCommand(joinCmd(cf))
channelCmd.AddCommand(createCmd(cf))
channelCmd.AddCommand(updateCmd(cf))
channelCmd.AddCommand(fetchCmd(cf))
channelCmd.AddCommand(listCmd(cf))

Expand Down
4 changes: 2 additions & 2 deletions peer/channel/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ func createChannelFromConfigTx(configTxFileName string) (*cb.Envelope, error) {
return utils.UnmarshalEnvelope(cftx)
}

func sanityCheckAndSignChannelCreateTx(envConfigUpdate *cb.Envelope) (*cb.Envelope, error) {
func sanityCheckAndSignConfigTx(envConfigUpdate *cb.Envelope) (*cb.Envelope, error) {
payload, err := utils.ExtractPayload(envConfigUpdate)
if err != nil {
return nil, InvalidCreateTx("bad payload")
Expand Down Expand Up @@ -150,7 +150,7 @@ func sendCreateChainTransaction(cf *ChannelCmdFactory) error {
}
}

if chCrtEnv, err = sanityCheckAndSignChannelCreateTx(chCrtEnv); err != nil {
if chCrtEnv, err = sanityCheckAndSignConfigTx(chCrtEnv); err != nil {
return err
}

Expand Down
8 changes: 4 additions & 4 deletions peer/channel/create_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -551,7 +551,7 @@ func TestSanityCheckAndSignChannelCreateTx(t *testing.T) {
env := &cb.Envelope{}
env.Payload = make([]byte, 10)
var err error
env, err = sanityCheckAndSignChannelCreateTx(env)
env, err = sanityCheckAndSignConfigTx(env)
assert.Error(t, err, "Error expected for nil payload")
assert.Contains(t, err.Error(), "bad payload")

Expand All @@ -560,7 +560,7 @@ func TestSanityCheckAndSignChannelCreateTx(t *testing.T) {
data, err1 := proto.Marshal(p)
assert.NoError(t, err1)
env = &cb.Envelope{Payload: data}
env, err = sanityCheckAndSignChannelCreateTx(env)
env, err = sanityCheckAndSignConfigTx(env)
assert.Error(t, err, "Error expected for bad payload header")
assert.Contains(t, err.Error(), "bad header")

Expand All @@ -570,7 +570,7 @@ func TestSanityCheckAndSignChannelCreateTx(t *testing.T) {
data, err = proto.Marshal(p)
assert.NoError(t, err)
env = &cb.Envelope{Payload: data}
env, err = sanityCheckAndSignChannelCreateTx(env)
env, err = sanityCheckAndSignConfigTx(env)
assert.Error(t, err, "Error expected for bad channel header")
assert.Contains(t, err.Error(), "could not unmarshall channel header")

Expand All @@ -588,7 +588,7 @@ func TestSanityCheckAndSignChannelCreateTx(t *testing.T) {
data, err = proto.Marshal(p)
assert.NoError(t, err)
env = &cb.Envelope{Payload: data}
env, err = sanityCheckAndSignChannelCreateTx(env)
env, err = sanityCheckAndSignConfigTx(env)
assert.Error(t, err, "Error expected for bad payload data")
assert.Contains(t, err.Error(), "Bad config update env")
}
85 changes: 85 additions & 0 deletions peer/channel/update.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
/*
Copyright IBM Corp. 2017 All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package channel

import (
"fmt"
"io/ioutil"

"errors"

"github.com/hyperledger/fabric/peer/common"
"github.com/hyperledger/fabric/protos/utils"

"github.com/spf13/cobra"
)

func updateCmd(cf *ChannelCmdFactory) *cobra.Command {
updateCmd := &cobra.Command{
Use: "update",
Short: "Send a configtx update.",
Long: "Signs and sends the supplied configtx update file to the channel. Requires '-f', '-o', '-c'.",
RunE: func(cmd *cobra.Command, args []string) error {
return update(cmd, args, cf)
},
}

return updateCmd
}

func update(cmd *cobra.Command, args []string, cf *ChannelCmdFactory) error {
//the global chainID filled by the "-c" command
if chainID == common.UndefinedParamValue {
return errors.New("Must supply channel ID")
}

if channelTxFile == "" {
return InvalidCreateTx("No configtx file name supplied")
}

var err error
if cf == nil {
cf, err = InitCmdFactory(EndorserNotRequired, OrdererRequired)
if err != nil {
return err
}
}

fileData, err := ioutil.ReadFile(channelTxFile)
if err != nil {
return ConfigTxFileNotFound(err.Error())
}

ctxEnv, err := utils.UnmarshalEnvelope(fileData)
if err != nil {
return err
}

sCtxEnv, err := sanityCheckAndSignConfigTx(ctxEnv)
if err != nil {
return err
}

var broadcastClient common.BroadcastClient
broadcastClient, err = cf.BroadcastFactory()
if err != nil {
return fmt.Errorf("Error getting broadcast client: %s", err)
}

defer broadcastClient.Close()
return broadcastClient.Send(sCtxEnv)
}
153 changes: 153 additions & 0 deletions peer/channel/update_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
/*
Copyright IBM Corp. 2017 All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package channel

import (
"io/ioutil"
"os"
"path/filepath"
"testing"

"github.com/hyperledger/fabric/peer/common"
cb "github.com/hyperledger/fabric/protos/common"

"github.com/stretchr/testify/assert"
)

func TestUpdateChannel(t *testing.T) {
InitMSP()

dir, err := ioutil.TempDir("/tmp", "createinvaltest-")
if err != nil {
t.Fatalf("couldn't create temp dir")
}
defer os.RemoveAll(dir) // clean up

mockchannel := "mockchannel"

configtxFile := filepath.Join(dir, mockchannel)
if _, err = createTxFile(configtxFile, cb.HeaderType_CONFIG_UPDATE, mockchannel); err != nil {
t.Fatalf("couldn't create tx file")
}

signer, err := common.GetDefaultSigner()
if err != nil {
t.Fatalf("Get default signer error: %v", err)
}

mockCF := &ChannelCmdFactory{
BroadcastFactory: mockBroadcastClientFactory,
Signer: signer,
DeliverClient: &mockDeliverClient{},
}

cmd := updateCmd(mockCF)

AddFlags(cmd)

args := []string{"-c", mockchannel, "-f", configtxFile, "-o", "localhost:7050"}
cmd.SetArgs(args)

assert.NoError(t, cmd.Execute())
}

func TestUpdateChannelMissingConfigTxFlag(t *testing.T) {
InitMSP()
mockchannel := "mockchannel"

signer, err := common.GetDefaultSigner()
if err != nil {
t.Fatalf("Get default signer error: %v", err)
}

mockCF := &ChannelCmdFactory{
BroadcastFactory: mockBroadcastClientFactory,
Signer: signer,
DeliverClient: &mockDeliverClient{},
}

cmd := updateCmd(mockCF)

AddFlags(cmd)

args := []string{"-c", mockchannel, "-o", "localhost:7050"}
cmd.SetArgs(args)

assert.Error(t, cmd.Execute())
}

func TestUpdateChannelMissingConfigTxFile(t *testing.T) {
InitMSP()
mockchannel := "mockchannel"

signer, err := common.GetDefaultSigner()
if err != nil {
t.Fatalf("Get default signer error: %v", err)
}

mockCF := &ChannelCmdFactory{
BroadcastFactory: mockBroadcastClientFactory,
Signer: signer,
DeliverClient: &mockDeliverClient{},
}

cmd := createCmd(mockCF)

AddFlags(cmd)

args := []string{"-c", mockchannel, "-f", "Non-existant", "-o", "localhost:7050"}
cmd.SetArgs(args)

assert.Error(t, cmd.Execute())
}

func TestUpdateChannelMissingChannelID(t *testing.T) {
InitMSP()

dir, err := ioutil.TempDir("/tmp", "createinvaltest-")
if err != nil {
t.Fatalf("couldn't create temp dir")
}
defer os.RemoveAll(dir) // clean up

mockchannel := "mockchannel"

configtxFile := filepath.Join(dir, mockchannel)
if _, err = createTxFile(configtxFile, cb.HeaderType_CONFIG_UPDATE, mockchannel); err != nil {
t.Fatalf("couldn't create tx file")
}

signer, err := common.GetDefaultSigner()
if err != nil {
t.Fatalf("Get default signer error: %v", err)
}

mockCF := &ChannelCmdFactory{
BroadcastFactory: mockBroadcastClientFactory,
Signer: signer,
DeliverClient: &mockDeliverClient{},
}

cmd := updateCmd(mockCF)

AddFlags(cmd)

args := []string{"-f", configtxFile, "-o", "localhost:7050"}
cmd.SetArgs(args)

assert.Error(t, cmd.Execute())
}

0 comments on commit 531de02

Please sign in to comment.