Add query to get all the channels for a given peer

This change adds a query which returns information about
all the channels for a given peer. The return value is a
ChannelQueryResponse proto which contains an array of
ChannelInfo protos, which each contain the channel id.
In the future, more information about the channels will
likely be added to the ChannelInfo proto.

https://jira.hyperledger.org/browse/FAB-2237

Change-Id: I46b96b37cfa607b7996fa65790e3288e0d0983b2
Signed-off-by: Will Lahti <[email protected]>

Author: wlahti

core/peer/peer.go

@@ -36,6 +36,7 @@ import (
 	"github.com/hyperledger/fabric/gossip/service"
 	mspmgmt "github.com/hyperledger/fabric/msp/mgmt"
 	"github.com/hyperledger/fabric/protos/common"
+	pb "github.com/hyperledger/fabric/protos/peer"
 	"github.com/hyperledger/fabric/protos/utils"
 	"github.com/op/go-logging"
 	"github.com/spf13/viper"
@@ -344,6 +345,24 @@ func NewPeerClientConnectionWithAddress(peerAddress string) (*grpc.ClientConn, e
 	return comm.NewClientConnectionWithAddress(peerAddress, true, false, nil)
 }
 
+// GetChannelsInfo returns an array with information about all channels for
+// this peer
+func GetChannelsInfo() []*pb.ChannelInfo {
+	// array to store metadata for all channels
+	var channelInfoArray []*pb.ChannelInfo
+
+	chains.RLock()
+	defer chains.RUnlock()
+	for key := range chains.list {
+		channelInfo := &pb.ChannelInfo{ChannelId: key}
+
+		// add this specific chaincode's metadata to the array of all chaincodes
+		channelInfoArray = append(channelInfoArray, channelInfo)
+	}
+
+	return channelInfoArray
+}
+
 // GetPolicyManagerMgmt returns a special PolicyManager whose
 // only function is to give access to the policy manager of
 // a given channel. If the channel does not exists then,

core/peer/peer_test.go

@@ -124,6 +124,11 @@ func TestCreateChainFromBlock(t *testing.T) {
 	Initialize(nil)
 
 	SetCurrConfigBlock(block, testChainID)
+
+	channels := GetChannelsInfo()
+	if len(channels) != 1 {
+		t.Fatalf("incorrect number of channels")
+	}
 }
 
 func TestNewPeerClientConnection(t *testing.T) {

core/scc/cscc/configure.go

@@ -24,6 +24,7 @@ package cscc
 import (
 	"fmt"
 
+	"github.com/golang/protobuf/proto"
 	"github.com/hyperledger/fabric/core/chaincode/shim"
 	"github.com/hyperledger/fabric/core/peer"
 	pb "github.com/hyperledger/fabric/protos/peer"
@@ -44,6 +45,7 @@ const (
 	JoinChain         string = "JoinChain"
 	UpdateConfigBlock string = "UpdateConfigBlock"
 	GetConfigBlock    string = "GetConfigBlock"
+	GetChannels       string = "GetChannels"
 )
 
 // Init is called once per chain when the chain is created.
@@ -67,11 +69,16 @@ func (e *PeerConfiger) Init(stub shim.ChaincodeStubInterface) pb.Response {
 func (e *PeerConfiger) Invoke(stub shim.ChaincodeStubInterface) pb.Response {
 	args := stub.GetArgs()
 
-	if len(args) < 2 {
+	if len(args) < 1 {
 		return shim.Error(fmt.Sprintf("Incorrect number of arguments, %d", len(args)))
 	}
+
 	fname := string(args[0])
 
+	if fname != GetChannels && len(args) < 2 {
+		return shim.Error(fmt.Sprintf("Incorrect number of arguments, %d", len(args)))
+	}
+
 	cnflogger.Debugf("Invoke function: %s", fname)
 
 	// TODO: Handle ACL
@@ -82,6 +89,8 @@ func (e *PeerConfiger) Invoke(stub shim.ChaincodeStubInterface) pb.Response {
 		return getConfigBlock(args[1])
 	} else if fname == UpdateConfigBlock {
 		return updateConfigBlock(args[1])
+	} else if fname == GetChannels {
+		return getChannels()
 	}
 
 	return shim.Error(fmt.Sprintf("Requested function %s not found.", fname))
@@ -151,3 +160,18 @@ func getConfigBlock(chainID []byte) pb.Response {
 
 	return shim.Success(blockBytes)
 }
+
+// getChannels returns information about all channels for this peer
+func getChannels() pb.Response {
+	channelInfoArray := peer.GetChannelsInfo()
+
+	// add array with info about all channels for this peer
+	cqr := &pb.ChannelQueryResponse{Channels: channelInfoArray}
+
+	cqrbytes, err := proto.Marshal(cqr)
+	if err != nil {
+		return shim.Error(err.Error())
+	}
+
+	return shim.Success(cqrbytes)
+}

core/scc/cscc/configure_test.go

@@ -170,6 +170,24 @@ func TestConfigerInvokeJoinChainCorrectParams(t *testing.T) {
 	if res := stub.MockInvoke("1", args); res.Status != shim.OK {
 		t.Fatalf("cscc invoke GetConfigBlock failed with: %v", err)
 	}
+
+	// get channels for the peer
+	args = [][]byte{[]byte(GetChannels)}
+	res := stub.MockInvoke("1", args)
+	if res.Status != shim.OK {
+		t.FailNow()
+	}
+
+	cqr := &pb.ChannelQueryResponse{}
+	err = proto.Unmarshal(res.Payload, cqr)
+	if err != nil {
+		t.FailNow()
+	}
+
+	// peer joined one channel so query should return an array with one channel
+	if len(cqr.GetChannels()) != 1 {
+		t.FailNow()
+	}
 }
 
 func TestConfigerInvokeUpdateConfigBlock(t *testing.T) {

protos/peer/admin.pb.go

@@ -45,3 +45,15 @@ message ChaincodeInfo {
   // blank if the query is returning information about installed chaincodes.
   string vscc = 6;
 }
+
+// ChannelQueryResponse returns information about each channel that pertains
+// to a query in lccc.go, such as GetChannels (returns all channels for a
+// given peer)
+message ChannelQueryResponse {
+  repeated ChannelInfo channels = 1;
+}
+
+// ChannelInfo contains general information about channels
+message ChannelInfo {
+  string channel_id = 1;
+}