[tmpnet] Refactor runtime configuration in preparation for kube

Author: maru-ava

tests/antithesis/compose.go

@@ -61,12 +61,19 @@ func GenerateComposeConfig(network *tmpnet.Network, baseImageName string) error
 			return errPluginDirEnvVarNotSet
 		}
 
+		network.DefaultRuntimeConfig = tmpnet.NodeRuntimeConfig{
+			Process: &tmpnet.ProcessRuntimeConfig{
+				AvalancheGoPath: avalancheGoPath,
+				PluginDir:       pluginDir,
+			},
+		}
+
 		bootstrapVolumePath, err := getBootstrapVolumePath(targetPath)
 		if err != nil {
 			return fmt.Errorf("failed to get bootstrap volume path: %w", err)
 		}
 
-		if err := initBootstrapDB(network, avalancheGoPath, pluginDir, bootstrapVolumePath); err != nil {
+		if err := initBootstrapDB(network, bootstrapVolumePath); err != nil {
 			return fmt.Errorf("failed to initialize db volumes: %w", err)
 		}
 	}

tests/antithesis/init_db.go

@@ -28,16 +28,14 @@ func getBootstrapVolumePath(targetPath string) (string, error) {
 // Bootstraps a local process-based network, creates its subnets and chains, and copies
 // the resulting db state from one of the nodes to the provided path. The path will be
 // created if it does not already exist.
-func initBootstrapDB(network *tmpnet.Network, avalancheGoPath string, pluginDir string, destPath string) error {
+func initBootstrapDB(network *tmpnet.Network, destPath string) error {
 	ctx, cancel := context.WithTimeout(context.Background(), time.Minute*2)
 	defer cancel()
 	if err := tmpnet.BootstrapNewNetwork(
 		ctx,
 		tests.NewDefaultLogger(""),
 		network,
 		"",
-		avalancheGoPath,
-		pluginDir,
 	); err != nil {
 		return fmt.Errorf("failed to bootstrap network: %w", err)
 	}

tests/fixture/e2e/env.go

@@ -15,7 +15,6 @@ import (
 	"github.com/stretchr/testify/require"
 	"go.uber.org/zap"
 
-	"github.com/ava-labs/avalanchego/config"
 	"github.com/ava-labs/avalanchego/tests"
 	"github.com/ava-labs/avalanchego/tests/fixture/tmpnet"
 	"github.com/ava-labs/avalanchego/utils/crypto/secp256k1"
@@ -154,14 +153,13 @@ func NewTestEnvironment(tc tests.TestContext, flagVars *FlagVars, desiredNetwork
 	// Start a new network
 	if network == nil {
 		network = desiredNetwork
-		avalancheBinaryPath, err := flagVars.AvalancheGoExecPath()
+		runtimeConfig, err := flagVars.NodeRuntimeConfig()
 		require.NoError(err)
+		network.DefaultRuntimeConfig = *runtimeConfig
 
 		StartNetwork(
 			tc,
 			network,
-			avalancheBinaryPath,
-			flagVars.PluginDir(),
 			flagVars.NetworkShutdownDelay(),
 			flagVars.StartNetwork(),
 			flagVars.ReuseNetwork(),
@@ -228,15 +226,11 @@ func (te *TestEnvironment) StartPrivateNetwork(network *tmpnet.Network) {
 	// Use the same configuration as the shared network
 	sharedNetwork, err := tmpnet.ReadNetwork(te.NetworkDir)
 	require.NoError(err)
-
-	pluginDir, err := sharedNetwork.DefaultFlags.GetStringVal(config.PluginDirKey)
-	require.NoError(err)
+	network.DefaultRuntimeConfig = sharedNetwork.DefaultRuntimeConfig
 
 	StartNetwork(
 		te.testContext,
 		network,
-		sharedNetwork.DefaultRuntimeConfig.AvalancheGoPath,
-		pluginDir,
 		te.PrivateNetworkShutdownDelay,
 		false, /* skipShutdown */
 		false, /* reuseNetwork */

tests/fixture/e2e/flags.go

@@ -7,53 +7,29 @@ import (
 	"flag"
 	"fmt"
 	"os"
-	"path/filepath"
 	"time"
 
 	"github.com/spf13/cast"
 
 	"github.com/ava-labs/avalanchego/tests/fixture/tmpnet"
+	"github.com/ava-labs/avalanchego/tests/fixture/tmpnet/flags"
 )
 
 type FlagVars struct {
-	avalancheGoExecPath string
-	pluginDir           string
-	networkDir          string
-	reuseNetwork        bool
-	startCollectors     bool
-	checkMonitoring     bool
-	startNetwork        bool
-	stopNetwork         bool
-	restartNetwork      bool
-	nodeCount           int
-	activateFortuna     bool
+	runtimeConfigVars *flags.RuntimeConfigVars
+	networkDir        string
+	reuseNetwork      bool
+	startCollectors   bool
+	checkMonitoring   bool
+	startNetwork      bool
+	stopNetwork       bool
+	restartNetwork    bool
+	nodeCount         int
+	activateFortuna   bool
 }
 
-func (v *FlagVars) AvalancheGoExecPath() (string, error) {
-	if err := v.validateAvalancheGoExecPath(); err != nil {
-		return "", err
-	}
-	return v.avalancheGoExecPath, nil
-}
-
-func (v *FlagVars) validateAvalancheGoExecPath() error {
-	if !filepath.IsAbs(v.avalancheGoExecPath) {
-		absPath, err := filepath.Abs(v.avalancheGoExecPath)
-		if err != nil {
-			return fmt.Errorf("avalanchego-path (%s) is a relative path but its absolute path cannot be determined: %w",
-				v.avalancheGoExecPath, err)
-		}
-
-		// If the absolute path file doesn't exist, it means it won't work out of the box.
-		if _, err := os.Stat(absPath); err != nil {
-			return fmt.Errorf("avalanchego-path (%s) is a relative path but must be an absolute path", v.avalancheGoExecPath)
-		}
-	}
-	return nil
-}
-
-func (v *FlagVars) PluginDir() string {
-	return v.pluginDir
+func (v *FlagVars) NodeRuntimeConfig() (*tmpnet.NodeRuntimeConfig, error) {
+	return v.runtimeConfigVars.GetNodeRuntimeConfig()
 }
 
 func (v *FlagVars) NetworkDir() string {
@@ -109,24 +85,7 @@ func (v *FlagVars) ActivateFortuna() bool {
 
 func RegisterFlags() *FlagVars {
 	vars := FlagVars{}
-	flag.StringVar(
-		&vars.avalancheGoExecPath,
-		"avalanchego-path",
-		os.Getenv(tmpnet.AvalancheGoPathEnvName),
-		fmt.Sprintf(
-			"[optional] avalanchego executable path if creating a new network. Also possible to configure via the %s env variable.",
-			tmpnet.AvalancheGoPathEnvName,
-		),
-	)
-	flag.StringVar(
-		&vars.pluginDir,
-		"plugin-dir",
-		tmpnet.GetEnvWithDefault(tmpnet.AvalancheGoPluginDirEnvName, os.ExpandEnv("$HOME/.avalanchego/plugins")),
-		fmt.Sprintf(
-			"[optional] the dir containing VM plugins. Also possible to configure via the %s env variable.",
-			tmpnet.AvalancheGoPluginDirEnvName,
-		),
-	)
+	vars.runtimeConfigVars = flags.NewRuntimeConfigFlagVars()
 	flag.StringVar(
 		&vars.networkDir,
 		"network-dir",

tests/fixture/e2e/helpers.go

@@ -271,8 +271,6 @@ func CheckBootstrapIsPossible(tc tests.TestContext, network *tmpnet.Network) *tm
 func StartNetwork(
 	tc tests.TestContext,
 	network *tmpnet.Network,
-	avalancheGoExecPath string,
-	pluginDir string,
 	shutdownDelay time.Duration,
 	skipShutdown bool,
 	reuseNetwork bool,
@@ -284,8 +282,6 @@ func StartNetwork(
 		tc.Log(),
 		network,
 		DefaultNetworkDir,
-		avalancheGoExecPath,
-		pluginDir,
 	)
 	if err != nil {
 		// Ensure nodes are stopped if bootstrap fails. The network configuration

tests/fixture/tmpnet/README.md

@@ -57,26 +57,31 @@ repositories.
 The functionality in this package is grouped by logical purpose into
 the following non-test files:
 
-| Filename                    | Types       | Purpose                                                     |
-|:----------------------------|:------------|:------------------------------------------------------------|
-| check_monitoring.go         |             | Enables checking if logs and metrics were collected         |
-| defaults.go                 |             | Defines common default configuration                        |
-| detached_process_default.go |             | Configures detached processes for darwin and linux          |
-| detached_process_windows.go |             | No-op detached process configuration for windows            |
-| flags.go                    | FlagsMap    | Simplifies configuration of avalanchego flags               |
-| genesis.go                  |             | Creates test genesis                                        |
-| kube.go                     |             | Library for Kubernetes interaction                          |
-| local_network.go            |             | Defines configuration for the default local network         |
-| monitor_processes.go        |             | Enables collection of logs and metrics from local processes |
-| network.go                  | Network     | Orchestrates and configures temporary networks              |
-| network_config.go           | Network     | Reads and writes network configuration                      |
-| network_test.go             |             | Simple test round-tripping Network serialization            |
-| node.go                     | Node        | Orchestrates and configures nodes                           |
-| node_config.go              | Node        | Reads and writes node configuration                         |
-| node_process.go             | NodeProcess | Orchestrates node processes                                 |
-| start_kind_cluster.go       |             | Starts a local kind cluster                                 |
-| subnet.go                   | Subnet      | Orchestrates subnets                                        |
-| utils.go                    |             | Defines shared utility functions                            |
+| Filename                    | Types       | Purpose                                                                |
+|:----------------------------|:------------|:-----------------------------------------------------------------------|
+| flags/                      |             | Directory defining flags usable with both stdlib flags and spf13/pflag |
+| flags/common.go             |             | Defines type definitions common across other files                     |
+| flags/process_runtime.go    |             | Defines flags configuring the process node runtime                     |
+| flags/runtime.go            |             | Defines flags configuring node runtime                                 |
+| tmpnetctl/                  |             | Directory containing main entrypoint for tmpnetctl command             |
+| check_monitoring.go         |             | Enables checking if logs and metrics were collected                    |
+| defaults.go                 |             | Defines common default configuration                                   |
+| detached_process_default.go |             | Configures detached processes for darwin and linux                     |
+| detached_process_windows.go |             | No-op detached process configuration for windows                       |
+| flags.go                    | FlagsMap    | Simplifies configuration of avalanchego flags                          |
+| genesis.go                  |             | Creates test genesis                                                   |
+| kube.go                     |             | Library for Kubernetes interaction                                     |
+| local_network.go            |             | Defines configuration for the default local network                    |
+| monitor_processes.go        |             | Enables collection of logs and metrics from local processes            |
+| network.go                  | Network     | Orchestrates and configures temporary networks                         |
+| network_config.go           | Network     | Reads and writes network configuration                                 |
+| network_test.go             |             | Simple test round-tripping Network serialization                       |
+| node.go                     | Node        | Orchestrates and configures nodes                                      |
+| node_config.go              | Node        | Reads and writes node configuration                                    |
+| node_process.go             | NodeProcess | Orchestrates node processes                                            |
+| start_kind_cluster.go       |             | Starts a local kind cluster                                            |
+| subnet.go                   | Subnet      | Orchestrates subnets                                                   |
+| utils.go                    |             | Defines shared utility functions                                       |
 
 ## Usage
 
@@ -133,17 +138,19 @@ flags.
 A temporary network can be managed in code:
 
 ```golang
-network := &tmpnet.Network{                   // Configure non-default values for the new network
+network := &tmpnet.Network{                      // Configure non-default values for the new network
     DefaultRuntimeConfig{
-        ReuseDynamicPorts: true,              // Configure process-based nodes to reuse a dynamically allocated API port when restarting
-    },
+        Process: &tmpnet.ProcessRuntimeConfig{
+            ReuseDynamicPorts: true,             // Configure process-based nodes to reuse a dynamically allocated API port when restarting
+        },
+    }
     DefaultFlags: tmpnet.FlagsMap{
-        config.LogLevelKey: "INFO",           // Change one of the network's defaults
+        config.LogLevelKey: "INFO",              // Change one of the network's defaults
     },
-    Nodes: tmpnet.NewNodesOrPanic(5),         // Number of initial validating nodes
-    Subnets: []*tmpnet.Subnet{                // Subnets to create on the new network once it is running
+    Nodes: tmpnet.NewNodesOrPanic(5),            // Number of initial validating nodes
+    Subnets: []*tmpnet.Subnet{                   // Subnets to create on the new network once it is running
         {
-            Name: "xsvm-a",                   // User-defined name used to reference subnet in code and on disk
+            Name: "xsvm-a",                      // User-defined name used to reference subnet in code and on disk
             Chains: []*tmpnet.Chain{
                 {
                     VMName: "xsvm",              // Name of the VM the chain will run, will be used to derive the name of the VM binary

tests/fixture/tmpnet/flags/common.go

@@ -0,0 +1,12 @@
+// Copyright (C) 2019-2024, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package flags
+
+// The following function signatures are common across flag and
+// spf13/pflag. They can be used to define a single registration method that
+// supports both flag libraries.
+
+type stringVarFunc func(p *string, name string, value string, usage string)
+
+type boolVarFunc func(p *bool, name string, value bool, usage string)

tests/fixture/tmpnet/flags/process_runtime.go

@@ -0,0 +1,95 @@
+// Copyright (C) 2019-2024, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package flags
+
+import (
+	"flag"
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/spf13/pflag"
+
+	"github.com/ava-labs/avalanchego/tests/fixture/tmpnet"
+)
+
+const (
+	processRuntime   = "process"
+	processDocPrefix = "[process runtime] "
+
+	avalanchegoPathFlag = "avalanchego-path"
+)
+
+var errAvalancheGoRequired = fmt.Errorf("--%s or %s are required", avalanchegoPathFlag, tmpnet.AvalancheGoPathEnvName)
+
+type processRuntimeVars struct {
+	config tmpnet.ProcessRuntimeConfig
+}
+
+func (v *processRuntimeVars) registerWithFlag() {
+	v.register(flag.StringVar, flag.BoolVar)
+}
+
+func (v *processRuntimeVars) registerWithFlagSet(flagSet *pflag.FlagSet) {
+	v.register(flagSet.StringVar, flagSet.BoolVar)
+}
+
+func (v *processRuntimeVars) register(stringVar stringVarFunc, boolVar boolVarFunc) {
+	stringVar(
+		&v.config.AvalancheGoPath,
+		avalanchegoPathFlag,
+		os.Getenv(tmpnet.AvalancheGoPathEnvName),
+		processDocPrefix+fmt.Sprintf(
+			"The avalanchego executable path. Also possible to configure via the %s env variable.",
+			tmpnet.AvalancheGoPathEnvName,
+		),
+	)
+	stringVar(
+		&v.config.PluginDir,
+		"plugin-dir",
+		tmpnet.GetEnvWithDefault(tmpnet.AvalancheGoPluginDirEnvName, os.ExpandEnv("$HOME/.avalanchego/plugins")),
+		processDocPrefix+fmt.Sprintf(
+			"The dir containing VM plugins. Also possible to configure via the %s env variable.",
+			tmpnet.AvalancheGoPluginDirEnvName,
+		),
+	)
+	boolVar(
+		&v.config.ReuseDynamicPorts,
+		"reuse-dynamic-ports",
+		false,
+		processDocPrefix+"Whether to attempt to reuse dynamically allocated ports across node restarts.",
+	)
+}
+
+func (v *processRuntimeVars) validate() error {
+	path := v.config.AvalancheGoPath
+
+	if len(path) == 0 {
+		return errAvalancheGoRequired
+	}
+
+	if filepath.IsAbs(path) {
+		if _, err := os.Stat(path); err != nil {
+			return fmt.Errorf("--%s (%s) not found: %w", avalanchegoPathFlag, path, err)
+		}
+		return nil
+	}
+
+	// A relative path must be resolvable to an absolute path
+	absPath, err := filepath.Abs(path)
+	if err != nil {
+		return fmt.Errorf(
+			"--%s (%s) is a relative path but its absolute path cannot be determined: %w",
+			avalanchegoPathFlag,
+			path,
+			err,
+		)
+	}
+
+	// The absolute path must exist
+	if _, err := os.Stat(absPath); err != nil {
+		return fmt.Errorf("--%s (%s) is a relative path but must be an absolute path", avalanchegoPathFlag, path)
+	}
+	return nil
+}