Merge pull request #52 from hyperledger-labs/feature/collection-gener…

…ation

Automatic collection generation

.gitignore

@@ -6,6 +6,7 @@ fabric/ca
 fabric/bin
 fabric/builders
 chaincode/vendor/*
+chaincode/collections.json
 ccapi/vendor/*
 cc-tools-demo.tar.gz
 package-lock.json

README.md

@@ -34,7 +34,7 @@ start all components of the project with 3 organizations.
 
 If you want to deploy with 1 organization, run the command `./startDev.sh -n 1`.
 
-To apply chaincode changes, run `$ ./upgradeCC2.sh <version> <sequence>` with a version higher than the current one (starts with 0.1). Append `-n 1` to the command if running with 1 organization.
+To apply chaincode changes, run `$ ./upgradeCC.sh <version> <sequence>` with a version higher than the current one (starts with 0.1). Append `-n 1` to the command if running with 1 organization.
 
 To apply CC API changes, run `$ ./reloadCCAPI.sh`.
 
@@ -44,10 +44,23 @@ To test transactions after starting all components, run `$ ./tryout.sh`.
 
 To test transactions using the godog tool, run `$ ./godog.sh`.
 
+
+## Generate TAR archive for the chaincode
+
+The `generateTar.sh` script is available to generate a `tar.gz` archive of the chaincode. 
+
+By running `$ ./generateTar.sh` without any option, the script generates a `collections.json` file for the private data on the chaincode with all the organizations defined on the readers section of private asset types, and then archives the code without the CCAPI.
+
+By using the `--org/-o` option along the script, it's possible to specify the organizations to be considered when generating the `collections.json` file. This option may be used multiple times to add all the organizations, ex: `$ ./generateTar.sh -o org1MSP -o org2MSP`.
+
+To also archive the the CCAPI alongside the chaincode, the `--ccapi/-c` flag may be used. Example: `$ ./generateTar.sh -c`.
+
+By standard the archive is created using the project name with *1.0* label, to change it the `--name/-n` and `--label/-l` flags may be used. Example: `$ ./generateTar.sh -n my-project -l 2.0`
+
 ## More
 
 You can reach GoLedger developers and `cc-tools` maintainers at our Discord - [Join us!](https://discord.gg/GndkYHxNyQ)
 
 More documentation and details on `cc-tools` can be found at [https://goledger-cc-tools.readthedocs.io/en/latest/](https://goledger-cc-tools.readthedocs.io/en/latest/)
 
-For production deployment please consider using GoFabric - [https://gofabric.io](https://gofabric.io)
+For production deployment please consider using GoFabric - [https://gofabric.io](https://gofabric.io)

chaincode/generateCollections.go

@@ -0,0 +1,82 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"io/ioutil"
+)
+
+type ArrayFlags []string
+
+func (i *ArrayFlags) String() string {
+	return "my string representation"
+}
+
+func (i *ArrayFlags) Set(value string) error {
+	*i = append(*i, value)
+	return nil
+}
+
+type CollectionElem struct {
+	Name              string `json:"name"`
+	RequiredPeerCount int    `json:"requiredPeerCount"`
+	MaxPeerCount      int    `json:"maxPeerCount"`
+	BlockToLive       int    `json:"blockToLive"`
+	MemberOnlyRead    bool   `json:"memberOnlyRead"`
+	Policy            string `json:"policy"`
+}
+
+func generateCollection(orgs ArrayFlags) {
+	collection := []CollectionElem{}
+
+	for _, a := range assetTypeList {
+		if len(a.Readers) > 0 {
+			elem := CollectionElem{
+				Name:              a.Tag,
+				RequiredPeerCount: 0,
+				MaxPeerCount:      3,
+				BlockToLive:       1000000,
+				MemberOnlyRead:    true,
+				Policy:            generatePolicy(a.Readers, orgs),
+			}
+			collection = append(collection, elem)
+		}
+	}
+
+	b, err := json.MarshalIndent(collection, "", "  ")
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+	err = ioutil.WriteFile("collections.json", b, 0644)
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+}
+
+func generatePolicy(readers []string, orgs ArrayFlags) string {
+	firstElem := true
+	policy := "OR("
+	for _, r := range readers {
+		if len(orgs) > 0 {
+			found := false
+			for _, o := range orgs {
+				if r == o {
+					found = true
+					break
+				}
+			}
+			if !found {
+				continue
+			}
+		}
+		if !firstElem {
+			policy += ", "
+		}
+		policy += fmt.Sprintf("'%s.member'", r)
+		firstElem = false
+	}
+	policy += ")"
+	return policy
+}

chaincode/main.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"flag"
 	"fmt"
 	"log"
 	"time"
@@ -45,6 +46,16 @@ func SetupCC() error {
 
 // main function starts up the chaincode in the container during instantiate
 func main() {
+	// Generate collection json
+	genFlag := flag.Bool("g", false, "Enable collection generation")
+	flag.Bool("orgs", false, "List of orgs to generate collection for")
+	flag.Parse()
+	if *genFlag {
+		listOrgs := flag.Args()
+		generateCollection(listOrgs)
+		return
+	}
+
 	log.Printf("Starting chaincode %s version %s\n", header.Name, header.Version)
 
 	err := SetupCC()

fabric/network.sh

@@ -460,7 +460,7 @@ CC_SRC_PATH="NA"
 # endorsement policy defaults to "NA". This would allow chaincodes to use the majority default policy.
 CC_END_POLICY="NA"
 # collection configuration defaults to "NA"
-CC_COLL_CONFIG="../chaincode/collections2.json"
+CC_COLL_CONFIG="../chaincode/collections.json"
 # chaincode init function defaults to "NA"
 CC_INIT_FCN="NA"
 # use this as the default docker-compose yaml definition

fabric/startDev.sh

@@ -16,12 +16,7 @@ then
   ORG_QNTY=3
 fi
 
-if [ $ORG_QNTY == 1 ]
-then
-  CCCG_PATH="../chaincode/collections2-org.json"
-else
-  CCCG_PATH="../chaincode/collections2.json"
-fi
+CCCG_PATH="../chaincode/collections.json"
 
 ./network.sh down -n $ORG_QNTY
 rm -rf organizations/peerOrganizations

generateCollection.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/bash
+
+while getopts "o:h" opt; do
+    case $opt in
+        o) orgs+=("$OPTARG");;
+        #...
+        h)
+            echo "Usage: ./generateCollection.sh [-o <org name>]"
+            echo "  -o: Include an organization in the collection configuration file"
+            echo "      This option can be used multiple times to include multiple organizations"
+            echo "      If no organizations are specified, the default is to include any organization found in the readers"
+            echo ""
+            echo "Example: ./generateCollection.sh -o org1MSP -o org2MSP -o org3MSP"
+            exit 0
+            ;;
+    esac
+done
+shift $((OPTIND -1))
+
+if [ ${#orgs[@]} -gt 0 ]
+then
+    cd ./chaincode; go run . -g --orgs ${orgs[@]}; cd ..
+else
+    cd ./chaincode; go run . -g; cd ..
+fi

generateTar.sh

@@ -3,6 +3,7 @@
 # Default values for the flags
 FLAG_CCAPI="none"
 FLAG_LABEL="1.0"
+SKIP_COLL_GEN=false
 
 # You can change this if you want to avoid using the --name flag
 FLAG_NAME="cc-tools-demo"
@@ -32,12 +33,29 @@ while [[ $# -gt 0 ]]; do
                 exit 1
             fi
             ;;
+        --org | -o)
+            if [[ $# -gt 1 ]]; then
+                orgs+=("$2")
+                shift 2
+            else
+                echo "Error: --org flag requires a value."
+                exit 1
+            fi
+            ;;
+        --skip | -s)
+            SKIP_COLL_GEN=true
+            shift 1
+            ;;
         --help | -h)
             echo "Usage: ./generateTar.sh [--ccapi] [--label <label>] [--name <name>]"
             echo "  --ccapi, -c: Include rest-server in the tar file. Default is no ccapi."
             echo "  --help , -h: Show this help message."
             echo "  --label, -l: Label to be used for the chaincode package. Default is 1.0."
             echo "  --name , -n: Name of the chaincode package. Default is ${FLAG_NAME}."
+            echo "  --org  , -o: Include an organization in the collection configuration file"
+            echo "      This option can be used multiple times to include multiple organizations"
+            echo "      If no organizations are specified, the default is to include any organization found in the readers"
+            echo "  --skip , -s: Skip the generation of the collections.json file"
             exit 0
             ;;
         *)
@@ -47,6 +65,17 @@ while [[ $# -gt 0 ]]; do
     esac
 done
 
+# Generate collection configuration file
+if [ "$SKIP_COLL_GEN" = false ]
+then
+    if [ ${#orgs[@]} -gt 0 ]
+    then
+        cd ./chaincode; go run . -g --orgs ${orgs[@]}; cd ..
+    else
+        cd ./chaincode; go run . -g; cd ..
+    fi
+fi
+
 # Remove previous tar file
 rm -f ${FLAG_NAME}.tar.gz
 
@@ -61,7 +90,7 @@ case $FLAG_CCAPI in
     go)
         # Create temporary directory for rest-server
         mkdir -p tmp/rest-server
-        cp -r ccapi/* tmp/rest-server
+        cp -r ccapi/. tmp/rest-server
 
         # Compress file with rest-server (GoFabric will use the one provided)
         tar -c --exclude=vendor -zf ${FLAG_NAME}.tar.gz chaincode.tar.gz -C tmp rest-server

startDev.sh

@@ -1,11 +1,14 @@
 #!/usr/bin/env bash
 
 ORG_QNTY=3
+SKIP_COLL_GEN=false
 
-while getopts n: opt; do
+while getopts n:c opt; do
     case $opt in
         n)  ORG_QNTY=${OPTARG}
             ;;
+        c)  SKIP_COLL_GEN=true
+            ;;
     esac
 done
 
@@ -16,6 +19,16 @@ then
   ORG_QNTY=3
 fi
 
+if [ "$SKIP_COLL_GEN" = false ] ; then
+    echo 'Generating collections configuration file...'
+    if [ $ORG_QNTY == 1 ]
+    then
+        cd ./chaincode; go run . -g --orgs orgMSP; cd ..
+    else
+        cd ./chaincode; go run . -g --orgs org1MSP org2MSP org3MSP; cd ..
+    fi
+fi
+
 # Clear unused images and volumes
 docker rmi $(docker images --quiet --filter "dangling=true")
 docker volume rm $(docker volume ls -qf dangling=true)