Skip to content

Commit a100d04

Browse files
committed
Add readme describing use of existing network
1 parent 4cd0cdf commit a100d04

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

tests/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Developing with tmpnet
2+
3+
The `load/` and `warp/` paths contain end-to-end (e2e) tests that use
4+
the [tmpnet
5+
fixture](https://github.com/ava-labs/avalanchego/blob/dev/tests/fixture/tmpnet/README.md). By
6+
default both test suites use the tmpnet fixture to create a temporary
7+
network that exists for only the duration of their execution.
8+
9+
It is possible to create a temporary network that can be reused across
10+
test runs to minimize the setup cost involved:
11+
12+
```bash
13+
# From the root of a clone of avalanchego, build the tmpnetctl cli
14+
$ ./scripts/build_tmpnetctl.sh
15+
16+
# Start a new temporary network configured with subnet-evm's default plugin path
17+
$ ./build/tmpnetctl start-network \
18+
--avalanche-path=./build/avalanchego
19+
--plugin-dir=$GOPATH/src/github.com/ava-labs/avalanchego/build/plugins
20+
21+
# From the root of a clone of subnet-evm, execute the warp test suite against the existing network
22+
$ ginkgo -vv ./tests/warp -- --use-existing-network --network-dir=$HOME/.tmpnet/networks/latest
23+
```
24+
25+
The network started by `tmpnetctl` won't come with subnets configured,
26+
so the test suite will add them to the network the first time it
27+
runs. Subsequent test runs will be able to reuse those subnets without
28+
having to set them up.

0 commit comments

Comments
 (0)