Docker local-testnet scripts

scripts/docker-testnet/README.md

@@ -5,6 +5,10 @@ script is provided. This can be done, by invoking the script or building the ima
 
 ```
 ./build.sh  # (Optional) Can be ignored if you already have the images stored in the local registry.
-./start.sh  # Will start the local-testnet.
+./setup.sh  # Will setup the local-testnet.
 ./clean.sh  # Will stop and remove the containers related to the local-testnet.
+
+Optionally
+./stop.sh   # Will stop all the containers in the local-testnet.
+./start.sh  # Will start all stopped containers from the initial local-testnet.
 ```

scripts/docker-testnet/functions.sh

@@ -29,105 +29,139 @@ createDockerNetwork() {
 }
 
 startSeedNode() {
+  local publishPortArgs=""
+  if [[ "$DOCKER_PUBLISH_PORTS" -gt 0 ]]; then
+    publishPortArgs="-p $DOCKER_PUBLISH_PORT_RANGE:10000"
+    (( DOCKER_PUBLISH_PORT_RANGE++ ))
+  fi
+
   docker run -d --name seednode \
       -v ${TESTNETDIR}/seednode/config:/go/mx-chain-go/cmd/seednode/config \
       --network ${DOCKER_NETWORK_NAME} \
+      $publishPortArgs \
       seednode:dev \
       --rest-api-interface=0.0.0.0:10000
 }
 
 startObservers() {
- local observerIdx=0
- # Example for loop with injected variables in Bash
- for ((i = 0; i < SHARDCOUNT; i++)); do
-   for ((j = 0; j < SHARD_OBSERVERCOUNT; j++)); do
-     # Your commands or code to be executed in each iteration
+  local observerIdx=0
+  local publishPortArgs=""
+
+  # Example for loop with injected variables in Bash
+  for ((i = 0; i < SHARDCOUNT; i++)); do
+    for ((j = 0; j < SHARD_OBSERVERCOUNT; j++)); do
+      # Your commands or code to be executed in each iteration
+      KEY_INDEX=$((TOTAL_NODECOUNT - observerIdx - 1))
+
+      if [[ "$DOCKER_PUBLISH_PORTS" -gt 0 ]]; then
+        publishPortArgs="-p $DOCKER_PUBLISH_PORT_RANGE:10000"
+      fi
+
+      docker run -d --name "observer${observerIdx}-${NETWORK_ADDRESS}.${IP_HOST_BYTE}-10200-shard${i}" \
+          -v $TESTNETDIR/node/config:/go/mx-chain-go/cmd/node/config \
+          --network ${DOCKER_NETWORK_NAME} \
+          $publishPortArgs \
+          node:dev \
+          --destination-shard-as-observer $i \
+          --rest-api-interface=0.0.0.0:10200 \
+          --config ./config/config_observer.toml \
+          --sk-index=${KEY_INDEX} \
+          $EXTRA_OBSERVERS_FLAGS
+
+
+      (( IP_HOST_BYTE++ ))
+      (( DOCKER_PUBLISH_PORT_RANGE++ ))
+      ((observerIdx++)) || true
+    done
+  done
+
+  for ((i = 0; i < META_OBSERVERCOUNT; i++)); do
      KEY_INDEX=$((TOTAL_NODECOUNT - observerIdx - 1))
 
-     docker run -d --name "observer${observerIdx}-${NETWORK_ADDRESS}.${IP_HOST_BYTE}-10200-shard${i}" \
+     if [[ "$DOCKER_PUBLISH_PORTS" -gt 0 ]]; then
+       publishPortArgs="-p $DOCKER_PUBLISH_PORT_RANGE:10000"
+     fi
+
+     docker run -d --name "observer${observerIdx}-${NETWORK_ADDRESS}.${IP_HOST_BYTE}-10200-metachain" \
          -v $TESTNETDIR/node/config:/go/mx-chain-go/cmd/node/config \
          --network ${DOCKER_NETWORK_NAME} \
+         $publishPortArgs \
          node:dev \
-         --destination-shard-as-observer $i \
+         --destination-shard-as-observer "metachain" \
          --rest-api-interface=0.0.0.0:10200 \
          --config ./config/config_observer.toml \
          --sk-index=${KEY_INDEX} \
          $EXTRA_OBSERVERS_FLAGS
 
-
      (( IP_HOST_BYTE++ ))
+     (( DOCKER_PUBLISH_PORT_RANGE++ ))
      ((observerIdx++)) || true
-   done
- done
-
- for ((i = 0; i < META_OBSERVERCOUNT; i++)); do
-    KEY_INDEX=$((TOTAL_NODECOUNT - observerIdx - 1))
-
-    docker run -d --name "observer${observerIdx}-${NETWORK_ADDRESS}.${IP_HOST_BYTE}-10200-metachain" \
-        -v $TESTNETDIR/node/config:/go/mx-chain-go/cmd/node/config \
-        --network ${DOCKER_NETWORK_NAME} \
-        node:dev \
-        --destination-shard-as-observer "metachain" \
-        --rest-api-interface=0.0.0.0:10200 \
-        --config ./config/config_observer.toml \
-        --sk-index=${KEY_INDEX} \
-        $EXTRA_OBSERVERS_FLAGS
-
-    (( IP_HOST_BYTE++ ))
-    ((observerIdx++)) || true
- done
+  done
 }
 
 startValidators() {
- validatorIdx=0
- # Example for loop with injected variables in Bash
- for ((i = 0; i < SHARDCOUNT; i++)); do
-   for ((j = 0; j < SHARD_VALIDATORCOUNT; j++)); do
+  local validatorIdx=0
+  local publishPortArgs=""
+  # Example for loop with injected variables in Bash
+  for ((i = 0; i < SHARDCOUNT; i++)); do
+    for ((j = 0; j < SHARD_VALIDATORCOUNT; j++)); do
+
+      if [[ "$DOCKER_PUBLISH_PORTS" -gt 0 ]]; then
+        publishPortArgs="-p $DOCKER_PUBLISH_PORT_RANGE:10000"
+      fi
+
+      docker run -d --name "validator${validatorIdx}-${NETWORK_ADDRESS}.${IP_HOST_BYTE}-10200-shard${i}" \
+          -v $TESTNETDIR/node/config:/go/mx-chain-go/cmd/node/config \
+          --network ${DOCKER_NETWORK_NAME} \
+          $publishPortArgs \
+          node:dev \
+          --rest-api-interface=0.0.0.0:10200 \
+          --config ./config/config_validator.toml \
+          --sk-index=${validatorIdx} \
+
+      (( IP_HOST_BYTE++ ))
+      (( DOCKER_PUBLISH_PORT_RANGE++ ))
+      ((validatorIdx++)) || true
+    done
+  done
 
-     docker run -d --name "validator${validatorIdx}-${NETWORK_ADDRESS}.${IP_HOST_BYTE}-10200-shard${i}" \
-         -v $TESTNETDIR/node/config:/go/mx-chain-go/cmd/node/config \
-         --network ${DOCKER_NETWORK_NAME} \
-         node:dev \
-         --rest-api-interface=0.0.0.0:10200 \
-         --config ./config/config_validator.toml \
-         --sk-index=${validatorIdx} \
+  for ((i = 0; i < META_VALIDATORCOUNT; i++)); do
 
-     (( IP_HOST_BYTE++ ))
-     ((validatorIdx++)) || true
-   done
- done
+    if [[ "$DOCKER_PUBLISH_PORTS" -gt 0 ]]; then
+      publishPortArgs="-p $DOCKER_PUBLISH_PORT_RANGE:10000"
+    fi
 
-  for ((i = 0; i < META_VALIDATORCOUNT; i++)); do
-     docker run -d --name "validator${validatorIdx}-${NETWORK_ADDRESS}.${IP_HOST_BYTE}-10200-metachain" \
+    docker run -d --name "validator${validatorIdx}-${NETWORK_ADDRESS}.${IP_HOST_BYTE}-10200-metachain" \
          -v $TESTNETDIR/node/config:/go/mx-chain-go/cmd/node/config \
          --network ${DOCKER_NETWORK_NAME} \
+         $publishPortArgs \
          node:dev \
          --rest-api-interface=0.0.0.0:10200 \
          --config ./config/config_observer.toml \
          --sk-index=${validatorIdx} \
 
-     (( IP_HOST_BYTE++ ))
-     ((validatorIdx++)) || true
+    (( IP_HOST_BYTE++ ))
+    (( DOCKER_PUBLISH_PORT_RANGE++ ))
+    ((validatorIdx++)) || true
   done
 }
 
 updateProxyConfigDocker() {
-    pushd $TESTNETDIR/proxy/config
-    cp config.toml config_edit.toml
-
-    # Truncate config.toml before the [[Observers]] list
-    sed -i -n '/\[\[Observers\]\]/q;p' config_edit.toml
+  pushd $TESTNETDIR/proxy/config
+  cp config.toml config_edit.toml
 
-    if [ "$SHARD_OBSERVERCOUNT" -le 0 ]; then
-        generateProxyValidatorListDocker config_edit.toml
-    else
-        generateProxyObserverListDocker config_edit.toml
-    fi
+  # Truncate config.toml before the [[Observers]] list
+  sed -i -n '/\[\[Observers\]\]/q;p' config_edit.toml
 
-    mv config_edit.toml config.toml
+  if [ "$SHARD_OBSERVERCOUNT" -le 0 ]; then
+    generateProxyValidatorListDocker config_edit.toml
+  else
+    generateProxyObserverListDocker config_edit.toml
+  fi
 
-    echo "Updated configuration for the Proxy."
-    popd
+  mv config_edit.toml config.toml
+  echo "Updated configuration for the Proxy."
+  popd
 }
 
 generateProxyObserverListDocker() {

scripts/docker-testnet/setup.sh

@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+
+set -eux
+
+export DOCKERTESTNETDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+MULTIVERSXTESTNETSCRIPTSDIR="$(dirname "$DOCKERTESTNETDIR")/testnet"
+
+source "$DOCKERTESTNETDIR/variables.sh"
+source "$DOCKERTESTNETDIR/functions.sh"
+source "$MULTIVERSXTESTNETSCRIPTSDIR/include/config.sh"
+source "$MULTIVERSXTESTNETSCRIPTSDIR/include/build.sh"
+
+cloneRepositories
+
+prepareFolders
+
+buildConfigGenerator
+
+generateConfig
+
+copyConfig
+
+copySeednodeConfig
+updateSeednodeConfig
+
+copyNodeConfig
+updateNodeConfig
+
+createDockerNetwork
+
+startSeedNode
+startObservers
+startValidators
+
+if [ $USE_PROXY -eq 1 ]; then
+  buildProxyImage
+  prepareFolders_Proxy
+  copyProxyConfig
+  updateProxyConfigDocker
+  startProxyDocker
+fi
+

scripts/docker-testnet/start.sh

@@ -2,42 +2,17 @@
 
 set -eux
 
-export DOCKERTESTNETDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+file_path="./tmp/stopped_containers"
 
-MULTIVERSXTESTNETSCRIPTSDIR="$(dirname "$DOCKERTESTNETDIR")/testnet"
-
-source "$DOCKERTESTNETDIR/variables.sh"
-source "$DOCKERTESTNETDIR/functions.sh"
-source "$MULTIVERSXTESTNETSCRIPTSDIR/include/config.sh"
-source "$MULTIVERSXTESTNETSCRIPTSDIR/include/build.sh"
-
-cloneRepositories
-
-prepareFolders
-
-buildConfigGenerator
-
-generateConfig
-
-copyConfig
-
-copySeednodeConfig
-updateSeednodeConfig
-
-copyNodeConfig
-updateNodeConfig
-
-createDockerNetwork
-
-startSeedNode
-startObservers
-startValidators
-
-if [ $USE_PROXY -eq 1 ]; then
-  buildProxyImage
-  prepareFolders_Proxy
-  copyProxyConfig
-  updateProxyConfigDocker
-  startProxyDocker
+# Check if the file exists
+if [ ! -f "$file_path" ]; then
+    echo "File $file_path not found."
+    exit 1
 fi
 
+# Read the file line by line
+while IFS= read -r line; do
+    docker start $line
+done < "$file_path"
+
+rmdir ./tmp

scripts/docker-testnet/stop.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+set -eux
+
+# Delete the entire testnet folder, which includes configuration, executables and logs.
+
+export MULTIVERSXTESTNETSCRIPTSDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+source "$MULTIVERSXTESTNETSCRIPTSDIR/variables.sh"
+
+# Get the IDs of containers attached to the network
+export CONTAINER_IDS=$(docker network inspect -f '{{range $k, $v := .Containers}}{{printf "%s\n" $k}}{{end}}' "$DOCKER_NETWORK_NAME")
+
+mkdir -p ./tmp
+
+# Stop each container
+echo "Stopping containers..."
+for CONTAINER_ID in $CONTAINER_IDS; do
+    docker stop "$CONTAINER_ID"
+    echo "$CONTAINER_ID" >> ./tmp/stopped_containers
+done

scripts/docker-testnet/variables.sh

@@ -6,6 +6,14 @@
 # Don't change the subnet, unless you know what you are doing. Prone to errors.
 export DOCKER_NETWORK_SUBNET="172.18.0.0/24"
 export DOCKER_NETWORK_NAME="local-testnet"
+
+# By default ports won't be published. If set to 1, all containers will port-forward to host network.
+export DOCKER_PUBLISH_PORTS=1
+
+if [[ "$DOCKER_PUBLISH_PORTS" -gt 0 ]]; then
+  export DOCKER_PUBLISH_PORT_RANGE=30000
+fi
+
 ########################################################################