Skip to content

Latest commit

 

History

History
 
 

e2e

README.md

Table of Contents

  1. How to write tests
  2. Test design
  3. Github Workflows
  4. Running Compatibility Tests
  5. Troubleshooting
  6. Importable Workflow

How to write tests

Adding a new test

All tests should go under the e2e directory. When adding a new test, either add a new test function to an existing test suite in the same file, or create a new test suite in a new file and add test functions there. New test files should follow the convention of module_name_test.go.

After creating a new test file, be sure to add a build constraint that ensures this file will not be included in the package to be built when running tests locally via make test. For an example of this, see any of the existing test files.

New test suites should be composed of testsuite.E2ETestSuite. This type has lots of useful helper functionality that will be quite common in most tests.

Note: see here for details about these requirements.

Running tests with custom images

Tests can be run using a Makefile target under the e2e directory. e2e/Makefile

The tests can be configured using a configuration file or environment variables.

See the minimal example or extended example 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.

The sample config contains comments outlining the available fields and their purpose.

There are several environment variables that alter the behaviour of the make target which will override any options specified in your config file. These are primarily used for CI and are not required for local development.

Environment Variable Description Default Value
CHAIN_IMAGE The image that will be used for the chain ghcr.io/cosmos/ibc-go-simd
CHAIN_A_TAG The tag used for chain A N/A
CHAIN_B_TAG The tag used for chain B N/A
CHAIN_BINARY The binary used in the container simd
RELAYER_TAG The tag used for the relayer 1.10.0
RELAYER_ID The type of relayer to use (rly/hermes) hermes

Note: when running tests locally, no images are pushed to the ghcr.io/cosmos/ibc-go-simd registry. The images which are used only exist locally only.

These environment variables allow us to run tests with arbitrary versions (from branches or releases) of simd and the go / hermes relayer.

Every time changes are pushed to a branch or to main, a new simd image is built and pushed here.

Example of running a single test

NOTE: environment variables can be set to override one or more config file variables, but the config file can still be used to set defaults.

make e2e-test entrypoint=TestInterchainAccountsTestSuite test=TestMsgSubmitTx_SuccessfulTransfer

If jq is installed, you only need to specify the test.

If fzf is also installed, you only need to run make e2e-test and you will be prompted with interactive test selection.

make e2e-test test=TestMsgSubmitTx_SuccessfulTransfer

Note: sometimes it can be useful to make changes to interchaintest when running tests locally. In order to do this, add the following line to e2e/go.mod

replace github.com/strangelove-ventures/interchaintest => ../../interchaintest

Or point it to any local checkout you have.

Example of running a full testsuite

NOTE: not all tests may support full parallel runs due to possible chain wide modifications such as params / gov proposals / chain restarts. See When to Use t.Parallel() for more information.

make e2e-suite entrypoint=TestTransferTestSuite

Similar to running a single test, if jq and fzf are installed you can run make e2e-suite and be prompted to interactively select a test suite to run.

Running tests outside the context of the Makefile

In order to run tests outside the context of the Makefile (e.g. from an IDE)

The default location for a config file will be ~/.ibc-go-e2e-config.yaml but this can be overridden by setting the E2E_CONFIG_PATH environment variable.

This should be set to the path of a valid config file you want to use, setting this env will depend on the IDE being used.

Test design

interchaintest

These E2E tests use the interchaintest framework. This framework creates chains and relayers in containers and allows for arbitrary commands to be executed in the chain containers, as well as allowing us to broadcast arbitrary messages which are signed on behalf of a user created in the test.

Test Suites

In order for tests to be run in parallel, we create the chains in SetupSuite, and each test is in charge of creating clients/connections/channels for itself.

This is explicitly not being done in SetupTest to enable maximum control and flexibility over the channel creation params.

When to use t.Parallel

tests should not be run in parallel when:

  • the test is modifying chain wide state such as modifying params via a gov proposal.
  • the test needs to perform a chain restart.
  • the test must make assertions which may not be deterministic due to other tests. (e.g. the TotalEscrowForDenom may be modified between tests)

CI configuration

There are two main github actions for e2e tests.

e2e.yaml which runs when collaborators create branches.

e2e-fork.yaml which runs when forks are created.

In e2e.yaml, the simd image is built and pushed to a registry and every test that is run uses the image that was built.

In e2e-fork.yaml, images are not pushed to this registry, but instead remain local to the host runner.

How tests are run

The tests use the matrix feature of Github Actions. The matrix is dynamically generated using this tool.

Note: there is currently a limitation that all tests belonging to a test suite must be in the same file. In order to support test functions spread in different files, we would either need to manually maintain a matrix or update the script to account for this. The script assumes there is a single test suite per test file to avoid an overly complex generation process.

Which looks under the e2e directory, and creates a task for each test suite function.

This tool can be run locally to see which tests will be run in CI.

go run cmd/build_test_matrix/main.go | jq

This string is used to generate a test matrix in the Github Action that runs the E2E tests.

All tests will be run on different hosts when running make e2e-test but make e2e-suite will run multiple tests in parallel on a shared host.

Miscellaneous

GitHub Workflows

Building and pushing a simd image

If we ever need to manually build and push an image, we can do so with the Build Simd Image GitHub workflow.

This can be triggered manually from the UI by navigating to

Actions -> Build Simd Image -> Run Workflow

And providing the git tag.

Alternatively, the gh CLI tool can be used to trigger this workflow.

gh workflow run "Build Simd Image" -f tag=v3.0.0

Running Compatibility Tests

To trigger the compatibility tests for a release branch, you can use the following command.

make compatibility-tests release_branch=release/v5.0.x

This will build an image from the tip of the release branch and run all tests specified in the corresponding json matrix files under .github/compatibility-test-matrices and is equivalent to going to the Github UI and navigating to

Actions -> Compatibility E2E -> Run Workflow -> release/v5.0.x

Troubleshooting

  • On Mac, after running a lot of tests, it can happen that containers start failing. To fix this, you can try clearing existing containers and restarting the docker daemon.

    This generally manifests itself as relayer or simd containers timing out during setup stages of the test. This doesn't happen in CI.

    # delete all images
docker system prune -af

    This issue doesn't seem to occur on other operating systems.

Accessing Logs

  • When a test fails in GitHub. The logs of the test will be uploaded (viewable in the summary page of the workflow). Note: There may be some discrepancy in the logs collected and the output of interchain test. The containers may run for a some time after the logs are collected, resulting in the displayed logs to differ slightly.

Importable Workflow

This repository contains an importable workflow that can be used from any other repository to test chain upgrades. The workflow can be used to test both non-IBC chains, and also IBC-enabled chains.

Prerequisites

  • In order to run this workflow, a docker container is required with tags for the versions you want to test.

  • Have an upgrade handler in the chain binary which is being upgraded to.

It's worth noting that all github repositories come with a built-in docker registry that makes it convenient to build and push images to.

This workflow can be used as a reference for how to build a docker image whenever a git tag is pushed.

How to import the workflow

You can refer to this example when including this workflow in your repo.

The referenced job will do the following:

  • Create two chains using the image found at ghcr.io/cosmos/ibc-go-simd:v4.3.0.
  • Perform IBC transfers verifying core functionality.
  • Upgrade chain A to ghcr.io/cosmos/ibc-go-simd:v5.1.0 by executing a governance proposal and using the plan name normal upgrade.
  • Perform additional IBC transfers and verifies the upgrade and migrations ran successfully.

Note: The plan name will always be specific to your chain. In this instance normal upgrade is referring to this upgrade handler

Workflow Options

Workflow Field Purpose
chain-image The docker image to use for the test
chain-a-tag The tag of chain A to use
chain-b-tag The tag of chain B to use
chain-upgrade-tag The tag chain A should be upgraded to
chain-binary The chain binary name
upgrade-plan-name The name of the upgrade plan to execute
test-entry-point Always TestUpgradeTestSuite
test Should be TestIBCChainUpgrade or TestChainUpgrade

TestIBCChainUpgrade should be used for ibc tests, while TestChainUpgrade should be used for single chain tests.