added to OSN new handler for fetch a block of channel

Signed-off-by: Fedor Partanskiy <fredprtnsk@gmail.com>

Author: pfi79

cmd/osnadmin/main.go

@@ -16,6 +16,7 @@ import (
 	"io"
 	"net/http"
 	"os"
+	"strconv"
 
 	"github.com/hyperledger/fabric-protos-go-apiv2/common"
 	"github.com/hyperledger/fabric/internal/osnadmin"
@@ -63,6 +64,11 @@ func executeForArgs(args []string) (output string, exit int, err error) {
 	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()
 	tlsHandshakeTimeShift := update.Flag("tlsHandshakeTimeShift", "The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint").Short('t').Default("0").Duration()
 
+	fetch := channel.Command("fetch", "Fetch a specified block, writing it to a file.")
+	fetchChannelID := fetch.Flag("channelID", "Channel ID").Short('c').Required().String()
+	fetchBlockID := fetch.Flag("blockID", "Block ID - <newest|oldest|config|(number)>").Short('b').Required().String()
+	fetchOutputFile := fetch.Flag("outputfile", "Puth to a file.").Short('f').Required().String()
+
 	command, err := app.Parse(args)
 	if err != nil {
 		return "", 1, err
@@ -141,6 +147,14 @@ func executeForArgs(args []string) (output string, exit int, err error) {
 		resp, err = osnadmin.Remove(osnURL, *removeChannelID, caCertPool, tlsClientCert)
 	case update.FullCommand():
 		resp, err = osnadmin.Update(osnURL, marshaledConfigEnvelope, caCertPool, tlsClientCert, *tlsHandshakeTimeShift)
+	case fetch.FullCommand():
+		if *fetchBlockID != "newest" && *fetchBlockID != "oldest" && *fetchBlockID != "config" {
+			_, err = strconv.Atoi(*fetchBlockID)
+			if err != nil {
+				return "", 1, fmt.Errorf("'%s' not equal <newest|oldest|config|(number)>", *fetchBlockID)
+			}
+		}
+		resp, err = osnadmin.Fetch(osnURL, *fetchChannelID, *fetchBlockID, caCertPool, tlsClientCert)
 	}
 	if err != nil {
 		return errorOutput(err), 1, nil
@@ -151,22 +165,28 @@ func executeForArgs(args []string) (output string, exit int, err error) {
 		return errorOutput(err), 1, nil
 	}
 
-	output, err = responseOutput(!*noStatus, resp.StatusCode, bodyBytes)
+	output, err = responseOutput(!*noStatus, resp.StatusCode, bodyBytes, *fetchOutputFile)
 	if err != nil {
 		return errorOutput(err), 1, nil
 	}
 
 	return output, 0, nil
 }
 
-func responseOutput(showStatus bool, statusCode int, responseBody []byte) (string, error) {
+func responseOutput(showStatus bool, statusCode int, responseBody []byte, outputFile string) (string, error) {
 	var buffer bytes.Buffer
 	if showStatus {
 		fmt.Fprintf(&buffer, "Status: %d\n", statusCode)
 	}
 	if len(responseBody) != 0 {
-		if err := json.Indent(&buffer, responseBody, "", "\t"); err != nil {
-			return "", err
+		if outputFile != "" {
+			if err := os.WriteFile(outputFile, responseBody, 0o644); err != nil {
+				return "", err
+			}
+		} else {
+			if err := json.Indent(&buffer, responseBody, "", "\t"); err != nil {
+				return "", err
+			}
 		}
 	}
 	return buffer.String(), nil

cmd/osnadmin/mocks/channel_management.go

@@ -23,6 +23,7 @@ type channelManagement interface {
 	JoinChannel(channelID string, configBlock *cb.Block) (types.ChannelInfo, error)
 	UpdateChannel(channelID string, configUpdateEnvelope *cb.Envelope) (types.ChannelInfo, error)
 	RemoveChannel(channelID string) error
+	FetchBlock(channelID string, blockID string) (*cb.Block, error)
 }
 
 func TestOsnadmin(t *testing.T) {

cmd/osnadmin/osnadmin_suite_test.go

@@ -18,6 +18,8 @@ The `osnadmin channel` command has the following subcommands:
   * join
   * list
   * remove
+  * update
+  * fetch
 
 ## osnadmin channel
 ```
@@ -56,6 +58,9 @@ Subcommands:
 
   channel update --channelID=CHANNELID --config-update-envelope=CONFIG-UPDATE-ENVELOPE [<flags>]
     Update an Ordering Service Node (OSN) to a channel.
+
+  channel fetch --channelID=CHANNELID --blockID=BLOCKID --outputfile=OUTPUTFILE
+    Fetch a specified block, writing it to a file.
 ```
 
 
@@ -169,6 +174,33 @@ Flags:
                                  handshakes with the orderer endpoint
 ```
 
+
+## osnadmin channel fetch
+```
+usage: osnadmin channel fetch --channelID=CHANNELID --blockID=BLOCKID --outputfile=OUTPUTFILE
+
+Fetch a specified block, writing it to a file.
+
+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, --blockID=BLOCKID          Block ID - <newest|oldest|config|(number)>
+  -f, --outputfile=OUTPUTFILE    Puth to a file.
+```
+
 ## Example Usage
 
 ### osnadmin channel join examples

docs/source/commands/osnadminchannel.md

@@ -13,3 +13,5 @@ The `osnadmin channel` command has the following subcommands:
   * join
   * list
   * remove
+  * update
+  * fetch

docs/wrappers/osnadmin_channel_preamble.md

@@ -171,6 +171,17 @@ func getBody(client *http.Client, url string) func() string {
 	}
 }
 
+func getBodyBinary(client *http.Client, url string) func() []byte {
+	return func() []byte {
+		resp, err := client.Get(url)
+		Expect(err).NotTo(HaveOccurred())
+		bodyBytes, err := io.ReadAll(resp.Body)
+		Expect(err).NotTo(HaveOccurred())
+		resp.Body.Close()
+		return bodyBytes
+	}
+}
+
 type ChannelInfo struct {
 	Name              string `json:"name"`
 	URL               string `json:"url"`
@@ -195,6 +206,29 @@ func ListOne(n *Network, o *Orderer, channel string) ChannelInfo {
 	return *c
 }
 
+func Fetch(n *Network, o *Orderer, channel string, blockID string, errStr string) *common.Block {
+	authClient, _ := OrdererOperationalClients(n, o)
+
+	protocol := "http"
+	if n.TLSEnabled {
+		protocol = "https"
+	}
+	fetchURL := fmt.Sprintf("%s://127.0.0.1:%d/participation/v1/channels/%s/blocks/%s", protocol, n.OrdererPort(o, AdminPort), channel, blockID)
+
+	body := getBodyBinary(authClient, fetchURL)()
+	if errStr != "" {
+		Expect(string(body)).To(ContainSubstring(errStr))
+
+		return nil
+	}
+
+	b := &common.Block{}
+	err := proto.Unmarshal(body, b)
+	Expect(err).NotTo(HaveOccurred())
+
+	return b
+}
+
 func Remove(n *Network, o *Orderer, channel string) {
 	authClient, _ := OrdererOperationalClients(n, o)
 

integration/nwo/channel_participation.go

@@ -0,0 +1,21 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package osnadmin
+
+import (
+	"crypto/tls"
+	"crypto/x509"
+	"fmt"
+	"net/http"
+)
+
+// Fetch get block from OSN.
+func Fetch(osnURL, channelID string, blockID string, caCertPool *x509.CertPool, tlsClientCert tls.Certificate) (*http.Response, error) {
+	url := fmt.Sprintf("%s/participation/v1/channels/%s/blocks/%s", osnURL, channelID, blockID)
+
+	return httpGet(url, caCertPool, tlsClientCert)
+}