Support configuration file for e2e tests (#3260)

Author: chatton

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.yaml) to get started. The default location the tests look is `~/.ibc-go-e2e-config.yaml`
+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 `yaml:"tag"`
 	// Type specifies the type of relayer that this is.
-	Type string
+	Type string `yaml:"type"`
+	// Image is the image that should be used for the relayer.
+	Image string `yaml:"image"`
 }
 
 // New returns an implementation of ibc.Relayer depending on the provided RelayerType.

e2e/sample.config.yaml

@@ -0,0 +1,40 @@
+# This file contains configuration for running e2e tests.
+# Many of these fields can be overridden with environment variables.
+# All fields that support this have the corresponding environment variable name in a comment beside the field.
+
+---
+chains:
+  # the entry at index 0 corresponds to CHAIN_A
+- chainId: chain-a
+  numValidators: 1
+  numFullNodes: 0
+  image: ghcr.io/cosmos/ibc-go-simd # override with CHAIN_IMAGE
+  tag: main # override with CHAIN_A_TAG
+  binary: simd # override with CHAIN_BINARY
+
+  # the entry at index 1 corresponds to CHAIN_B
+- chainId: chain-b
+  numValidators: 1
+  numFullNodes: 0
+  image: ghcr.io/cosmos/ibc-go-simd # override with CHAIN_IMAGE
+  tag: main # override with CHAIN_B_TAG
+  binary: simd # override with CHAIN_BINARY
+
+relayer:
+  type: rly # override with RELAYER_TYPE
+  image: damiannolan/rly
+  tag: latest # override with RELAYER_TAG
+
+cometbft:
+  logLevel: info
+
+debug:
+  # setting this value to true will force log collection even if the test passes.
+  dumpLogs: false
+
+# Required only for upgrade tests.
+# Chain A will be upgraded the specified tag.
+# The plan name must be registered as an upgrade handler in the given tag.
+upgrade:
+  planName: ""
+  tag: ""

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.yaml"
+  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.yaml to ${config_file_path}"
+    cp sample.config.yaml "${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 ..