Initial commit

Author: rhyslbw

README.md

@@ -0,0 +1,10 @@
+# `cardano-node-ogmios` Docker Sync GitHub Action
+Use this action to sync an instance of `cardano-node-ogmios` into a cache to 
+enable integration testing within a GitHub Workflow. As demonstrated in the 
+[Ogmios repository](), the [network synchronization workflow]() synchronizes a testnet instance 
+every six hours, which is then pushed to a cache used in the [continuous integration workflow]().
+
+
+['Ogmios repository']: https://github.com/CardanoSolutions/ogmios
+[network synchronization workflow]: https://github.com/CardanoSolutions/ogmios/blob/master/.github/workflows/network-synchronization.yaml
+[continuous integration workflow]: https://github.com/CardanoSolutions/ogmios/blob/master/.github/workflows/continuous-integration.yaml

action.yml

@@ -0,0 +1,51 @@
+name: cardano-node-ogmios-docker-sync
+description: Synchronize cardano-node-ogmios using Docker
+inputs:
+  container-name:
+    description: Docker container name
+    required: false
+    default: cardano-node-ogmios
+  db-dir:
+    description: Path to the host db mount
+    required: true
+  network:
+    description: Cardano network
+    required: true
+  ogmios-port:
+    description: Mapped host Ogmios port
+    required: false
+    default: '1337'
+  repository:
+    description: Docker repository
+    required: false
+    default: cardanosolutions/cardano-node-ogmios
+  version:
+    description: Ogmios version
+    required: false
+    default: latest
+runs:
+  using: composite
+  steps:
+    - name: 🔵 Set Docker Image
+      id: docker-image
+      shell: bash
+      run: |
+        echo "::set-output name=value::${{ inputs.repository }}:${{ inputs.version }}-${{ inputs.network }}"
+
+    - name: 📥 Pull Image
+      run: |
+        docker pull ${{ steps.docker-image.outputs.value }}
+      shell: bash
+
+    - name: ⟲ Sync
+      run: |
+        docker run -d --name ${{ inputs.container-name }} -p ${{ inputs.ogmios-port }}:1337 -v ${{ inputs.db-dir }}:/db ${{ steps.docker-image.outputs.value }}
+        ./scripts/wait-for-sync.sh ${{ inputs.ogmios-port }} 1
+      shell: bash
+
+    - name: 🧹 Cleanup
+      run: |
+        docker stop ${{ inputs.container-name }}
+        docker rm ${{ inputs.container-name }}
+        docker rmi ${{ steps.docker-image.outputs.value }}
+      shell: bash

scripts/wait-for-sync.sh

@@ -0,0 +1,77 @@
+#!/usr/bin/env bash
+
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+# wait-for-sync.sh
+#
+#   Wait for an ogmios / cardano-node to be synchronized with the network, up to a given threshold.
+#
+# Usage: ./wait-for-sync.sh OGMIOS_PORT THRESHOLD
+#
+# Examples:
+#   ./wait-for-sync.sh 1337 1
+#   ./wait-for-sync.sh 1338 0.95
+
+
+set -eo pipefail
+
+exitWithUsage () {
+  echo -e "Error: missing argument(s)!\n"
+  echo -e "Usage: $0 OGMIOS_PORT THRESHOLD"
+  echo -e "    Wait until a running Ogmios server at OGMIOS_PORT reaches THRESHOLD network synchronization.\n"
+  echo -e "Example: \n    $0 1338 0.95"
+  exit 1
+}
+
+OGMIOS_PORT=$1
+if [ -z "$OGMIOS_PORT" ]; then
+  exitWithUsage
+fi
+
+THRESHOLD=$2
+if [ -z "$THRESHOLD" ]; then
+  exitWithUsage
+fi
+
+URL=http://localhost:$OGMIOS_PORT/health
+
+showProgress () {
+  N="$1"
+  PER=$(printf "%.3f\n" "$(bc <<< "$N * 100")")
+  LEN=$(printf "%.0f\n" "$(bc <<< "$N * 50")")
+
+  BAR=""
+  for ((i=1; i<=$LEN; i++))
+  do
+    BAR="$BAR▣"
+  done
+  for ((i=$LEN; i<=50; i++))
+  do
+    BAR="$BAR "
+  done
+
+  echo -en "Network synchronization: [$BAR] $PER%\r"
+}
+
+for (( ;; ))
+do
+  HEALTH=$(curl -sS $URL)
+  NETWORK_SYNCHRONIZATION=$(sed 's/.*"networkSynchronization":\([0-9]\+\.\?[0-9]*\).*/\1/' <<< $HEALTH)
+
+  RE='^[0-9]+\.?[0-9]*$'
+  if ! [[ $NETWORK_SYNCHRONIZATION =~ $RE ]] ; then
+     echo "error: unexpected response from /health endpoint: $HEALTH"
+     exit 1
+  fi
+
+  showProgress $NETWORK_SYNCHRONIZATION
+  PREDICATE=$(bc <<< "$NETWORK_SYNCHRONIZATION >= $THRESHOLD")
+
+  if [ "$PREDICATE" -eq 1 ]; then
+    exit 0
+  else
+    sleep 5
+  fi
+done