[tmpnet] Switch FlagsMap from map[string]any to map[string]string (#3884)

Author: maru-ava

tests/antithesis/compose.go

@@ -8,7 +8,6 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
-	"strconv"
 
 	"github.com/compose-spec/compose-go/types"
 	"gopkg.in/yaml.v3"
@@ -97,10 +96,7 @@ func initComposeConfig(
 	targetPath string,
 ) error {
 	// Generate a compose project for the specified network
-	project, err := newComposeProject(network, nodeImageName, workloadImageName)
-	if err != nil {
-		return fmt.Errorf("failed to create compose project: %w", err)
-	}
+	project := newComposeProject(network, nodeImageName, workloadImageName)
 
 	absPath, err := filepath.Abs(targetPath)
 	if err != nil {
@@ -135,7 +131,7 @@ func initComposeConfig(
 
 // Create a new docker compose project for an antithesis test setup
 // for the provided network configuration.
-func newComposeProject(network *tmpnet.Network, nodeImageName string, workloadImageName string) (*types.Project, error) {
+func newComposeProject(network *tmpnet.Network, nodeImageName string, workloadImageName string) *types.Project {
 	networkName := "avalanche-testnet"
 	baseNetworkAddress := "10.0.20"
 
@@ -148,18 +144,9 @@ func newComposeProject(network *tmpnet.Network, nodeImageName string, workloadIm
 	for i, node := range network.Nodes {
 		address := fmt.Sprintf("%s.%d", baseNetworkAddress, 3+i)
 
-		tlsKey, err := node.Flags.GetStringVal(config.StakingTLSKeyContentKey)
-		if err != nil {
-			return nil, err
-		}
-		tlsCert, err := node.Flags.GetStringVal(config.StakingCertContentKey)
-		if err != nil {
-			return nil, err
-		}
-		signerKey, err := node.Flags.GetStringVal(config.StakingSignerKeyContentKey)
-		if err != nil {
-			return nil, err
-		}
+		tlsKey := node.Flags[config.StakingTLSKeyContentKey]
+		tlsCert := node.Flags[config.StakingCertContentKey]
+		signerKey := node.Flags[config.StakingSignerKeyContentKey]
 
 		env := types.Mapping{
 			config.NetworkNameKey:             constants.LocalName,
@@ -175,14 +162,7 @@ func newComposeProject(network *tmpnet.Network, nodeImageName string, workloadIm
 
 		// Apply configuration appropriate to a test network
 		for k, v := range tmpnet.DefaultTestFlags() {
-			switch value := v.(type) {
-			case string:
-				env[k] = value
-			case bool:
-				env[k] = strconv.FormatBool(value)
-			default:
-				return nil, fmt.Errorf("unable to convert unsupported type %T to string", v)
-			}
+			env[k] = v
 		}
 
 		serviceName := getServiceName(i)
@@ -195,10 +175,7 @@ func newComposeProject(network *tmpnet.Network, nodeImageName string, workloadIm
 			},
 		}
 
-		trackSubnets, err := node.Flags.GetStringVal(config.TrackSubnetsKey)
-		if err != nil {
-			return nil, err
-		}
+		trackSubnets := node.Flags[config.TrackSubnetsKey]
 		if len(trackSubnets) > 0 {
 			env[config.TrackSubnetsKey] = trackSubnets
 			if i == bootstrapIndex {
@@ -282,7 +259,7 @@ func newComposeProject(network *tmpnet.Network, nodeImageName string, workloadIm
 			},
 		},
 		Services: services,
-	}, nil
+	}
 }
 
 // Convert a mapping of avalanche config keys to a mapping of env vars

tests/e2e/p/interchain_workflow.go

@@ -8,7 +8,6 @@ import (
 	"time"
 
 	"github.com/onsi/ginkgo/v2"
-	"github.com/spf13/cast"
 	"github.com/stretchr/testify/require"
 
 	"github.com/ava-labs/avalanchego/api/info"
@@ -44,8 +43,7 @@ var _ = e2e.DescribePChain("[Interchain Workflow]", ginkgo.Label(e2e.UsesCChainL
 		)
 
 		tc.By("checking that the network has a compatible minimum stake duration", func() {
-			minStakeDuration := cast.ToDuration(network.DefaultFlags[config.MinStakeDurationKey])
-			require.Equal(tmpnet.DefaultMinStakeDuration, minStakeDuration)
+			require.Equal(tmpnet.DefaultMinStakeDuration, network.DefaultFlags[config.MinStakeDurationKey])
 		})
 
 		tc.By("creating wallet with a funded key to send from and recipient key to deliver to")

tests/e2e/p/staking_rewards.go

@@ -8,7 +8,6 @@ import (
 
 	"github.com/mitchellh/mapstructure"
 	"github.com/onsi/ginkgo/v2"
-	"github.com/spf13/cast"
 	"github.com/stretchr/testify/require"
 	"go.uber.org/zap"
 
@@ -50,8 +49,7 @@ var _ = ginkgo.Describe("[Staking Rewards]", func() {
 		)
 
 		tc.By("checking that the network has a compatible minimum stake duration", func() {
-			minStakeDuration := cast.ToDuration(network.DefaultFlags[config.MinStakeDurationKey])
-			require.Equal(tmpnet.DefaultMinStakeDuration, minStakeDuration)
+			require.Equal(tmpnet.DefaultMinStakeDuration, network.DefaultFlags[config.MinStakeDurationKey])
 		})
 
 		tc.By("adding alpha node, whose uptime should result in a staking reward")

tests/fixture/subnet/xsvm.go

@@ -33,7 +33,7 @@ func NewXSVMOrPanic(name string, key *secp256k1.PrivateKey, nodes ...*tmpnet.Nod
 
 	return &tmpnet.Subnet{
 		Name: name,
-		Config: tmpnet.FlagsMap{
+		Config: tmpnet.ConfigMap{
 			// Reducing this from the 1s default speeds up tx acceptance
 			"proposerMinBlockDelay": 0,
 		},

tests/fixture/tmpnet/README.md

@@ -69,7 +69,7 @@ the following non-test files:
 | 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                          |
+| flagsmap.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                    |

tests/fixture/tmpnet/check_monitoring.go

@@ -273,10 +273,7 @@ func getSelectors(networkUUID string) (string, error) {
 	selectors := []string{}
 	githubLabels := githubLabelsFromEnv()
 	for label := range githubLabels {
-		value, err := githubLabels.GetStringVal(label)
-		if err != nil {
-			return "", err
-		}
+		value := githubLabels[label]
 		if len(value) == 0 {
 			continue
 		}

tests/fixture/tmpnet/defaults.go

@@ -30,7 +30,7 @@ const (
 	DefaultPreFundedKeyCount = 50
 
 	// A short minimum stake duration enables testing of staking logic.
-	DefaultMinStakeDuration = time.Second
+	DefaultMinStakeDuration = "1s"
 
 	defaultConfigFilename = "config.json"
 )
@@ -41,8 +41,8 @@ func DefaultTestFlags() FlagsMap {
 		config.NetworkPeerListPullGossipFreqKey: "250ms",
 		config.NetworkMaxReconnectDelayKey:      "1s",
 		config.HealthCheckFreqKey:               "2s",
-		config.AdminAPIEnabledKey:               true,
-		config.IndexEnabledKey:                  true,
+		config.AdminAPIEnabledKey:               "true",
+		config.IndexEnabledKey:                  "true",
 	}
 }
 
@@ -60,7 +60,7 @@ func DefaultTmpnetFlags() FlagsMap {
 		config.LogDisplayLevelKey: logging.Off.String(), // Display logging not needed since nodes run headless
 		config.LogLevelKey:        logging.Debug.String(),
 		// Specific to e2e testing
-		config.ProposerVMUseCurrentHeightKey: true,
+		config.ProposerVMUseCurrentHeightKey: "true",
 		// Reducing this from the 1s default speeds up tx acceptance
 		config.ProposerVMMinBlockDelayKey: "0s",
 	}
@@ -69,14 +69,14 @@ func DefaultTmpnetFlags() FlagsMap {
 }
 
 // A set of chain configurations appropriate for testing.
-func DefaultChainConfigs() map[string]FlagsMap {
-	return map[string]FlagsMap{
+func DefaultChainConfigs() map[string]ConfigMap {
+	return map[string]ConfigMap{
 		// Supply only non-default configuration to ensure that default
 		// values will be used. Available C-Chain configuration options are
 		// defined in the `github.com/ava-labs/coreth/evm` package.
 		"C": {
 			"warp-api-enabled": true,
-			"log-level":        "trace",
+			"log-level":        logging.Trace.String(),
 		},
 	}
 }

tests/fixture/tmpnet/flags.go renamed to tests/fixture/tmpnet/flagsmap.go

@@ -8,14 +8,12 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/spf13/cast"
-
 	"github.com/ava-labs/avalanchego/utils/perms"
 )
 
 // Defines a mapping of flag keys to values intended to be supplied to
 // an invocation of an AvalancheGo node.
-type FlagsMap map[string]interface{}
+type FlagsMap map[string]string
 
 // Utility function simplifying construction of a FlagsMap from a file.
 func ReadFlagsMap(path string, description string) (FlagsMap, error) {
@@ -32,7 +30,7 @@ func ReadFlagsMap(path string, description string) (FlagsMap, error) {
 
 // SetDefault ensures the effectiveness of a flag override by only
 // setting a value supplied whose key is not already explicitly set.
-func (f FlagsMap) SetDefault(key string, value any) {
+func (f FlagsMap) SetDefault(key string, value string) {
 	if _, ok := f[key]; !ok {
 		f[key] = value
 	}
@@ -47,34 +45,6 @@ func (f FlagsMap) SetDefaults(defaults FlagsMap) {
 	}
 }
 
-// GetStringVal simplifies retrieving a map value as a string.
-func (f FlagsMap) GetStringVal(key string) (string, error) {
-	rawVal, ok := f[key]
-	if !ok {
-		return "", nil
-	}
-
-	val, err := cast.ToStringE(rawVal)
-	if err != nil {
-		return "", fmt.Errorf("failed to cast value for %q: %w", key, err)
-	}
-	return val, nil
-}
-
-// GetBoolVal simplifies retrieving a map value as a bool.
-func (f FlagsMap) GetBoolVal(key string, defaultVal bool) (bool, error) {
-	rawVal, ok := f[key]
-	if !ok {
-		return defaultVal, nil
-	}
-
-	val, err := cast.ToBoolE(rawVal)
-	if err != nil {
-		return false, fmt.Errorf("failed to cast value for %q: %w", key, err)
-	}
-	return val, nil
-}
-
 // Write simplifies writing a FlagsMap to the provided path. The
 // description is used in error messages.
 func (f FlagsMap) Write(path string, description string) error {

tests/fixture/tmpnet/network.go

@@ -79,6 +79,10 @@ func init() {
 	}
 }
 
+// ConfigMap enables defining configuration in a format appropriate
+// for round-tripping through JSON back to golang structs.
+type ConfigMap map[string]any
+
 // Collects the configuration for running a temporary avalanchego network
 type Network struct {
 	// Uniquely identifies the temporary network for metrics
@@ -107,10 +111,10 @@ type Network struct {
 	Genesis *genesis.UnparsedConfig
 
 	// Configuration for primary subnets
-	PrimarySubnetConfig FlagsMap
+	PrimarySubnetConfig ConfigMap
 
 	// Configuration for primary network chains (P, X, C)
-	PrimaryChainConfigs map[string]FlagsMap
+	PrimaryChainConfigs map[string]ConfigMap
 
 	// Default configuration to use when creating new nodes
 	DefaultFlags         FlagsMap
@@ -229,14 +233,19 @@ func (n *Network) EnsureDefaultConfig(log logging.Logger) error {
 
 	// Ensure primary chains are configured
 	if n.PrimaryChainConfigs == nil {
-		n.PrimaryChainConfigs = map[string]FlagsMap{}
+		n.PrimaryChainConfigs = map[string]ConfigMap{}
 	}
 	defaultChainConfigs := DefaultChainConfigs()
-	for alias, chainConfig := range defaultChainConfigs {
+	for alias, defaultChainConfig := range defaultChainConfigs {
 		if _, ok := n.PrimaryChainConfigs[alias]; !ok {
-			n.PrimaryChainConfigs[alias] = FlagsMap{}
+			n.PrimaryChainConfigs[alias] = ConfigMap{}
+		}
+		primaryChainConfig := n.PrimaryChainConfigs[alias]
+		for key, value := range defaultChainConfig {
+			if _, ok := primaryChainConfig[key]; !ok {
+				primaryChainConfig[key] = value
+			}
 		}
-		n.PrimaryChainConfigs[alias].SetDefaults(chainConfig)
 	}
 
 	return nil
@@ -377,8 +386,8 @@ func (n *Network) Bootstrap(ctx context.Context, log logging.Logger) error {
 	// The node that will be used to create subnets and bootstrap the network
 	bootstrapNode := n.Nodes[0]
 
-	// Whether sybil protection will need to be re-enabled after subnet creation
-	reEnableSybilProtection := false
+	// An existing sybil protection value that may need to be restored after subnet creation
+	var existingSybilProtectionValue *string
 
 	if len(n.Nodes) > 1 {
 		// Reduce the cost of subnet creation for a network of multiple nodes by
@@ -389,14 +398,11 @@ func (n *Network) Bootstrap(ctx context.Context, log logging.Logger) error {
 		log.Info("starting a single-node network with sybil protection disabled for quicker subnet creation")
 
 		// If sybil protection is enabled, it should be re-enabled before the node is used to bootstrap the other nodes
-		var err error
-		reEnableSybilProtection, err = bootstrapNode.Flags.GetBoolVal(config.SybilProtectionEnabledKey, true)
-		if err != nil {
-			return fmt.Errorf("failed to read sybil protection flag: %w", err)
+		if value, ok := bootstrapNode.Flags[config.SybilProtectionEnabledKey]; ok {
+			existingSybilProtectionValue = &value
 		}
-
 		// Ensure sybil protection is disabled for the bootstrap node.
-		bootstrapNode.Flags[config.SybilProtectionEnabledKey] = false
+		bootstrapNode.Flags[config.SybilProtectionEnabledKey] = "false"
 	}
 
 	if err := n.StartNodes(ctx, log, bootstrapNode); err != nil {
@@ -413,11 +419,17 @@ func (n *Network) Bootstrap(ctx context.Context, log logging.Logger) error {
 		return err
 	}
 
-	if reEnableSybilProtection {
+	if existingSybilProtectionValue == nil {
 		log.Info("re-enabling sybil protection",
 			zap.Stringer("nodeID", bootstrapNode.NodeID),
 		)
 		delete(bootstrapNode.Flags, config.SybilProtectionEnabledKey)
+	} else {
+		log.Info("restoring previous sybil protection value",
+			zap.Stringer("nodeID", bootstrapNode.NodeID),
+			zap.String("sybilProtectionEnabled", *existingSybilProtectionValue),
+		)
+		bootstrapNode.Flags[config.SybilProtectionEnabledKey] = *existingSybilProtectionValue
 	}
 
 	log.Info("restarting bootstrap node",
@@ -640,10 +652,7 @@ func (n *Network) CreateSubnets(ctx context.Context, log logging.Logger, apiURI
 
 	reconfiguredNodes := []*Node{}
 	for _, node := range n.Nodes {
-		existingTrackedSubnets, err := node.Flags.GetStringVal(config.TrackSubnetsKey)
-		if err != nil {
-			return err
-		}
+		existingTrackedSubnets := node.Flags[config.TrackSubnetsKey]
 		trackedSubnets := n.TrackedSubnetsForNode(node.NodeID)
 		if existingTrackedSubnets == trackedSubnets {
 			continue
@@ -801,7 +810,7 @@ func (n *Network) GetGenesisFileContent() (string, error) {
 // GetSubnetConfigContent returns the base64-encoded and
 // JSON-marshaled map of subnetID to subnet configuration.
 func (n *Network) GetSubnetConfigContent() (string, error) {
-	subnetConfigs := map[ids.ID]FlagsMap{}
+	subnetConfigs := map[ids.ID]ConfigMap{}
 
 	if len(n.PrimarySubnetConfig) > 0 {
 		subnetConfigs[constants.PrimaryNetworkID] = n.PrimarySubnetConfig
@@ -894,7 +903,7 @@ func (n *Network) writeNodeFlags(log logging.Logger, node *Node) error {
 		isSingleNodeNetwork := (len(n.Nodes) == 1 && len(n.Genesis.InitialStakers) == 1)
 		if isSingleNodeNetwork {
 			log.Info("defaulting to sybil protection disabled to enable a single-node network to start")
-			flags.SetDefault(config.SybilProtectionEnabledKey, false)
+			flags.SetDefault(config.SybilProtectionEnabledKey, "false")
 		}
 	}
 

tests/fixture/tmpnet/network_config.go

@@ -152,8 +152,8 @@ func (n *Network) readConfig() error {
 type serializedNetworkConfig struct {
 	UUID                 string                  `json:"uuid,omitempty"`
 	Owner                string                  `json:"owner,omitempty"`
-	PrimarySubnetConfig  FlagsMap                `json:"primarySubnetConfig,omitempty"`
-	PrimaryChainConfigs  map[string]FlagsMap     `json:"primaryChainConfigs,omitempty"`
+	PrimarySubnetConfig  ConfigMap               `json:"primarySubnetConfig,omitempty"`
+	PrimaryChainConfigs  map[string]ConfigMap    `json:"primaryChainConfigs,omitempty"`
 	DefaultFlags         FlagsMap                `json:"defaultFlags,omitempty"`
 	DefaultRuntimeConfig NodeRuntimeConfig       `json:"defaultRuntimeConfig,omitempty"`
 	PreFundedKeys        []*secp256k1.PrivateKey `json:"preFundedKeys,omitempty"`