[FAB-8904] Make CCContext implement fmt.Stringer

... and cleanup comments along the way

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

Author: sykesm

core/common/ccprovider/ccprovider.go

@@ -1,17 +1,7 @@
 /*
-Copyright IBM Corp. 2017 All Rights Reserved.
+Copyright IBM Corp. All Rights Reserved.
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-		 http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+SPDX-License-Identifier: Apache-2.0
 */
 
 package ccprovider
@@ -35,7 +25,7 @@ var ccproviderLogger = flogging.MustGetLogger("ccprovider")
 
 var chaincodeInstallPath string
 
-//CCPackage encapsulates a chaincode package which can be
+// CCPackage encapsulates a chaincode package which can be
 //    raw ChaincodeDeploymentSpec
 //    SignedChaincodeDeploymentSpec
 // Attempt to keep the interface at a level with minimal
@@ -71,7 +61,7 @@ type CCPackage interface {
 	GetId() []byte
 }
 
-//SetChaincodesPath sets the chaincode path for this peer
+// SetChaincodesPath sets the chaincode path for this peer
 func SetChaincodesPath(path string) {
 	if s, err := os.Stat(path); err != nil {
 		if os.IsNotExist(err) {
@@ -88,7 +78,7 @@ func SetChaincodesPath(path string) {
 	chaincodeInstallPath = path
 }
 
-//GetChaincodePackage returns the chaincode package from the file system
+// GetChaincodePackage returns the chaincode package from the file system
 func GetChaincodePackage(ccname string, ccversion string) ([]byte, error) {
 	path := fmt.Sprintf("%s/%s.%s", chaincodeInstallPath, ccname, ccversion)
 	var ccbytes []byte
@@ -99,7 +89,7 @@ func GetChaincodePackage(ccname string, ccversion string) ([]byte, error) {
 	return ccbytes, nil
 }
 
-//ChaincodePackageExists returns whether the chaincode package exists in the file system
+// ChaincodePackageExists returns whether the chaincode package exists in the file system
 func ChaincodePackageExists(ccname string, ccversion string) (bool, error) {
 	path := filepath.Join(chaincodeInstallPath, ccname+"."+ccversion)
 	_, err := os.Stat(path)
@@ -111,7 +101,7 @@ func ChaincodePackageExists(ccname string, ccversion string) (bool, error) {
 }
 
 type CCCacheSupport interface {
-	//GetChaincode is needed by the cache to get chaincode data
+	// GetChaincode is needed by the cache to get chaincode data
 	GetChaincode(ccname string, ccversion string) (CCPackage, error)
 }
 
@@ -121,11 +111,11 @@ type CCInfoFSImpl struct{}
 
 // GetChaincodeFromFS this is a wrapper for hiding package implementation.
 func (*CCInfoFSImpl) GetChaincode(ccname string, ccversion string) (CCPackage, error) {
-	//try raw CDS
+	// try raw CDS
 	cccdspack := &CDSPackage{}
 	_, _, err := cccdspack.InitFromFS(ccname, ccversion)
 	if err != nil {
-		//try signed CDS
+		// try signed CDS
 		ccscdspack := &SignedCDSPackage{}
 		_, _, err = ccscdspack.InitFromFS(ccname, ccversion)
 		if err != nil {
@@ -243,10 +233,10 @@ func CheckInstantiationPolicy(name, version string, cdLedger *ChaincodeData) err
 // GetCCPackage tries each known package implementation one by one
 // till the right package is found
 func GetCCPackage(buf []byte) (CCPackage, error) {
-	//try raw CDS
+	// try raw CDS
 	cccdspack := &CDSPackage{}
 	if _, err := cccdspack.InitFromBuffer(buf); err != nil {
-		//try signed CDS
+		// try signed CDS
 		ccscdspack := &SignedCDSPackage{}
 		if _, err := ccscdspack.InitFromBuffer(buf); err != nil {
 			return nil, err
@@ -314,97 +304,105 @@ func GetInstalledChaincodes() (*pb.ChaincodeQueryResponse, error) {
 	return cqr, nil
 }
 
-//CCContext pass this around instead of string of args
+// CCContext pass this around instead of string of args
 type CCContext struct {
-	//ChainID chain id
+	// ChainID chain id
 	ChainID string
 
-	//Name chaincode name
+	// Name chaincode name
 	Name string
 
-	//Version used to construct the chaincode image and register
+	// Version used to construct the chaincode image and register
 	Version string
 
-	//TxID is the transaction id for the proposal (if any)
+	// TxID is the transaction id for the proposal (if any)
 	TxID string
 
-	//Syscc is this a system chaincode
+	// Syscc is this a system chaincode
 	Syscc bool
 
-	//SignedProposal for this invoke (if any)
-	//this is kept here for access control and in case we need to pass something
-	//from this to the chaincode
+	// SignedProposal for this invoke (if any) this is kept here for access
+	// control and in case we need to pass something from this to the chaincode
 	SignedProposal *pb.SignedProposal
 
-	//Proposal for this invoke (if any)
-	//this is kept here just in case we need to pass something
-	//from this to the chaincode
+	// Proposal for this invoke (if any) this is kept here just in case we need to
+	// pass something from this to the chaincode
 	Proposal *pb.Proposal
 
-	//this is not set but computed (note that this is not exported. use GetCanonicalName)
+	// canonicalName is not set but computed
 	canonicalName string
 
 	// this is additional data passed to the chaincode
 	ProposalDecorations map[string][]byte
 }
 
-//NewCCContext just construct a new struct with whatever args
-func NewCCContext(cid, name, version, txid string, syscc bool, signedProp *pb.SignedProposal, prop *pb.Proposal) *CCContext {
-	//version CANNOT be empty. The chaincode namespace has to use version and chain name.
-	//All system chaincodes share the same version given by utils.GetSysCCVersion. Note
-	//that neither Chain Name or Version are stored in a chaincodes state on the ledger
-	if version == "" {
-		panic(fmt.Sprintf("---empty version---(chain=%s,chaincode=%s,version=%s,txid=%s,syscc=%t,proposal=%p", cid, name, version, txid, syscc, prop))
+// NewCCContext just construct a new struct with whatever args
+func NewCCContext(cname, name, version, txid string, syscc bool, signedProp *pb.SignedProposal, prop *pb.Proposal) *CCContext {
+	cccid := &CCContext{
+		ChainID:             cname,
+		Name:                name,
+		Version:             version,
+		TxID:                txid,
+		Syscc:               syscc,
+		SignedProposal:      signedProp,
+		Proposal:            prop,
+		canonicalName:       name + ":" + version,
+		ProposalDecorations: nil,
 	}
 
-	canName := name + ":" + version
-
-	cccid := &CCContext{cid, name, version, txid, syscc, signedProp, prop, canName, nil}
-
-	ccproviderLogger.Debugf("NewCCCC (chain=%s,chaincode=%s,version=%s,txid=%s,syscc=%t,proposal=%p,canname=%s", cid, name, version, txid, syscc, prop, cccid.canonicalName)
+	// The version CANNOT be empty. The chaincode namespace has to use version and chain name.
+	// Note that neither channel name nor version are stored on the ledger.
+	if version == "" {
+		panic(fmt.Sprintf("---empty version---(%s)", cccid))
+	}
 
+	ccproviderLogger.Debugf("NewCCCC(%s)", cccid)
 	return cccid
 }
 
-//GetCanonicalName returns the canonical name associated with the proposal context
+func (cccid *CCContext) String() string {
+	return fmt.Sprintf("chain=%s,chaincode=%s,version=%s,txid=%s,syscc=%t,proposal=%p,canname=%s",
+		cccid.ChainID, cccid.Name, cccid.Version, cccid.TxID, cccid.Syscc, cccid.Proposal, cccid.canonicalName)
+}
+
+// GetCanonicalName returns the canonical name associated with the proposal context
 func (cccid *CCContext) GetCanonicalName() string {
 	if cccid.canonicalName == "" {
-		panic(fmt.Sprintf("cccid not constructed using NewCCContext(chain=%s,chaincode=%s,version=%s,txid=%s,syscc=%t)", cccid.ChainID, cccid.Name, cccid.Version, cccid.TxID, cccid.Syscc))
+		panic(fmt.Sprintf("missing canonical name: %s", cccid))
 	}
 
 	return cccid.canonicalName
 }
 
 //-------- ChaincodeData is stored on the LSCC -------
 
-//ChaincodeData defines the datastructure for chaincodes to be serialized by proto
-//Type provides an additional check by directing to use a specific package after instantiation
-//Data is Type specifc (see CDSPackage and SignedCDSPackage)
+// ChaincodeData defines the datastructure for chaincodes to be serialized by proto
+// Type provides an additional check by directing to use a specific package after instantiation
+// Data is Type specifc (see CDSPackage and SignedCDSPackage)
 type ChaincodeData struct {
-	//Name of the chaincode
+	// Name of the chaincode
 	Name string `protobuf:"bytes,1,opt,name=name"`
 
-	//Version of the chaincode
+	// Version of the chaincode
 	Version string `protobuf:"bytes,2,opt,name=version"`
 
-	//Escc for the chaincode instance
+	// Escc for the chaincode instance
 	Escc string `protobuf:"bytes,3,opt,name=escc"`
 
-	//Vscc for the chaincode instance
+	// Vscc for the chaincode instance
 	Vscc string `protobuf:"bytes,4,opt,name=vscc"`
 
-	//Policy endorsement policy for the chaincode instance
+	// Policy endorsement policy for the chaincode instance
 	Policy []byte `protobuf:"bytes,5,opt,name=policy,proto3"`
 
-	//Data data specific to the package
+	// Data data specific to the package
 	Data []byte `protobuf:"bytes,6,opt,name=data,proto3"`
 
-	//Id of the chaincode that's the unique fingerprint for the CC
-	//This is not currently used anywhere but serves as a good
-	//eyecatcher
+	// Id of the chaincode that's the unique fingerprint for the CC This is not
+	// currently used anywhere but serves as a good eyecatcher
 	Id []byte `protobuf:"bytes,7,opt,name=id,proto3"`
 
-	//InstantiationPolicy for the chaincode
+	// InstantiationPolicy for the chaincode
 	InstantiationPolicy []byte `protobuf:"bytes,8,opt,name=instantiation_policy,proto3"`
 }
 
@@ -439,15 +437,15 @@ func (cd *ChaincodeData) Endorsement() string {
 	return cd.Escc
 }
 
-//implement functions needed from proto.Message for proto's mar/unmarshal functions
+// implement functions needed from proto.Message for proto's mar/unmarshal functions
 
-//Reset resets
+// Reset resets
 func (cd *ChaincodeData) Reset() { *cd = ChaincodeData{} }
 
-//String converts to string
+// String converts to string
 func (cd *ChaincodeData) String() string { return proto.CompactTextString(cd) }
 
-//ProtoMessage just exists to make proto happy
+// ProtoMessage just exists to make proto happy
 func (*ChaincodeData) ProtoMessage() {}
 
 // ChaincodeProvider provides an abstraction layer that is