[FAB-7123] Clean golint warnings

C0rWin · C0rWin · commit 1ca3393ec3f7 · 2017-11-28T15:43:29.000+02:00
There are few golint warning on gossip module packages, this commit
takes care to address them.

Change-Id: I13a85ad990f981a0da42446962ac0993383cc8b5
Signed-off-by: Artem Barger &lt;bartem@il.ibm.com&gt;
diff --git a/gossip/comm/crypto.go b/gossip/comm/crypto.go
@@ -17,8 +17,6 @@ import (
 	"math/big"
 	"os"
 
-	"errors"
-
 	"github.com/hyperledger/fabric/common/util"
 	gutil "github.com/hyperledger/fabric/gossip/util"
 	"golang.org/x/net/context"
@@ -35,6 +33,8 @@ func writeFile(filename string, keyType string, data []byte) error {
 	return pem.Encode(f, &pem.Block{Type: keyType, Bytes: data})
 }
 
+// GenerateCertificatesOrPanic generates a a random pair of public and private keys
+// and return TLS certificate
 func GenerateCertificatesOrPanic() tls.Certificate {
 	privKeyFile := fmt.Sprintf("key.%d.priv", gutil.RandomUInt64())
 	certKeyFile := fmt.Sprintf("cert.%d.pub", gutil.RandomUInt64())
@@ -76,7 +76,7 @@ func GenerateCertificatesOrPanic() tls.Certificate {
 		panic(err)
 	}
 	if len(cert.Certificate) == 0 {
-		panic(errors.New("Certificate chain is empty"))
+		panic("Certificate chain is empty")
 	}
 	return cert
 }
diff --git a/gossip/common/common.go b/gossip/common/common.go
@@ -23,8 +23,8 @@ type PKIidType []byte
 // IsNotSameFilter generate filter function which
 // provides a predicate to identify whenever current id
 // equals to another one.
-func (this PKIidType) IsNotSameFilter(that PKIidType) bool {
-	return !bytes.Equal(this, that)
+func (id PKIidType) IsNotSameFilter(that PKIidType) bool {
+	return !bytes.Equal(id, that)
 }
 
 // MessageAcceptor is a predicate that is used to
diff --git a/gossip/gossip/certstore.go b/gossip/gossip/certstore.go
@@ -44,11 +44,11 @@ func newCertStore(puller pull.Mediator, idMapper identity.Mapper, selfIdentity a
 		certStore.logger.Panicf("Failed associating self PKIID to cert: %+v", errors.WithStack(err))
 	}
 
-	selfIdMsg, err := certStore.createIdentityMessage()
+	selfIDMsg, err := certStore.createIdentityMessage()
 	if err != nil {
 		certStore.logger.Panicf("Failed creating self identity message: %+v", errors.WithStack(err))
 	}
-	puller.Add(selfIdMsg)
+	puller.Add(selfIDMsg)
 	puller.RegisterMsgHook(pull.RequestMsgType, func(_ []string, msgs []*proto.SignedGossipMessage, _ proto.ReceivedMessage) {
 		for _, msg := range msgs {
 			pkiID := common.PKIidType(msg.GetPeerIdentity().PkiId)
diff --git a/gossip/gossip/gossip_test.go b/gossip/gossip/gossip_test.go
@@ -236,9 +236,9 @@ func newGossipInstanceWithCustomMCS(portPrefix int, id int, maxMsgCount int, mcs
 		PublishStateInfoInterval:   time.Duration(1) * time.Second,
 		RequestStateInfoInterval:   time.Duration(1) * time.Second,
 	}
-	selfId := api.PeerIdentityType(conf.InternalEndpoint)
+	selfID := api.PeerIdentityType(conf.InternalEndpoint)
 	g := NewGossipServiceWithServer(conf, &orgCryptoService{}, mcs,
-		selfId, nil)
+		selfID, nil)
 
 	return g
 }
@@ -268,9 +268,9 @@ func newGossipInstanceWithOnlyPull(portPrefix int, id int, maxMsgCount int, boot
 	}
 
 	cryptoService := &naiveCryptoService{}
-	selfId := api.PeerIdentityType(conf.InternalEndpoint)
+	selfID := api.PeerIdentityType(conf.InternalEndpoint)
 	g := NewGossipServiceWithServer(conf, &orgCryptoService{}, cryptoService,
-		selfId, nil)
+		selfID, nil)
 	return g
 }
 
diff --git a/gossip/gossip/orgs_test.go b/gossip/gossip/orgs_test.go
@@ -112,8 +112,8 @@ func newGossipInstanceWithExternalEndpoint(portPrefix int, id int, mcs *configur
 		PublishStateInfoInterval:   time.Duration(1) * time.Second,
 		RequestStateInfoInterval:   time.Duration(1) * time.Second,
 	}
-	selfId := api.PeerIdentityType(conf.InternalEndpoint)
-	g := NewGossipServiceWithServer(conf, mcs, mcs, selfId,
+	selfID := api.PeerIdentityType(conf.InternalEndpoint)
+	g := NewGossipServiceWithServer(conf, mcs, mcs, selfID,
 		nil)
 
 	return g
diff --git a/gossip/privdata/coordinator.go b/gossip/privdata/coordinator.go
@@ -99,10 +99,14 @@ func (d2s dig2sources) keys() []*gossip2.PvtDataDigest {
 	return res
 }
 
+// Fetcher interface which defines API to fetch missing
+// private data elements
 type Fetcher interface {
 	fetch(dig2src dig2sources) ([]*gossip2.PvtDataElement, error)
 }
 
+// Support encapsulates set of interfaces to
+// aggregate required functionality by single struct
 type Support struct {
 	privdata.CollectionStore
 	txvalidator.Validator
@@ -573,14 +577,14 @@ func (data blockData) forEachTxn(txsFilter txValidationFlags, consumer blockCons
 func endorsersFromOrgs(ns string, col string, endorsers []*peer.Endorsement, orgs []string) []*peer.Endorsement {
 	var res []*peer.Endorsement
 	for _, e := range endorsers {
-		sId := &msp.SerializedIdentity{}
-		err := proto.Unmarshal(e.Endorser, sId)
+		sID := &msp.SerializedIdentity{}
+		err := proto.Unmarshal(e.Endorser, sID)
 		if err != nil {
 			logger.Warning("Failed unmarshalling endorser:", err)
 			continue
 		}
-		if !util.Contains(sId.Mspid, orgs) {
-			logger.Debug(sId.Mspid, "isn't among the collection's orgs:", orgs, "for namespace", ns, ",collection", col)
+		if !util.Contains(sID.Mspid, orgs) {
+			logger.Debug(sID.Mspid, "isn't among the collection's orgs:", orgs, "for namespace", ns, ",collection", col)
 			continue
 		}
 		res = append(res, e)
diff --git a/gossip/privdata/coordinator_test.go b/gossip/privdata/coordinator_test.go
@@ -220,8 +220,8 @@ func (fc *fetchCall) expectingEndorsers(orgs ...string) *fetchCall {
 		fc.fetcher.expectedEndorsers = make(map[string]struct{})
 	}
 	for _, org := range orgs {
-		sId := &msp.SerializedIdentity{Mspid: org, IdBytes: []byte(fmt.Sprintf("p0%s", org))}
-		b, _ := pb.Marshal(sId)
+		sID := &msp.SerializedIdentity{Mspid: org, IdBytes: []byte(fmt.Sprintf("p0%s", org))}
+		b, _ := pb.Marshal(sID)
 		fc.fetcher.expectedEndorsers[string(b)] = struct{}{}
 	}
 
diff --git a/gossip/privdata/dataretriever.go b/gossip/privdata/dataretriever.go
@@ -3,6 +3,7 @@ Copyright IBM Corp. All Rights Reserved.
 
 SPDX-License-Identifier: Apache-2.0
 */
+
 package privdata
 
 import (
@@ -40,6 +41,8 @@ type dataRetriever struct {
 	store DataStore
 }
 
+// NewDataRetriever constructing function for implementation of the
+// StorageDataRetriever interface
 func NewDataRetriever(store DataStore) StorageDataRetriever {
 	return &dataRetriever{store: store}
 }
diff --git a/gossip/privdata/pull.go b/gossip/privdata/pull.go
@@ -27,11 +27,13 @@ import (
 )
 
 const (
-	MembershipPollingBackoff    = time.Second
+	membershipPollingBackoff    = time.Second
 	responseWaitTime            = time.Second * 5
 	maxMembershipPollIterations = 5
 )
 
+// PrivateDataRetriever interfacce which defines API capable
+// of retrieving required private data
 type PrivateDataRetriever interface {
 	// CollectionRWSet returns the bytes of CollectionPvtReadWriteSet for a given txID and collection from the transient store
 	CollectionRWSet(dig *proto.PvtDataDigest) []util.PrivateRWSet
@@ -67,6 +69,7 @@ type puller struct {
 	PrivateDataRetriever
 }
 
+// NewPuller creates new private data puller
 func NewPuller(cs privdata.CollectionStore, g gossip, dataRetriever PrivateDataRetriever, channel string) *puller {
 	p := &puller{
 		pubSub:               util.NewPubSub(),
@@ -195,7 +198,7 @@ func (p *puller) waitForMembership() []discovery.NetworkMember {
 		if polIteration == maxMembershipPollIterations {
 			return nil
 		}
-		time.Sleep(MembershipPollingBackoff)
+		time.Sleep(membershipPollingBackoff)
 	}
 	return members
 }
@@ -354,10 +357,10 @@ func (dig2f digestToFilterMapping) flattenFilterValues() []filter.RoutingFilter
 }
 
 // String returns a string representation of t he digestToFilterMapping
-func (dig2Filter digestToFilterMapping) String() string {
+func (dig2f digestToFilterMapping) String() string {
 	var buffer bytes.Buffer
 	collection2TxID := make(map[string][]string)
-	for dig := range dig2Filter {
+	for dig := range dig2f {
 		collection2TxID[dig.Collection] = append(collection2TxID[dig.Collection], dig.TxId)
 	}
 	for col, txIDs := range collection2TxID {
diff --git a/gossip/privdata/pull_test.go b/gossip/privdata/pull_test.go
@@ -152,9 +152,8 @@ func (g *mockGossip) PeerFilter(channel common.ChainID, messagePredicate api.Sub
 			args := g.Called(channel, messagePredicate)
 			if args.Get(1) != nil {
 				return nil, args.Get(1).(error)
-			} else {
-				return args.Get(0).(filter.RoutingFilter), nil
 			}
+			return args.Get(0).(filter.RoutingFilter), nil
 		}
 	}
 	return func(member discovery.NetworkMember) bool {
diff --git a/gossip/privdata/util.go b/gossip/privdata/util.go
@@ -72,8 +72,8 @@ func (bf *blockFactory) AddTxnWithEndorsement(txID string, nsName string, hash [
 	}
 
 	if org != "" {
-		sId := &msp.SerializedIdentity{Mspid: org, IdBytes: []byte(fmt.Sprintf("p0%s", org))}
-		b, _ := proto.Marshal(sId)
+		sID := &msp.SerializedIdentity{Mspid: org, IdBytes: []byte(fmt.Sprintf("p0%s", org))}
+		b, _ := proto.Marshal(sID)
 		ccPayload.Action.Endorsements = []*peer.Endorsement{
 			{
 				Endorser: b,
diff --git a/gossip/service/gossip_service.go b/gossip/service/gossip_service.go
@@ -197,13 +197,17 @@ func (g *gossipServiceImpl) NewConfigEventer() ConfigProcessor {
 	return newConfigEventer(g)
 }
 
+// Support aggregates functionality of several
+// interfaces required by gossip service
 type Support struct {
 	Validator txvalidator.Validator
 	Committer committer.Committer
 	Store     privdata2.TransientStore
 	Cs        privdata.CollectionStore
 }
 
+// DataStoreSupport aggregates interfaces capable
+// of handling either incoming blocks or private data
 type DataStoreSupport struct {
 	committer.Committer
 	privdata2.TransientStore
diff --git a/gossip/service/gossip_service_test.go b/gossip/service/gossip_service_test.go
@@ -652,11 +652,11 @@ func newGossipInstance(portPrefix int, id int, maxMsgCount int, boot ...int) Gos
 		PublishStateInfoInterval:   time.Duration(1) * time.Second,
 		RequestStateInfoInterval:   time.Duration(1) * time.Second,
 	}
-	selfId := api.PeerIdentityType(conf.InternalEndpoint)
+	selfID := api.PeerIdentityType(conf.InternalEndpoint)
 	cryptoService := &naiveCryptoService{}
 
 	gossip := gossip.NewGossipServiceWithServer(conf, &orgCryptoService{}, cryptoService,
-		selfId, nil)
+		selfID, nil)
 
 	gossipService := &gossipServiceImpl{
 		mcs:             cryptoService,
diff --git a/gossip/state/state.go b/gossip/state/state.go
@@ -154,7 +154,7 @@ func init() {
 	logger = util.GetLogger(util.LoggingStateModule, "")
 }
 
-// NewGossipCoordinatedStateProvider creates state provider with coordinator instance
+// NewGossipStateProvider creates state provider with coordinator instance
 // to orchestrate arrival of private rwsets and blocks before committing them into the ledger.
 func NewGossipStateProvider(chainID string, services *ServicesMediator, ledger ledgerResources) GossipStateProvider {
 
diff --git a/gossip/state/state_test.go b/gossip/state/state_test.go
@@ -1246,7 +1246,7 @@ func TestTransferOfPrivateRWSet(t *testing.T) {
 
 	coord1.On("LedgerHeight", mock.Anything).Return(uint64(5), nil)
 
-	var data map[uint64]*testData = map[uint64]*testData{
+	var data = map[uint64]*testData{
 		uint64(2): {
 			block: &pcomm.Block{
 				Header: &pcomm.BlockHeader{
@@ -1422,7 +1422,7 @@ func (t testPeer) Comm() chan proto.ReceivedMessage {
 	return t.commChannel
 }
 
-var peers map[string]testPeer = map[string]testPeer{
+var peers = map[string]testPeer{
 	"peer1": {
 		id:            "peer1",
 		gossipChannel: make(chan *proto.GossipMessage),

Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,6 @@ import (`
`17`	`17`	`"math/big"`
`18`	`18`	`"os"`
`19`	`19`
`20`		`- "errors"`
`21`		`-`
`22`	`20`	`"github.com/hyperledger/fabric/common/util"`
`23`	`21`	`gutil "github.com/hyperledger/fabric/gossip/util"`
`24`	`22`	`"golang.org/x/net/context"`
`@@ -35,6 +33,8 @@ func writeFile(filename string, keyType string, data []byte) error {`
`35`	`33`	`return pem.Encode(f, &pem.Block{Type: keyType, Bytes: data})`
`36`	`34`	`}`
`37`	`35`
	`36`	`+// GenerateCertificatesOrPanic generates a a random pair of public and private keys`
	`37`	`+// and return TLS certificate`
`38`	`38`	`func GenerateCertificatesOrPanic() tls.Certificate {`
`39`	`39`	`privKeyFile := fmt.Sprintf("key.%d.priv", gutil.RandomUInt64())`
`40`	`40`	`certKeyFile := fmt.Sprintf("cert.%d.pub", gutil.RandomUInt64())`
`@@ -76,7 +76,7 @@ func GenerateCertificatesOrPanic() tls.Certificate {`
`76`	`76`	`panic(err)`
`77`	`77`	`}`
`78`	`78`	`if len(cert.Certificate) == 0 {`
`79`		`- panic(errors.New("Certificate chain is empty"))`
	`79`	`+ panic("Certificate chain is empty")`
`80`	`80`	`}`
`81`	`81`	`return cert`
`82`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,11 +44,11 @@ func newCertStore(puller pull.Mediator, idMapper identity.Mapper, selfIdentity a`
`44`	`44`	`certStore.logger.Panicf("Failed associating self PKIID to cert: %+v", errors.WithStack(err))`
`45`	`45`	`}`
`46`	`46`
`47`		`- selfIdMsg, err := certStore.createIdentityMessage()`
	`47`	`+ selfIDMsg, err := certStore.createIdentityMessage()`
`48`	`48`	`if err != nil {`
`49`	`49`	`certStore.logger.Panicf("Failed creating self identity message: %+v", errors.WithStack(err))`
`50`	`50`	`}`
`51`		`- puller.Add(selfIdMsg)`
	`51`	`+ puller.Add(selfIDMsg)`
`52`	`52`	`puller.RegisterMsgHook(pull.RequestMsgType, func(_ []string, msgs []*proto.SignedGossipMessage, _ proto.ReceivedMessage) {`
`53`	`53`	`for _, msg := range msgs {`
`54`	`54`	`pkiID := common.PKIidType(msg.GetPeerIdentity().PkiId)`
Original file line number	Diff line number	Diff line change
`@@ -236,9 +236,9 @@ func newGossipInstanceWithCustomMCS(portPrefix int, id int, maxMsgCount int, mcs`
`236`	`236`	`PublishStateInfoInterval: time.Duration(1) * time.Second,`
`237`	`237`	`RequestStateInfoInterval: time.Duration(1) * time.Second,`
`238`	`238`	`}`
`239`		`- selfId := api.PeerIdentityType(conf.InternalEndpoint)`
	`239`	`+ selfID := api.PeerIdentityType(conf.InternalEndpoint)`
`240`	`240`	`g := NewGossipServiceWithServer(conf, &orgCryptoService{}, mcs,`
`241`		`- selfId, nil)`
	`241`	`+ selfID, nil)`
`242`	`242`
`243`	`243`	`return g`
`244`	`244`	`}`
`@@ -268,9 +268,9 @@ func newGossipInstanceWithOnlyPull(portPrefix int, id int, maxMsgCount int, boot`
`268`	`268`	`}`
`269`	`269`
`270`	`270`	`cryptoService := &naiveCryptoService{}`
`271`		`- selfId := api.PeerIdentityType(conf.InternalEndpoint)`
	`271`	`+ selfID := api.PeerIdentityType(conf.InternalEndpoint)`
`272`	`272`	`g := NewGossipServiceWithServer(conf, &orgCryptoService{}, cryptoService,`
`273`		`- selfId, nil)`
	`273`	`+ selfID, nil)`
`274`	`274`	`return g`
`275`	`275`	`}`
`276`	`276`
Original file line number	Diff line number	Diff line change
`@@ -220,8 +220,8 @@ func (fc fetchCall) expectingEndorsers(orgs ...string) fetchCall {`
`220`	`220`	`fc.fetcher.expectedEndorsers = make(map[string]struct{})`
`221`	`221`	`}`
`222`	`222`	`for _, org := range orgs {`
`223`		`- sId := &msp.SerializedIdentity{Mspid: org, IdBytes: []byte(fmt.Sprintf("p0%s", org))}`
`224`		`- b, _ := pb.Marshal(sId)`
	`223`	`+ sID := &msp.SerializedIdentity{Mspid: org, IdBytes: []byte(fmt.Sprintf("p0%s", org))}`
	`224`	`+ b, _ := pb.Marshal(sID)`
`225`	`225`	`fc.fetcher.expectedEndorsers[string(b)] = struct{}{}`
`226`	`226`	`}`
`227`	`227`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ Copyright IBM Corp. All Rights Reserved.`
`3`	`3`
`4`	`4`	`SPDX-License-Identifier: Apache-2.0`
`5`	`5`	`*/`
	`6`	`+`
`6`	`7`	`package privdata`
`7`	`8`
`8`	`9`	`import (`
`@@ -40,6 +41,8 @@ type dataRetriever struct {`
`40`	`41`	`store DataStore`
`41`	`42`	`}`
`42`	`43`
	`44`	`+// NewDataRetriever constructing function for implementation of the`
	`45`	`+// StorageDataRetriever interface`
`43`	`46`	`func NewDataRetriever(store DataStore) StorageDataRetriever {`
`44`	`47`	`return &dataRetriever{store: store}`
`45`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,11 +27,13 @@ import (`
`27`	`27`	`)`
`28`	`28`
`29`	`29`	`const (`
`30`		`- MembershipPollingBackoff = time.Second`
	`30`	`+ membershipPollingBackoff = time.Second`
`31`	`31`	`responseWaitTime = time.Second * 5`
`32`	`32`	`maxMembershipPollIterations = 5`
`33`	`33`	`)`
`34`	`34`
	`35`	`+// PrivateDataRetriever interfacce which defines API capable`
	`36`	`+// of retrieving required private data`
`35`	`37`	`type PrivateDataRetriever interface {`
`36`	`38`	`// CollectionRWSet returns the bytes of CollectionPvtReadWriteSet for a given txID and collection from the transient store`
`37`	`39`	`CollectionRWSet(dig *proto.PvtDataDigest) []util.PrivateRWSet`
`@@ -67,6 +69,7 @@ type puller struct {`
`67`	`69`	`PrivateDataRetriever`
`68`	`70`	`}`
`69`	`71`
	`72`	`+// NewPuller creates new private data puller`
`70`	`73`	`func NewPuller(cs privdata.CollectionStore, g gossip, dataRetriever PrivateDataRetriever, channel string) *puller {`
`71`	`74`	`p := &puller{`
`72`	`75`	`pubSub: util.NewPubSub(),`
`@@ -195,7 +198,7 @@ func (p *puller) waitForMembership() []discovery.NetworkMember {`
`195`	`198`	`if polIteration == maxMembershipPollIterations {`
`196`	`199`	`return nil`
`197`	`200`	`}`
`198`		`- time.Sleep(MembershipPollingBackoff)`
	`201`	`+ time.Sleep(membershipPollingBackoff)`
`199`	`202`	`}`
`200`	`203`	`return members`
`201`	`204`	`}`
`@@ -354,10 +357,10 @@ func (dig2f digestToFilterMapping) flattenFilterValues() []filter.RoutingFilter`
`354`	`357`	`}`
`355`	`358`
`356`	`359`	`// String returns a string representation of t he digestToFilterMapping`
`357`		`-func (dig2Filter digestToFilterMapping) String() string {`
	`360`	`+func (dig2f digestToFilterMapping) String() string {`
`358`	`361`	`var buffer bytes.Buffer`
`359`	`362`	`collection2TxID := make(map[string][]string)`
`360`		`- for dig := range dig2Filter {`
	`363`	`+ for dig := range dig2f {`
`361`	`364`	`collection2TxID[dig.Collection] = append(collection2TxID[dig.Collection], dig.TxId)`
`362`	`365`	`}`
`363`	`366`	`for col, txIDs := range collection2TxID {`
Original file line number	Diff line number	Diff line change
`@@ -152,9 +152,8 @@ func (g *mockGossip) PeerFilter(channel common.ChainID, messagePredicate api.Sub`
`152`	`152`	`args := g.Called(channel, messagePredicate)`
`153`	`153`	`if args.Get(1) != nil {`
`154`	`154`	`return nil, args.Get(1).(error)`
`155`		`- } else {`
`156`		`- return args.Get(0).(filter.RoutingFilter), nil`
`157`	`155`	`}`
	`156`	`+ return args.Get(0).(filter.RoutingFilter), nil`
`158`	`157`	`}`
`159`	`158`	`}`
`160`	`159`	`return func(member discovery.NetworkMember) bool {`