qa-rpc-integration-tests-remote.yml

name: QA - RPC Integration Tests Remote

on:
  workflow_dispatch:     # Run manually
  push:
    branches:
      - main
      - 'release/3.*'
  pull_request:
    branches:
      - main
      - 'release/3.*'
    types:
      - opened
      - reopened
      - synchronize
      - ready_for_review


jobs:
  mainnet-rpc-integ-tests-remote:
    concurrency:
      group: >-
        ${{
          (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/heads/release/')) && 
          format('{0}-{1}', github.workflow, github.run_id) ||
          format('{0}-{1}', github.workflow, github.ref)
        }}
      cancel-in-progress: true
    runs-on: [ self-hosted, qa, Ethereum, rpc-integration-commitment ]
    env:
      ERIGON_TESTBED_AREA: /opt/erigon-testbed
      ERIGON_QA_PATH: /home/qarunner/erigon-qa
      ERIGON_ASSERT: true
      RPC_PAST_TEST_DIR: /opt/rpc-past-tests/remote
      CHAIN: mainnet

    steps:
      - name: Check out repository
        uses: actions/checkout@v6

      - name: Set reference data dir based on branch
        run: |
          # For pull_request events base_ref is the target branch name; for push/dispatch parse from ref.
          BRANCH="${{ github.base_ref }}"
          if [ -z "$BRANCH" ]; then
            BRANCH="${{ github.ref }}"
            BRANCH="${BRANCH#refs/heads/}"
          fi
          if [[ "$BRANCH" == release/* ]]; then
            VERSION="${BRANCH#release/}"
            echo "ERIGON_REFERENCE_DATA_DIR=/opt/erigon-versions/reference-version-${VERSION}/datadir" >> $GITHUB_ENV
          else
            echo "ERIGON_REFERENCE_DATA_DIR=/opt/erigon-versions/reference-version/datadir" >> $GITHUB_ENV
          fi

      - name: Clean Erigon Build Directory
        run: |
          make clean

      - name: Build Erigon RPCDaemon and integration
        run: |
          make rpcdaemon erigon integration
        working-directory: ${{ github.workspace }}

      - name: Pause the Erigon instance dedicated to db maintenance
        run: |
          python3 $ERIGON_QA_PATH/test_system/db-producer/pause_production.py || true

      - name: Save Erigon Chaindata Directory
        id: save_chaindata_step
        run: |
          rm -rf $ERIGON_TESTBED_AREA/chaindata-prev || true
          echo "Backup chaindata"
          cp -r $ERIGON_REFERENCE_DATA_DIR/chaindata $ERIGON_TESTBED_AREA/chaindata-prev

      - name: Run Migrations
        working-directory: ${{ github.workspace }}/build/bin
        run: |
          echo "Running migrations on datadir..."
          ./integration run_migrations --datadir $ERIGON_REFERENCE_DATA_DIR --chain $CHAIN

      - name: Run Erigon
        working-directory: ${{ github.workspace }}/build/bin
        run: |
          echo "Starting Erigon..."
          
          ./erigon --datadir $ERIGON_REFERENCE_DATA_DIR --persist.receipts --prune.experimental.include-commitment-history --nodiscover --maxpeers 0 --no-downloader --prune.mode=archive --http=false > erigon.log 2>&1 &

          ERIGON_PID=$!          
          ERIGON_EXIT_STATUS=$?
          echo "ERIGON_PID=$ERIGON_PID" >> $GITHUB_ENV
          echo "erigon_started=true" >> $GITHUB_OUTPUT
          
          sleep 15
          tail erigon.log
          
          if [ $ERIGON_EXIT_STATUS -ne 0 ]; then            
            echo "Erigon failed to start"
            echo "::error::Error detected during tests: Erigon failed to start"
            exit 1
          fi
          echo "Erigon started"

      - name: Run RpcDaemon
        working-directory: ${{ github.workspace }}/build/bin
        run: |
          echo "Starting RpcDaemon..."
          
          ./rpcdaemon --http.api admin,debug,eth,parity,erigon,trace,web3,txpool,ots,net --ws > rpcdaemon.log 2>&1 &

          RPC_DAEMON_PID=$!          
          RPC_DAEMON_EXIT_STATUS=$?
          echo "RPC_DAEMON_PID=$RPC_DAEMON_PID" >> $GITHUB_ENV
          echo "rpc_daemon_started=true" >> $GITHUB_OUTPUT
          
          sleep 5
          tail rpcdaemon.log
          
          if [ $RPC_DAEMON_EXIT_STATUS -ne 0 ]; then            
            echo "RpcDaemon failed to start"
            echo "::error::Error detected during tests: RpcDaemon failed to start"
            exit 1
          fi
          echo "RpcDaemon started"

      - name: Wait for port 8545 to be opened
        run: |
          for i in {1..30}; do
            if nc -z localhost 8545; then
              echo "Port 8545 is open"
              break
            fi
            echo "Waiting for port 8545 to open..."
            sleep 10
          done
          if ! nc -z localhost 8545; then
            echo "Port 8545 did not open in time"
            echo "::error::Error detected during tests: Port 8545 did not open in time"
            exit 1
          fi

      - name: Run RPC Integration Tests
        id: test_step
        run: |
          mkdir -p $RPC_PAST_TEST_DIR
          commit=$(git -C ${{runner.workspace}}/erigon rev-parse --short HEAD)
          TEST_RESULT_DIR="$RPC_PAST_TEST_DIR/mainnet_$(date +%Y%m%d_%H%M%S)_integration_${commit}_http"
          echo "TEST_RESULT_DIR=$TEST_RESULT_DIR" >> $GITHUB_ENV

          chmod +x ${{ runner.workspace }}/erigon/.github/workflows/scripts/run_rpc_tests_remote_ethereum.sh
          
          set +e # Disable exit on error for test run
          ${{ runner.workspace }}/erigon/.github/workflows/scripts/run_rpc_tests_remote_ethereum.sh ${{ runner.workspace }} $TEST_RESULT_DIR
          test_exit_status=$? # Capture test runner script exit status
          set -e # Re-enable exit on error after test run

          echo "test_executed=true" >> $GITHUB_OUTPUT

          echo
          if [ $test_exit_status -eq 0 ]; then
            echo "RPC tests completed successfully"
            echo "TEST_RESULT=success" >> "$GITHUB_OUTPUT"
          else
            echo "::error::Error detected during RPC tests: some tests failed, check the logs or the artifacts for more details"
            echo "TEST_RESULT=failure" >> "$GITHUB_OUTPUT"
            exit 1
          fi

      - name: Generate Summary
        if: always() && steps.test_step.outputs.test_executed == 'true'
        run: |
          SUMMARY_FILE="${{ env.TEST_RESULT_DIR }}/summary.md"
          LOG_FILE="${{ env.TEST_RESULT_DIR }}/output.log"

          cat << 'EOF' > $SUMMARY_FILE
          # ${{ github.workflow }} Report

          ## Test Configuration
          - **Chain:** ${{ env.CHAIN }}
          - **Result:** ${{ steps.test_step.outputs.TEST_RESULT }}

          ## Test Output
          ```
          EOF

          cat $LOG_FILE >> $SUMMARY_FILE

          echo '```' >> $SUMMARY_FILE

          cat $SUMMARY_FILE
          cat $SUMMARY_FILE >> $GITHUB_STEP_SUMMARY

      - name: Stop Erigon & RpcDaemon
        if: always()
        working-directory: ${{ github.workspace }}/build/bin
        run: |
          # Clean up rpcdaemon process if it's still running
          if [ -n "$RPC_DAEMON_PID" ] && kill -0 $RPC_DAEMON_PID 2> /dev/null; then
            echo "RpcDaemon stopping..."
            kill $RPC_DAEMON_PID
            echo "RpcDaemon stopped"
          else
            echo "RpcDaemon has already terminated"
          fi
          if [ -n "$ERIGON_PID" ] && kill -0 $ERIGON_PID 2> /dev/null; then
            echo "Erigon stopping..."
            kill $ERIGON_PID
            echo "Erigon stopped"
          else
            echo "Erigon has already terminated"
          fi

      - name: Restore Erigon Chaindata Directory
        if: always()
        run: |
          if [ -d "$ERIGON_TESTBED_AREA/chaindata-prev" ] && [ "${{ steps.save_chaindata_step.outcome }}" == "success" ]; then
          rm -rf $ERIGON_REFERENCE_DATA_DIR/chaindata
          echo "Restore chaindata"
          mv $ERIGON_TESTBED_AREA/chaindata-prev $ERIGON_REFERENCE_DATA_DIR/chaindata
          fi

      - name: Resume the Erigon instance dedicated to db maintenance
        if: always()
        run: |
          python3 $ERIGON_QA_PATH/test_system/db-producer/resume_production.py || true

      - name: Upload test results
        if: always() && steps.test_step.outputs.test_executed == 'true'
        uses: actions/upload-artifact@v6
        with:
          name: test-results
          path: |
            ${{ env.TEST_RESULT_DIR }}
            ${{ github.workspace }}/build/bin/rpcdaemon.log 
            ${{ github.workspace }}/build/bin/erigon.log 

      - name: Save test results
        if: always() && steps.test_step.outputs.test_executed == 'true'
        working-directory: ${{ github.workspace }}
        env:
          TEST_RESULT: ${{ steps.test_step.outputs.TEST_RESULT }}
        run: |
          db_version=$(python3 $ERIGON_QA_PATH/test_system/qa-tests/uploads/prod_info.py $ERIGON_REFERENCE_DATA_DIR/../production.ini production erigon_repo_commit)
          if [ -z "$db_version" ]; then
            db_version="no-version"
          fi
          
          python3 $ERIGON_QA_PATH/test_system/qa-tests/uploads/upload_test_results.py --repo erigon --commit $(git rev-parse HEAD) --branch ${{ github.ref_name }} --test_name rpc-integration-tests-remote --chain $CHAIN --runner ${{ runner.name }} --db_version $db_version --outcome $TEST_RESULT #--result_file ${{ github.workspace }}/result-$CHAIN.json

      - name: Action to check failure condition
        if: failure()
        run: |
          if [ "${{ steps.test_step.outputs.test_executed }}" != "true" ]; then
            echo "::error::Test not executed, workflow failed for infrastructure reasons"
          fi
          exit 1

      - name: Action for Success
        if: steps.test_step.outputs.TEST_RESULT == 'success'
        run: echo "::notice::Tests completed successfully"