[FAB-7132] Add couch indexes to chaincode install pkg

Allow indexes that support chaincode queries to be defined
alongside chaincode. Any index defined in chaincode directory
/statedb/couchdb/indexes will get added to the chaincode
deployment spec code package, so that when the chaincode
is both installed on a peer and instantiated on a channel,
the indexes can be automatically deployed to couchdb.

Change-Id: Iaf33a436e76998ae74608d3605acab5643a52f9f
Signed-off-by: David Enyeart <enyeart@us.ibm.com>

Author: denyeart

core/chaincode/platforms/golang/package.go

@@ -87,6 +87,7 @@ func getCode(spec *pb.ChaincodeSpec) (*CodeDescriptor, error) {
 
 type SourceDescriptor struct {
 	Name, Path string
+	IsMetadata bool
 	Info       os.FileInfo
 }
 type SourceMap map[string]SourceDescriptor
@@ -115,13 +116,20 @@ func findSource(gopath, pkg string) (SourceMap, error) {
 		}
 
 		if info.IsDir() {
+
+			// Allow import of the top level chaincode directory into chaincode code package
 			if path == tld {
-				// We dont want to import any directories, but we don't want to stop processing
-				// at the TLD either.
 				return nil
 			}
 
-			// Do not recurse
+			// Allow import of META-INF metadata directories into chaincode code package tar.
+			// META-INF directories contain chaincode metadata artifacts such as statedb index definitions
+			if isMetadataDir(path, tld) {
+				logger.Debug("Files in META-INF directory will be included in code package tar:", path)
+				return nil
+			}
+
+			// Do not import any other directories into chaincode code package
 			logger.Debugf("skipping dir: %s", path)
 			return filepath.SkipDir
 		}
@@ -137,7 +145,7 @@ func findSource(gopath, pkg string) (SourceMap, error) {
 			return fmt.Errorf("error obtaining relative path for %s: %s", path, err)
 		}
 
-		sources[name] = SourceDescriptor{Name: name, Path: path, Info: info}
+		sources[name] = SourceDescriptor{Name: name, Path: path, IsMetadata: isMetadataDir(path, tld), Info: info}
 
 		return nil
 	}
@@ -148,3 +156,8 @@ func findSource(gopath, pkg string) (SourceMap, error) {
 
 	return sources, nil
 }
+
+// isMetadataDir checks to see if the current path is in the META-INF directory at the root of the chaincode directory
+func isMetadataDir(path, tld string) bool {
+	return strings.HasPrefix(path, filepath.Join(tld, "META-INF"))
+}

core/chaincode/platforms/golang/platform.go

@@ -426,6 +426,23 @@ func (goPlatform *Platform) GetDeploymentPayload(spec *pb.ChaincodeSpec) ([]byte
 	tw := tar.NewWriter(gw)
 
 	for _, file := range files {
+
+		// If the file is metadata rather than golang code, remove the leading go code path, for example:
+		// file.Name:  src/github.com/hyperledger/fabric/examples/chaincode/go/marbles02/META-INF/statedb/couchdb/indexes/indexOwner.json
+		// tar file:   META-INF/statedb/couchdb/indexes/indexOwner.json
+		if file.IsMetadata {
+
+			// Ensure META-INF directory can be found, then grab the META-INF relative path to use for packaging
+			if !strings.HasPrefix(file.Name, filepath.Join("src", code.Pkg, "META-INF")) {
+				return nil, fmt.Errorf("Could not find META-INF directory in metadata file %s.", file.Name)
+			}
+			file.Name, err = filepath.Rel(filepath.Join("src", code.Pkg), file.Name)
+			if err != nil {
+				return nil, fmt.Errorf("Could not get relative path for META-INF directory %s. Error:%s", file.Name, err)
+			}
+		}
+
+		logger.Debug("Writing file to chaincode code package tarball:", file.Name)
 		err = cutil.WriteFileToPackage(file.Path, file.Name, tw)
 		if err != nil {
 			return nil, fmt.Errorf("Error writing %s to tar: %s", file.Name, err)

core/chaincode/platforms/golang/platform_test.go

@@ -165,6 +165,41 @@ func Test_DeploymentPayload(t *testing.T) {
 	}
 }
 
+func Test_DeploymentPayloadWithStateDBArtifacts(t *testing.T) {
+	platform := &Platform{}
+	spec := &pb.ChaincodeSpec{
+		ChaincodeId: &pb.ChaincodeID{
+			Path: "github.com/hyperledger/fabric/examples/chaincode/go/marbles02",
+		},
+	}
+
+	payload, err := platform.GetDeploymentPayload(spec)
+	assert.NoError(t, err)
+
+	t.Logf("payload size: %d", len(payload))
+
+	is := bytes.NewReader(payload)
+	gr, err := gzip.NewReader(is)
+	if err == nil {
+		tr := tar.NewReader(gr)
+
+		var foundIndexArtifact bool
+		for {
+			header, err := tr.Next()
+			if err != nil {
+				// We only get here if there are no more entries to scan
+				break
+			}
+
+			t.Logf("%s (%d)", header.Name, header.Size)
+			if header.Name == "META-INF/statedb/couchdb/indexes/indexOwner.json" {
+				foundIndexArtifact = true
+			}
+		}
+		assert.Equal(t, true, foundIndexArtifact, "should have found statedb index artifact in marbles02 META-INF directory")
+	}
+}
+
 func Test_decodeUrl(t *testing.T) {
 	cs := &pb.ChaincodeSpec{
 		ChaincodeId: &pb.ChaincodeID{

examples/chaincode/go/marbles02/META-INF/statedb/couchdb/indexes/indexOwner.json

@@ -0,0 +1 @@
+{"index":{"fields":["chaincodeid","data.owner"]},"name":"indexOwner","type":"json"}