- Works with fixture-managed networks.
- Compiles to a single binary with customizable configurations.
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.
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.
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:
.
└── 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"
.
By default, a new ephemeral test network will be started before each test run. When developing e2e tests, it may be helpful to create a persistent test network to test against. 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 use a persistent network:
# From the root of the avalanchego repo
# Build the testnetctl binary
$ ./scripts/build_testnetctl.sh
# Start a new network
$ ./build/testnetctl start-network --avalanchego-path=/path/to/avalanchego
...
Started network 1000 @ /home/me/.testnetctl/networks/1000
Configure testnetctl to target this network by default with one of the following statements:
- source /home/me/.testnetctl/networks/1000/network.env
- export TESTNETCTL_NETWORK_DIR=/home/me/.testnetctl/networks/1000
- export TESTNETCTL_NETWORK_DIR=/home/me/.testnetctl/networks/latest
# Start a new test run using the persistent network
ginkgo -v ./tests/e2e -- \
--avalanchego-path=/path/to/avalanchego \
--ginkgo.focus-file=[name of file containing test] \
--use-persistent-network \
--network-dir=/path/to/network
# It is also possible to set the AVALANCHEGO_PATH env var instead of supplying --avalanchego-path
# and to set TESTNETCTL_NETWORK_DIR instead of supplying --network-dir.
See the testnet fixture README for more details.
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 ...