fixup Move fixture code out of e2e to enable unit test execution

maru-ava · maru-ava · commit 91dd7c365068 · 2023-07-11T10:51:56.000-07:00
Also rename avctl to testnetctl to avoid any confusion about its
intended purpose.
diff --git a/scripts/build_test.sh b/scripts/build_test.sh
@@ -9,4 +9,5 @@ AVALANCHE_PATH=$( cd "$( dirname "${BASH_SOURCE[0]}" )"; cd .. && pwd )
 # Load the constants
 source "$AVALANCHE_PATH"/scripts/constants.sh
 
-go test -shuffle=on -race -timeout="120s" -coverprofile="coverage.out" -covermode="atomic" $(go list ./... | grep -v /mocks | grep -v proto | grep -v tests)
+# Ensure execution of fixture unit tests under tests/ but exclude ginkgo tests in tests/e2e and tests/upgrade
+go test -shuffle=on -race -timeout="120s" -coverprofile="coverage.out" -covermode="atomic" $(go list ./... | grep -v /mocks | grep -v proto | grep -v tests/e2e | grep -v tests/upgrade)
diff --git a/scripts/build_testnetctl.sh b/scripts/build_testnetctl.sh
@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+# Avalanchego root folder
+AVALANCHE_PATH=$( cd "$( dirname "${BASH_SOURCE[0]}" )"; cd .. && pwd )
+# Load the constants
+source "$AVALANCHE_PATH"/scripts/constants.sh
+
+echo "Building testnetctl..."
+go build -ldflags\
+   "-X github.com/ava-labs/avalanchego/version.GitCommit=$git_commit $static_ld_flags"\
+   -o "$AVALANCHE_PATH/build/testnetctl"\
+   "$AVALANCHE_PATH/tests/fixture/testnet/cmd/"*.go
diff --git a/tests/e2e/README.md b/tests/e2e/README.md
@@ -48,27 +48,26 @@ To use a persistent network:
 ```bash
 # From the root of the avalanchego repo
 
-# Build the avctl binary
-$ go build -o build/avctl ./tests/e2e/fixture/cmd/*.go  && avctl start
+# Build the testnetctl binary
+$ scripts/build_testnetctl.sh
 
 # Start a new network
-$ ./build/avctl start-network --avalanchego-path=/path/to/avalanchego
+$ ./build/testnetctl start-network --avalanchego-path=/path/to/avalanchego
 ...
-Started network 1337 @ /home/me/.avctl/1337-20230705-213938-1707053131
+Started network 1337 @ /home/me/.testnetctl/1337-20230705-213938-1707053131
 
-Configure avctl to target this network by default with one of the following statements:
- - source /home/me/.avctl/1337-20230705-213938-1707053131/network.env
- - export AVCTL_NETWORK_DIR=/home/me/.avctl/1337-20230705-213938-1707053131
+Configure testnetctl to target this network by default with one of the following statements:
+ - source /home/me/.testnetctl/1337-20230705-213938-1707053131/network.env
+ - export TESTNETCTL_NETWORK_DIR=/home/me/.testnetctl/1337-20230705-213938-1707053131
 
 # Start a new test run to use the persistent network
-ginkgo build ./tests/e2e/ && \
-  ./tests/e2e/e2e.test \
+ginkgo -v ./tests/e2e -- \
     --avalanchego-path=/path/to/avalanchego \
     --test-keys-file=$PWD/tests/test.insecure.secp256k1.keys \
     --network-dir=/path/to/network \
     --ginkgo-focus-file=[name of file containing test] \
     --use-persistent-network
 
 # Also possible to set the AVALANCHEGO_PATH env var instead of supplying --avalanchego-path
-# Also possible to set the AVCTL_NETWORK_DIR env var instead of supplying --network-dir
+# Also possible to set the TESTNETCTL_NETWORK_DIR env var instead of supplying --network-dir
 ```
diff --git a/tests/e2e/e2e.go b/tests/e2e/e2e.go
@@ -16,8 +16,8 @@ import (
 
 	"github.com/ava-labs/avalanchego/ids"
 	"github.com/ava-labs/avalanchego/tests"
-	"github.com/ava-labs/avalanchego/tests/e2e/fixture"
-	"github.com/ava-labs/avalanchego/tests/e2e/fixture/local"
+	"github.com/ava-labs/avalanchego/tests/fixture/testnet"
+	"github.com/ava-labs/avalanchego/tests/fixture/testnet/local"
 	"github.com/ava-labs/avalanchego/utils/crypto/secp256k1"
 	"github.com/ava-labs/avalanchego/vms/secp256k1fx"
 )
@@ -279,6 +279,6 @@ func (te *TestEnvironment) Teardown() error {
 	return nil
 }
 
-func (te *TestEnvironment) GetNetwork() (fixture.Network, error) {
+func (te *TestEnvironment) GetNetwork() (testnet.Network, error) {
 	return local.LoadNetwork(te.networkDir)
 }
diff --git a/tests/e2e/e2e_test.go b/tests/e2e/e2e_test.go
@@ -14,7 +14,7 @@ import (
 	"github.com/onsi/gomega"
 
 	"github.com/ava-labs/avalanchego/tests/e2e"
-	"github.com/ava-labs/avalanchego/tests/e2e/fixture/local"
+	"github.com/ava-labs/avalanchego/tests/fixture/testnet/local"
 
 	// ensure test packages are scanned by ginkgo
 	_ "github.com/ava-labs/avalanchego/tests/e2e/banff"
diff --git a/tests/fixture/testnet/README.md b/tests/fixture/testnet/README.md
@@ -1,4 +1,4 @@
-# Network Fixture
+# Test Network Fixture
 
 This package contains configuration and interfaces that are
 independent of a given orchestration mechanism
diff --git a/tests/fixture/testnet/cmd/main.go b/tests/fixture/testnet/cmd/main.go
@@ -9,15 +9,15 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/ava-labs/avalanchego/tests/e2e/fixture/local"
+	"github.com/ava-labs/avalanchego/tests/fixture/testnet/local"
 )
 
 func main() {
 	var networkDir string
 	var rootDir string
 	rootCmd := &cobra.Command{
-		Use:   "avctl",
-		Short: "avctl commands",
+		Use:   "testnetctl",
+		Short: "testnetctl commands",
 	}
 	rootCmd.PersistentFlags().StringVar(&networkDir, "network-dir", os.Getenv(local.NetworkDirEnvName), "The path to the configuration directory of a local network")
 	rootCmd.PersistentFlags().StringVar(&rootDir, "root-dir", os.Getenv(local.RootDirEnvName), "The path to the root directory for local networks")
@@ -46,7 +46,7 @@ func main() {
 				return err
 			}
 
-			fmt.Fprintf(os.Stdout, "\nConfigure avctl to target this network by default with one of the following statements:")
+			fmt.Fprintf(os.Stdout, "\nConfigure testnetctl to target this network by default with one of the following statements:")
 			fmt.Fprintf(os.Stdout, "\n - source %s\n", network.EnvFilePath())
 			fmt.Fprintf(os.Stdout, " - %s\n", network.EnvFileContents())
 
@@ -80,7 +80,7 @@ func main() {
 	rootCmd.AddCommand(stopNetworkCmd)
 
 	if err := rootCmd.Execute(); err != nil {
-		fmt.Fprintf(os.Stderr, "avctl failed %v\n", err)
+		fmt.Fprintf(os.Stderr, "testnetctl failed %v\n", err)
 		os.Exit(1)
 	}
 	os.Exit(0)
diff --git a/tests/fixture/testnet/config.go b/tests/fixture/testnet/config.go
@@ -1,7 +1,7 @@
 // Copyright (C) 2019-2023, Ava Labs, Inc. All rights reserved.
 // See the file LICENSE for licensing terms.
 
-package fixture
+package testnet
 
 import (
 	"encoding/base64"
@@ -80,7 +80,7 @@ func (c *NetworkConfig) PopulateNetworkConfig(networkID uint32, validatorIDs []i
 			// - Randomly generate the network id (making sure it isn't a reserved ID)
 			// - Use only the network id (without a datetime suffix) on the filesystem
 			// - Support referring to a network by just the id against a default path
-			//   - e.g. ~/.avctl/[network id]
+			//   - e.g. ~/.testnetctl/[network id]
 			networkID = uint32(1337)
 		}
 
diff --git a/tests/fixture/testnet/interfaces.go b/tests/fixture/testnet/interfaces.go
@@ -1,7 +1,7 @@
 // Copyright (C) 2019-2023, Ava Labs, Inc. All rights reserved.
 // See the file LICENSE for licensing terms.
 
-package fixture
+package testnet
 
 import "github.com/ava-labs/avalanchego/ids"
 
diff --git a/tests/fixture/testnet/local/README.md b/tests/fixture/testnet/local/README.md
@@ -4,8 +4,8 @@ This package implements a simple orchestrator for the avalanchego
 nodes of a local network. Configuration is stored on disk, and nodes
 run as independent processes whose runtime state is also written to
 disk. Using persistent storage for configuration and runtime state
-allows for both the avctl cli tool and e2e test fixture to orchestrate
-the local networks without the use of an rpc daemon.
+allows for both the testnetctl cli tool and e2e test fixture to
+orchestrate the local networks without the use of an rpc daemon.
 
 ## Package details
 
@@ -27,27 +27,27 @@ shared configuration abstractions without complication.
 
 ## Usage
 
-### Via avctl
+### Via testnetctl
 
-A local network can be managed by the avctl cli tool:
+A local network can be managed by the testnetctl cli tool:
 
 ```bash
 # From the root of the avalanchego repo
 
-# Build the avctl binary
-$ go build -o build/avctl ./tests/e2e/fixture/cmd/*.go
+# Build the testnetctl binary
+$ scripts/build_testnetctl.sh
 
 # Start a new network
-$ ./build/avctl start-network --avalanchego-path=/path/to/avalanchego
+$ ./build/testnetctl start-network --avalanchego-path=/path/to/avalanchego
 ...
-Started network 1337 @ /home/me/.avctl/1337-20230705-213938-1707053131
+Started network 1337 @ /home/me/.testnetctl/1337-20230705-213938-1707053131
 
-Configure avctl to target this network by default with one of the following statements:
- - source /home/me/.avctl/1337-20230705-213938-1707053131/network.env
- - export AVCTL_NETWORK_DIR=/home/me/.avctl/1337-20230705-213938-1707053131
+Configure testnetctl to target this network by default with one of the following statements:
+ - source /home/me/.testnetctl/1337-20230705-213938-1707053131/network.env
+ - export TESTNETCTL_NETWORK_DIR=/home/me/.testnetctl/1337-20230705-213938-1707053131
 
 # Stop the network
-$ ./build/avctl stop-network --network-dir=/path/to/network
+$ ./build/testnetctl stop-network --network-dir=/path/to/network
 ```
 
 ### Via code
@@ -57,7 +57,7 @@ A local network can be managed in code:
 ```golang
 network, _ := local.StartNetwork(
     ginkgo.GinkgoWriter,
-    "", // Use default root dir (~/.avctl)
+    "", // Use default root dir (~/.testnetctl)
     &local.LocalNetwork{
         LocalConfig: local.LocalConfig{
             ExecPath: "/path/to/avalanchego",  // Defining the avalanchego exec path is required
@@ -82,7 +82,7 @@ configuration and by supplying a nodeCount argument of `0`:
 ```golang
 network, _ := local.StartNetwork(
     ginkgo.GinkgoWriter,
-    "", // Use default root dir (~/.avctl)
+    "", // Use default root dir (~/.testnetctl)
     &local.LocalNetwork{
         LocalConfig: local.LocalConfig{
             ExecPath: "/path/to/avalanchego",  // Default avalanchego path
@@ -121,7 +121,7 @@ A local network relies on configuration written to disk in the following structu
 
 ```
 HOME
-└── .avctl                                           // Default parent directory for local networks
+└── .testnetctl                                           // Default parent directory for local networks
     └── 1337-20230630-203525-2336789419              // Network path with form [network-id]-[timestamp]
         ├── NodeID-37E8UK3x2YFsHE3RdALmfWcppcZ1eTuj9 // The id of a node is the name of its data dir
         │   ├── chainData
@@ -171,11 +171,11 @@ at `[chain-config-dir]/C/cchain_config.json`.
 
 ### Network env
 
-A shell script that sets the `AVCTL_NETWORK_DIR` env var to the path
-of the network is stored at `[network-dir]/network.env`. Sourcing this
-file (i.e. `. network.env`) in a shell will configure ginkgo e2e and
-the avctl command to implicitly target the network path specified in
-the env var.
+A shell script that sets the `TESTNETCTL_NETWORK_DIR` env var to the
+path of the network is stored at `[network-dir]/network.env`. Sourcing
+this file (i.e. `. network.env`) in a shell will configure ginkgo e2e
+and the testnetctl command to implicitly target the network path
+specified in the env var.
 
 ### Node configuration
 
diff --git a/tests/fixture/testnet/local/config.go b/tests/fixture/testnet/local/config.go
@@ -5,21 +5,21 @@ package local
 
 import (
 	cfg "github.com/ava-labs/avalanchego/config"
-	"github.com/ava-labs/avalanchego/tests/e2e/fixture"
+	"github.com/ava-labs/avalanchego/tests/fixture/testnet"
 )
 
 const (
 	// Constants defining the names of shell variables whose value can
 	// configure local network orchestration.
 	AvalancheGoEnvName = "AVALANCHEGO_PATH"
-	NetworkDirEnvName  = "AVCTL_NETWORK_DIR"
-	RootDirEnvName     = "AVCTL_ROOT_DIR"
+	NetworkDirEnvName  = "TESTNETCTL_NETWORK_DIR"
+	RootDirEnvName     = "TESTNETCTL_ROOT_DIR"
 )
 
 // A set of flags appropriate for local testing.
-func LocalFlags(networkID uint32) fixture.FlagsMap {
+func LocalFlags(networkID uint32) testnet.FlagsMap {
 	// Supply only non-default configuration to ensure that default values will be used.
-	return fixture.FlagsMap{
+	return testnet.FlagsMap{
 		cfg.NetworkPeerListGossipFreqKey: "250ms",
 		cfg.NetworkMaxReconnectDelayKey:  "1s",
 		cfg.PublicIPKey:                  "127.0.0.1",
@@ -36,7 +36,7 @@ func LocalFlags(networkID uint32) fixture.FlagsMap {
 }
 
 // C-Chain config for local testing.
-func LocalCChainConfig() fixture.FlagsMap {
+func LocalCChainConfig() testnet.FlagsMap {
 	// EVM configuration is defined in the `github.com/ava-labs/coreth/evm` package
 
 	// Supply only non-default configuration to ensure that default values will be used.
diff --git a/tests/fixture/testnet/local/network.go b/tests/fixture/testnet/local/network.go
@@ -16,7 +16,7 @@ import (
 	cfg "github.com/ava-labs/avalanchego/config"
 	"github.com/ava-labs/avalanchego/genesis"
 	"github.com/ava-labs/avalanchego/ids"
-	"github.com/ava-labs/avalanchego/tests/e2e/fixture"
+	"github.com/ava-labs/avalanchego/tests/fixture/testnet"
 	"github.com/ava-labs/avalanchego/utils/perms"
 )
 
@@ -26,12 +26,12 @@ func GetDefaultRootDir() (string, error) {
 	if err != nil {
 		return "", err
 	}
-	return filepath.Join(homeDir, ".avctl"), nil
+	return filepath.Join(homeDir, ".testnetctl"), nil
 }
 
 // Defines the configuration required for a local network (i.e. one composed of local processes).
 type LocalNetwork struct {
-	fixture.NetworkConfig
+	testnet.NetworkConfig
 	LocalConfig
 
 	// Nodes with local configuration
@@ -42,13 +42,13 @@ type LocalNetwork struct {
 }
 
 // Returns the configuration of the network in backend-agnostic form.
-func (ln *LocalNetwork) GetConfig() fixture.NetworkConfig {
+func (ln *LocalNetwork) GetConfig() testnet.NetworkConfig {
 	return ln.NetworkConfig
 }
 
 // Returns the nodes of the network in backend-agnostic form.
-func (ln *LocalNetwork) GetNodes() []fixture.Node {
-	nodes := []fixture.Node{}
+func (ln *LocalNetwork) GetNodes() []testnet.Node {
+	nodes := []testnet.Node{}
 	for _, node := range ln.Nodes {
 		nodes = append(nodes, node)
 	}
@@ -122,7 +122,7 @@ func (ln *LocalNetwork) PopulateLocalNetworkConfig(networkID uint32, nodeCount i
 		nodes := []*LocalNode{}
 		for i := 0; i < nodeCount; i++ {
 			node := &LocalNode{
-				NodeConfig: *fixture.NewNodeConfig(),
+				NodeConfig: *testnet.NewNodeConfig(),
 			}
 			nodes = append(nodes, node)
 		}
@@ -169,12 +169,12 @@ func (ln *LocalNetwork) PopulateNodeConfig(node *LocalNode) error {
 	}
 
 	// Set defaults common to all nodes
-	fixture.SetDefaultFlags(flags, ln.DefaultFlags)
-	defaults := fixture.FlagsMap{
+	testnet.SetDefaultFlags(flags, ln.DefaultFlags)
+	defaults := testnet.FlagsMap{
 		cfg.GenesisFileKey:    ln.GetGenesisPath(),
 		cfg.ChainConfigDirKey: ln.GetChainConfigDir(),
 	}
-	fixture.SetDefaultFlags(flags, defaults)
+	testnet.SetDefaultFlags(flags, defaults)
 
 	// Ensure the node's data dir is configured
 	dataDir := node.GetDataDir()
@@ -343,7 +343,7 @@ func (ln *LocalNetwork) ReadGenesis() error {
 }
 
 func (ln *LocalNetwork) WriteGenesis() error {
-	bytes, err := fixture.DefaultJSONMarshal(ln.Genesis)
+	bytes, err := testnet.DefaultJSONMarshal(ln.Genesis)
 	if err != nil {
 		return fmt.Errorf("failed to marshal genesis: %w", err)
 	}
@@ -366,7 +366,7 @@ func (ln *LocalNetwork) ReadCChainConfig() error {
 	if err != nil {
 		return fmt.Errorf("failed to read cchain config: %w", err)
 	}
-	cChainConfig := fixture.FlagsMap{}
+	cChainConfig := testnet.FlagsMap{}
 	if err := json.Unmarshal(bytes, &cChainConfig); err != nil {
 		return fmt.Errorf("failed to unmarshal cchain config: %w", err)
 	}
@@ -380,7 +380,7 @@ func (ln *LocalNetwork) WriteCChainConfig() error {
 	if err := os.MkdirAll(dir, perms.ReadWriteExecute); err != nil {
 		return fmt.Errorf("failed to create cchain config dir: %w", err)
 	}
-	bytes, err := fixture.DefaultJSONMarshal(ln.CChainConfig)
+	bytes, err := testnet.DefaultJSONMarshal(ln.CChainConfig)
 	if err != nil {
 		return fmt.Errorf("failed to marshal cchain config: %w", err)
 	}
@@ -392,7 +392,7 @@ func (ln *LocalNetwork) WriteCChainConfig() error {
 
 // Used to marshal/unmarshal persistent local network defaults.
 type localDefaults struct {
-	Flags          fixture.FlagsMap
+	Flags          testnet.FlagsMap
 	ExecPath       string
 	UseStaticPorts bool
 }
@@ -422,7 +422,7 @@ func (ln *LocalNetwork) WriteDefaults() error {
 		ExecPath:       ln.ExecPath,
 		UseStaticPorts: ln.UseStaticPorts,
 	}
-	bytes, err := fixture.DefaultJSONMarshal(defaults)
+	bytes, err := testnet.DefaultJSONMarshal(defaults)
 	if err != nil {
 		return fmt.Errorf("failed to marshal defaults: %w", err)
 	}
diff --git a/tests/fixture/testnet/local/network_test.go b/tests/fixture/testnet/local/network_test.go
diff --git a/tests/fixture/testnet/local/node.go b/tests/fixture/testnet/local/node.go
diff --git a/tests/fixture/testnet/local/process.go b/tests/fixture/testnet/local/process.go
diff --git a/tests/fixture/testnet/local/process_test.go b/tests/fixture/testnet/local/process_test.go

Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,8 @@ import (`
`16`	`16`
`17`	`17`	`"github.com/ava-labs/avalanchego/ids"`
`18`	`18`	`"github.com/ava-labs/avalanchego/tests"`
`19`		`- "github.com/ava-labs/avalanchego/tests/e2e/fixture"`
`20`		`- "github.com/ava-labs/avalanchego/tests/e2e/fixture/local"`
	`19`	`+ "github.com/ava-labs/avalanchego/tests/fixture/testnet"`
	`20`	`+ "github.com/ava-labs/avalanchego/tests/fixture/testnet/local"`
`21`	`21`	`"github.com/ava-labs/avalanchego/utils/crypto/secp256k1"`
`22`	`22`	`"github.com/ava-labs/avalanchego/vms/secp256k1fx"`
`23`	`23`	`)`
`@@ -279,6 +279,6 @@ func (te *TestEnvironment) Teardown() error {`
`279`	`279`	`return nil`
`280`	`280`	`}`
`281`	`281`
`282`		`-func (te *TestEnvironment) GetNetwork() (fixture.Network, error) {`
	`282`	`+func (te *TestEnvironment) GetNetwork() (testnet.Network, error) {`
`283`	`283`	`return local.LoadNetwork(te.networkDir)`
`284`	`284`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Network Fixture`
	`1`	`+# Test Network Fixture`
`2`	`2`
`3`	`3`	`This package contains configuration and interfaces that are`
`4`	`4`	`independent of a given orchestration mechanism`