Merge branch 'main' into CI-tests

Author: dzikowski

.github/workflows/release-on-tag.yml

@@ -15,9 +15,7 @@ jobs:
 
       - name: Verify version
         run: |
-          TAG=$(git describe --tags --abbrev=0)
-          VERSION=${TAG:1}
-          echo "TAG: $TAG"
+          VERSION=$(git describe --tags --abbrev=0)
           echo "VERSION: $VERSION"
           PKG_JSON_VERSION=$(jq -r '.version' <"$GITHUB_WORKSPACE/package.json")
           if [ "$VERSION" != "$PKG_JSON_VERSION" ]; then

.github/workflows/test-on-push.yml

@@ -243,3 +243,27 @@ jobs:
           path: |
             e2e-network/docker/test-06-v3-bft.sh.logs/*
             e2e-network/docker/test-06-v3-bft.sh.tmpdir/fablo-target/**/*
+  test-07-v2-peer-dev-mode:
+    needs: test-main
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+
+      - name: Build Fablo
+        run: |
+          shellcheck --version && \
+          yamllint -v && \
+          npm install && \
+          ./fablo-build.sh
+
+      - name: Test v2 peer dev mode
+        run: e2e-network/docker/test-07-v2-peer-dev-mode.sh
+
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: test-07-v2-peer-dev-mode-snapshot
+          path: |
+            e2e-network/docker/test-07-v2-peer-dev-mode.sh.logs/*
+            e2e-network/docker/test-07-v2-peer-dev-mode.sh.tmpdir/fablo-target/**/*

CHANGELOG.md

@@ -1,6 +1,6 @@
-## 2.3.0
-
-### Features
+## 2.3.0 
+* Support for running Java chaincode in development mode
+ [#553](https://github.com/hyperledger-labs/fablo/pull/553)
 * Hardcode fablo config inside init generator
   [#554](https://github.com/hyperledger-labs/fablo/pull/554)
 * Publish sample chaincode Docker image
@@ -10,7 +10,6 @@
 * Export network topology with Mermaid 
   [#565](https://github.com/hyperledger-labs/fablo/pull/565)
 
-
 ## 2.2.0
 
 ### Features

Dockerfile

@@ -10,6 +10,7 @@ COPY package-lock.json /fablo/package-lock.json
 
 # copy files for init network
 COPY samples/chaincodes/chaincode-kv-node /fablo/generators/init/templates/chaincodes/chaincode-kv-node
+COPY samples/gateway/node /fablo/generators/init/templates/gateway/node
 
 WORKDIR /fablo
 RUN npm install --silent --only=prod

README.md

@@ -72,7 +72,7 @@ In this case, however, you should use generated `fablo-docker.sh` instead of `fa
 ### init
 
 ```bash
-fablo init [node] [rest] [dev]
+fablo init [node] [rest] [dev] [gateway]
 ```
 
 Creates simple network config file in current dir.
@@ -82,6 +82,7 @@ Fablo `init` command takes three parameters (the order does not matter):
 * Option `node` makes Fablo to generate a sample Node.js chaincode as well.
 * Option `rest` enables simple REST API with [Fablo REST](https://github.com/fablo-io/fablo-rest) as standalone Docker container.
 * Option `dev` enables running peers in dev mode (so the hot reload for chaincode is possible).
+* Option `gateway` makes Fablo generate a sample Node.js server that connects to the gateway.
 
 Sample command:
 
@@ -263,6 +264,8 @@ This feature allows hot reload of chaincode code and speeds up the development a
 Fablo will run peers in dev mode when `global.peerDevMode` is set to `true`.
 Note: in this case TLS has to be disabled, otherwise config validation fails.
 
+#### For Node.js Chaincode:
+
 The simplest way of trying Fablo with dev mode is as follows:
 
 1. Execute `fablo init node dev`.
@@ -277,7 +280,7 @@ The simplest way of trying Fablo with dev mode is as follows:
    ```
    Now, when you update the chaincode source code, it will be automatically refreshed on Hyperledger Fabric Network.
 
-Our sample chaincode definition contains some scripts for running chaincode in dev mode:
+The relevant scripts in `package.json` look like:
 
 ```json
   "scripts": {
@@ -287,13 +290,44 @@ Our sample chaincode definition contains some scripts for running chaincode in d
     ...
   },
 ```
-
-Worth considering:
+**Worth considering for Node.js chaincode:**
 * If you want chaincode to be running on multiple peers, you need to start it multiple times, specifying different `--peer.address`
 * In case of errors ensure you have the same `--chaincode-id-name` as `CC_PACKAGE_ID` in Fablo output.
 
 Feel free to update this scripts to adjust it to your chaincode definition.
 
+
+#### For Java Chaincode:
+
+To run Java chaincode in dev mode:
+
+1. Make sure your Fablo config has `global.peerDevMode` set to `true` and TLS disabled.
+
+2. Start the network with `fablo up`.
+
+3. Build and run the Java chaincode locally. As a sample you may use the chaincode from the Fablo source code from the `samples/chaincodes/java-chaincode` directory. Ensure a proper relative path is provided in Fablo config.
+   ```bash
+   cd samples/chaincodes/java-chaincode
+   ./run-dev.sh
+   ```
+
+   The `run-dev.sh` script will:
+   - Build the chaincode using Gradle's shadowJar task
+   - Automatically detect the peer's IP address from the Docker container
+   - Start the chaincode with debug logging enabled
+   - Connect to the peer at port 7051
+
+For local development and review:
+- The chaincode will run with the name `simple-asset:1.0`
+- Debug level logging is enabled via `CORE_CHAINCODE_LOGLEVEL=debug`
+- You can modify the Java code and rebuild/restart to see changes
+- The peer connection is automatically configured using the Docker container's IP
+
+**Worth considering for Java chaincode:**
+- If you want the chaincode running on multiple peers, start multiple instances with different `CORE_PEER_ADDRESS` values
+- Ensure `CORE_CHAINCODE_ID_NAME` matches the chaincode name and version in your Fablo config (for instance `chaincode1:0.0.1`)
+- The Java chaincode uses Gradle's ShadowJar plugin to package all dependencies into a single JAR file
+
 ## Channel scripts
 
 ### channel help

e2e-network/docker/test-05-v3.sh

@@ -61,6 +61,41 @@ waitForContainer "peer0.org1.example.com" "Membership view has changed. peers we
 waitForContainer "peer1.org1.example.com" "Learning about the configured anchor peers of Org1MSP for channel my-channel1"
 waitForContainer "peer1.org1.example.com" "Membership view has changed. peers went online:.*peer0.org1.example.com:7041"
 
+# Gateway client test
+GATEWAY_CLIENT_DIR="$FABLO_HOME/samples/gateway/node"
+GATEWAY_CLIENT_OUTPUT_FILE="$TEST_LOGS/gateway_client.log"
+echo "Testing Node.js Gateway client..."
+
+echo "Installing gateway client dependencies..."
+(cd "$GATEWAY_CLIENT_DIR" && npm install --silent --no-progress)
+
+echo "Running Node.js Gateway client and checking output..."
+(
+  cd "$GATEWAY_CLIENT_DIR" &&
+    export \
+      CHANNEL_NAME="my-channel1" \
+      CONTRACT_NAME="chaincode1" \
+      MSP_ID="Org1MSP" \
+      PEER_ORG_NAME="peer0.org1.example.com" \
+      PEER_GATEWAY_URL="localhost:7041" \
+      TLS_ROOT_CERT="$TEST_TMP/fablo-target/fabric-config/crypto-config/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/ca.crt" \
+      CREDENTIALS="$TEST_TMP/fablo-target/fabric-config/crypto-config/peerOrganizations/org1.example.com/users/User1@org1.example.com/msp/signcerts/User1@org1.example.com-cert.pem" \
+      PRIVATE_KEY_PEM="$TEST_TMP/fablo-target/fabric-config/crypto-config/peerOrganizations/org1.example.com/users/User1@org1.example.com/msp/keystore/priv-key.pem" &&
+  node server.js > "$GATEWAY_CLIENT_OUTPUT_FILE" 2>&1
+)
+GATEWAY_EXIT_CODE=$?
+
+if [ $GATEWAY_EXIT_CODE -ne 0 ]; then
+  echo "❌ failed: Node.js Gateway client script failed with exit code $GATEWAY_EXIT_CODE."
+  cat "$GATEWAY_CLIENT_OUTPUT_FILE"
+  exit 1
+fi
+
+expectCommand "cat \"$GATEWAY_CLIENT_OUTPUT_FILE\"" "\"success\":\"OK\""
+
+echo "🎉 Node.js Gateway client test complete 🎉"
+
+
 # Test simple chaincode
 expectInvoke "peer0.org1.example.com" "my-channel1" "chaincode1" \
   '{"Args":["KVContract:put", "name", "Willy Wonka"]}' \

e2e-network/docker/test-07-v2-peer-dev-mode.sh

@@ -0,0 +1,78 @@
+#!/usr/bin/env bash
+
+set -e
+
+TEST_TMP="$(rm -rf "$0.tmpdir" && mkdir -p "$0.tmpdir" && (cd "$0.tmpdir" && pwd))"
+TEST_LOGS="$(mkdir -p "$0.logs" && (cd "$0.logs" && pwd))"
+FABLO_HOME="$TEST_TMP/../../.."
+
+export FABLO_HOME
+
+CONFIG="$FABLO_HOME/samples/fablo-config-hlf2-1org-1chaincode-peer-dev-mode.json"
+NODECHAINCODE="$FABLO_HOME/samples/chaincodes/chaincode-kv-node"
+
+networkUp() {
+  "$FABLO_HOME/fablo-build.sh"
+  (cd "$TEST_TMP" && "$FABLO_HOME/fablo.sh" up "$CONFIG")
+}
+
+dumpLogs() {
+  echo "Saving logs of $1 to $TEST_LOGS/$1.log"
+  mkdir -p "$TEST_LOGS"
+  docker logs "$1" >"$TEST_LOGS/$1.log" 2>&1
+}
+
+networkDown() {
+  sleep 2
+  (for name in $(docker ps --format '{{.Names}}'); do dumpLogs "$name"; done)
+  (cd "$TEST_TMP" && "$FABLO_HOME/fablo.sh" down)
+}
+
+waitForContainer() {
+  sh "$TEST_TMP/../wait-for-container.sh" "$1" "$2"
+}
+
+waitForChaincode() {
+  (cd "$TEST_TMP" && sh ../wait-for-chaincode.sh "$1" "$2" "$3" "$4")
+}
+
+expectInvoke() {
+  (cd "$TEST_TMP" && sh ../expect-invoke-cli.sh "$1" "$2" "$3" "$4" "$5" "$6")
+}
+
+expectCommand() {
+  sh "$TEST_TMP/../expect-command.sh" "$1" "$2"
+}
+
+trap networkDown EXIT
+trap 'networkDown ; echo "Test failed" ; exit 1' ERR SIGINT
+
+# start the network
+networkUp
+
+# check if all nodes are ready
+waitForContainer "orderer0.group1.orderer.example.com" "Beginning to serve requests"
+waitForContainer "db.ca.org1.example.com" "database system is ready to accept connections"
+waitForContainer "ca.org1.example.com" "Listening on http://0.0.0.0:7054"
+waitForContainer "couchdb.peer0.org1.example.com" "Apache CouchDB has started. Time to relax."
+waitForContainer "peer0.org1.example.com" "Joining gossip network of channel my-channel1 with 1 organizations"
+waitForChaincode "peer0.org1.example.com" "my-channel1" "chaincode1" "0.0.1"
+
+echo "All nodes are ready"
+echo "Starting chaincode in development mode..."
+# make sure nodemon is installed and Install if not
+if ! command -v nodemon &> /dev/null; then
+  echo "nodemon could not be found, installing..."
+  npm install -g nodemon
+else
+  echo "nodemon is already installed"
+fi
+# start the chaincode in development mode
+(cd "$NODECHAINCODE" && npm i && npm run start:watch) &
+
+sleep 5
+
+# Test simple chaincode
+expectInvoke "peer0.org1.example.com" "my-channel1" "chaincode1" \
+  '{"Args":["KVContract:put", "name", "Willy Wonka"]}' \
+  '{\"success\":\"OK\"}'