feat/tests

.github/workflows/testnet_tests.yml

@@ -0,0 +1,112 @@
+name: testnet tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  besu:
+      runs-on: ubuntu-24.04
+      strategy:
+        matrix:
+          cl_name:
+            - lighthouse
+            - lodestar
+            - nimbus-eth2
+            - prysm
+            - teku
+        fail-fast: false
+      steps:
+          - name: Checkout code
+            uses: actions/checkout@v4
+
+          - uses: ./node-test
+            with:
+              network: testnet
+              el_name: besu 
+              cl_name: ${{matrix.cl_name}}
+  # erigon:
+  #     runs-on: ubuntu-24.04
+  #     strategy:
+  #       matrix:
+  #         cl_name:
+  #           - lighthouse
+  #           - lodestar
+  #           - nimbus-eth2
+  #           - prysm
+  #           - teku
+  #       fail-fast: false
+  #     steps:
+  #         - name: Checkout code
+  #           uses: actions/checkout@v4
+
+  #         - uses: ./node-test
+  #           with:
+  #             network: testnet
+  #             el_name: erigon 
+  #             cl_name: ${{matrix.cl_name}}
+  # geth:
+  #     runs-on: ubuntu-24.04
+  #     strategy:
+  #       matrix:
+  #         cl_name:
+  #           - lighthouse
+  #           - lodestar
+  #           - nimbus-eth2
+  #           - prysm
+  #           - teku
+  #       fail-fast: false
+  #     steps:
+  #         - name: Checkout code
+  #           uses: actions/checkout@v4
+
+  #         - uses: ./node-test
+  #           with:
+  #             network: testnet
+  #             el_name: geth 
+  #             cl_name: ${{matrix.cl_name}}
+
+  # nethermind:
+  #     runs-on: ubuntu-24.04
+  #     strategy:
+  #       matrix:
+  #         cl_name:
+  #           - lighthouse
+  #           - lodestar
+  #           - nimbus-eth2
+  #           - prysm
+  #           - teku
+  #       fail-fast: false
+  #     steps:
+  #         - name: Checkout code
+  #           uses: actions/checkout@v4
+
+  #         - uses: ./node-test
+  #           with:
+  #             network: testnet
+  #             el_name: nethermind 
+  #             cl_name: ${{matrix.cl_name}}
+  # reth:
+  #     runs-on: ubuntu-24.04
+  #     strategy:
+  #       matrix:
+  #         cl_name:
+  #           - lighthouse
+  #           - lodestar
+  #           - nimbus-eth2
+  #           - prysm
+  #           - teku
+  #       fail-fast: false
+  #     steps:
+  #         - name: Checkout code
+  #           uses: actions/checkout@v4
+
+  #         - uses: ./node-test
+  #           with:
+  #             networK: testnet
+  #             el_name: reth 
+  #             cl_name: ${{matrix.cl_name}}

README.md

@@ -1,5 +1,12 @@
 # run-a-node
 
+[![mainnet](https://github.com/eth-pkg/run-a-node/actions/workflows/mainnet_tests.yml/badge.svg)](https://github.com/eth-pkg/run-a-node/actions/workflows/mainnet_tests.yml)
+[![holesky](https://github.com/eth-pkg/run-a-node/actions/workflows/holesky_tests.yml/badge.svg)](https://github.com/eth-pkg/run-a-node/actions/workflows/holesky_tests.yml)
+[![sepolia](https://github.com/eth-pkg/run-a-node/actions/workflows/sepolia_tests.yml/badge.svg)](https://github.com/eth-pkg/run-a-node/actions/workflows/sepolia_tests.yml)
+
+[![testnet](https://github.com/eth-pkg/run-a-node/actions/workflows/testnet_tests.yml/badge.svg)](https://github.com/eth-pkg/run-a-node/actions/workflows/testnet_tests.yml)
+[![ephemery](https://github.com/eth-pkg/run-a-node/actions/workflows/ephemery_tests.yml/badge.svg)](https://github.com/eth-pkg/run-a-node/actions/workflows/ephemery_tests.yml)
+
 This repository features two main components: the `run-a-node` top-level node running script and the `run-a-client` standardized script. The `run-a-client` script is designed to run each client uniformly, respecting each client's unique options while providing a minimal abstraction layer. This allows users to easily run clients without delving into detailed configurations until they are ready to modify specific config values.
 
 Options are moved into configuration files, which are provided through CLI variables, ensuring a consistent format for each client. However, specific client configuration files can still be used if needed.
@@ -10,6 +17,7 @@ This repository was created as a result of the `eth-nodes` Debian packaging proj
 
 **NOTE:** This repository is under active development. The code can change drastically, and bugs should be expected.
 
+
 ## Running a Client Pair
 
 Open two terminals and execute the following commands:
@@ -39,3 +47,23 @@ The available options for both `run-a-client` and `run-a-node` scripts are:
 - `<network>`: ephemery, holesky, mainnet, sepolia, testnet
 - `<consensus_client>`: lighthouse, lodestar, nimbus-eth2, prsym, teku
 - `<execution_client>`: besu, erigon, geth, nethermind, reth
+
+
+## Running tests 
+
+
+```bash
+bats --show-output-of-passing-tests tests/test_<network>.bats
+```
+
+If you want to filter by client or client pair, (timeout is based on how slow or fast your internet download speed)
+
+```bash
+timeout 11m bats --show-output-of-passing-tests tests/test_<network>.bats --filter <client>
+```
+
+or by client pair 
+
+```bash
+timeout 25m bats --show-output-of-passing-tests tests/test_<network>.bats --filter <execution_client>-<consensus_client>
+```

clients/besu/24.5.1/run-besu.sh

@@ -2,7 +2,6 @@
 
 set -e 
 
-
 display_help() {
     echo "Usage: $0 [OPTIONS]"
     echo ""
@@ -248,4 +247,4 @@ append_option "--bonsai-limit-trie-logs-enabled" "$BESU_CLI_BONSAI_LIMIT_TRIE_LO
 
 echo "Running: besu $OPTIONS"
 
-besu $OPTIONS
+exec besu $OPTIONS

clients/erigon/2.60.0/run-erigon.sh

@@ -292,4 +292,4 @@ add_option "--config" "$ERIGON_CLI_CONFIG"
 
 echo "Using Options: erigon $OPTIONS"
 
-erigon $OPTIONS
+exec erigon $OPTIONS

clients/geth/1.14.3/run-geth.sh

@@ -269,4 +269,4 @@ fi
 
 echo "Using Options: geth $OPTIONS"
 
-geth $OPTIONS
+exec geth $OPTIONS

clients/lighthouse/5.1.3/run-lighthouse.sh

@@ -238,4 +238,4 @@ append_option "--wss-checkpoint" "$LIGHTHOUSE_CLI_BN_WSS_CHECKPOINT"
 
 
 echo "Starting lighthouse beacon_node $OPTIONS"
-lighthouse beacon_node $OPTIONS
+exec lighthouse beacon_node $OPTIONS

clients/lighthouse/5.1.3/run-validator.sh

@@ -1,4 +1,6 @@
-set -e 
+#!/usr/bin/env bash 
+
+set -e
 
 display_help() {
     echo "Usage: $0 [OPTIONS]"
@@ -147,4 +149,4 @@ append_option "--web3-signer-max-idle-connections" "$LIGHTHOUSE_CLI_VALIDATOR_WE
 
 echo "Using Options: $OPTIONS"
 
-lighthouse validator_client $OPTIONS
+exec lighthouse validator_client $OPTIONS

clients/lodestar/1.18.1/run-lodestar.sh

@@ -158,4 +158,6 @@ append_option "--network.connectToDiscv5Bootnodes" "$LODESTAR_CLI_NETWORK_CONNEC
 append_option "--genesisStateFile" "$LODESTAR_CLI_BN_GENSIS_STATE_FILE"
 
 echo "Starting lodestar beacon $OPTIONS"
-lodestar beacon $OPTIONS
+
+# on ci the postrm fails, so it not in path
+exec /usr/lib/eth-node-lodestar/bin/lodestar beacon $OPTIONS

clients/lodestar/1.18.1/run-validator.sh

@@ -132,4 +132,4 @@ append_flag "--distributed" "$LODESTAR_CLI_VALIDATOR_DISTRIBUTED"
 
 echo "Using Options: $OPTIONS"
 
-docker run chainsafe/lodestar validator $OPTIONS
+exec docker run chainsafe/lodestar validator $OPTIONS

clients/nethermind/1.26.0/run-nethermind.sh

@@ -563,4 +563,5 @@ append_option "--Wallet.DevAccounts" "$NETHERMIND_CLI_WALLET_DEV_ACCOUNTS"
 
 echo "Using Options: nethermind $OPTIONS"
 
-nethermind $OPTIONS
+# CI problem again, with cache
+exec /usr/lib/eth-node-nethermind/bin/Nethermind.Runner/release/nethermind $OPTIONS

clients/nimbus-eth2/24.5.1/run-nimbus-eth2.sh

@@ -1,12 +1,12 @@
-#!/usr/bin/env bash 
+#!/usr/bin/env bash
 
-set -e 
+set -e
 
 display_help() {
     echo "Usage: $0 [OPTIONS]"
     echo ""
     echo "Options:"
-    echo "  --conf-file FILE, -e FILE   Path to .conf formatted configuration file."   
+    echo "  --conf-file FILE, -e FILE   Path to .conf formatted configuration file."
     echo "  --help, -h                    Displays this help text and exits."
     echo "  --version, -v                 Displays the version and exits."
     exit 0
@@ -24,22 +24,22 @@ VERSION=false
 
 while [[ "$#" -gt 0 ]]; do
     case $1 in
-        --conf-file|-e)
-            CONFIG_FILES+=("$2")
-            shift 2
-            ;;
-        --help|-h)
-            HELP=true
-            shift
-            ;;
-        --version|-v)
-            VERSION=true
-            shift
-            ;;  
-        *)
-            echo "Error: Unknown option $1"
-            display_help
-            ;;
+    --conf-file | -e)
+        CONFIG_FILES+=("$2")
+        shift 2
+        ;;
+    --help | -h)
+        HELP=true
+        shift
+        ;;
+    --version | -v)
+        VERSION=true
+        shift
+        ;;
+    *)
+        echo "Error: Unknown option $1"
+        display_help
+        ;;
     esac
 done
 
@@ -69,15 +69,15 @@ done
 OPTIONS=""
 
 add_option() {
-  local option=$1
-  local value=$2
-  if [ -n "$value" ]; then
-    if [ "$value" == "" ];then 
-        OPTIONS="$OPTIONS $option"
-    else 
-        OPTIONS="$OPTIONS $option=$value"
-    fi 
-  fi
+    local option=$1
+    local value=$2
+    if [ -n "$value" ]; then
+        if [ "$value" == "" ]; then
+            OPTIONS="$OPTIONS $option"
+        else
+            OPTIONS="$OPTIONS $option=$value"
+        fi
+    fi
 }
 
 add_option "--config-file" "$NIMBUS_ETH2_CONFIG_FILE"
@@ -159,8 +159,22 @@ add_option "--payload-builder-url" "$NIMBUS_ETH2_PAYLOAD_BUILDER_URL"
 add_option "--local-block-value-boost" "$NIMBUS_ETH2_LOCAL_BLOCK_VALUE_BOOST"
 add_option "--history" "$NIMBUS_ETH2_HISTORY"
 
-echo "Using Options: $OPTIONS"
 
-echo "Using Options: nimbus-eth2 $OPTIONS"
+echo "Using Options: nimbus_beacon_node $OPTIONS"
+
+# hack to download state before starting client
+if [ -n "$NIMBUS_ETH2_FINALIZED_CHECKPOINT_STATE" ]; then
+    echo "Downloading checkpoint state for nimbus-eth2"
+    echo "curl -o $NIMBUS_ETH2_FINALIZED_CHECKPOINT_STATE \
+            -H 'Accept: application/octet-stream' \
+            $BASE_CONFIG_CL_CHECKPPOINT_SYNC_URLr/eth/v2/debug/beacon/states/finalized"
+    if [ "$NIMBUS_ETH2_FINALIZED_CHECKPOINT_STATE" != "" ]; then
+        curl -o $NIMBUS_ETH2_FINALIZED_CHECKPOINT_STATE \
+            -H 'Accept: application/octet-stream' \
+            $BASE_CONFIG_CL_CHECKPPOINT_SYNC_URL/eth/v2/debug/beacon/states/finalized
+
+    fi
+fi
 
-nimbus_beacon_node $OPTIONS
+# on ci the postrm fails, so it not in path
+exec /usr/lib/eth-node-nimbus-eth2/bin/nimbus_beacon_node $OPTIONS

clients/nimbus-eth2/24.5.1/run-validator.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash 
+
 set -e 
 
 display_help() {
@@ -84,4 +86,5 @@ append_flag(){
 
 echo "Using Options: $OPTIONS"
 
-/usr/lib/eth-node-nimbus-eth2/bin/validator $OPTIONS
+# TODO 
+exec /usr/lib/eth-node-nimbus-eth2/bin/validator $OPTIONS

clients/prysm/5.0.3/run-prysm.sh

@@ -120,7 +120,6 @@ append_flag "--slasher" "$PRSYM_CLI_SLASHER"
 append_flag "--interop-eth1data-votes" "$PRSYM_CLI_INTEROP_ETH1DATA_VOTES"
 append_flag "--force-clear-db" "$PRSYM_CLI_FORCE_CLEAR_DB"
 
-
 append_option "--api-timeout" "$PRSYM_CLI_API_TIMEOUT"
 append_option "--bootstrap-node" "$PRSYM_CLI_BOOTSTRAP_NODE"
 append_option "--chain-config-file" "$PRSYM_CLI_CHAIN_CONFIG_FILE"
@@ -218,4 +217,5 @@ append_option "--interop-num-validators" "$PRSYM_CLI_INTEROP_NUM_VALIDATORS"
 
 echo "Using Options: beacon-chain $OPTIONS"
 
-beacon-chain $OPTIONS
+# on ci the postrm fails, so it not in path
+exec /usr/lib/eth-node-prysm/bin/beacon-chain $OPTIONS

clients/prysm/5.0.3/run-validator.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash 
+
 set -e 
 
 display_help() {
@@ -167,4 +169,5 @@ append_option "--interop-start-index" "$PRYSM_CLI_VALIDATOR_INTEROP_START_INDEX"
 
 echo "Using Options: $OPTIONS"
 
-/usr/lib/eth-node-prysm/bin/validator $OPTIONS
+# TODO 
+exec /usr/lib/eth-node-prysm/bin/validator $OPTIONS

clients/reth/1.0.0/run-reth.sh

@@ -201,4 +201,4 @@ append_flag "--quiet" "$RETH_CLI_NODE_QUIET"
 
 echo "Starting node with options: reth node $OPTIONS"
 
-reth node $OPTIONS
+exec reth node $OPTIONS