ci: Add ibc-rs/Hermes integration test

.github/workflows/test.yml

@@ -26,3 +26,23 @@ jobs:
         with:
           command: test
           args: --all-features
+
+  # TODO: Remove the IBC_COMMITISH env var once the phase 4 work has been merged
+  # to master in ibc-rs.
+  ibc-integration:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Build Docker image
+        run: |
+          docker build \
+            -f ci/Dockerfile \
+            -t informaldev/basecoin-rs-ci \
+            ./ci
+      - name: Run test
+        run: |
+          docker run --rm \
+            --env IBC_COMMITISH=basecoin/phase-4-1 \
+            -v `pwd`:/src/basecoin-rs \
+            informaldev/basecoin-rs-ci
+

ci/Dockerfile

@@ -0,0 +1,45 @@
+ARG TENDERMINT_VERSION=0.34.11
+ARG GAIA_VERSION=5.0.5
+ARG RUST_VERSION=1.57
+
+FROM tendermint/tendermint:v${TENDERMINT_VERSION} AS tendermint
+FROM cephalopodequipment/gaiad:${GAIA_VERSION} AS gaia
+FROM rust:${RUST_VERSION}-slim-bullseye
+
+COPY --from=tendermint /usr/bin/tendermint /usr/bin/tendermint
+COPY --from=gaia /usr/bin/gaiad /usr/bin/gaiad
+
+ENV IBC_SRC=/src/ibc-rs
+ENV BASECOIN_SRC=/src/basecoin-rs
+ENV LOG_DIR=/var/log/basecoin-rs
+ENV IBC_COMMITISH=master
+
+COPY entrypoint.sh /usr/bin/entrypoint.sh
+COPY tendermint-config/ /basecoin/.tendermint/config
+COPY hermes-config.toml /basecoin/.hermes/config.toml
+COPY one-chain /basecoin/one-chain
+COPY tests/ /basecoin/tests
+
+RUN apt update && \
+    apt upgrade -y && \
+    apt install -y curl pkg-config libssl-dev git && \
+    useradd -U -s /bin/bash -d /basecoin basecoin && \
+    mkdir -p "${IBC_SRC}" && \
+    mkdir -p "${BASECOIN_SRC}" && \
+    mkdir -p "${LOG_DIR}" && \
+    mkdir -p /basecoin && \
+    mkdir -p /basecoin/.tendermint/config && \
+    mkdir -p /basecoin/.hermes && \
+    chown -R basecoin:basecoin "${IBC_SRC}" && \
+    chown -R basecoin:basecoin "${LOG_DIR}" && \
+    chown -R basecoin:basecoin "${BASECOIN_SRC}" && \
+    chown -R basecoin:basecoin /basecoin
+
+VOLUME "${IBC_SRC}"
+VOLUME "${BASECOIN_SRC}"
+
+WORKDIR /basecoin
+USER basecoin:basecoin
+
+ENTRYPOINT ["/usr/bin/entrypoint.sh"]
+CMD []

ci/README.md

@@ -0,0 +1,84 @@
+# CI-related scripts
+
+This folder contains scripts and configuration relating to integration testing
+for basecoin-rs (which could also be modified to act as an integration test for
+ibc-rs).
+
+## Docker image
+
+[`Dockerfile`](./Dockerfile) contains the primary script for building a Docker
+image to test basecoin-rs.
+
+### Building
+
+From the root of this repository:
+
+```bash
+docker build -f ci/Dockerfile -t informaldev/basecoin-rs-ci ./ci
+```
+
+### Running
+
+Running the image with appropriate parameters will allow you to test a build of
+basecoin-rs with a particular build of ibc-rs (specifically the relayer,
+Hermes). At present, by default, this executes the
+[`create-connection`](./tests/create-connection.sh) script as a test if no `CMD`
+is supplied to the image when running it.
+
+From the root of this repository:
+
+```bash
+# Build basecoin-rs (located at `pwd`) and a local version of ibc-rs located at
+# `/path/to/local/ibc-rs`.
+docker run --rm -it \
+    -v `pwd`:/src/basecoin-rs \
+    -v /path/to/local/ibc-rs/:/src/ibc-rs \
+    informaldev/basecoin-rs-ci
+
+# If no local ibc-rs source volume is mounted, the image will automatically pull
+# the latest ibc-rs code on master from the ibc-rs repository on GitHub.
+docker run --rm -it \
+    -v `pwd`:/src/basecoin-rs \
+    informaldev/basecoin-rs-ci
+
+# Specify the branch/tag/commit at which to clone the ibc-rs repository from
+# which to build Hermes. In this case, we use branch "basecoin/phase-4-1":
+docker run --rm -it \
+    -v `pwd`:/src/basecoin-rs \
+    -e IBC_COMMITISH=basecoin/phase-4-1 \
+    informaldev/basecoin-rs-ci
+
+# If you don't want to execute the tests, and rather want a BASH prompt from
+# which you can manually interact with the various running binaries.
+docker run --rm -it \
+    -v `pwd`:/src/basecoin-rs \
+    informaldev/basecoin-rs-ci \
+    /bin/bash
+
+```
+
+### What does this image do?
+
+For even more detail, see [`entrypoint.sh`](./entrypoint.sh). In sequence, a
+container run from this image will:
+
+1. Clone the [ibc-rs repository][ibc-rs-repo] if no ibc-rs sources have been
+   mounted into the container.
+2. Build the Hermes binary from the ibc-rs sources in the container.
+3. Build the basecoin-rs binary from the basecoin-rs source volume mounted into
+   the container.
+4. Set up a single [Gaia] instance to act as a foreign chain for interacting
+   with basecoin-rs. The ID of this chain will be `ibc-0`.
+5. Configure Hermes.
+6. Start a [Tendermint] node and the basecoin-rs binary (the Tendermint node
+   will automatically connect to the basecoin-rs binary, providing a chain with
+   ID `basecoin-0`).
+7. If no `CMD` arguments are provided for the container, it will automatically
+   execute the [`create-connection.sh`](./tests/create-connection.sh) script,
+   which creates and updates an IBC channel between `basecoin-0` and `ibc-0`. If
+   `CMD` arguments are provided for the container, that test will not be
+   executed and the relevant `CMD` arguments will be executed instead.
+
+[ibc-rs-repo]: https://github.com/informalsystems/ibc-rs
+[Gaia]: https://github.com/cosmos/gaia
+[Tendermint]: https://github.com/tendermint/tendermint

ci/entrypoint.sh

@@ -0,0 +1,94 @@
+#!/bin/bash
+set -euo pipefail
+
+IBC_SRC=${IBC_SRC:-/src/ibc-rs}
+BASECOIN_SRC=${BASECOIN_SRC:-/src/basecoin-rs}
+BUILD_ROOT="${HOME}/build"
+IBC_BUILD="${BUILD_ROOT}/ibc-rs"
+BASECOIN_BUILD="${BUILD_ROOT}/basecoin-rs"
+BASECOIN_BIN="${BASECOIN_BUILD}/debug/tendermint-basecoin"
+HERMES_BIN="${IBC_BUILD}/release/hermes"
+IBC_REPO=https://github.com/informalsystems/ibc-rs.git
+IBC_COMMITISH=${IBC_COMMITISH:-master}
+CHAIN_DATA="${HOME}/data"
+HERMES_CONFIG="${HOME}/.hermes/config.toml"
+LOG_DIR=${LOG_DIR:-/var/log/basecoin-rs}
+TESTS_DIR=${TESTS_DIR:-${HOME}/tests}
+DEFAULT_TEST=${DEFAULT_TEST:-${TESTS_DIR}/create-connection.sh}
+
+if [ ! -f "${BASECOIN_SRC}/Cargo.toml" ]; then
+  echo "basecoin-rs sources must be mounted into ${BASECOIN_SRC} for this script to work properly."
+  exit 1
+fi
+
+if [ ! -f "${IBC_SRC}/Cargo.toml" ]; then
+  echo "No ibc-rs sources detected. Cloning repo at ${IBC_COMMITISH}..."
+  git clone "${IBC_REPO}" "${IBC_SRC}"
+  echo "Checking out ${IBC_COMMITISH}..."
+  cd "${IBC_SRC}"
+  git checkout "${IBC_COMMITISH}"
+  git status
+  echo ""
+fi
+
+cd "${IBC_SRC}"
+echo "Building Hermes..."
+cargo build --release --bin hermes --target-dir "${IBC_BUILD}/"
+
+cd "${BASECOIN_SRC}"
+echo ""
+echo "Building basecoin-rs..."
+cargo build --target-dir "${BASECOIN_BUILD}"
+
+echo ""
+echo "Setting up chain ibc-0..."
+mkdir -p "${CHAIN_DATA}"
+"${HOME}/one-chain" gaiad ibc-0 "${CHAIN_DATA}" 26657 26656 6060 9090 100000000000
+
+echo ""
+echo "Configuring Hermes..."
+"${HERMES_BIN}" -c "${HERMES_CONFIG}" \
+    keys add ibc-0 \
+    -f "${CHAIN_DATA}/ibc-0/user_seed.json"
+
+echo "Generating user key..."
+gaiad keys add user --keyring-backend="test" --output json > "${HOME}/user_seed.json"
+echo "Adding user key to basecoin-0 chain..."
+"${HERMES_BIN}" -c "${HERMES_CONFIG}" keys add basecoin-0 -f "${HOME}/user_seed.json"
+
+echo ""
+echo "Starting Tendermint..."
+tendermint unsafe-reset-all
+tendermint node > "${LOG_DIR}/tendermint.log" 2>&1 &
+
+echo "Starting basecoin-rs..."
+cd "${BASECOIN_SRC}"
+"${BASECOIN_BIN}" -p 26358 -v > "${LOG_DIR}/basecoin.log" 2>&1 &
+
+echo "Waiting for Tendermint node to be available..."
+set +e
+for retry in {1..4}; do
+  sleep 5
+  curl "http://127.0.0.1:26357/abci_info"
+  CURL_STATUS=$?
+  if [ ${CURL_STATUS} -eq 0 ]; then
+    break
+  else
+    echo "curl exit code status ${CURL_STATUS} (attempt ${retry})"
+  fi
+done
+set -e
+# Will fail if we still can't reach the Tendermint node
+curl "http://127.0.0.1:26357/abci_info" > /dev/null 2>&1
+
+if [ ! -z "$@" ]; then
+  cd "${HOME}"
+  exec "$@"
+else
+  echo ""
+  echo "No parameters supplied. Executing default test: ${DEFAULT_TEST}"
+  "${DEFAULT_TEST}"
+  echo ""
+  echo "Success!"
+fi
+

ci/hermes-config.toml

@@ -0,0 +1,93 @@
+[global]
+log_level = 'trace'
+
+[[chains]]
+id = 'ibc-0'
+rpc_addr = 'http://127.0.0.1:26657'
+grpc_addr = 'http://127.0.0.1:9090'
+websocket_addr = 'ws://localhost:26657/websocket'
+rpc_timeout = '10s'
+account_prefix = 'cosmos'
+key_name = 'testkey'
+store_prefix = 'ibc'
+gas_price = { price = 0.001, denom = 'stake' }
+clock_drift = '5s'
+trusting_period = '14days'
+
+[chains.trust_threshold]
+numerator = '1'
+denominator = '3'
+
+[[chains]]
+id = 'basecoin-0'
+rpc_addr = 'http://127.0.0.1:26357'
+grpc_addr = 'http://127.0.0.1:9093'
+websocket_addr = 'ws://localhost:26357/websocket'
+rpc_timeout = '10s'
+account_prefix = 'cosmos'
+key_name = 'testkey'
+store_prefix = 'ibc'
+gas_price = { price = 0.001, denom = 'stake' }
+clock_drift = '5s'
+trusting_period = '14days'
+proof_specs = '''
+[
+  {
+    "leaf_spec": {
+      "hash": 1,
+      "prehash_key": 0,
+      "prehash_value": 0,
+      "length": 0,
+      "prefix": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+    },
+    "inner_spec": {
+      "child_order": [
+        0,
+        1,
+        2
+      ],
+      "child_size": 32,
+      "min_prefix_length": 0,
+      "max_prefix_length": 64,
+      "empty_child": [
+        0,
+        32
+      ],
+      "hash": 1
+    },
+    "max_depth": 0,
+    "min_depth": 0
+  },
+  {
+    "leaf_spec": {
+      "hash": 1,
+      "prehash_key": 0,
+      "prehash_value": 0,
+      "length": 0,
+      "prefix": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+    },
+    "inner_spec": {
+      "child_order": [
+        0,
+        1,
+        2
+      ],
+      "child_size": 32,
+      "min_prefix_length": 0,
+      "max_prefix_length": 64,
+      "empty_child": [
+        0,
+        32
+      ],
+      "hash": 1
+    },
+    "max_depth": 0,
+    "min_depth": 0
+  }
+]
+'''
+
+[chains.trust_threshold]
+numerator = '1'
+denominator = '3'
+