added to OSN new handler for fetch a block of channel

part 3

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,12 @@ 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()
+	tlsHandshakeTimeShift1 := fetch.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()
+
 	command, err := app.Parse(args)
 	if err != nil {
 		return "", 1, err
@@ -141,6 +148,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, *tlsHandshakeTimeShift1)
 	}
 	if err != nil {
 		return errorOutput(err), 1, nil
@@ -151,22 +166,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 statusCode == http.StatusOK && 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/main_test.go

@@ -22,6 +22,7 @@ import (
 	cb "github.com/hyperledger/fabric-protos-go-apiv2/common"
 	"github.com/hyperledger/fabric/cmd/osnadmin/mocks"
 	"github.com/hyperledger/fabric/common/crypto/tlsgen"
+	. "github.com/hyperledger/fabric/internal/test"
 	"github.com/hyperledger/fabric/orderer/common/channelparticipation"
 	"github.com/hyperledger/fabric/orderer/common/localconfig"
 	"github.com/hyperledger/fabric/orderer/common/types"
@@ -694,7 +695,7 @@ var _ = Describe("osnadmin", func() {
 				tlsConfig = nil
 			})
 
-			It("uses the channel participation API to join a channel", func() {
+			It("uses the channel participation API to update a channel", func() {
 				args := []string{
 					"channel",
 					"update",
@@ -713,6 +714,137 @@ var _ = Describe("osnadmin", func() {
 		})
 	})
 
+	Describe("Fetch", func() {
+		var (
+			blockPath string
+			block     *cb.Block
+		)
+
+		BeforeEach(func() {
+			blockPath = filepath.Join(tempDir, "block.pb")
+			block = blockWithGroups(
+				map[string]*cb.ConfigGroup{
+					"Application": {},
+				},
+				"testing123",
+			)
+			mockChannelManagement.FetchBlockReturns(block, nil)
+		})
+
+		AfterEach(func() {
+			_ = os.Remove(blockPath)
+		})
+
+		It("uses the channel participation API to fetch a block", func() {
+			args := []string{
+				"channel",
+				"fetch",
+				"--outputfile", blockPath,
+				"--channelID", channelID,
+				"--blockID", "100",
+				"--orderer-address", ordererURL,
+				"--ca-file", ordererCACert,
+				"--client-cert", clientCert,
+				"--client-key", clientKey,
+			}
+			output, exit, err := executeForArgs(args)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(exit).To(Equal(0))
+			Expect(output).To(Equal(fmt.Sprintf("Status: %d\n", 200)))
+
+			blockBytes, err := os.ReadFile(blockPath)
+			Expect(err).NotTo(HaveOccurred())
+
+			b := &cb.Block{}
+			err = proto.Unmarshal(blockBytes, b)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(b).To(ProtoEqual(block))
+		})
+
+		Context("when the block is empty", func() {
+			BeforeEach(func() {
+				block = &cb.Block{}
+				mockChannelManagement.FetchBlockReturns(block, nil)
+			})
+
+			It("returns with exit code 1 and prints the error", func() {
+				args := []string{
+					"channel",
+					"fetch",
+					"--outputfile", blockPath,
+					"--channelID", channelID,
+					"--blockID", "100",
+					"--orderer-address", ordererURL,
+					"--ca-file", ordererCACert,
+					"--client-cert", clientCert,
+					"--client-key", clientKey,
+				}
+				output, exit, err := executeForArgs(args)
+				Expect(err).NotTo(HaveOccurred())
+				Expect(exit).To(Equal(0))
+				Expect(output).To(Equal(fmt.Sprintf("Status: %d\n", 200)))
+
+				blockBytes, err := os.ReadFile(blockPath)
+				Expect(err).To(HaveOccurred())
+				Expect(blockBytes).To(BeNil())
+			})
+		})
+
+		Context("when fetch the channel fails", func() {
+			BeforeEach(func() {
+				mockChannelManagement.FetchBlockReturns(nil, types.ErrChannelNotExist)
+			})
+
+			It("returns 404 does not exist", func() {
+				args := []string{
+					"channel",
+					"fetch",
+					"--outputfile", blockPath,
+					"--channelID", channelID,
+					"--blockID", "100",
+					"--orderer-address", ordererURL,
+					"--ca-file", ordererCACert,
+					"--client-cert", clientCert,
+					"--client-key", clientKey,
+				}
+				output, exit, err := executeForArgs(args)
+				expectedOutput := types.ErrorResponse{
+					Error: "channel does not exist",
+				}
+				checkStatusOutput(output, exit, err, 404, expectedOutput)
+			})
+		})
+
+		Context("when TLS is disabled", func() {
+			BeforeEach(func() {
+				tlsConfig = nil
+			})
+
+			It("uses the channel participation API to fetch a block", func() {
+				args := []string{
+					"channel",
+					"fetch",
+					"--outputfile", blockPath,
+					"--channelID", channelID,
+					"--blockID", "100",
+					"--orderer-address", ordererURL,
+				}
+				output, exit, err := executeForArgs(args)
+				Expect(err).NotTo(HaveOccurred())
+				Expect(exit).To(Equal(0))
+				Expect(output).To(Equal(fmt.Sprintf("Status: %d\n", 200)))
+
+				blockBytes, err := os.ReadFile(blockPath)
+				Expect(err).NotTo(HaveOccurred())
+
+				b := &cb.Block{}
+				err = proto.Unmarshal(blockBytes, b)
+				Expect(err).NotTo(HaveOccurred())
+				Expect(b).To(ProtoEqual(block))
+			})
+		})
+	})
+
 	Describe("Flags", func() {
 		It("accepts short versions of the --orderer-address, --channelID, and --config-block flags", func() {
 			configBlock := blockWithGroups(
@@ -750,6 +882,41 @@ var _ = Describe("osnadmin", func() {
 			checkStatusOutput(output, exit, err, 201, expectedOutput)
 		})
 
+		It("accepts short versions of the --channelID, --blockID, and --outputfile flags", func() {
+			blockPath := filepath.Join(tempDir, "block.pb")
+			block := blockWithGroups(
+				map[string]*cb.ConfigGroup{
+					"Application": {},
+				},
+				"testing123",
+			)
+			mockChannelManagement.FetchBlockReturns(block, nil)
+
+			args := []string{
+				"channel",
+				"fetch",
+				"-f", blockPath,
+				"-c", channelID,
+				"-b", "oldest",
+				"-o", ordererURL,
+				"--ca-file", ordererCACert,
+				"--client-cert", clientCert,
+				"--client-key", clientKey,
+			}
+			output, exit, err := executeForArgs(args)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(exit).To(Equal(0))
+			Expect(output).To(Equal(fmt.Sprintf("Status: %d\n", 200)))
+
+			blockBytes, err := os.ReadFile(blockPath)
+			Expect(err).NotTo(HaveOccurred())
+
+			b := &cb.Block{}
+			err = proto.Unmarshal(blockBytes, b)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(b).To(ProtoEqual(block))
+		})
+
 		Context("when an unknown flag is used", func() {
 			It("returns an error for long flags", func() {
 				_, _, err := executeForArgs([]string{"channel", "list", "--bad-flag"})

docs/source/commands/osnadminchannel.md

@@ -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 [<flags>]
+    Fetch a specified block, writing it to a file.
 ```
 
 
@@ -169,6 +174,35 @@ Flags:
                                  handshakes with the orderer endpoint
 ```
 
+## osnadmin channel fetch
+```
+usage: osnadmin channel fetch --channelID=CHANNELID --blockID=BLOCKID --outputfile=OUTPUTFILE [<flags>]
+
+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.
+  -t, --tlsHandshakeTimeShift=0  The amount of time to shift backwards for
+                                 certificate expiration checks during TLS
+                                 handshakes with the orderer endpoint
+```
+
 ## Example Usage
 
 ### osnadmin channel join examples

docs/wrappers/osnadmin_channel_preamble.md

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

internal/osnadmin/fetch.go

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

internal/osnadmin/httpclient.go

@@ -45,3 +45,8 @@ func httpGet(url string, caCertPool *x509.CertPool, tlsClientCert tls.Certificat
 	client := httpClient(caCertPool, tlsClientCert, 0)
 	return client.Get(url)
 }
+
+func httpGetTimeShift(url string, caCertPool *x509.CertPool, tlsClientCert tls.Certificate, timeShift time.Duration) (*http.Response, error) {
+	client := httpClient(caCertPool, tlsClientCert, timeShift)
+	return client.Get(url)
+}

scripts/help_docs.sh

@@ -134,7 +134,7 @@ generateOrCheck \
         docs/wrappers/configtxlator_postscript.md \
         "${commands[@]}"
 
-commands=("osnadmin channel" "osnadmin channel join" "osnadmin channel list" "osnadmin channel remove" "osnadmin channel update")
+commands=("osnadmin channel" "osnadmin channel join" "osnadmin channel list" "osnadmin channel remove" "osnadmin channel update" "osnadmin channel fetch")
 generateOrCheck \
         docs/source/commands/osnadminchannel.md \
         docs/wrappers/osnadmin_channel_preamble.md \