[FAB-7948] Removing *WithOpts functions in chmgmtclient

Change-Id: I0e8e441921adc6edb51fb33226daadcfba37012a
Signed-off-by: Sudesh Shetty <[email protected]>

api/apitxn/chmgmtclient/chmgmt.go

@@ -18,17 +18,18 @@ type SaveChannelRequest struct {
 	SigningIdentity fab.IdentityContext
 }
 
-// SaveChannelOpts contains options for saving channel
-type SaveChannelOpts struct {
+// Opts contains options for saving channel, this struct is intended for reference only.
+// Will be used in form of Option to pass arguments
+type Opts struct {
 	OrdererID string // use specific orderer
 }
 
+//Option func for each Opts argument
+type Option func(opts *Opts) error
+
 // ChannelMgmtClient supports creating new channels
 type ChannelMgmtClient interface {
 
-	// SaveChannel creates or updates channel
-	SaveChannel(req SaveChannelRequest) error
-
-	// SaveChannel creates or updates channel with custom options
-	SaveChannelWithOpts(req SaveChannelRequest, opts SaveChannelOpts) error
+	// SaveChannel creates or updates channel with optional Opts options
+	SaveChannel(req SaveChannelRequest, options ...Option) error
 }

api/apitxn/chmgmtclient/opts.go

@@ -0,0 +1,15 @@
+/*
+Copyright SecureKey Technologies Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package chmgmtclient
+
+//WithOrdererID encapsulates OrdererID to Option
+func WithOrdererID(ordererID string) Option {
+	return func(opts *Opts) error {
+		opts.OrdererID = ordererID
+		return nil
+	}
+}

pkg/fabric-txn/chmgmtclient/chmgmt.go

@@ -34,12 +34,12 @@ func NewChannelMgmtClient(client fab.Resource, config config.Config) (*ChannelMg
 }
 
 // SaveChannel creates or updates channel
-func (cc *ChannelMgmtClient) SaveChannel(req chmgmt.SaveChannelRequest) error {
-	return cc.SaveChannelWithOpts(req, chmgmt.SaveChannelOpts{})
-}
+func (cc *ChannelMgmtClient) SaveChannel(req chmgmt.SaveChannelRequest, options ...chmgmt.Option) error {
 
-// SaveChannelWithOpts creates or updates channel with custom options
-func (cc *ChannelMgmtClient) SaveChannelWithOpts(req chmgmt.SaveChannelRequest, opts chmgmt.SaveChannelOpts) error {
+	opts, err := cc.prepareSaveChannelOpts(options...)
+	if err != nil {
+		return err
+	}
 
 	if req.ChannelID == "" || req.ChannelConfig == "" {
 		return errors.New("must provide channel ID and channel config")
@@ -110,3 +110,15 @@ func (cc *ChannelMgmtClient) SaveChannelWithOpts(req chmgmt.SaveChannelRequest,
 
 	return nil
 }
+
+//prepareSaveChannelOpts Reads chmgmt.Opts from chmgmt.Option array
+func (cc *ChannelMgmtClient) prepareSaveChannelOpts(options ...chmgmt.Option) (chmgmt.Opts, error) {
+	saveChannelOpts := chmgmt.Opts{}
+	for _, option := range options {
+		err := option(&saveChannelOpts)
+		if err != nil {
+			return saveChannelOpts, errors.WithMessage(err, "Failed to read save channel opts")
+		}
+	}
+	return saveChannelOpts, nil
+}

pkg/fabric-txn/chmgmtclient/chmgmt_test.go

@@ -109,22 +109,22 @@ func TestSaveChannelWithOpts(t *testing.T) {
 	req := chmgmtclient.SaveChannelRequest{ChannelID: "mychannel", ChannelConfig: channelConfig}
 
 	// Test empty option (default order is random orderer from config)
-	opts := chmgmtclient.SaveChannelOpts{}
-	err := cc.SaveChannelWithOpts(req, opts)
+	opts := chmgmtclient.WithOrdererID("")
+	err := cc.SaveChannel(req, opts)
 	if err != nil {
 		t.Fatal(err)
 	}
 
 	// Test valid orderer ID
-	opts.OrdererID = "orderer.example.com"
-	err = cc.SaveChannelWithOpts(req, opts)
+	opts = chmgmtclient.WithOrdererID("orderer.example.com")
+	err = cc.SaveChannel(req, opts)
 	if err != nil {
 		t.Fatal(err)
 	}
 
 	// Test invalid orderer ID
-	opts.OrdererID = "Invalid"
-	err = cc.SaveChannelWithOpts(req, opts)
+	opts = chmgmtclient.WithOrdererID("Invalid")
+	err = cc.SaveChannel(req, opts)
 	if err == nil {
 		t.Fatal("Should have failed for invalid orderer ID")
 	}