Bridge zombienet tests refactoring (paritytech#3260)

Related to paritytech#3242

Reorganizing the bridge zombienet tests in order to:
- separate the environment spawning from the actual tests
- offer better control over the tests and some possibility to
orchestrate them as opposed to running everything from the zndsl file

Only rewrote the asset transfer test using this new "framework". The old
logic and old tests weren't functionally modified or deleted. The plan
is to get feedback on this approach first and if this is agreed upon,
migrate the other 2 tests later in separate PRs and also do other
improvements later.

bridges/zombienet/README.md

@@ -23,7 +23,7 @@ To start those tests, you need to:
 
 - copy fresh `substrate-relay` binary, built in previous point, to the `~/local_bridge_testing/bin/substrate-relay`;
 
-- change the `POLKADOT_SDK_FOLDER` and `ZOMBIENET_BINARY_PATH` (and ensure that the nearby variables
+- change the `POLKADOT_SDK_PATH` and `ZOMBIENET_BINARY_PATH` (and ensure that the nearby variables
 have correct values) in the `./run-tests.sh`.
 
 After that, you could run tests with the `./run-tests.sh` command. Hopefully, it'll show the

bridges/zombienet/environments/rococo-westend/helper.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+$POLKADOT_SDK_PATH/cumulus/scripts/bridges_rococo_westend.sh "$@"

bridges/zombienet/environments/rococo-westend/rococo-init.zndsl

@@ -0,0 +1,8 @@
+Description: User is able to transfer WND from Westend Asset Hub to Rococo Asset Hub and back
+Network: ../../../../cumulus/zombienet/bridge-hubs/bridge_hub_rococo_local_network.toml
+Creds: config
+
+# ensure that initialization has completed
+asset-hub-rococo-collator1: js-script ../../helpers/wait-hrmp-channel-opened.js with "1013" within 300 seconds
+
+

bridges/zombienet/environments/rococo-westend/rococo.zndsl

@@ -0,0 +1,7 @@
+Description: User is able to transfer WND from Westend Asset Hub to Rococo Asset Hub and back
+Network: ../../../../cumulus/zombienet/bridge-hubs/bridge_hub_rococo_local_network.toml
+Creds: config
+
+# relay is already started - let's wait until with-Westend GRANPDA pallet is initialized at Rococo
+bridge-hub-rococo-collator1: js-script ../../helpers/best-finalized-header-at-bridged-chain.js with "Westend,0" within 400 seconds
+

bridges/zombienet/environments/rococo-westend/spawn.sh

@@ -0,0 +1,71 @@
+#!/bin/bash
+
+set -e
+
+trap "trap - SIGTERM && kill -9 -$$" SIGINT SIGTERM EXIT
+
+source "${BASH_SOURCE%/*}/../../utils/common.sh"
+source "${BASH_SOURCE%/*}/../../utils/zombienet.sh"
+
+# whether to init the chains (open HRMP channels, set XCM version, create reserve assets, etc)
+init=0
+while [ $# -ne 0 ]
+do
+    arg="$1"
+    case "$arg" in
+        --init)
+            init=1
+            ;;
+    esac
+    shift
+done
+
+logs_dir=$TEST_DIR/logs
+helper_script="${BASH_SOURCE%/*}/helper.sh"
+
+rococo_def=$POLKADOT_SDK_PATH/cumulus/zombienet/bridge-hubs/bridge_hub_rococo_local_network.toml
+start_zombienet $TEST_DIR $rococo_def rococo_dir rococo_pid
+echo
+
+westend_def=$POLKADOT_SDK_PATH/cumulus/zombienet/bridge-hubs/bridge_hub_westend_local_network.toml
+start_zombienet $TEST_DIR $westend_def westend_dir westend_pid
+echo
+
+if [[ $init -eq 1 ]]; then
+  rococo_init_log=$logs_dir/rococo-init.log
+  echo -e "Setting up the rococo side of the bridge. Logs available at: $rococo_init_log\n"
+
+  westend_init_log=$logs_dir/westend-init.log
+  echo -e "Setting up the westend side of the bridge. Logs available at: $westend_init_log\n"
+
+  $helper_script init-asset-hub-rococo-local >> $rococo_init_log 2>&1 &
+  rococo_init_pid=$!
+  $helper_script init-asset-hub-westend-local >> $westend_init_log 2>&1 &
+  westend_init_pid=$!
+  wait -n $rococo_init_pid $westend_init_pid
+
+
+  $helper_script init-bridge-hub-rococo-local >> $rococo_init_log 2>&1 &
+  rococo_init_pid=$!
+  $helper_script init-bridge-hub-westend-local >> $westend_init_log 2>&1 &
+  westend_init_pid=$!
+  wait -n $rococo_init_pid $westend_init_pid
+
+  run_zndsl ${BASH_SOURCE%/*}/rococo-init.zndsl $rococo_dir
+  run_zndsl ${BASH_SOURCE%/*}/westend-init.zndsl $westend_dir
+fi
+
+relay_log=$logs_dir/relay.log
+echo -e "Starting rococo-westend relay. Logs available at: $relay_log\n"
+start_background_process "$helper_script run-relay" $relay_log relay_pid
+
+run_zndsl ${BASH_SOURCE%/*}/rococo.zndsl $rococo_dir
+echo $rococo_dir > $TEST_DIR/rococo.env
+echo
+
+run_zndsl ${BASH_SOURCE%/*}/westend.zndsl $westend_dir
+echo $westend_dir > $TEST_DIR/westend.env
+echo
+
+wait -n $rococo_pid $westend_pid $relay_pid
+kill -9 -$$

bridges/zombienet/environments/rococo-westend/westend-init.zndsl

@@ -0,0 +1,7 @@
+Description: User is able to transfer ROC from Rococo Asset Hub to Westend Asset Hub and back
+Network: ../../../../cumulus/zombienet/bridge-hubs/bridge_hub_westend_local_network.toml
+Creds: config
+
+# ensure that initialization has completed
+asset-hub-westend-collator1: js-script ../../helpers/wait-hrmp-channel-opened.js with "1002" within 600 seconds
+

bridges/zombienet/environments/rococo-westend/westend.zndsl

@@ -0,0 +1,6 @@
+Description: User is able to transfer ROC from Rococo Asset Hub to Westend Asset Hub and back
+Network: ../../../../cumulus/zombienet/bridge-hubs/bridge_hub_westend_local_network.toml
+Creds: config
+
+# relay is already started - let's wait until with-Rococo GRANPDA pallet is initialized at Westend
+bridge-hub-westend-collator1: js-script ../../helpers/best-finalized-header-at-bridged-chain.js with "Rococo,0" within 400 seconds

bridges/zombienet/helpers/best-finalized-header-at-bridged-chain.js

@@ -18,7 +18,7 @@ async function run(nodeName, networkInfo, args) {
         }
 
         // else sleep and retry
-        await new Promise((resolve) => setTimeout(resolve, 12000));
+        await new Promise((resolve) => setTimeout(resolve, 6000));
     }
 }
 

bridges/zombienet/helpers/native-assets-balance-increased.js

@@ -13,7 +13,7 @@ async function run(nodeName, networkInfo, args) {
         }
 
         // else sleep and retry
-        await new Promise((resolve) => setTimeout(resolve, 12000));
+        await new Promise((resolve) => setTimeout(resolve, 6000));
     }
 }
 

bridges/zombienet/helpers/relayer-rewards.js

@@ -21,7 +21,7 @@ async function run(nodeName, networkInfo, args) {
         }
 
         // else sleep and retry
-        await new Promise((resolve) => setTimeout(resolve, 12000));
+        await new Promise((resolve) => setTimeout(resolve, 6000));
     }
 }
 

bridges/zombienet/helpers/wait-hrmp-channel-opened.js

@@ -15,7 +15,7 @@ async function run(nodeName, networkInfo, args) {
         }
 
         // else sleep and retry
-        await new Promise((resolve) => setTimeout(resolve, 12000));
+        await new Promise((resolve) => setTimeout(resolve, 6000));
     }
 }
 

bridges/zombienet/helpers/wrapped-assets-balance.js

@@ -19,7 +19,7 @@ async function run(nodeName, networkInfo, args) {
         }
 
         // else sleep and retry
-        await new Promise((resolve) => setTimeout(resolve, 12000));
+        await new Promise((resolve) => setTimeout(resolve, 6000));
     }
 }
 

bridges/zombienet/run-new-test.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+
+set -e
+
+test=$1
+shift
+
+# whether to use paths for zombienet+bridges tests container or for local testing
+ZOMBIENET_DOCKER_PATHS=0
+while [ $# -ne 0 ]
+do
+    arg="$1"
+    case "$arg" in
+        --docker)
+            ZOMBIENET_DOCKER_PATHS=1
+            ;;
+    esac
+    shift
+done
+
+export POLKADOT_SDK_PATH=`realpath ${BASH_SOURCE%/*}/../..`
+
+# set path to binaries
+if [ "$ZOMBIENET_DOCKER_PATHS" -eq 1 ]; then
+    # otherwise zombienet uses some hardcoded paths
+    unset RUN_IN_CONTAINER
+    unset ZOMBIENET_IMAGE
+
+    export POLKADOT_BINARY=/usr/local/bin/polkadot
+    export POLKADOT_PARACHAIN_BINARY=/usr/local/bin/polkadot-parachain
+
+    export ZOMBIENET_BINARY=/usr/local/bin/zombie
+    export SUBSTRATE_RELAY_BINARY=/usr/local/bin/substrate-relay
+else
+    export POLKADOT_BINARY=$POLKADOT_SDK_PATH/target/release/polkadot
+    export POLKADOT_PARACHAIN_BINARY=$POLKADOT_SDK_PATH/target/release/polkadot-parachain
+
+    export ZOMBIENET_BINARY=~/local_bridge_testing/bin/zombienet-linux-x64
+    export SUBSTRATE_RELAY_BINARY=~/local_bridge_testing/bin/substrate-relay
+fi
+
+export TEST_DIR=`mktemp -d /tmp/bridges-tests-run-XXXXX`
+echo -e "Test folder: $TEST_DIR\n"
+
+${BASH_SOURCE%/*}/tests/$test/run.sh
+
+kill -9 -$$ || echo "Environment already teared down"

bridges/zombienet/run-tests.sh

@@ -27,34 +27,27 @@ done
 
 # assuming that we'll be using native provide && all processes will be executing locally
 # (we need absolute paths here, because they're used when scripts are called by zombienet from tmp folders)
-export POLKADOT_SDK_FOLDER=`realpath $(dirname "$0")/../..`
-export BRIDGE_TESTS_FOLDER=$POLKADOT_SDK_FOLDER/bridges/zombienet/tests
+export POLKADOT_SDK_PATH=`realpath $(dirname "$0")/../..`
+export BRIDGE_TESTS_FOLDER=$POLKADOT_SDK_PATH/bridges/zombienet/tests
 
 # set pathc to binaries
 if [ "$ZOMBIENET_DOCKER_PATHS" -eq 1 ]; then
-    export POLKADOT_BINARY_PATH=/usr/local/bin/polkadot
-    export POLKADOT_PARACHAIN_BINARY_PATH=/usr/local/bin/polkadot-parachain
-    export POLKADOT_PARACHAIN_BINARY_PATH_FOR_ASSET_HUB_ROCOCO=/usr/local/bin/polkadot-parachain
-    export POLKADOT_PARACHAIN_BINARY_PATH_FOR_ASSET_HUB_WESTEND=/usr/local/bin/polkadot-parachain
+    export POLKADOT_BINARY=/usr/local/bin/polkadot
+    export POLKADOT_PARACHAIN_BINARY=/usr/local/bin/polkadot-parachain
 
-    export SUBSTRATE_RELAY_PATH=/usr/local/bin/substrate-relay
+    export SUBSTRATE_RELAY_BINARY=/usr/local/bin/substrate-relay
     export ZOMBIENET_BINARY_PATH=/usr/local/bin/zombie
 else
-    export POLKADOT_BINARY_PATH=$POLKADOT_SDK_FOLDER/target/release/polkadot
-    export POLKADOT_PARACHAIN_BINARY_PATH=$POLKADOT_SDK_FOLDER/target/release/polkadot-parachain
-    export POLKADOT_PARACHAIN_BINARY_PATH_FOR_ASSET_HUB_ROCOCO=$POLKADOT_PARACHAIN_BINARY_PATH
-    export POLKADOT_PARACHAIN_BINARY_PATH_FOR_ASSET_HUB_WESTEND=$POLKADOT_PARACHAIN_BINARY_PATH
+    export POLKADOT_BINARY=$POLKADOT_SDK_PATH/target/release/polkadot
+    export POLKADOT_PARACHAIN_BINARY=$POLKADOT_SDK_PATH/target/release/polkadot-parachain
 
-    export SUBSTRATE_RELAY_PATH=~/local_bridge_testing/bin/substrate-relay
+    export SUBSTRATE_RELAY_BINARY=~/local_bridge_testing/bin/substrate-relay
     export ZOMBIENET_BINARY_PATH=~/local_bridge_testing/bin/zombienet-linux
 fi
 
 # check if `wait` supports -p flag
 if [ `printf "$BASH_VERSION\n5.1" | sort -V | head -n 1` = "5.1" ]; then IS_BASH_5_1=1; else IS_BASH_5_1=0; fi
 
-# check if `wait` supports -p flag
-if [ `printf "$BASH_VERSION\n5.1" | sort -V | head -n 1` = "5.1" ]; then IS_BASH_5_1=1; else IS_BASH_5_1=0; fi
-
 # bridge configuration
 export LANE_ID="00000002"
 

bridges/zombienet/scripts/invoke-script.sh

@@ -2,6 +2,6 @@
 
 INVOKE_LOG=`mktemp -p $TEST_FOLDER invoke.XXXXX`
 
-pushd $POLKADOT_SDK_FOLDER/cumulus/scripts
+pushd $POLKADOT_SDK_PATH/cumulus/scripts
 ./bridges_rococo_westend.sh $1 >$INVOKE_LOG 2>&1
 popd

bridges/zombienet/scripts/start-relayer.sh

@@ -2,6 +2,6 @@
 
 RELAY_LOG=`mktemp -p $TEST_FOLDER relay.XXXXX`
 
-pushd $POLKADOT_SDK_FOLDER/cumulus/scripts
+pushd $POLKADOT_SDK_PATH/cumulus/scripts
 ./bridges_rococo_westend.sh run-relay >$RELAY_LOG 2>&1&
 popd

bridges/zombienet/tests/0001-asset-transfer/roc-reaches-westend.zndsl

@@ -0,0 +1,12 @@
+Description: User is able to transfer ROC from Rococo Asset Hub to Westend Asset Hub and back
+Network: ../../../../cumulus/zombienet/bridge-hubs/bridge_hub_westend_local_network.toml
+Creds: config
+
+# send ROC to //Alice from Rococo AH to Westend AH
+asset-hub-westend-collator1: run ../../environments/rococo-westend/helper.sh with "reserve-transfer-assets-from-asset-hub-rococo-local" within 120 seconds
+
+# check that //Alice received the ROC on Westend AH
+asset-hub-westend-collator1: js-script ../../helpers/wrapped-assets-balance.js with "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY,0,Rococo" within 300 seconds
+
+# check that the relayer //Charlie is rewarded by Westend AH
+bridge-hub-westend-collator1: js-script ../../helpers/relayer-rewards.js with "5FLSigC9HGRKVhB9FiEo4Y3koPsNmBmLJbpXg2mp1hXcS59Y,0x00000002,0x6268726F,ThisChain,0" within 30 seconds

bridges/zombienet/tests/0001-asset-transfer/run.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+set -e
+
+source "${BASH_SOURCE%/*}/../../utils/common.sh"
+source "${BASH_SOURCE%/*}/../../utils/zombienet.sh"
+
+${BASH_SOURCE%/*}/../../environments/rococo-westend/spawn.sh --init &
+env_pid=$!
+
+ensure_process_file $env_pid $TEST_DIR/rococo.env 400
+rococo_dir=`cat $TEST_DIR/rococo.env`
+echo
+
+ensure_process_file $env_pid $TEST_DIR/westend.env 180
+westend_dir=`cat $TEST_DIR/westend.env`
+echo
+
+run_zndsl ${BASH_SOURCE%/*}/roc-reaches-westend.zndsl $westend_dir
+run_zndsl ${BASH_SOURCE%/*}/wnd-reaches-rococo.zndsl $rococo_dir
+
+run_zndsl ${BASH_SOURCE%/*}/wroc-reaches-rococo.zndsl $rococo_dir
+run_zndsl ${BASH_SOURCE%/*}/wwnd-reaches-westend.zndsl $westend_dir

bridges/zombienet/tests/0001-asset-transfer/wnd-reaches-rococo.zndsl

@@ -0,0 +1,12 @@
+Description: User is able to transfer WND from Westend Asset Hub to Rococo Asset Hub and back
+Network: ../../../../cumulus/zombienet/bridge-hubs/bridge_hub_rococo_local_network.toml
+Creds: config
+
+# send WND to //Alice from Westend AH to Rococo AH
+asset-hub-rococo-collator1: run ../../environments/rococo-westend/helper.sh with "reserve-transfer-assets-from-asset-hub-westend-local" within 120 seconds
+
+# check that //Alice received the WND on Rococo AH
+asset-hub-rococo-collator1: js-script ../../helpers/wrapped-assets-balance.js with "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY,0,Westend" within 300 seconds
+
+# check that the relayer //Charlie is rewarded by Rococo AH
+bridge-hub-rococo-collator1: js-script ../../helpers/relayer-rewards.js with "5FLSigC9HGRKVhB9FiEo4Y3koPsNmBmLJbpXg2mp1hXcS59Y,0x00000002,0x62687764,ThisChain,0" within 30 seconds

bridges/zombienet/tests/0001-asset-transfer/wroc-reaches-rococo.zndsl

@@ -0,0 +1,10 @@
+Description: User is able to transfer ROC from Rococo Asset Hub to Westend Asset Hub and back
+Network: ../../../../cumulus/zombienet/bridge-hubs/bridge_hub_westend_local_network.toml
+Creds: config
+
+# send wROC back to Alice from Westend AH to Rococo AH
+asset-hub-rococo-collator1: run ../../environments/rococo-westend/helper.sh with "withdraw-reserve-assets-from-asset-hub-westend-local" within 120 seconds
+
+# check that //Alice received the wROC on Rococo AH
+# (we wait until //Alice account increases here - there are no other transactions that may increase it)
+asset-hub-rococo-collator1: js-script ../../helpers/native-assets-balance-increased.js with "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY" within 300 seconds

bridges/zombienet/tests/0001-asset-transfer/wwnd-reaches-westend.zndsl

@@ -0,0 +1,10 @@
+Description: User is able to transfer ROC from Rococo Asset Hub to Westend Asset Hub and back
+Network: ../../../../cumulus/zombienet/bridge-hubs/bridge_hub_westend_local_network.toml
+Creds: config
+
+# send wWND back to Alice from Rococo AH to Westend AH
+asset-hub-westend-collator1: run ../../environments/rococo-westend/helper.sh with "withdraw-reserve-assets-from-asset-hub-rococo-local" within 120 seconds
+
+# check that //Alice received the wWND on Westend AH
+# (we wait until //Alice account increases here - there are no other transactions that may increase it)
+asset-hub-westend-collator1: js-script ../../helpers/native-assets-balance-increased.js with "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY" within 300 seconds

bridges/zombienet/utils/common.sh

@@ -0,0 +1,45 @@
+#!/bin/bash
+
+function start_background_process() {
+    local command=$1
+    local log_file=$2
+    local __pid=$3
+
+    $command > $log_file 2>&1 &
+    eval $__pid="'$!'"
+}
+
+function wait_for_process_file() {
+    local pid=$1
+    local file=$2
+    local timeout=$3
+    local __found=$4
+
+    local time=0
+    until [ -e $file ]; do
+      if ! kill -0 $pid; then
+        echo "Process finished unsuccessfully"
+        return
+      fi
+      if (( time++ >= timeout )); then
+        echo "Timeout waiting for file $file: $timeout seconds"
+        eval $__found=0
+        return
+      fi
+      sleep 1
+    done
+
+    echo "File $file found after $time seconds"
+    eval $__found=1
+}
+
+function ensure_process_file() {
+    local pid=$1
+    local file=$2
+    local timeout=$3
+
+    wait_for_process_file $pid $file $timeout file_found
+    if [ "$file_found" != "1" ]; then
+      exit 1
+    fi
+}