added to OSN new handler for update config of channel

Signed-off-by: Fedor Partanskiy <[email protected]>

Author: pfi79

cmd/osnadmin/main.go

@@ -58,6 +58,10 @@ func executeForArgs(args []string) (output string, exit int, err error) {
 	remove := channel.Command("remove", "Remove a channel from an Ordering Service Node (OSN).")
 	removeChannelID := remove.Flag("channelID", "Channel ID").Short('c').Required().String()
 
+	update := channel.Command("update", "Update an Ordering Service Node (OSN) to a channel.")
+	updateChannelID := update.Flag("channelID", "Channel ID").Short('c').Required().String()
+	configUpdateEnvelopePath := update.Flag("config-update-envelope", "Path to the file containing an up-to-date config update envelope for the channel").Short('e').Required().String()
+
 	command, err := app.Parse(args)
 	if err != nil {
 		return "", 1, err
@@ -105,6 +109,19 @@ func executeForArgs(args []string) (output string, exit int, err error) {
 		}
 	}
 
+	var marshaledConfigEnvelope []byte
+	if *configUpdateEnvelopePath != "" {
+		marshaledConfigEnvelope, err = os.ReadFile(*configUpdateEnvelopePath)
+		if err != nil {
+			return "", 1, fmt.Errorf("reading config updte envelope: %s", err)
+		}
+
+		err = validateEnvelopeChannelID(marshaledConfigEnvelope, *updateChannelID)
+		if err != nil {
+			return "", 1, err
+		}
+	}
+
 	//
 	// call the underlying implementations
 	//
@@ -121,6 +138,8 @@ func executeForArgs(args []string) (output string, exit int, err error) {
 		resp, err = osnadmin.ListAllChannels(osnURL, caCertPool, tlsClientCert)
 	case remove.FullCommand():
 		resp, err = osnadmin.Remove(osnURL, *removeChannelID, caCertPool, tlsClientCert)
+	case update.FullCommand():
+		resp, err = osnadmin.Update(osnURL, marshaledConfigEnvelope, caCertPool, tlsClientCert)
 	}
 	if err != nil {
 		return errorOutput(err), 1, nil
@@ -186,3 +205,24 @@ func validateBlockChannelID(blockBytes []byte, channelID string) error {
 
 	return nil
 }
+
+func validateEnvelopeChannelID(envelopeBytes []byte, channelID string) error {
+	envelope := &common.Envelope{}
+	err := proto.Unmarshal(envelopeBytes, envelope)
+	if err != nil {
+		return fmt.Errorf("unmarshalling envelope: %s", err)
+	}
+
+	envelopeChannelID, err := protoutil.GetChannelIDFromEnvelope(envelope)
+	if err != nil {
+		return err
+	}
+
+	// quick sanity check that the orderer admin is joining
+	// the channel they think they're joining.
+	if channelID != envelopeChannelID {
+		return fmt.Errorf("specified --channelID %s does not match channel ID %s in config update envelope", channelID, envelopeChannelID)
+	}
+
+	return nil
+}

cmd/osnadmin/mocks/channel_management.go

@@ -21,6 +21,7 @@ type channelManagement interface {
 	ChannelList() types.ChannelList
 	ChannelInfo(channelID string) (types.ChannelInfo, error)
 	JoinChannel(channelID string, configBlock *cb.Block) (types.ChannelInfo, error)
+	UpdateChannel(channelID string, configUpdateEnvelope *cb.Envelope) (types.ChannelInfo, error)
 	RemoveChannel(channelID string) error
 }
 

cmd/osnadmin/osnadmin_suite_test.go

@@ -53,6 +53,9 @@ Subcommands:
 
   channel remove --channelID=CHANNELID
     Remove a channel from an Ordering Service Node (OSN).
+    
+  channel update --channelID=CHANNELID --config-update-envelope=CONFIG-UPDATE-ENVELOPE
+    Update an Ordering Service Node (OSN) to a channel.
 ```
 
 
@@ -135,6 +138,33 @@ Flags:
   -c, --channelID=CHANNELID      Channel ID
 ```
 
+## osnadmin channel update
+```
+usage: osnadmin channel update --channelID=CHANNELID --config-update-envelope=CONFIG-UPDATE-ENVELOPE
+
+Update an Ordering Service Node (OSN) to a channel.
+
+Flags:
+      --help                     Show context-sensitive help (also try
+                                 --help-long and --help-man).
+  -o, --orderer-address=ORDERER-ADDRESS
+                                 Admin endpoint of the OSN
+      --ca-file=CA-FILE          Path to file containing PEM-encoded TLS CA
+                                 certificate(s) for the OSN
+      --client-cert=CLIENT-CERT  Path to file containing PEM-encoded X509 public
+                                 key to use for mutual TLS communication with
+                                 the OSN
+      --client-key=CLIENT-KEY    Path to file containing PEM-encoded private key
+                                 to use for mutual TLS communication with the
+                                 OSN
+      --no-status                Remove the HTTP status message from the command
+                                 output
+  -c, --channelID=CHANNELID      Channel ID
+  -b, --config-block=CONFIG-BLOCK
+                                 Path to the file containing an up-to-date
+                                 config block for the channel
+```
+
 ## Example Usage
 
 ### osnadmin channel join examples
@@ -220,4 +250,30 @@ Here's an example of the `osnadmin channel remove` command.
 
   Status 204 is returned upon successful removal of a channel.
 
+### osnadmin channel update examples
+
+Here's an example of the `osnadmin channel update` command.
+
+* Update the example of the `my channel` channel defined by the modified config 
+  contained in the `my channel-config-envelope.pb` file. 
+  Use the endpoint of the order administrator
+  at `order.example.com:9443`.
+
+  ```
+  osnadmin channel update -o orderer.example.com:9443 --ca-file $CA_FILE --client-cert $CLIENT_CERT --client-key $CLIENT_KEY --channelID mychannel --config-update-envelope mychannel-genesis-block.pb
+
+  Status: 201
+  {
+    "name": "mychannel",
+    "url": "/participation/v1/channels/mychannel",
+    "consensusRelation": "consenter",
+    "status": "active",
+    "height": 1
+  }
+
+  ```
+
+  Status 201 and the channel details are returned indicating that the channel has been
+  successfully updated.
+
 <a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.

docs/source/commands/osnadminchannel.md

@@ -65,6 +65,45 @@ func GenerateJoinRequest(url, channel string, blockBytes []byte) *http.Request {
 	return req
 }
 
+func Update(n *nwo.Network, o *nwo.Orderer, channel string, envelope *common.Envelope, expectedChannelInfo ChannelInfo) {
+	envelopeBytes, err := proto.Marshal(envelope)
+	Expect(err).NotTo(HaveOccurred())
+
+	protocol := "http"
+	if n.TLSEnabled {
+		protocol = "https"
+	}
+	url := fmt.Sprintf("%s://127.0.0.1:%d/participation/v1/channels", protocol, n.OrdererPort(o, nwo.AdminPort))
+	req := GenerateUpdateRequest(url, channel, envelopeBytes)
+	authClient, unauthClient := nwo.OrdererOperationalClients(n, o)
+
+	client := unauthClient
+	if n.TLSEnabled {
+		client = authClient
+	}
+	body := doBody(client, req)
+	c := &ChannelInfo{}
+	err = json.Unmarshal(body, c)
+	Expect(err).NotTo(HaveOccurred())
+	Expect(*c).To(Equal(expectedChannelInfo))
+}
+
+func GenerateUpdateRequest(url, channel string, envelopeBytes []byte) *http.Request {
+	updateBody := new(bytes.Buffer)
+	writer := multipart.NewWriter(updateBody)
+	part, err := writer.CreateFormFile("config-update-envelope", fmt.Sprintf("%s-update.envelope", channel))
+	Expect(err).NotTo(HaveOccurred())
+	part.Write(envelopeBytes)
+	err = writer.Close()
+	Expect(err).NotTo(HaveOccurred())
+
+	req, err := http.NewRequest(http.MethodPost, url, updateBody)
+	Expect(err).NotTo(HaveOccurred())
+	req.Header.Set("Content-Type", writer.FormDataContentType())
+
+	return req
+}
+
 func doBody(client *http.Client, req *http.Request) []byte {
 	resp, err := client.Do(req)
 	Expect(err).NotTo(HaveOccurred())