Avalanche e2e test suites

• Works with fixture-managed temporary networks.
• Compiles to a single binary with customizable configurations.

Running tests

go install -v github.com/onsi/ginkgo/v2/[email protected]
ACK_GINKGO_RC=true ginkgo build ./tests/e2e
./tests/e2e/e2e.test --help

./tests/e2e/e2e.test \
--avalanchego-path=./build/avalanchego

See tests.e2e.sh for an example.

Filtering test execution with labels

In cases where a change can be verified against only a subset of tests, it is possible to filter the tests that will be executed by the declarative labels that have been applied to them. Available labels are defined as constants in describe.go with names of the form *Label. The following example runs only those tests that primarily target the X-Chain:

./tests/e2e/e2e.test \
  --avalanchego-path=./build/avalanchego \
  --ginkgo.label-filter=x

The ginkgo docs provide further detail on how to compose label queries.

Adding tests

Define any flags/configurations in e2e.go.

Create a new package to implement feature-specific tests, or add tests to an existing package. For example:

tests
└── e2e
    ├── README.md
    ├── e2e.go
    ├── e2e_test.go
    └── x
        └── transfer.go
            └── virtuous.go

e2e.go defines common configuration for other test packages. x/transfer/virtuous.go defines X-Chain transfer tests, labeled with x, which can be selected by ./tests/e2e/e2e.test --ginkgo.label-filter "x".

Reusing temporary networks

By default, a new temporary test network will be started before each test run and stopped at the end of the run. When developing e2e tests, it may be helpful to reuse temporary networks across multiple test runs. This can increase the speed of iteration by removing the requirement to start a new network for every invocation of the test under development.

To enable network reuse across test runs, pass --reuse-network as an argument to the test suite:

ginkgo -v ./tests/e2e -- --avalanchego-path=/path/to/avalanchego --reuse-network

If a network is not already running the first time the suite runs with --reuse-network, one will be started automatically and configured for reuse by subsequent test runs also supplying --reuse-network.

Restarting temporary networks

When iterating on a change to avalanchego and/or a VM, it may be useful to restart a running network to ensure the network is using the latest binary state. Supplying --restart-network in addition to --reuse-network will ensure that all nodes are restarted before tests are run. --restart-network is ignored if a network is not running or if --stop-network is supplied.

Stopping temporary networks

To stop a network configured for reuse, invoke the test suite with the --stop-network argument. This will stop the network and exit immediately without executing any tests:

ginkgo -v ./tests/e2e -- --stop-network

Skipping bootstrap checks

By default many tests will attempt to bootstrap a new node with the post-test network state. While this is a valuable activity to perform in CI, it can add considerable latency to test development. To disable these bootstrap checks during development, set the E2E_SKIP_BOOTSTRAP_CHECKS env var to a non-empty value:

E2E_SKIP_BOOTSTRAP_CHECKS=1 ginkgo -v ./tests/e2e ...