Support configuration file for e2e tests

e2e/Makefile

@@ -7,10 +7,13 @@ cleanup-ibc-test-containers:
 		$(DOCKER) rm $$id ; \
 	done
 
-e2e-test: cleanup-ibc-test-containers
+init:
+	./scripts/init.sh
+
+e2e-test: init cleanup-ibc-test-containers
 	./scripts/run-e2e.sh $(test) $(entrypoint)
 
 compatibility-tests:
 	./scripts/run-compatibility-tests.sh $(release_branch)
 
-.PHONY: cleanup-ibc-test-containers e2e-test compatibility-tests
+.PHONY: cleanup-ibc-test-containers e2e-test compatibility-tests init

e2e/README.md

@@ -37,7 +37,13 @@ be quite common in most tests.
 
 Tests can be run using a Makefile target under the e2e directory. `e2e/Makefile`
 
-There are several envinronment variables that alter the behaviour of the make target.
+The tests can be configured using a configuration file or environment variables.
+
+See [the example](./sample.config.json) to get started. The default location the tests look is `~/.ibc-go-e2e-config.json`
+But this can be specified directly using the `E2E_CONFIG_PATH` environment variable.
+
+There are several environment variables that alter the behaviour of the make target which will override any
+options specified in your config file.
 
 | Environment Variable | Description                               | Default Value |
 |----------------------|-------------------------------------------|---------------|

e2e/relayer/relayer.go

@@ -22,9 +22,11 @@ const (
 // Config holds configuration values for the relayer used in the tests.
 type Config struct {
 	// Tag is the tag used for the relayer image.
-	Tag string
+	Tag string `json:"tag"`
 	// Type specifies the type of relayer that this is.
-	Type string
+	Type string `json:"type"`
+	// Image is the image that should be used for the relayer.
+	Image string `json:"image"`
 }
 
 // New returns an implementation of ibc.Relayer depending on the provided RelayerType.

e2e/sample.config.json

@@ -0,0 +1,28 @@
+{
+  "chains": [
+    {
+      "chainId": "chain-a",
+      "numValidators": 1,
+      "numFullNodes": 0,
+      "image": "ghcr.io/cosmos/ibc-go-simd",
+      "tag": "main",
+      "binary": "simd"
+    },
+    {
+      "chainId": "chain-b",
+      "numValidators": 1,
+      "numFullNodes": 0,
+      "image": "ghcr.io/cosmos/ibc-go-simd",
+      "tag": "main",
+      "binary": "simd"
+    }
+  ],
+  "relayer": {
+    "type": "rly",
+    "image": "damiannolan/rly",
+    "tag": "latest"
+  },
+  "cometbft": {
+    "logLevel": "info"
+  }
+}

e2e/scripts/init.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+set -euo pipefail
+
+# ensure_config_file makes sure there is a config file for the e2e tests either by creating a new one using the sample,
+# it is copied to either the default location or the specified env location.
+function ensure_config_file(){
+  local config_file_path="${HOME}/.ibc-go-e2e-config.json"
+  if [[ ! -z "${E2E_CONFIG_PATH:-}" ]]; then
+    config_file_path="${E2E_CONFIG_PATH}"
+  fi
+  if [[ ! -f "${config_file_path}" ]]; then
+    echo "creating e2e config file from sample."
+    echo "copying sample.config.json to ${config_file_path}"
+    cp sample.config.json "${config_file_path}"
+  fi
+  echo "using config file at ${config_file_path} for e2e test"
+}
+
+ensure_config_file

e2e/scripts/run-e2e.sh

@@ -5,10 +5,6 @@ set -eo pipefail
 TEST="${1}"
 ENTRY_POINT="${2:-}"
 
-export CHAIN_A_TAG="${CHAIN_A_TAG:-main}"
-export CHAIN_IMAGE="${CHAIN_IMAGE:-ghcr.io/cosmos/ibc-go-simd}"
-export CHAIN_BINARY="${CHAIN_BINARY:-simd}"
-
 # if jq is installed, we can automatically determine the test entrypoint.
 if command -v jq > /dev/null; then
    cd ..