[tmpnet] Avoid serializing the node data directory

This is intended to simplify usage by CLI.

Author: maru-ava

tests/fixture/tmpnet/network.go

@@ -504,23 +504,22 @@ func (n *Network) RestartNode(ctx context.Context, log logging.Logger, node *Nod
 
 // Stops all nodes in the network.
 func (n *Network) Stop(ctx context.Context) error {
-	// Target all nodes, including the ephemeral ones
-	nodes, err := ReadNodes(n, true /* includeEphemeral */)
-	if err != nil {
+	// Ensure the node state is up-to-date
+	if err := n.readNodes(); err != nil {
 		return err
 	}
 
 	var errs []error
 
 	// Initiate stop on all nodes
-	for _, node := range nodes {
+	for _, node := range n.Nodes {
 		if err := node.InitiateStop(ctx); err != nil {
 			errs = append(errs, fmt.Errorf("failed to stop node %s: %w", node.NodeID, err))
 		}
 	}
 
 	// Wait for stop to complete on all nodes
-	for _, node := range nodes {
+	for _, node := range n.Nodes {
 		if err := node.WaitForStopped(ctx); err != nil {
 			errs = append(errs, fmt.Errorf("failed to wait for node %s to stop: %w", node.NodeID, err))
 		}
@@ -554,16 +553,6 @@ func (n *Network) EnsureNodeConfig(node *Node) error {
 		return err
 	}
 
-	if len(n.Dir) > 0 {
-		// Ensure the node's data dir is configured
-		dataDir := node.GetDataDir()
-		if len(dataDir) == 0 {
-			// NodeID will have been set by EnsureKeys
-			dataDir = filepath.Join(n.Dir, node.NodeID.String())
-			node.Flags[config.DataDirKey] = dataDir
-		}
-	}
-
 	return nil
 }
 
@@ -768,16 +757,13 @@ func (n *Network) GetNodeURIs() []NodeURI {
 // collecting the bootstrap details for restarting a node).
 // For consumption outside of avalanchego. Needs to be kept exported.
 func (n *Network) GetBootstrapIPsAndIDs(skippedNode *Node) ([]string, []string, error) {
-	// Collect staking addresses of non-ephemeral nodes for use in bootstrapping a node
-	nodes, err := ReadNodes(n, false /* includeEphemeral */)
-	if err != nil {
-		return nil, nil, fmt.Errorf("failed to read network's nodes: %w", err)
-	}
-	var (
-		bootstrapIPs = make([]string, 0, len(nodes))
-		bootstrapIDs = make([]string, 0, len(nodes))
-	)
-	for _, node := range nodes {
+	bootstrapIPs := []string{}
+	bootstrapIDs := []string{}
+	for _, node := range n.Nodes {
+		if node.IsEphemeral {
+			// Ephemeral nodes are not guaranteed to stay running
+			continue
+		}
 		if skippedNode != nil && node.NodeID == skippedNode.NodeID {
 			continue
 		}
@@ -940,12 +926,16 @@ func (n *Network) writeNodeFlags(log logging.Logger, node *Node) error {
 	// Only configure the plugin dir with a non-empty value to ensure the use of
 	// the default value (`[datadir]/plugins`) when no plugin dir is configured.
 	processConfig := node.getRuntimeConfig().Process
-	if processConfig != nil && len(processConfig.PluginDir) > 0 {
-		// Ensure the plugin directory exists or the node will fail to start
-		if err := os.MkdirAll(processConfig.PluginDir, perms.ReadWriteExecute); err != nil {
-			return fmt.Errorf("failed to create plugin dir: %w", err)
+	if processConfig != nil {
+		if len(processConfig.PluginDir) > 0 {
+			// Ensure the plugin directory exists or the node will fail to start
+			if err := os.MkdirAll(processConfig.PluginDir, perms.ReadWriteExecute); err != nil {
+				return fmt.Errorf("failed to create plugin dir: %w", err)
+			}
+			flags.SetDefault(config.PluginDirKey, processConfig.PluginDir)
 		}
-		flags.SetDefault(config.PluginDirKey, processConfig.PluginDir)
+
+		flags.SetDefault(config.DataDirKey, node.GetDataDir())
 	}
 
 	// Set the network and tmpnet defaults last to ensure they can be overridden

tests/fixture/tmpnet/network_config.go

@@ -57,13 +57,35 @@ func (n *Network) readNetwork() error {
 	return n.readConfig()
 }
 
-// Read the non-ephemeral nodes associated with the network from disk.
+// Read the nodes associated with the network from disk.
 func (n *Network) readNodes() error {
-	nodes, err := ReadNodes(n, false /* includeEphemeral */)
+	nodes := []*Node{}
+
+	// Node configuration is stored in child directories
+	entries, err := os.ReadDir(n.Dir)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to read dir: %w", err)
 	}
+	for _, entry := range entries {
+		if !entry.IsDir() {
+			continue
+		}
+
+		node := NewNode()
+		dataDir := filepath.Join(n.Dir, entry.Name())
+		err := node.Read(n, dataDir)
+		if errors.Is(err, os.ErrNotExist) {
+			// If no config file exists, assume this is not the path of a node
+			continue
+		} else if err != nil {
+			return err
+		}
+
+		nodes = append(nodes, node)
+	}
+
 	n.Nodes = nodes
+
 	return nil
 }
 

tests/fixture/tmpnet/node.go

@@ -6,19 +6,15 @@ package tmpnet
 import (
 	"context"
 	"encoding/base64"
-	"errors"
 	"fmt"
 	"io"
 	"net"
 	"net/http"
 	"net/netip"
-	"os"
 	"path/filepath"
 	"strings"
 	"time"
 
-	"github.com/spf13/cast"
-
 	"github.com/ava-labs/avalanchego/config"
 	"github.com/ava-labs/avalanchego/ids"
 	"github.com/ava-labs/avalanchego/staking"
@@ -91,17 +87,15 @@ type Node struct {
 }
 
 // Initializes a new node with only the data dir set
-func NewNode(dataDir string) *Node {
+func NewNode() *Node {
 	return &Node{
-		Flags: FlagsMap{
-			config.DataDirKey: dataDir,
-		},
+		Flags: FlagsMap{},
 	}
 }
 
 // Initializes an ephemeral node using the provided config flags
 func NewEphemeralNode(flags FlagsMap) *Node {
-	node := NewNode("")
+	node := NewNode()
 	node.Flags = flags
 	node.IsEphemeral = true
 
@@ -112,7 +106,7 @@ func NewEphemeralNode(flags FlagsMap) *Node {
 func NewNodesOrPanic(count int) []*Node {
 	nodes := make([]*Node, count)
 	for i := range nodes {
-		node := NewNode("")
+		node := NewNode()
 		if err := node.EnsureKeys(); err != nil {
 			panic(err)
 		}
@@ -121,51 +115,6 @@ func NewNodesOrPanic(count int) []*Node {
 	return nodes
 }
 
-// Reads a node's configuration from the specified directory.
-func ReadNode(dataDir string) (*Node, error) {
-	node := NewNode(dataDir)
-	return node, node.Read()
-}
-
-// Reads nodes from the specified network directory.
-func ReadNodes(network *Network, includeEphemeral bool) ([]*Node, error) {
-	nodes := []*Node{}
-
-	// Node configuration is stored in child directories
-	entries, err := os.ReadDir(network.Dir)
-	if err != nil {
-		return nil, fmt.Errorf("failed to read dir: %w", err)
-	}
-	for _, entry := range entries {
-		if !entry.IsDir() {
-			continue
-		}
-
-		nodeDir := filepath.Join(network.Dir, entry.Name())
-		node, err := ReadNode(nodeDir)
-		if errors.Is(err, os.ErrNotExist) {
-			// If no config file exists, assume this is not the path of a node
-			continue
-		} else if err != nil {
-			return nil, err
-		}
-
-		if !includeEphemeral && node.IsEphemeral {
-			continue
-		}
-
-		if err := node.EnsureNodeID(); err != nil {
-			return nil, fmt.Errorf("failed to ensure NodeID: %w", err)
-		}
-
-		node.network = network
-
-		nodes = append(nodes, node)
-	}
-
-	return nodes, nil
-}
-
 // Retrieves the runtime for the node.
 func (n *Node) getRuntime() NodeRuntime {
 	if n.runtime == nil {
@@ -211,7 +160,7 @@ func (n *Node) readState() error {
 }
 
 func (n *Node) GetDataDir() string {
-	return cast.ToString(n.Flags[config.DataDirKey])
+	return filepath.Join(n.network.Dir, n.NodeID.String())
 }
 
 func (n *Node) GetLocalURI(ctx context.Context) (string, func(), error) {

tests/fixture/tmpnet/node_config.go

@@ -17,6 +17,10 @@ import (
 // The Node type is defined in this file node_config.go
 // (reading/writing configuration) and node.go (orchestration).
 
+func getNodeConfigPath(dataDir string) string {
+	return filepath.Join(dataDir, defaultConfigFilename)
+}
+
 // For consumption outside of avalanchego. Needs to be kept exported.
 func (n *Node) GetFlagsPath() string {
 	return filepath.Join(n.GetDataDir(), "flags.json")
@@ -33,12 +37,9 @@ func (n *Node) writeFlags(flags FlagsMap) error {
 	return nil
 }
 
-func (n *Node) getConfigPath() string {
-	return filepath.Join(n.GetDataDir(), defaultConfigFilename)
-}
-
-func (n *Node) readConfig() error {
-	bytes, err := os.ReadFile(n.getConfigPath())
+func (n *Node) readConfig(dataDir string) error {
+	configPath := getNodeConfigPath(dataDir)
+	bytes, err := os.ReadFile(configPath)
 	if err != nil {
 		return fmt.Errorf("failed to read node config: %w", err)
 	}
@@ -64,14 +65,20 @@ func (n *Node) writeConfig() error {
 	if err != nil {
 		return fmt.Errorf("failed to marshal node config: %w", err)
 	}
-	if err := os.WriteFile(n.getConfigPath(), bytes, perms.ReadWrite); err != nil {
+	configPath := getNodeConfigPath(n.GetDataDir())
+	if err := os.WriteFile(configPath, bytes, perms.ReadWrite); err != nil {
 		return fmt.Errorf("failed to write node config: %w", err)
 	}
 	return nil
 }
 
-func (n *Node) Read() error {
-	if err := n.readConfig(); err != nil {
+func (n *Node) Read(network *Network, dataDir string) error {
+	n.network = network
+
+	if err := n.readConfig(dataDir); err != nil {
+		return err
+	}
+	if err := n.EnsureNodeID(); err != nil {
 		return err
 	}
 	return n.readState()