Merge pull request #2476 from input-output-hk/dlachaume/2471/add-cardano-node-startup-check-step

Test: add Cardano node startup check to `Mithril Client multi-platform test` workflow

Author: dlachaume

.github/workflows/scripts/verify-cardano-db-restoration.sh

@@ -0,0 +1,74 @@
+#!/bin/bash
+
+set -e
+
+if [[ $# -lt 1 ]]; then
+  echo "Usage: $0 <file containing 'mithril-client' CLI download output> [--include-ancillary]"
+  echo "The first argument must be the file path containing the raw output (stdout) of the mithril-client CLI download command."
+  echo "The second optional argument must be '--include-ancillary' if ancillary files are included."
+  exit 1
+fi
+
+if [[ ! -f "$1" ]]; then
+  echo "Error: File '$1' not found."
+  exit 1
+fi
+
+CLIENT_CMD_OUTPUT=$(cat "$1")
+INCLUDE_ANCILLARY="$2"
+
+DOCKER_CMD=$(echo "$CLIENT_CMD_OUTPUT" | grep -E '^\s*docker run')
+if [[ -z "$DOCKER_CMD" ]]; then
+  echo "No Docker command found in mithril-client CLI command output."
+  exit 1
+fi
+
+echo "Extracted Docker command:"
+echo "$DOCKER_CMD"
+
+DOCKER_CMD_DETACHED="${DOCKER_CMD/docker run/docker run -d}"
+echo "Running Docker command in detached mode:"
+echo "$DOCKER_CMD_DETACHED"
+
+CONTAINER_ID=$(eval "$DOCKER_CMD_DETACHED")
+
+wait_for_log() {
+  local CONTAINER_ID="$1"
+  local TIMEOUT="$2"
+  local LOG_MESSAGE="$3"
+
+  echo "Waiting up to $TIMEOUT seconds for '$LOG_MESSAGE'..."
+  for ((i=1; i<=TIMEOUT; i++)); do
+    if docker logs "$CONTAINER_ID" 2>&1 | grep -q "$LOG_MESSAGE"; then
+      echo "Found '$LOG_MESSAGE' in logs."
+      return 0
+    fi
+    sleep 1
+  done
+
+  echo "'$LOG_MESSAGE' not found within $TIMEOUT seconds."
+  docker logs "$CONTAINER_ID"
+  return 1
+}
+
+if wait_for_log "$CONTAINER_ID" 15 "Started opening Immutable DB"; then
+  echo "✅ The Cardano node started successfully from the Mithril snapshot."
+else
+  echo "❌ Failed to start the Cardano node from the Mithril snapshot."
+  exit 1
+fi
+
+if [[ "$INCLUDE_ANCILLARY" == "--include-ancillary" ]]; then
+  echo "Parameter '--include-ancillary' is set."
+  if wait_for_log "$CONTAINER_ID" 30 "Chain extended, new tip"; then
+    echo "✅ The Cardano node started successfully from the Mithril snapshot with the ancillary files."
+    exit 0
+  else
+    echo "❌ Failed to start the Cardano node from the Mithril snapshot with the ancillary files."
+    exit 1
+  fi
+else
+  echo "Parameter '--include-ancillary' is not set."
+  echo "Skipping additional check for 'Chain extended, new tip' in logs."
+  exit 0
+fi

.github/workflows/test-client.yml

@@ -40,11 +40,6 @@ on:
         required: false
         type: string
         default: https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/ancillary.vkey
-      include_ancillary:
-        description: Include ancillary files in the download.
-        required: true
-        type: boolean
-        default: true
       enable_debug:
         description: Enable debug output ("-vvv") for the mithril-client calls
         required: true
@@ -72,9 +67,6 @@ on:
       ancillary_verification_key:
         type: string
         default: https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/ancillary.vkey
-      include_ancillary:
-        type: boolean
-        default: true
       enable_debug:
         type: boolean
         default: false
@@ -85,6 +77,8 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-24.04, macos-14, windows-latest]
+        extra_args: ["", "--include-ancillary"]
+
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout sources
@@ -110,9 +104,6 @@ jobs:
           echo "TRANSACTIONS_HASHES_TO_CERTIFY=${{ inputs.transactions_hashes_to_certify }}" >> $GITHUB_ENV
 
           echo "ANCILLARY_VERIFICATION_KEY=$(curl -s ${{ inputs.ancillary_verification_key }})" >> $GITHUB_ENV
-          if [[ "${{ inputs.include_ancillary }}" == "true" ]]; then
-            echo "INCLUDE_ANCILLARY=--include-ancillary" >> $GITHUB_OUTPUT
-          fi
 
       - name: Assessing aggregator capabilities (Unix)
         id: aggregator_capability_unix
@@ -169,7 +160,12 @@ jobs:
       - name: Cardano Database Snapshot / download & restore latest
         shell: bash
         working-directory: ./bin
-        run: ./mithril-client ${{ steps.prepare.outputs.debug_level }} --origin-tag CI cardano-db download $CDB_SNAPSHOT_DIGEST $INCLUDE_ANCILLARY
+        run: ./mithril-client ${{ steps.prepare.outputs.debug_level }} --origin-tag CI cardano-db download $CDB_SNAPSHOT_DIGEST ${{ matrix.extra_args }} > cdb-download-output.txt 2>&1
+
+      - name: Cardano Database Snapshot / verify Cardano node starts successfully
+        if: runner.os == 'Linux'
+        shell: bash
+        run: .github/workflows/scripts/verify-cardano-db-restoration.sh ./bin/cdb-download-output.txt "${{ matrix.extra_args }}"
 
       - name: Mithril Stake Distribution / list and get last hash
         shell: bash
@@ -243,13 +239,19 @@ jobs:
         if: steps.aggregator_capability_unix.outputs.cardano_database_v2_enabled == 'true' || steps.aggregator_capability_windows.outputs.cardano_database_v2_enabled == 'true'
         shell: bash
         working-directory: ./bin
-        run: ./mithril-client ${{ steps.prepare.outputs.debug_level }} --unstable --origin-tag CI cardano-db-v2 download $CARDANO_DATABASE_V2_SNAPSHOT_HASH $INCLUDE_ANCILLARY
+        run: ./mithril-client ${{ steps.prepare.outputs.debug_level }} --unstable --origin-tag CI cardano-db-v2 download $CARDANO_DATABASE_V2_SNAPSHOT_HASH ${{ matrix.extra_args }} > cdb-v2-download-output.txt 2>&1
+
+      - name: Cardano Database V2 Snapshot / verify Cardano node starts successfully
+        if: runner.os == 'Linux' && steps.aggregator_capability_unix.outputs.cardano_database_v2_enabled == 'true'
+        shell: bash
+        run: .github/workflows/scripts/verify-cardano-db-restoration.sh ./bin/cdb-v2-download-output.txt "${{ matrix.extra_args }}"
 
   test-docker:
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-24.04]
+        extra_args: ["", "--include-ancillary"]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Prepare environment variables
@@ -267,9 +269,6 @@ jobs:
           echo "TRANSACTIONS_HASHES_TO_CERTIFY=${{ inputs.transactions_hashes_to_certify }}" >> $GITHUB_ENV
 
           echo "ANCILLARY_VERIFICATION_KEY=$(curl -s ${{ inputs.ancillary_verification_key }})" >> $GITHUB_ENV
-          if [[ "${{ inputs.include_ancillary }}" == "true" ]]; then
-            echo "INCLUDE_ANCILLARY=--include-ancillary" >> $GITHUB_OUTPUT
-          fi
 
       - name: Assessing aggregator capabilities
         id: aggregator_capability
@@ -286,7 +285,7 @@ jobs:
         id: command
         shell: bash
         run: |
-          echo "mithril_client=docker run --rm -e NETWORK=$NETWORK -e GENESIS_VERIFICATION_KEY=$GENESIS_VERIFICATION_KEY -e AGGREGATOR_ENDPOINT=$AGGREGATOR_ENDPOINT --name='mithril-client' ghcr.io/input-output-hk/mithril-client:$MITHRIL_IMAGE_ID"  >> $GITHUB_OUTPUT
+          echo "mithril_client=docker run --rm -e NETWORK=$NETWORK -e GENESIS_VERIFICATION_KEY=$GENESIS_VERIFICATION_KEY -e ANCILLARY_VERIFICATION_KEY=$ANCILLARY_VERIFICATION_KEY -e AGGREGATOR_ENDPOINT=$AGGREGATOR_ENDPOINT --name='mithril-client' ghcr.io/input-output-hk/mithril-client:$MITHRIL_IMAGE_ID"  >> $GITHUB_OUTPUT
 
       - name: Show client version
         shell: bash
@@ -300,7 +299,7 @@ jobs:
 
       - name: Cardano Database Snapshot / download & restore latest
         shell: bash
-        run: ${{ steps.command.outputs.mithril_client }} ${{ steps.prepare.outputs.debug_level }} --origin-tag CI cardano-db download $CDB_SNAPSHOT_DIGEST --download-dir /app $INCLUDE_ANCILLARY
+        run: ${{ steps.command.outputs.mithril_client }} ${{ steps.prepare.outputs.debug_level }} --origin-tag CI cardano-db download $CDB_SNAPSHOT_DIGEST --download-dir /app ${{ matrix.extra_args }}
 
       - name: Mithril Stake Distribution / list and get last hash
         shell: bash
@@ -363,7 +362,7 @@ jobs:
       - name: Cardano Database V2 Snapshot / download & restore latest (Full restoration)
         if: steps.aggregator_capability.outputs.cardano_database_v2_enabled == 'true'
         shell: bash
-        run: ${{ steps.command.outputs.mithril_client }} ${{ steps.prepare.outputs.debug_level }} --origin-tag CI --unstable cardano-db-v2 download $CARDANO_DATABASE_V2_SNAPSHOT_HASH --download-dir /app $INCLUDE_ANCILLARY
+        run: ${{ steps.command.outputs.mithril_client }} ${{ steps.prepare.outputs.debug_level }} --origin-tag CI --unstable cardano-db-v2 download $CARDANO_DATABASE_V2_SNAPSHOT_HASH --download-dir /app ${{ matrix.extra_args }}
 
   test-mithril-client-wasm:
     strategy: