[FAB-9752] Wire registry into handler

This sets up for additional refactoring and unit tests for the Handler.

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

Author: sykesm

core/chaincode/chaincode_support.go

@@ -62,7 +62,7 @@ func NewChaincodeSupport(
 		ccStartupTimeout: ccstartuptimeout,
 		keepalive:        config.Keepalive,
 		executetimeout:   config.ExecuteTimeout,
-		handlerRegistry:  NewHandlerRegistry(userrunsCC),
+		HandlerRegistry:  NewHandlerRegistry(userrunsCC),
 		PackageProvider:  packageProvider,
 		ACLProvider:      aclProvider,
 	}
@@ -92,7 +92,6 @@ func NewChaincodeSupport(
 // ChaincodeSupport responsible for providing interfacing with chaincodes from the Peer.
 type ChaincodeSupport struct {
 	caCert           []byte
-	handlerRegistry  *HandlerRegistry
 	peerAddress      string
 	ccStartupTimeout time.Duration
 	peerNetworkID    string
@@ -103,6 +102,7 @@ type ChaincodeSupport struct {
 	ContainerRuntime Runtime
 	PackageProvider  PackageProvider
 	ACLProvider      ACLProvider
+	HandlerRegistry  *HandlerRegistry
 	sccp             sysccprovider.SystemChaincodeProvider
 }
 
@@ -114,24 +114,12 @@ func (cs *ChaincodeSupport) SetSysCCProvider(sccp sysccprovider.SystemChaincodeP
 	cs.sccp = sccp
 }
 
-func (cs *ChaincodeSupport) registerHandler(chaincodehandler *Handler) error {
-	return cs.handlerRegistry.Register(chaincodehandler)
-}
-
-func (cs *ChaincodeSupport) deregisterHandler(chaincodehandler *Handler) error {
-	return cs.handlerRegistry.Deregister(chaincodehandler.ChaincodeID.GetName())
-}
-
-func (cs *ChaincodeSupport) ready(chaincodehandler *Handler) {
-	cs.handlerRegistry.Ready(chaincodehandler.ChaincodeID.GetName())
-}
-
 // launchAndWaitForReady launches a container for the specified chaincode
 // context if one is not already running. It then waits for the chaincode
 // registration to complete or for the process to time out.
 func (cs *ChaincodeSupport) launchAndWaitForReady(ctx context.Context, cccid *ccprovider.CCContext, cds *pb.ChaincodeDeploymentSpec) error {
 	cname := cccid.GetCanonicalName()
-	ready, err := cs.handlerRegistry.Launching(cname)
+	ready, err := cs.HandlerRegistry.Launching(cname)
 	if err != nil {
 		return err
 	}
@@ -175,7 +163,7 @@ func (cs *ChaincodeSupport) Stop(ctx context.Context, cccid *ccprovider.CCContex
 		return errors.New("chaincode name not set")
 	}
 
-	defer cs.handlerRegistry.Deregister(cname)
+	defer cs.HandlerRegistry.Deregister(cname)
 
 	err := cs.ContainerRuntime.Stop(ctx, cccid, cds)
 	if err != nil {
@@ -191,7 +179,7 @@ func (cs *ChaincodeSupport) Launch(context context.Context, cccid *ccprovider.CC
 	cID := spec.GetChaincodeSpec().ChaincodeId
 	cMsg := spec.GetChaincodeSpec().Input
 
-	if cs.handlerRegistry.Handler(cname) != nil {
+	if cs.HandlerRegistry.Handler(cname) != nil {
 		return cID, cMsg, nil
 	}
 
@@ -290,7 +278,7 @@ func (cs *ChaincodeSupport) Execute(ctxt context.Context, cccid *ccprovider.CCCo
 
 	chaincodeLogger.Debugf("chaincode canonical name: %s", canName)
 	//we expect the chaincode to be running... sanity check
-	handler := cs.handlerRegistry.Handler(canName)
+	handler := cs.HandlerRegistry.Handler(canName)
 	if handler == nil {
 		chaincodeLogger.Debugf("cannot execute-chaincode is not running: %s", canName)
 		return nil, errors.Errorf("cannot execute transaction for %s", canName)

core/chaincode/chaincode_support_test.go

@@ -1015,7 +1015,7 @@ func TestLaunchAndWaitSuccess(t *testing.T) {
 		ccStartupTimeout: time.Duration(10) * time.Second,
 		peerNetworkID:    "networkID",
 		peerID:           "peerID",
-		handlerRegistry:  handlerRegistry,
+		HandlerRegistry:  handlerRegistry,
 		ContainerRuntime: fakeRuntime,
 	}
 	spec := &pb.ChaincodeSpec{Type: pb.ChaincodeSpec_Type(pb.ChaincodeSpec_Type_value["GOLANG"]), ChaincodeId: &pb.ChaincodeID{Name: "testcc", Version: "0"}}
@@ -1042,7 +1042,7 @@ func TestLaunchAndWaitTimeout(t *testing.T) {
 		ccStartupTimeout: 500 * time.Millisecond,
 		peerNetworkID:    "networkID",
 		peerID:           "peerID",
-		handlerRegistry:  NewHandlerRegistry(false),
+		HandlerRegistry:  NewHandlerRegistry(false),
 		ContainerRuntime: fakeRuntime,
 	}
 	spec := &pb.ChaincodeSpec{Type: pb.ChaincodeSpec_Type(pb.ChaincodeSpec_Type_value["GOLANG"]), ChaincodeId: &pb.ChaincodeID{Name: "testcc", Version: "0"}}
@@ -1068,7 +1068,7 @@ func TestLaunchAndWaitLaunchError(t *testing.T) {
 		ccStartupTimeout: time.Duration(10) * time.Second,
 		peerNetworkID:    "networkID",
 		peerID:           "peerID",
-		handlerRegistry:  NewHandlerRegistry(false),
+		HandlerRegistry:  NewHandlerRegistry(false),
 		ContainerRuntime: fakeRuntime,
 	}
 	spec := &pb.ChaincodeSpec{Type: pb.ChaincodeSpec_Type(pb.ChaincodeSpec_Type_value["GOLANG"]), ChaincodeId: &pb.ChaincodeID{Name: "testcc", Version: "0"}}
@@ -1298,7 +1298,7 @@ func TestCCFramework(t *testing.T) {
 	initializeCC(t, chainID, ccname, ccSide, chaincodeSupport)
 
 	//chaincode support should not allow dups
-	if err := chaincodeSupport.registerHandler(&Handler{ChaincodeID: &pb.ChaincodeID{Name: ccname + ":0"}, sccp: chaincodeSupport.sccp}); err == nil {
+	if err := chaincodeSupport.HandlerRegistry.Register(&Handler{ChaincodeID: &pb.ChaincodeID{Name: ccname + ":0"}, sccp: chaincodeSupport.sccp}); err == nil {
 		t.Fatalf("expected re-register to fail")
 	}
 

core/chaincode/handler.go

@@ -47,12 +47,14 @@ type ACLProvider interface {
 	CheckACL(resName string, channelID string, idinfo interface{}) error
 }
 
+type Registry interface {
+	Register(*Handler) error
+	Ready(cname string)
+	Deregister(cname string) error
+}
+
 // internal interface to scope dependencies on ChaincodeSupport
 type handlerSupport interface {
-	deregisterHandler(*Handler) error
-	registerHandler(*Handler) error
-	ready(*Handler)
-
 	GetChaincodeDefinition(ctxt context.Context, txid string, signedProp *pb.SignedProposal, prop *pb.Proposal, chainID string, chaincodeID string) (resourcesconfig.ChaincodeDefinition, error)
 	Launch(context context.Context, cccid *ccprovider.CCContext, spec ccprovider.ChaincodeSpecGetter) (*pb.ChaincodeID, *pb.ChaincodeInput, error)
 	Execute(ctxt context.Context, cccid *ccprovider.CCContext, msg *pb.ChaincodeMessage, timeout time.Duration) (*pb.ChaincodeMessage, error)
@@ -89,6 +91,7 @@ type Handler struct {
 	keepalive  time.Duration
 	userRunsCC bool
 
+	registry    Registry
 	aclProvider ACLProvider
 }
 
@@ -217,7 +220,7 @@ func (h *Handler) checkACL(signedProp *pb.SignedProposal, proposal *pb.Proposal,
 }
 
 func (h *Handler) deregister() {
-	h.handlerSupport.deregisterHandler(h)
+	h.registry.Deregister(h.ChaincodeID.Name)
 }
 
 func (h *Handler) waitForKeepaliveTimer() <-chan time.Time {
@@ -333,6 +336,7 @@ func newChaincodeSupportHandler(chaincodeSupport *ChaincodeSupport, peerChatStre
 		keepalive:          chaincodeSupport.keepalive,
 		userRunsCC:         chaincodeSupport.userRunsCC,
 		aclProvider:        chaincodeSupport.ACLProvider,
+		registry:           chaincodeSupport.HandlerRegistry,
 		sccp:               sccp,
 	}
 
@@ -381,7 +385,7 @@ func (h *Handler) sendReady() error {
 	}
 
 	h.state = ready
-	h.handlerSupport.ready(h)
+	h.registry.Ready(h.ChaincodeID.Name)
 
 	chaincodeLogger.Debugf("Changed to state ready for chaincode %+v", h.ChaincodeID)
 
@@ -411,7 +415,7 @@ func (h *Handler) handleRegister(msg *pb.ChaincodeMessage) {
 
 	// Now register with the chaincodeSupport
 	h.ChaincodeID = chaincodeID
-	err = h.handlerSupport.registerHandler(h)
+	err = h.registry.Register(h)
 	if err != nil {
 		h.notifyDuringStartup(false)
 		return