[FAB-14053] move discovery proto extensions

Change-Id: I07c1970189b01e9f5ff3d3b866760b0384bc0f75
Signed-off-by: Matthew Sykes <sykesmat@us.ibm.com>

Author: sykesm

discovery/client/client.go

@@ -14,15 +14,19 @@ import (
 	"time"
 
 	"github.com/golang/protobuf/proto"
+	"github.com/hyperledger/fabric/discovery/protoext"
 	"github.com/hyperledger/fabric/protos/discovery"
 	"github.com/hyperledger/fabric/protos/gossip"
 	"github.com/hyperledger/fabric/protos/msp"
 	"github.com/pkg/errors"
 )
 
-var (
-	configTypes = []discovery.QueryType{discovery.ConfigQueryType, discovery.PeerMembershipQueryType, discovery.ChaincodeQueryType, discovery.LocalMembershipQueryType}
-)
+var configTypes = []protoext.QueryType{
+	protoext.ConfigQueryType,
+	protoext.PeerMembershipQueryType,
+	protoext.ChaincodeQueryType,
+	protoext.LocalMembershipQueryType,
+}
 
 // Client interacts with the discovery server
 type Client struct {
@@ -34,7 +38,7 @@ type Client struct {
 func NewRequest() *Request {
 	r := &Request{
 		invocationChainMapping: make(map[int][]InvocationChain),
-		queryMapping:           make(map[discovery.QueryType]map[string]int),
+		queryMapping:           make(map[protoext.QueryType]map[string]int),
 		Request:                &discovery.Request{},
 	}
 	// pre-populate types
@@ -49,7 +53,7 @@ type Request struct {
 	lastChannel string
 	lastIndex   int
 	// map from query type to channel to expected index in response
-	queryMapping map[discovery.QueryType]map[string]int
+	queryMapping map[protoext.QueryType]map[string]int
 	// map from expected index in response to invocation chains
 	invocationChainMapping map[int][]InvocationChain
 	*discovery.Request
@@ -65,7 +69,7 @@ func (req *Request) AddConfigQuery() *Request {
 		Channel: ch,
 		Query:   q,
 	})
-	req.addQueryMapping(discovery.ConfigQueryType, ch)
+	req.addQueryMapping(protoext.ConfigQueryType, ch)
 	return req
 }
 
@@ -91,7 +95,7 @@ func (req *Request) AddEndorsersQuery(interests ...*discovery.ChaincodeInterest)
 		invocationChains = append(invocationChains, interest.Chaincodes)
 	}
 	req.addChaincodeQueryMapping(invocationChains)
-	req.addQueryMapping(discovery.ChaincodeQueryType, ch)
+	req.addQueryMapping(protoext.ChaincodeQueryType, ch)
 	return req, nil
 }
 
@@ -104,7 +108,7 @@ func (req *Request) AddLocalPeersQuery() *Request {
 		Query: q,
 	})
 	var ic InvocationChain
-	req.addQueryMapping(discovery.LocalMembershipQueryType, channnelAndInvocationChain("", ic))
+	req.addQueryMapping(protoext.LocalMembershipQueryType, channnelAndInvocationChain("", ic))
 	return req
 }
 
@@ -127,7 +131,7 @@ func (req *Request) AddPeersQuery(invocationChain ...*discovery.ChaincodeCall) *
 		ic = InvocationChain(invocationChain)
 	}
 	req.addChaincodeQueryMapping([]InvocationChain{ic})
-	req.addQueryMapping(discovery.PeerMembershipQueryType, channnelAndInvocationChain(ch, ic))
+	req.addQueryMapping(protoext.PeerMembershipQueryType, channnelAndInvocationChain(ch, ic))
 	return req
 }
 
@@ -145,7 +149,7 @@ func (req *Request) addChaincodeQueryMapping(invocationChains []InvocationChain)
 	req.invocationChainMapping[req.lastIndex] = invocationChains
 }
 
-func (req *Request) addQueryMapping(queryType discovery.QueryType, key string) {
+func (req *Request) addQueryMapping(queryType protoext.QueryType, key string) {
 	req.queryMapping[queryType][key] = req.lastIndex
 	req.lastIndex++
 }
@@ -193,7 +197,7 @@ type localResponse struct {
 }
 
 func (cr *localResponse) Peers() ([]*Peer, error) {
-	return parsePeers(discovery.LocalMembershipQueryType, cr.response, "")
+	return parsePeers(protoext.LocalMembershipQueryType, cr.response, "")
 }
 
 type channelResponse struct {
@@ -203,7 +207,7 @@ type channelResponse struct {
 
 func (cr *channelResponse) Config() (*discovery.ConfigResult, error) {
 	res, exists := cr.response[key{
-		queryType: discovery.ConfigQueryType,
+		queryType: protoext.ConfigQueryType,
 		k:         cr.channel,
 	}]
 
@@ -218,7 +222,7 @@ func (cr *channelResponse) Config() (*discovery.ConfigResult, error) {
 	return nil, res.(error)
 }
 
-func parsePeers(queryType discovery.QueryType, r response, channel string, invocationChain ...*discovery.ChaincodeCall) ([]*Peer, error) {
+func parsePeers(queryType protoext.QueryType, r response, channel string, invocationChain ...*discovery.ChaincodeCall) ([]*Peer, error) {
 	peerKeys := key{
 		queryType: queryType,
 		k:         fmt.Sprintf("%s %s", channel, InvocationChain(invocationChain).String()),
@@ -237,22 +241,22 @@ func parsePeers(queryType discovery.QueryType, r response, channel string, invoc
 }
 
 func (cr *channelResponse) Peers(invocationChain ...*discovery.ChaincodeCall) ([]*Peer, error) {
-	return parsePeers(discovery.PeerMembershipQueryType, cr.response, cr.channel, invocationChain...)
+	return parsePeers(protoext.PeerMembershipQueryType, cr.response, cr.channel, invocationChain...)
 }
 
 func (cr *channelResponse) Endorsers(invocationChain InvocationChain, f Filter) (Endorsers, error) {
 	// If we have a key that has no chaincode field,
 	// it means it's an error returned from the service
 	if err, exists := cr.response[key{
-		queryType: discovery.ChaincodeQueryType,
+		queryType: protoext.ChaincodeQueryType,
 		k:         cr.channel,
 	}]; exists {
 		return nil, err.(error)
 	}
 
 	// Else, the service returned a response that isn't an error
 	res, exists := cr.response[key{
-		queryType:       discovery.ChaincodeQueryType,
+		queryType:       protoext.ChaincodeQueryType,
 		k:               cr.channel,
 		invocationChain: invocationChain.String(),
 	}]
@@ -328,7 +332,7 @@ func (resp response) ForChannel(ch string) ChannelResponse {
 }
 
 type key struct {
-	queryType       discovery.QueryType
+	queryType       protoext.QueryType
 	k               string
 	invocationChain string
 }
@@ -338,14 +342,14 @@ func (req *Request) computeResponse(r *discovery.Response) (response, error) {
 	resp := make(response)
 	for configType, channel2index := range req.queryMapping {
 		switch configType {
-		case discovery.ConfigQueryType:
+		case protoext.ConfigQueryType:
 			err = resp.mapConfig(channel2index, r)
-		case discovery.ChaincodeQueryType:
+		case protoext.ChaincodeQueryType:
 			err = resp.mapEndorsers(channel2index, r, req.invocationChainMapping)
-		case discovery.PeerMembershipQueryType:
-			err = resp.mapPeerMembership(channel2index, r, discovery.PeerMembershipQueryType)
-		case discovery.LocalMembershipQueryType:
-			err = resp.mapPeerMembership(channel2index, r, discovery.LocalMembershipQueryType)
+		case protoext.PeerMembershipQueryType:
+			err = resp.mapPeerMembership(channel2index, r, protoext.PeerMembershipQueryType)
+		case protoext.LocalMembershipQueryType:
+			err = resp.mapPeerMembership(channel2index, r, protoext.LocalMembershipQueryType)
 		}
 		if err != nil {
 			return nil, err
@@ -357,12 +361,12 @@ func (req *Request) computeResponse(r *discovery.Response) (response, error) {
 
 func (resp response) mapConfig(channel2index map[string]int, r *discovery.Response) error {
 	for ch, index := range channel2index {
-		config, err := r.ConfigAt(index)
+		config, err := protoext.ResponseConfigAt(r, index)
 		if config == nil && err == nil {
 			return errors.Errorf("expected QueryResult of either ConfigResult or Error but got %v instead", r.Results[index])
 		}
 		key := key{
-			queryType: discovery.ConfigQueryType,
+			queryType: protoext.ConfigQueryType,
 			k:         ch,
 		}
 
@@ -376,9 +380,9 @@ func (resp response) mapConfig(channel2index map[string]int, r *discovery.Respon
 	return nil
 }
 
-func (resp response) mapPeerMembership(key2Index map[string]int, r *discovery.Response, qt discovery.QueryType) error {
+func (resp response) mapPeerMembership(key2Index map[string]int, r *discovery.Response, qt protoext.QueryType) error {
 	for k, index := range key2Index {
-		membersRes, err := r.MembershipAt(index)
+		membersRes, err := protoext.ResponseMembershipAt(r, index)
 		if membersRes == nil && err == nil {
 			return errors.Errorf("expected QueryResult of either PeerMembershipResult or Error but got %v instead", r.Results[index])
 		}
@@ -403,7 +407,7 @@ func (resp response) mapPeerMembership(key2Index map[string]int, r *discovery.Re
 	return nil
 }
 
-func peersForChannel(membersRes *discovery.PeerMembershipResult, qt discovery.QueryType) ([]*Peer, error) {
+func peersForChannel(membersRes *discovery.PeerMembershipResult, qt protoext.QueryType) ([]*Peer, error) {
 	var peers []*Peer
 	for org, peersOfCurrentOrg := range membersRes.PeersByOrg {
 		for _, peer := range peersOfCurrentOrg.Peers {
@@ -435,23 +439,23 @@ func peersForChannel(membersRes *discovery.PeerMembershipResult, qt discovery.Qu
 	return peers, nil
 }
 
-func isStateInfoExpected(qt discovery.QueryType) bool {
-	return qt != discovery.LocalMembershipQueryType
+func isStateInfoExpected(qt protoext.QueryType) bool {
+	return qt != protoext.LocalMembershipQueryType
 }
 
 func (resp response) mapEndorsers(
 	channel2index map[string]int,
 	r *discovery.Response,
 	chaincodeQueryMapping map[int][]InvocationChain) error {
 	for ch, index := range channel2index {
-		ccQueryRes, err := r.EndorsersAt(index)
+		ccQueryRes, err := protoext.ResponseEndorsersAt(r, index)
 		if ccQueryRes == nil && err == nil {
 			return errors.Errorf("expected QueryResult of either ChaincodeQueryResult or Error but got %v instead", r.Results[index])
 		}
 
 		if err != nil {
 			key := key{
-				queryType: discovery.ChaincodeQueryType,
+				queryType: protoext.ChaincodeQueryType,
 				k:         ch,
 			}
 			resp[key] = errors.New(err.Content)
@@ -475,7 +479,7 @@ func (resp response) mapEndorsersOfChannel(ccRs *discovery.ChaincodeQueryResult,
 			return errors.Errorf("expected chaincode %s but got endorsement descriptor for %s", expectedCCName, desc.Chaincode)
 		}
 		key := key{
-			queryType:       discovery.ChaincodeQueryType,
+			queryType:       protoext.ChaincodeQueryType,
 			k:               channel,
 			invocationChain: invocationChain[i].String(),
 		}

discovery/protoext/querytype.go

@@ -0,0 +1,36 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package protoext
+
+import "github.com/hyperledger/fabric/protos/discovery"
+
+// QueryType defines the types of service discovery requests
+type QueryType uint8
+
+const (
+	InvalidQueryType QueryType = iota
+	ConfigQueryType
+	PeerMembershipQueryType
+	ChaincodeQueryType
+	LocalMembershipQueryType
+)
+
+// GetType returns the type of the request
+func GetQueryType(q *discovery.Query) QueryType {
+	switch {
+	case q.GetCcQuery() != nil:
+		return ChaincodeQueryType
+	case q.GetConfigQuery() != nil:
+		return ConfigQueryType
+	case q.GetPeerQuery() != nil:
+		return PeerMembershipQueryType
+	case q.GetLocalPeers() != nil:
+		return LocalMembershipQueryType
+	default:
+		return InvalidQueryType
+	}
+}

discovery/protoext/querytype_test.go

@@ -0,0 +1,36 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package protoext_test
+
+import (
+	"strconv"
+	"testing"
+
+	"github.com/hyperledger/fabric/discovery/protoext"
+	"github.com/hyperledger/fabric/protos/discovery"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestGetQueryType(t *testing.T) {
+	tests := []struct {
+		q        *discovery.Query
+		expected protoext.QueryType
+	}{
+		{q: &discovery.Query{Query: &discovery.Query_PeerQuery{PeerQuery: &discovery.PeerMembershipQuery{}}}, expected: protoext.PeerMembershipQueryType},
+		{q: &discovery.Query{Query: &discovery.Query_ConfigQuery{ConfigQuery: &discovery.ConfigQuery{}}}, expected: protoext.ConfigQueryType},
+		{q: &discovery.Query{Query: &discovery.Query_CcQuery{CcQuery: &discovery.ChaincodeQuery{}}}, expected: protoext.ChaincodeQueryType},
+		{q: &discovery.Query{Query: &discovery.Query_LocalPeers{LocalPeers: &discovery.LocalPeerQuery{}}}, expected: protoext.LocalMembershipQueryType},
+		{q: &discovery.Query{Query: &discovery.Query_CcQuery{}}, expected: protoext.InvalidQueryType},
+		{q: nil, expected: protoext.InvalidQueryType},
+	}
+
+	for i, tt := range tests {
+		t.Run(strconv.Itoa(i), func(t *testing.T) {
+			assert.Equal(t, tt.expected, protoext.GetQueryType(tt.q))
+		})
+	}
+}

discovery/protoext/response.go

@@ -0,0 +1,30 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package protoext
+
+import "github.com/hyperledger/fabric/protos/discovery"
+
+// ResponseConfigAt returns the ConfigResult at a given index in the Response,
+// or an Error if present.
+func ResponseConfigAt(m *discovery.Response, i int) (*discovery.ConfigResult, *discovery.Error) {
+	r := m.Results[i]
+	return r.GetConfigResult(), r.GetError()
+}
+
+// ResponseMembershipAt returns the PeerMembershipResult at a given index in the Response,
+// or an Error if present.
+func ResponseMembershipAt(m *discovery.Response, i int) (*discovery.PeerMembershipResult, *discovery.Error) {
+	r := m.Results[i]
+	return r.GetMembers(), r.GetError()
+}
+
+// ResponseEndorsersAt returns the PeerMembershipResult at a given index in the Response,
+// or an Error if present.
+func ResponseEndorsersAt(m *discovery.Response, i int) (*discovery.ChaincodeQueryResult, *discovery.Error) {
+	r := m.Results[i]
+	return r.GetCcQueryRes(), r.GetError()
+}

discovery/protoext/signedreq.go

@@ -0,0 +1,20 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package protoext
+
+import (
+	"github.com/gogo/protobuf/proto"
+	"github.com/hyperledger/fabric/protos/discovery"
+)
+
+// SignedRequestToRequest deserializes this SignedRequest's payload
+// and returns the serialized Request in its object form.
+// Returns an error in case the operation fails.
+func SignedRequestToRequest(sr *discovery.SignedRequest) (*discovery.Request, error) {
+	req := &discovery.Request{}
+	return req, proto.Unmarshal(sr.Payload, req)
+}

discovery/protoext/signedreq_test.go

@@ -0,0 +1,31 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package protoext_test
+
+import (
+	"testing"
+
+	"github.com/gogo/protobuf/proto"
+	"github.com/hyperledger/fabric/discovery/protoext"
+	"github.com/hyperledger/fabric/protos/discovery"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestSignedRequestToRequest(t *testing.T) {
+	sr := &discovery.SignedRequest{
+		Payload: []byte{0},
+	}
+	r, err := protoext.SignedRequestToRequest(sr)
+	assert.Error(t, err)
+
+	req := &discovery.Request{}
+	b, _ := proto.Marshal(req)
+	sr.Payload = b
+	r, err = protoext.SignedRequestToRequest(sr)
+	assert.NoError(t, err)
+	assert.NotNil(t, r)
+}