FAB-10975 Split Execute into Execute/ExecuteInit

Presently, the Execute function can either take a
'ChaincodeInvocationSpec' or a 'ChaincodeDeploymentSpec', and the path
switches in a few different places depending on which it is.  This makes
the code complicated and difficult to understand, and in the interest of
removing the chaincode deployment spec entirely, this code path should
be isolated.

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

Author: Jason Yellick

core/chaincode/ccproviderimpl.go

@@ -57,10 +57,15 @@ func (c *CCProviderImpl) ExecuteChaincode(ctxt context.Context, cccid *ccprovide
 }
 
 // Execute executes the chaincode given context and spec (invocation or deploy)
-func (c *CCProviderImpl) Execute(ctxt context.Context, cccid *ccprovider.CCContext, spec ccprovider.ChaincodeSpecGetter) (*pb.Response, *pb.ChaincodeEvent, error) {
+func (c *CCProviderImpl) Execute(ctxt context.Context, cccid *ccprovider.CCContext, spec *pb.ChaincodeInvocationSpec) (*pb.Response, *pb.ChaincodeEvent, error) {
 	return c.cs.Execute(ctxt, cccid, spec)
 }
 
+// ExecuteInit executes the chaincode given context and spec (invocation or deploy)
+func (c *CCProviderImpl) ExecuteInit(ctxt context.Context, cccid *ccprovider.CCContext, spec *pb.ChaincodeDeploymentSpec) (*pb.Response, *pb.ChaincodeEvent, error) {
+	return c.cs.ExecuteInit(ctxt, cccid, spec)
+}
+
 // Stop stops the chaincode given context and spec
 func (c *CCProviderImpl) Stop(ctxt context.Context, cccid *ccprovider.CCContext, spec *pb.ChaincodeDeploymentSpec) error {
 	return c.cs.Stop(ctxt, cccid, spec)

core/chaincode/chaincode_support.go

@@ -30,7 +30,8 @@ type Runtime interface {
 
 // Launcher is used to launch chaincode runtimes.
 type Launcher interface {
-	Launch(context context.Context, cccid *ccprovider.CCContext, spec ccprovider.ChaincodeSpecGetter) error
+	Launch(context context.Context, cccid *ccprovider.CCContext, spec *pb.ChaincodeInvocationSpec) error
+	LaunchInit(context context.Context, cccid *ccprovider.CCContext, spec *pb.ChaincodeDeploymentSpec) error
 }
 
 // ChaincodeSupport responsible for providing interfacing with chaincodes from the Peer.
@@ -96,10 +97,24 @@ func NewChaincodeSupport(
 	return cs
 }
 
+// LaunchForInit bypasses getting the chaincode spec from the LSCC table
+// as in the case of v1.0-v1.2 lifecycle, the chaincode will not yet be
+// defined in the LSCC table
+func (cs *ChaincodeSupport) LaunchInit(ctx context.Context, cccid *ccprovider.CCContext, spec *pb.ChaincodeDeploymentSpec) error {
+	cname := cccid.GetCanonicalName()
+	if cs.HandlerRegistry.Handler(cname) != nil {
+		return nil
+	}
+
+	ctx = context.WithValue(ctx, ccintf.GetCCHandlerKey(), cs)
+
+	return cs.Launcher.LaunchInit(ctx, cccid, spec)
+}
+
 // Launch starts executing chaincode if it is not already running. This method
 // blocks until the peer side handler gets into ready state or encounters a fatal
 // error. If the chaincode is already running, it simply returns.
-func (cs *ChaincodeSupport) Launch(ctx context.Context, cccid *ccprovider.CCContext, spec ccprovider.ChaincodeSpecGetter) error {
+func (cs *ChaincodeSupport) Launch(ctx context.Context, cccid *ccprovider.CCContext, spec *pb.ChaincodeInvocationSpec) error {
 	cname := cccid.GetCanonicalName()
 	if cs.HandlerRegistry.Handler(cname) != nil {
 		return nil
@@ -177,9 +192,19 @@ func createCCMessage(messageType pb.ChaincodeMessage_Type, cid string, txid stri
 	return ccmsg, nil
 }
 
+// Execute init invokes chaincode and returns the original response.
+func (cs *ChaincodeSupport) ExecuteInit(ctxt context.Context, cccid *ccprovider.CCContext, spec *pb.ChaincodeDeploymentSpec) (*pb.Response, *pb.ChaincodeEvent, error) {
+	resp, err := cs.InvokeInit(ctxt, cccid, spec)
+	return processChaincodeExecutionResult(cccid, resp, err)
+}
+
 // Execute invokes chaincode and returns the original response.
-func (cs *ChaincodeSupport) Execute(ctxt context.Context, cccid *ccprovider.CCContext, spec ccprovider.ChaincodeSpecGetter) (*pb.Response, *pb.ChaincodeEvent, error) {
+func (cs *ChaincodeSupport) Execute(ctxt context.Context, cccid *ccprovider.CCContext, spec *pb.ChaincodeInvocationSpec) (*pb.Response, *pb.ChaincodeEvent, error) {
 	resp, err := cs.Invoke(ctxt, cccid, spec)
+	return processChaincodeExecutionResult(cccid, resp, err)
+}
+
+func processChaincodeExecutionResult(cccid *ccprovider.CCContext, resp *pb.ChaincodeMessage, err error) (*pb.Response, *pb.ChaincodeEvent, error) {
 	if err != nil {
 		return nil, nil, errors.Wrapf(err, "failed to execute transaction %s", cccid.TxID)
 	}
@@ -209,18 +234,33 @@ func (cs *ChaincodeSupport) Execute(ctxt context.Context, cccid *ccprovider.CCCo
 	}
 }
 
+func (cs *ChaincodeSupport) InvokeInit(ctxt context.Context, cccid *ccprovider.CCContext, spec *pb.ChaincodeDeploymentSpec) (*pb.ChaincodeMessage, error) {
+	cctyp := pb.ChaincodeMessage_INIT
+
+	err := cs.LaunchInit(ctxt, cccid, spec)
+	if err != nil {
+		return nil, err
+	}
+
+	chaincodeSpec := spec.GetChaincodeSpec()
+	if chaincodeSpec == nil {
+		return nil, errors.New("chaincode spec is nil")
+	}
+
+	input := chaincodeSpec.Input
+	input.Decorations = cccid.ProposalDecorations
+	ccMsg, err := createCCMessage(cctyp, cccid.ChainID, cccid.TxID, input)
+	if err != nil {
+		return nil, errors.WithMessage(err, "failed to create chaincode message")
+	}
+
+	return cs.execute(ctxt, cccid, ccMsg)
+}
+
 // 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(ctxt context.Context, cccid *ccprovider.CCContext, spec ccprovider.ChaincodeSpecGetter) (*pb.ChaincodeMessage, error) {
-	var cctyp pb.ChaincodeMessage_Type
-	switch spec.(type) {
-	case *pb.ChaincodeDeploymentSpec:
-		cctyp = pb.ChaincodeMessage_INIT
-	case *pb.ChaincodeInvocationSpec:
-		cctyp = pb.ChaincodeMessage_TRANSACTION
-	default:
-		return nil, errors.New("a deployment or invocation spec is required")
-	}
+func (cs *ChaincodeSupport) Invoke(ctxt context.Context, cccid *ccprovider.CCContext, spec *pb.ChaincodeInvocationSpec) (*pb.ChaincodeMessage, error) {
+	cctyp := pb.ChaincodeMessage_TRANSACTION
 
 	chaincodeSpec := spec.GetChaincodeSpec()
 	if chaincodeSpec == nil {

core/chaincode/exectransaction_test.go

@@ -459,7 +459,7 @@ func deploy2(ctx context.Context, cccid *ccprovider.CCContext, chaincodeDeployme
 	}
 
 	var resp *pb.Response
-	if resp, _, err = chaincodeSupport.Execute(ctx, cccid, chaincodeDeploymentSpec); err != nil {
+	if resp, _, err = chaincodeSupport.ExecuteInit(ctx, cccid, chaincodeDeploymentSpec); err != nil {
 		return nil, fmt.Errorf("Error deploying chaincode(2): %s", err)
 	}
 
@@ -742,6 +742,7 @@ func runChaincodeInvokeChaincode(t *testing.T, channel1 string, channel2 string,
 		nextBlockNumber2,
 		chaincodeSupport,
 	)
+
 	if err != nil {
 		stopChaincode(ctxt, cccid1, chaincodeSupport)
 		stopChaincode(ctxt, cccid2, chaincodeSupport)

core/chaincode/handler.go

@@ -44,7 +44,7 @@ type Registry interface {
 
 // An Invoker invokes chaincode.
 type Invoker interface {
-	Invoke(ctxt context.Context, cccid *ccprovider.CCContext, spec ccprovider.ChaincodeSpecGetter) (*pb.ChaincodeMessage, error)
+	Invoke(ctxt context.Context, cccid *ccprovider.CCContext, spec *pb.ChaincodeInvocationSpec) (*pb.ChaincodeMessage, error)
 }
 
 // SystemCCProvider provides system chaincode metadata.

core/chaincode/handler_test.go

@@ -1506,7 +1506,7 @@ var _ = Describe("Handler", func() {
 			})
 
 			It("marks the new transaction simulator as done after execute", func() {
-				fakeInvoker.InvokeStub = func(context.Context, *ccprovider.CCContext, ccprovider.ChaincodeSpecGetter) (*pb.ChaincodeMessage, error) {
+				fakeInvoker.InvokeStub = func(context.Context, *ccprovider.CCContext, *pb.ChaincodeInvocationSpec) (*pb.ChaincodeMessage, error) {
 					Expect(newTxSimulator.DoneCallCount()).To(Equal(0))
 					return responseMessage, nil
 				}

core/chaincode/lifecycle.go

@@ -18,7 +18,7 @@ import (
 
 // Executor is used to invoke chaincode.
 type Executor interface {
-	Execute(ctxt context.Context, cccid *ccprovider.CCContext, cis ccprovider.ChaincodeSpecGetter) (*pb.Response, *pb.ChaincodeEvent, error)
+	Execute(ctxt context.Context, cccid *ccprovider.CCContext, cis *pb.ChaincodeInvocationSpec) (*pb.Response, *pb.ChaincodeEvent, error)
 }
 
 // Lifecycle provides methods to invoke the lifecycle system chaincode.

core/chaincode/mock/executor.go

@@ -35,27 +35,29 @@ type RuntimeLauncher struct {
 	StartupTimeout  time.Duration
 }
 
-// Launch chaincode with the appropriate runtime.
-func (r *RuntimeLauncher) Launch(ctx context.Context, cccid *ccprovider.CCContext, spec ccprovider.ChaincodeSpecGetter) error {
-	chaincodeID := spec.GetChaincodeSpec().ChaincodeId
-	cds, _ := spec.(*pb.ChaincodeDeploymentSpec)
-	if cds == nil {
-		var err error
-		cds, err = r.getDeploymentSpec(ctx, cccid, chaincodeID)
-		if err != nil {
-			return err
-		}
+// LaunchInit launches a container which is not yet defined in the LSCC table
+// This is only necessary for the pre v1.3 lifecycle
+func (r *RuntimeLauncher) LaunchInit(ctx context.Context, cccid *ccprovider.CCContext, spec *pb.ChaincodeDeploymentSpec) error {
+	err := r.start(ctx, cccid, spec)
+	if err != nil {
+		chaincodeLogger.Errorf("start failed: %+v", err)
+		return err
 	}
 
-	if cds.CodePackage == nil && cds.ExecEnv != pb.ChaincodeDeploymentSpec_SYSTEM {
-		ccpack, err := r.PackageProvider.GetChaincode(chaincodeID.Name, chaincodeID.Version)
-		if err != nil {
-			return errors.Wrap(err, "failed to get chaincode package")
-		}
-		cds = ccpack.GetDepSpec()
+	chaincodeLogger.Debug("launch complete")
+
+	return nil
+}
+
+// Launch chaincode with the appropriate runtime.
+func (r *RuntimeLauncher) Launch(ctx context.Context, cccid *ccprovider.CCContext, spec *pb.ChaincodeInvocationSpec) error {
+	chaincodeID := spec.GetChaincodeSpec().ChaincodeId
+	cds, err := r.getDeploymentSpec(ctx, cccid, chaincodeID)
+	if err != nil {
+		return err
 	}
 
-	err := r.start(ctx, cccid, cds)
+	err = r.start(ctx, cccid, cds)
 	if err != nil {
 		chaincodeLogger.Errorf("start failed: %+v", err)
 		return err
@@ -81,6 +83,16 @@ func (r *RuntimeLauncher) getDeploymentSpec(ctx context.Context, cccid *ccprovid
 }
 
 func (r *RuntimeLauncher) start(ctx context.Context, cccid *ccprovider.CCContext, cds *pb.ChaincodeDeploymentSpec) error {
+	// Note, it is not actually possible for cds.CodePackage to be non-nil in the real world
+	// But some of the tests rely on the idea that it might be set.
+	if cds.CodePackage == nil && cds.ExecEnv != pb.ChaincodeDeploymentSpec_SYSTEM {
+		ccpack, err := r.PackageProvider.GetChaincode(cds.Name(), cds.Version())
+		if err != nil {
+			return errors.Wrap(err, "failed to get chaincode package")
+		}
+		cds = ccpack.GetDepSpec()
+	}
+
 	cname := cccid.GetCanonicalName()
 	launchState, err := r.Registry.Launching(cname)
 	if err != nil {