FAB-16124 Use BuiltinSCC real

We are currently faking the 'SCCProvider.IsSysCC' in a number of places.
This code is now so simple and can be trivially initialized as a real,
removing the fakes.

Change-Id: I447d2434145dd44079c54ec7543b388835f023a1
Signed-off-by: Jason Yellick <jyellick@us.ibm.com>

Author: Jason Yellick

core/chaincode/chaincode_suite_test.go

@@ -85,11 +85,6 @@ type transactionRegistry interface {
 	chaincode.TransactionRegistry
 }
 
-//go:generate counterfeiter -o mock/system_chaincode_provider.go --fake-name SystemCCProvider . systemCCProvider
-type systemCCProvider interface {
-	chaincode.SystemCCProvider
-}
-
 //go:generate counterfeiter -o mock/acl_provider.go --fake-name ACLProvider . aclProvider
 type aclProvider interface {
 	chaincode.ACLProvider

core/chaincode/chaincode_support.go

@@ -18,6 +18,7 @@ import (
 	"github.com/hyperledger/fabric/core/container/ccintf"
 	"github.com/hyperledger/fabric/core/ledger"
 	"github.com/hyperledger/fabric/core/peer"
+	"github.com/hyperledger/fabric/core/scc"
 	pb "github.com/hyperledger/fabric/protos/peer"
 	"github.com/pkg/errors"
 )
@@ -56,6 +57,7 @@ type Lifecycle interface {
 type ChaincodeSupport struct {
 	ACLProvider            ACLProvider
 	AppConfig              ApplicationConfigRetriever
+	BuiltinSCCs            scc.BuiltinSCCs
 	DeployedCCInfoProvider ledger.DeployedChaincodeInfoProvider
 	ExecuteTimeout         time.Duration
 	HandlerMetrics         *HandlerMetrics
@@ -65,7 +67,6 @@ type ChaincodeSupport struct {
 	Lifecycle              Lifecycle
 	Peer                   *peer.Peer
 	Runtime                Runtime
-	SystemCCProvider       SystemCCProvider
 	TotalQueryLimit        int
 	UserRunsCC             bool
 }
@@ -123,7 +124,7 @@ func (cs *ChaincodeSupport) HandleChaincodeStream(stream ccintf.ChaincodeStream)
 		ACLProvider:                cs.ACLProvider,
 		TXContexts:                 NewTransactionContexts(),
 		ActiveTransactions:         NewActiveTransactions(),
-		SystemCCProvider:           cs.SystemCCProvider,
+		BuiltinSCCs:                cs.BuiltinSCCs,
 		SystemCCVersion:            util.GetSysCCVersion(),
 		InstantiationPolicyChecker: CheckInstantiationPolicyFunc(ccprovider.CheckInstantiationPolicy),
 		QueryResponseBuilder:       &QueryResponseGenerator{MaxResultLimit: 100},
@@ -209,7 +210,7 @@ func processChaincodeExecutionResult(txid, ccName string, resp *pb.ChaincodeMess
 // Invoke will invoke chaincode and return the message containing the response.
 // The chaincode will be launched if it is not already running.
 func (cs *ChaincodeSupport) Invoke(txParams *ccprovider.TransactionParams, cccid *ccprovider.CCContext, input *pb.ChaincodeInput) (*pb.ChaincodeMessage, error) {
-	if cs.SystemCCProvider.IsSysCC(cccid.Name) {
+	if cs.BuiltinSCCs.IsSysCC(cccid.Name) {
 		return cs.invokeSystem(txParams, cccid, input)
 	}
 

core/chaincode/chaincode_support_test.go

@@ -177,7 +177,7 @@ func initMockPeer(chainIDs ...string) (*peer.Peer, *ChaincodeSupport, func(), er
 	globalConfig := GlobalConfig()
 	globalConfig.StartupTimeout = 10 * time.Second
 	globalConfig.ExecuteTimeout = 1 * time.Second
-	lsccImpl := lscc.New(scc.BuiltinSCCs{}, sccp, mockAclProvider, peerInstance.GetMSPIDs, newPolicyChecker(peerInstance))
+	lsccImpl := lscc.New(map[string]struct{}{"lscc": {}}, sccp, mockAclProvider, peerInstance.GetMSPIDs, newPolicyChecker(peerInstance))
 	ml := &mock.Lifecycle{}
 	ml.ChaincodeContainerInfoStub = func(_, name string, _ ledger.SimpleQueryExecutor) (*ccprovider.ChaincodeContainerInfo, error) {
 		switch name {
@@ -242,7 +242,7 @@ func initMockPeer(chainIDs ...string) (*peer.Peer, *ChaincodeSupport, func(), er
 		Lifecycle:              ml,
 		Peer:                   peerInstance,
 		Runtime:                containerRuntime,
-		SystemCCProvider:       scc.BuiltinSCCs{},
+		BuiltinSCCs:            map[string]struct{}{"lscc": {}},
 		TotalQueryLimit:        globalConfig.TotalQueryLimit,
 		UserRunsCC:             userRunsCC,
 	}
@@ -1029,8 +1029,8 @@ func TestGetTxContextFromHandler(t *testing.T) {
 	defer cleanup()
 
 	h := Handler{
-		TXContexts:       NewTransactionContexts(),
-		SystemCCProvider: &scc.BuiltinSCCs{},
+		TXContexts:  NewTransactionContexts(),
+		BuiltinSCCs: map[string]struct{}{"lscc": {}},
 	}
 
 	txid := "1"
@@ -1224,7 +1224,7 @@ func TestCCFramework(t *testing.T) {
 	initializeCC(t, chainID, ccname, ccSide, chaincodeSupport)
 
 	//chaincode support should not allow dups
-	handler := &Handler{chaincodeID: &pb.ChaincodeID{Name: ccname + ":0"}, SystemCCProvider: chaincodeSupport.SystemCCProvider}
+	handler := &Handler{chaincodeID: &pb.ChaincodeID{Name: ccname + ":0"}, BuiltinSCCs: chaincodeSupport.BuiltinSCCs}
 	if err := chaincodeSupport.HandlerRegistry.Register(handler); err == nil {
 		t.Fatalf("expected re-register to fail")
 	}

core/chaincode/exectransaction_test.go

@@ -109,7 +109,8 @@ func initPeer(chainIDs ...string) (*cm.Lifecycle, net.Listener, *ChaincodeSuppor
 	ca, _ := tlsgen.NewCA()
 	pr := platforms.NewRegistry(&golang.Platform{})
 	mockAclProvider := &mock.ACLProvider{}
-	lsccImpl := lscc.New(scc.BuiltinSCCs{}, sccp, mockAclProvider, peerInstance.GetMSPIDs, newPolicyChecker(peerInstance))
+	builtinSCCs := map[string]struct{}{"lscc": {}}
+	lsccImpl := lscc.New(builtinSCCs, sccp, mockAclProvider, peerInstance.GetMSPIDs, newPolicyChecker(peerInstance))
 	ml := &cm.Lifecycle{}
 	ml.ChaincodeContainerInfoStub = func(_, name string, _ ledger.SimpleQueryExecutor) (*ccprovider.ChaincodeContainerInfo, error) {
 		switch name {
@@ -183,7 +184,7 @@ func initPeer(chainIDs ...string) (*cm.Lifecycle, net.Listener, *ChaincodeSuppor
 		Lifecycle:              ml,
 		Peer:                   peerInstance,
 		Runtime:                containerRuntime,
-		SystemCCProvider:       scc.BuiltinSCCs{},
+		BuiltinSCCs:            builtinSCCs,
 		TotalQueryLimit:        globalConfig.TotalQueryLimit,
 		UserRunsCC:             userRunsCC,
 	}

core/chaincode/handler.go

@@ -24,6 +24,7 @@ import (
 	"github.com/hyperledger/fabric/core/common/sysccprovider"
 	"github.com/hyperledger/fabric/core/container/ccintf"
 	"github.com/hyperledger/fabric/core/ledger"
+	"github.com/hyperledger/fabric/core/scc"
 	"github.com/hyperledger/fabric/protos/common"
 	pb "github.com/hyperledger/fabric/protos/peer"
 	"github.com/pkg/errors"
@@ -50,11 +51,6 @@ type Invoker interface {
 	Invoke(txParams *ccprovider.TransactionParams, cccid *ccprovider.CCContext, spec *pb.ChaincodeInput) (*pb.ChaincodeMessage, error)
 }
 
-// SystemCCProvider provides system chaincode metadata.
-type SystemCCProvider interface {
-	IsSysCC(name string) bool
-}
-
 // TransactionRegistry tracks active transactions for each channel.
 type TransactionRegistry interface {
 	Add(channelID, txID string) bool
@@ -137,8 +133,8 @@ type Handler struct {
 	TXContexts ContextRegistry
 	// activeTransactions holds active transaction identifiers.
 	ActiveTransactions TransactionRegistry
-	// SystemCCProvider provides access to system chaincode metadata
-	SystemCCProvider SystemCCProvider
+	// BuiltinSCCs can be used to determine if a name is associated with a system chaincode
+	BuiltinSCCs scc.BuiltinSCCs
 	// InstantiationPolicyChecker is used to evaluate the chaincode instantiation policies.
 	InstantiationPolicyChecker InstantiationPolicyChecker
 	// QueryResponeBuilder is used to build query responses
@@ -356,7 +352,7 @@ func (h *Handler) checkACL(signedProp *pb.SignedProposal, proposal *pb.Proposal,
 	// - an application chaincode
 	//   (and we still need to determine whether the invoker can invoke it)
 
-	if h.SystemCCProvider.IsSysCC(ccIns.ChaincodeName) {
+	if h.BuiltinSCCs.IsSysCC(ccIns.ChaincodeName) {
 		// Allow this call
 		return nil
 	}
@@ -1017,7 +1013,7 @@ func (h *Handler) getTxContextForInvoke(channelID string, txid string, payload [
 	// If targetInstance is not an SCC, isValidTxSim should be called which will return an err.
 	// We do not want to propagate calls to user CCs when the original call was to a SCC
 	// without a channel context (ie, no ledger context).
-	if !h.SystemCCProvider.IsSysCC(targetInstance.ChaincodeName) {
+	if !h.BuiltinSCCs.IsSysCC(targetInstance.ChaincodeName) {
 		// normal path - UCC invocation with an empty ("") channel: isValidTxSim will return an error
 		return h.isValidTxSim("", txid, "could not get valid transaction")
 	}
@@ -1193,7 +1189,7 @@ func (h *Handler) HandleInvokeChaincode(msg *pb.ChaincodeMessage, txContext *Tra
 	version := h.SystemCCVersion
 	var idBytes []byte
 	requiresInit := false
-	if !h.SystemCCProvider.IsSysCC(targetInstance.ChaincodeName) {
+	if !h.BuiltinSCCs.IsSysCC(targetInstance.ChaincodeName) {
 		// if its a user chaincode, get the details
 		cd, err := h.DefinitionGetter.ChaincodeDefinition(targetInstance.ChainID, targetInstance.ChaincodeName, txParams.TXSimulator)
 		if err != nil {

core/chaincode/handler_test.go

@@ -20,6 +20,7 @@ import (
 	"github.com/hyperledger/fabric/core/common/ccprovider"
 	"github.com/hyperledger/fabric/core/common/sysccprovider"
 	"github.com/hyperledger/fabric/core/container/ccintf"
+	"github.com/hyperledger/fabric/core/scc"
 	pb "github.com/hyperledger/fabric/protos/peer"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/ginkgo/extensions/table"
@@ -32,7 +33,7 @@ var _ = Describe("Handler", func() {
 		fakeTransactionRegistry        *mock.TransactionRegistry
 		fakeContextRegistry            *fake.ContextRegistry
 		fakeChatStream                 *mock.ChaincodeStream
-		fakeSystemCCProvider           *mock.SystemCCProvider
+		builtinSCCs                    scc.BuiltinSCCs
 		fakeTxSimulator                *mock.TxSimulator
 		fakeHistoryQueryExecutor       *mock.HistoryQueryExecutor
 		fakeQueryResponseBuilder       *fake.QueryResponseBuilder
@@ -61,7 +62,6 @@ var _ = Describe("Handler", func() {
 		fakeTransactionRegistry.AddReturns(true)
 
 		fakeChatStream = &mock.ChaincodeStream{}
-		fakeSystemCCProvider = &mock.SystemCCProvider{}
 
 		fakeTxSimulator = &mock.TxSimulator{}
 		fakeHistoryQueryExecutor = &mock.HistoryQueryExecutor{}
@@ -106,6 +106,8 @@ var _ = Describe("Handler", func() {
 		fakeExecuteTimeouts = &metricsfakes.Counter{}
 		fakeExecuteTimeouts.WithReturns(fakeExecuteTimeouts)
 
+		builtinSCCs = map[string]struct{}{}
+
 		chaincodeMetrics := &chaincode.HandlerMetrics{
 			ShimRequestsReceived:  fakeShimRequestsReceived,
 			ShimRequestsCompleted: fakeShimRequestsCompleted,
@@ -122,7 +124,7 @@ var _ = Describe("Handler", func() {
 			InstantiationPolicyChecker: fakeInstantiationPolicyChecker,
 			QueryResponseBuilder:       fakeQueryResponseBuilder,
 			Registry:                   fakeHandlerRegistry,
-			SystemCCProvider:           fakeSystemCCProvider,
+			BuiltinSCCs:                builtinSCCs,
 			SystemCCVersion:            "system-cc-version",
 			TXContexts:                 fakeContextRegistry,
 			UUIDGenerator: chaincode.UUIDGeneratorFunc(func() string {
@@ -416,60 +418,46 @@ var _ = Describe("Handler", func() {
 					incomingMessage.ChannelId = ""
 				})
 
-				It("checks if the target is system chaincode", func() {
+				It("validates the transaction context", func() {
+					txContext.TXSimulator = nil
 					handler.HandleTransaction(incomingMessage, fakeMessageHandler.Handle)
 
-					Expect(fakeSystemCCProvider.IsSysCCCallCount()).To(Equal(1))
-					name := fakeSystemCCProvider.IsSysCCArgsForCall(0)
-					Expect(name).To(Equal("target-chaincode-name"))
+					Eventually(fakeChatStream.SendCallCount).Should(Equal(1))
+					msg := fakeChatStream.SendArgsForCall(0)
+					Expect(msg).To(Equal(&pb.ChaincodeMessage{
+						Type:    pb.ChaincodeMessage_ERROR,
+						Payload: []byte("INVOKE_CHAINCODE failed: transaction ID: tx-id: could not get valid transaction"),
+						Txid:    "tx-id",
+					}))
 				})
 
-				Context("when the target chaincode is not system chaincode", func() {
+				Context("when the target is system chaincode", func() {
 					BeforeEach(func() {
-						fakeSystemCCProvider.IsSysCCReturns(false)
+						builtinSCCs["target-chaincode-name"] = struct{}{}
 					})
 
-					It("validates the transaction context", func() {
+					It("gets the transaction context without validation", func() {
 						txContext.TXSimulator = nil
 						handler.HandleTransaction(incomingMessage, fakeMessageHandler.Handle)
 
+						Expect(fakeContextRegistry.GetCallCount()).To(Equal(1))
 						Eventually(fakeChatStream.SendCallCount).Should(Equal(1))
 						msg := fakeChatStream.SendArgsForCall(0)
-						Expect(msg).To(Equal(&pb.ChaincodeMessage{
-							Type:    pb.ChaincodeMessage_ERROR,
-							Payload: []byte("INVOKE_CHAINCODE failed: transaction ID: tx-id: could not get valid transaction"),
-							Txid:    "tx-id",
-						}))
+						Expect(msg).To(Equal(expectedResponse))
 					})
 
-					Context("when the target is system chaincode", func() {
-						BeforeEach(func() {
-							fakeSystemCCProvider.IsSysCCReturns(true)
-						})
-
-						It("gets the transaction context without validation", func() {
-							txContext.TXSimulator = nil
+					Context("and the transaction context is missing", func() {
+						It("returns an error", func() {
+							fakeContextRegistry.GetReturns(nil)
 							handler.HandleTransaction(incomingMessage, fakeMessageHandler.Handle)
 
-							Expect(fakeContextRegistry.GetCallCount()).To(Equal(1))
 							Eventually(fakeChatStream.SendCallCount).Should(Equal(1))
 							msg := fakeChatStream.SendArgsForCall(0)
-							Expect(msg).To(Equal(expectedResponse))
-						})
-
-						Context("and the transaction context is missing", func() {
-							It("returns an error", func() {
-								fakeContextRegistry.GetReturns(nil)
-								handler.HandleTransaction(incomingMessage, fakeMessageHandler.Handle)
-
-								Eventually(fakeChatStream.SendCallCount).Should(Equal(1))
-								msg := fakeChatStream.SendArgsForCall(0)
-								Expect(msg).To(Equal(&pb.ChaincodeMessage{
-									Type:    pb.ChaincodeMessage_ERROR,
-									Payload: []byte("INVOKE_CHAINCODE failed: transaction ID: tx-id: failed to get transaction context"),
-									Txid:    "tx-id",
-								}))
-							})
+							Expect(msg).To(Equal(&pb.ChaincodeMessage{
+								Type:    pb.ChaincodeMessage_ERROR,
+								Payload: []byte("INVOKE_CHAINCODE failed: transaction ID: tx-id: failed to get transaction context"),
+								Txid:    "tx-id",
+							}))
 						})
 					})
 				})
@@ -2197,15 +2185,6 @@ var _ = Describe("Handler", func() {
 			fakeInvoker.InvokeReturns(responseMessage, nil)
 		})
 
-		It("checks if the target is a system chaincode", func() {
-			_, err := handler.HandleInvokeChaincode(incomingMessage, txContext)
-			Expect(err).NotTo(HaveOccurred())
-
-			Expect(fakeSystemCCProvider.IsSysCCCallCount() >= 1).To(BeTrue())
-			name := fakeSystemCCProvider.IsSysCCArgsForCall(0)
-			Expect(name).To(Equal("target-chaincode-name"))
-		})
-
 		It("evaluates the access control policy", func() {
 			_, err := handler.HandleInvokeChaincode(incomingMessage, txContext)
 			Expect(err).NotTo(HaveOccurred())
@@ -2331,7 +2310,7 @@ var _ = Describe("Handler", func() {
 
 		Context("when the target is a system chaincode", func() {
 			BeforeEach(func() {
-				fakeSystemCCProvider.IsSysCCReturns(true)
+				builtinSCCs["target-chaincode-name"] = struct{}{}
 			})
 
 			It("does not perform acl checks", func() {
@@ -2352,10 +2331,6 @@ var _ = Describe("Handler", func() {
 		})
 
 		Context("when the target is not a system chaincode", func() {
-			BeforeEach(func() {
-				fakeSystemCCProvider.IsSysCCReturns(false)
-			})
-
 			It("gets the chaincode definition", func() {
 				_, err := handler.HandleInvokeChaincode(incomingMessage, txContext)
 				Expect(err).NotTo(HaveOccurred())