e2e: Switch from ANR to testnet fixture

Author: maru-ava

scripts/tests.e2e.persistent.sh

@@ -16,12 +16,13 @@ if ! [[ "$0" =~ scripts/tests.e2e.persistent.sh ]]; then
   exit 255
 fi
 
-export AVALANCHEGO_PATH="${1-${AVALANCHEGO_PATH}}"
+AVALANCHEGO_PATH="${1-${AVALANCHEGO_PATH}}"
 if [[ -z "${AVALANCHEGO_PATH}" ]]; then
   echo "Missing AVALANCHEGO_PATH argument!"
   echo "Usage: ${0} [AVALANCHEGO_PATH]" >>/dev/stderr
   exit 255
 fi
+export AVALANCHEGO_PATH="$(realpath ${AVALANCHEGO_PATH})"
 
 # Create a temporary directory to store persistent network
 ROOT_DIR="$(mktemp -d -t e2e-testnet.XXXXX)"
@@ -52,4 +53,6 @@ else
 fi
 
 echo "───────────────────────────────────────────────────────────────────────────────────────────────────────────────"
-# TODO(marun) Enable e2e testing
+# Setting E2E_USE_PERSISTENT_NETWORK configures tests.e2e.sh to use
+# the persistent network identified by TESTNETCTL_NETWORK_DIR.
+E2E_USE_PERSISTENT_NETWORK=1 ./scripts/tests.e2e.sh

scripts/tests.e2e.sh

@@ -11,18 +11,7 @@ if ! [[ "$0" =~ scripts/tests.e2e.sh ]]; then
   exit 255
 fi
 
-AVALANCHEGO_PATH="${1-}"
-if [[ -z "${AVALANCHEGO_PATH}" ]]; then
-  echo "Missing AVALANCHEGO_PATH argument!"
-  echo "Usage: ${0} [AVALANCHEGO_PATH]" >>/dev/stderr
-  exit 255
-fi
-
 #################################
-echo "installing avalanche-network-runner"
-ANR_WORKDIR="/tmp"
-./scripts/install_anr.sh
-
 # Sourcing constants.sh ensures that the necessary CGO flags are set to
 # build the portable version of BLST. Without this, ginkgo may fail to
 # build the test binary if run on a host (e.g. github worker) that lacks
@@ -37,27 +26,29 @@ ACK_GINKGO_RC=true ginkgo build ./tests/e2e
 ./tests/e2e/e2e.test --help
 
 #################################
-# run "avalanche-network-runner" server
-echo "launch avalanche-network-runner in the background"
-$ANR_WORKDIR/avalanche-network-runner \
-  server \
-  --log-level debug \
-  --port=":12342" \
-  --disable-grpc-gateway &
-PID=${!}
+E2E_USE_PERSISTENT_NETWORK="${E2E_USE_PERSISTENT_NETWORK:-}"
+TESTNETCTL_NETWORK_DIR="${TESTNETCTL_NETWORK_DIR:-}"
+if [[ -n "${E2E_USE_PERSISTENT_NETWORK}" && -n "${TESTNETCTL_NETWORK_DIR}" ]]; then
+  echo "running e2e tests against a persistent network configured at ${TESTNETCTL_NETWORK_DIR}"
+  E2E_ARGS="--use-persistent-network"
+else
+  AVALANCHEGO_PATH="${1-}"
+  if [[ -z "${AVALANCHEGO_PATH}" ]]; then
+    echo "Missing AVALANCHEGO_PATH argument!"
+    echo "Usage: ${0} [AVALANCHEGO_PATH]" >>/dev/stderr
+    exit 255
+  fi
+  echo "running e2e tests against an ephemeral local cluster deployed with ${AVALANCHEGO_PATH}"
+  AVALANCHEGO_PATH="$(realpath ${AVALANCHEGO_PATH})"
+  E2E_ARGS="--avalanchego-path=${AVALANCHEGO_PATH}"
+fi
 
 #################################
-echo "running e2e tests against the local cluster with ${AVALANCHEGO_PATH}"
-./tests/e2e/e2e.test \
-  --ginkgo.v \
-  --log-level debug \
-  --network-runner-grpc-endpoint="0.0.0.0:12342" \
-  --network-runner-avalanchego-path=${AVALANCHEGO_PATH} \
-  --network-runner-avalanchego-log-level="WARN" \
-  --test-keys-file=tests/test.insecure.secp256k1.keys &&
-  EXIT_CODE=$? || EXIT_CODE=$?
-
-kill ${PID}
+# - Execute in parallel (-p) with the ginkgo cli to minimize execution time.
+#   The test binary by itself isn't capable of running specs in parallel.
+# - Execute in random order to identify unwanted dependency
+ginkgo -p -v --randomize-all ./tests/e2e/e2e.test -- ${E2E_ARGS} \
+&& EXIT_CODE=$? || EXIT_CODE=$?
 
 if [[ ${EXIT_CODE} -gt 0 ]]; then
   echo "FAILURE with exit code ${EXIT_CODE}"

tests/e2e/README.md

@@ -1,6 +1,6 @@
 # Avalanche e2e test suites
 
-- Works for any environments (e.g., local, test network).
+- Works with fixture-managed networks.
 - Compiles to a single binary with customizable configurations.
 
 ## Running tests
@@ -11,7 +11,6 @@ ACK_GINKGO_RC=true ginkgo build ./tests/e2e
 ./tests/e2e/e2e.test --help
 
 ./tests/e2e/e2e.test \
---network-runner-grpc-endpoint="0.0.0.0:12340" \
 --avalanchego-path=./build/avalanchego
 ```
 
@@ -29,8 +28,51 @@ Create a new package to implement feature-specific tests, or add tests to an exi
     ├── README.md
     ├── e2e.go
     ├── e2e_test.go
-    └── ping
-        └── suites.go
+    └── x
+        └── transfer.go
+            └── virtuous.go
 ```
 
-`e2e.go` defines common configurations (e.g., network-runner client) for other test packages. `ping/suites.go` defines ping tests, annotated by `[Ping]`, which can be selected by `./tests/e2e/e2e.test --ginkgo.focus "\[Local\] \[Ping\]"`.
+`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"`.
+
+## Testing against a persistent network
+
+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:
+
+```bash
+# 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=/Users/me/.testnetctl/networks/latest
+
+# Start a new test run to use 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
+
+# Also possible to set the AVALANCHEGO_PATH env var instead of supplying --avalanchego-path
+# Also possible to set the TESTNETCTL_NETWORK_DIR env var instead of supplying --network-dir
+```
+
+See the testnet fixture [README](../fixture/testnet/local/README.md) for more details.

tests/e2e/banff/suites.go

@@ -11,7 +11,6 @@ import (
 
 	"github.com/onsi/gomega"
 
-	"github.com/ava-labs/avalanchego/genesis"
 	"github.com/ava-labs/avalanchego/ids"
 	"github.com/ava-labs/avalanchego/tests"
 	"github.com/ava-labs/avalanchego/tests/e2e"
@@ -28,23 +27,15 @@ var _ = ginkgo.Describe("[Banff]", func() {
 		// use this for filtering tests by labels
 		// ref. https://onsi.github.io/ginkgo/#spec-labels
 		ginkgo.Label(
-			"require-network-runner",
 			"xp",
 			"banff",
 		),
 		func() {
-			ginkgo.By("reload initial snapshot for test independence", func() {
-				err := e2e.Env.RestoreInitialState(true /*switchOffNetworkFirst*/)
-				gomega.Expect(err).Should(gomega.BeNil())
-			})
-
-			uris := e2e.Env.GetURIs()
-			gomega.Expect(uris).ShouldNot(gomega.BeEmpty())
-
-			kc := secp256k1fx.NewKeychain(genesis.EWOQKey)
+			key := e2e.Env.AllocateTestKeys(1)[0]
+			kc := secp256k1fx.NewKeychain(key)
 			var wallet primary.Wallet
 			ginkgo.By("initialize wallet", func() {
-				walletURI := uris[0]
+				walletURI := e2e.Env.URIs[0]
 
 				// 5-second is enough to fetch initial UTXOs for test cluster in "primary.NewWallet"
 				ctx, cancel := context.WithTimeout(context.Background(), e2e.DefaultWalletCreationTimeout)
@@ -65,7 +56,7 @@ var _ = ginkgo.Describe("[Banff]", func() {
 			owner := &secp256k1fx.OutputOwners{
 				Threshold: 1,
 				Addrs: []ids.ShortID{
-					genesis.EWOQKey.PublicKey().Address(),
+					key.Address(),
 				},
 			}
 

tests/e2e/describe.go

@@ -13,6 +13,12 @@ func DescribeXChain(text string, body func()) bool {
 	return ginkgo.Describe("[X-Chain] "+text, body)
 }
 
+// DescribeXChainSerial annotates serial tests for X-Chain.
+// Can run with any type of cluster (e.g., local, fuji, mainnet).
+func DescribeXChainSerial(text string, body func()) bool {
+	return ginkgo.Describe("[X-Chain] "+text, ginkgo.Serial, body)
+}
+
 // DescribePChain annotates the tests for P-Chain.
 // Can run with any type of cluster (e.g., local, fuji, mainnet).
 func DescribePChain(text string, body func()) bool {