[FAB-5602] add channel create outputBlock flag

By default, peer channel create will create a file in the current
directory named $CHANNEL.block. If a different output file is desired,
the --outputBlock flag can be used to specify the path.

Change-Id: I8b0f2ced26c62a21e3139688c588c10763ed533c
Signed-off-by: Matthew Sykes <sykesmat@us.ibm.com>

Author: sykesm

peer/channel/channel.go

@@ -42,6 +42,7 @@ var (
 	// create related variables
 	channelID     string
 	channelTxFile string
+	outputBlock   string
 	timeout       int
 )
 
@@ -78,6 +79,7 @@ func resetFlags() {
 	flags.StringVarP(&genesisBlockPath, "blockpath", "b", common.UndefinedParamValue, "Path to file containing genesis block")
 	flags.StringVarP(&channelID, "channelID", "c", common.UndefinedParamValue, "In case of a newChain command, the channel ID to create.")
 	flags.StringVarP(&channelTxFile, "file", "f", "", "Configuration transaction file generated by a tool such as configtxgen for submitting to orderer")
+	flags.StringVarP(&outputBlock, "outputBlock", "", common.UndefinedParamValue, `The path to write the genesis block for the channel. (default ./<channelID>.block)`)
 	flags.IntVarP(&timeout, "timeout", "t", 5, "Channel creation timeout")
 }
 

peer/channel/create.go

@@ -37,8 +37,6 @@ import (
 //ConfigTxFileNotFound channel create configuration tx file not found
 type ConfigTxFileNotFound string
 
-const createCmdDescription = "Create a channel"
-
 func (e ConfigTxFileNotFound) Error() string {
 	return fmt.Sprintf("channel create configuration tx file not found %s", string(e))
 }
@@ -53,15 +51,16 @@ func (e InvalidCreateTx) Error() string {
 func createCmd(cf *ChannelCmdFactory) *cobra.Command {
 	createCmd := &cobra.Command{
 		Use:   "create",
-		Short: createCmdDescription,
-		Long:  createCmdDescription,
+		Short: "Create a channel",
+		Long:  "Create a channel and write the genesis block to a file.",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return create(cmd, args, cf)
 		},
 	}
 	flagList := []string{
 		"channelID",
 		"file",
+		"outputBlock",
 		"timeout",
 	}
 	attachFlags(createCmd, flagList)
@@ -173,14 +172,13 @@ func sendCreateChainTransaction(cf *ChannelCmdFactory) error {
 }
 
 func executeCreate(cf *ChannelCmdFactory) error {
-	var err error
-
-	if err = sendCreateChainTransaction(cf); err != nil {
+	err := sendCreateChainTransaction(cf)
+	if err != nil {
 		return err
 	}
 
-	var block *cb.Block
-	if block, err = getGenesisBlock(cf); err != nil {
+	block, err := getGenesisBlock(cf)
+	if err != nil {
 		return err
 	}
 
@@ -190,7 +188,11 @@ func executeCreate(cf *ChannelCmdFactory) error {
 	}
 
 	file := channelID + ".block"
-	if err = ioutil.WriteFile(file, b, 0644); err != nil {
+	if outputBlock != common.UndefinedParamValue {
+		file = outputBlock
+	}
+	err = ioutil.WriteFile(file, b, 0644)
+	if err != nil {
 		return err
 	}
 
@@ -202,6 +204,7 @@ func create(cmd *cobra.Command, args []string, cf *ChannelCmdFactory) error {
 	if channelID == common.UndefinedParamValue {
 		return errors.New("Must supply channel ID")
 	}
+
 	// Parsing of the command line is done so silence cmd usage
 	cmd.SilenceUsage = true
 

peer/channel/create_test.go

@@ -178,6 +178,51 @@ func TestCreateChain(t *testing.T) {
 		t.Fail()
 		t.Errorf("expected create command to succeed")
 	}
+
+	filename := mockchain + ".block"
+	if _, err := os.Stat(filename); err != nil {
+		t.Fail()
+		t.Errorf("expected %s to exist", filename)
+	}
+}
+
+func TestCreateChainWithOutputBlock(t *testing.T) {
+	InitMSP()
+	cleanup := configtest.SetDevFabricConfigPath(t)
+	defer cleanup()
+
+	mockchain := "mockchain"
+
+	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)
+
+	tempDir, err := ioutil.TempDir("", "create-output")
+	if err != nil {
+		t.Fatalf("failed to create temporary directory")
+	}
+	defer os.RemoveAll(tempDir)
+
+	outputBlockPath := filepath.Join(tempDir, "output.block")
+	args := []string{"-c", mockchain, "-o", "localhost:7050", "--outputBlock", outputBlockPath}
+	cmd.SetArgs(args)
+	defer func() { outputBlock = "" }()
+
+	err = cmd.Execute()
+	assert.NoError(t, err, "execute should succeed")
+
+	_, err = os.Stat(outputBlockPath)
+	assert.NoErrorf(t, err, "expected %s to exist", outputBlockPath)
 }
 
 func TestCreateChainWithDefaultAnchorPeers(t *testing.T) {
@@ -398,7 +443,7 @@ func TestCreateChainFromTx(t *testing.T) {
 	defer cleanup()
 
 	mockchannel := "mockchannel"
-	dir, err := ioutil.TempDir("/tmp", "createtestfromtx-")
+	dir, err := ioutil.TempDir("", "createtestfromtx-")
 	if err != nil {
 		t.Fatalf("couldn't create temp dir")
 	}
@@ -459,7 +504,7 @@ func TestCreateChainInvalidTx(t *testing.T) {
 
 	mockchannel := "mockchannel"
 
-	dir, err := ioutil.TempDir("/tmp", "createinvaltest-")
+	dir, err := ioutil.TempDir("", "createinvaltest-")
 	if err != nil {
 		t.Fatalf("couldn't create temp dir")
 	}
@@ -531,7 +576,7 @@ func TestCreateChainNilCF(t *testing.T) {
 	defer cleanup()
 
 	mockchannel := "mockchannel"
-	dir, err := ioutil.TempDir("/tmp", "createinvaltest-")
+	dir, err := ioutil.TempDir("", "createinvaltest-")
 	assert.NoError(t, err, "Couldn't create temp dir")
 	defer os.RemoveAll(dir) // clean up