start using config file instead of cmdline flags

Author: felipemadero

.golangci.yml

@@ -1,14 +1,14 @@
 # https://golangci-lint.run/usage/configuration/
 run:
   timeout: 10m
-  # skip auto-generated files.
-  skip-files:
-    - ".*\\.pb\\.go$"
-    - ".*mock.*"
 
 issues:
   # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
   max-same-issues: 0
+  # skip auto-generated files.
+  exclude-files:
+    - ".*\\.pb\\.go$"
+    - ".*mock.*"
 
 linters:
   # please, do not use `enable-all`: it's deprecated and will be removed soon.

local/helpers.go

@@ -2,6 +2,7 @@ package local
 
 import (
 	"encoding/base64"
+	"encoding/json"
 	"fmt"
 	"math/rand"
 	"net"
@@ -45,40 +46,32 @@ func writeFiles(networkID uint32, genesis []byte, nodeRootDir string, nodeConfig
 	}
 	files := []file{
 		{
-			flagValue: filepath.Join(nodeRootDir, stakingKeyFileName),
-			path:      filepath.Join(nodeRootDir, stakingKeyFileName),
+			flagValue: filepath.Join(nodeRootDir, "staking", stakingKeyFileName),
+			path:      filepath.Join(nodeRootDir, "staking", stakingKeyFileName),
 			pathKey:   config.StakingTLSKeyPathKey,
 			contents:  []byte(nodeConfig.StakingKey),
 		},
 		{
-			flagValue: filepath.Join(nodeRootDir, stakingCertFileName),
-			path:      filepath.Join(nodeRootDir, stakingCertFileName),
+			flagValue: filepath.Join(nodeRootDir, "staking", stakingCertFileName),
+			path:      filepath.Join(nodeRootDir, "staking", stakingCertFileName),
 			pathKey:   config.StakingCertPathKey,
 			contents:  []byte(nodeConfig.StakingCert),
 		},
 		{
-			flagValue: filepath.Join(nodeRootDir, stakingSigningKeyFileName),
-			path:      filepath.Join(nodeRootDir, stakingSigningKeyFileName),
+			flagValue: filepath.Join(nodeRootDir, "staking", stakingSigningKeyFileName),
+			path:      filepath.Join(nodeRootDir, "staking", stakingSigningKeyFileName),
 			pathKey:   config.StakingSignerKeyPathKey,
 			contents:  decodedStakingSigningKey,
 		},
 	}
 	if networkID != constants.LocalID {
 		files = append(files, file{
-			flagValue: filepath.Join(nodeRootDir, genesisFileName),
-			path:      filepath.Join(nodeRootDir, genesisFileName),
+			flagValue: filepath.Join(nodeRootDir, "configs", genesisFileName),
+			path:      filepath.Join(nodeRootDir, "configs", genesisFileName),
 			pathKey:   config.GenesisFileKey,
 			contents:  genesis,
 		})
 	}
-	if len(nodeConfig.ConfigFile) != 0 {
-		files = append(files, file{
-			flagValue: filepath.Join(nodeRootDir, configFileName),
-			path:      filepath.Join(nodeRootDir, configFileName),
-			pathKey:   config.ConfigFileKey,
-			contents:  []byte(nodeConfig.ConfigFile),
-		})
-	}
 	flags := map[string]string{}
 	for _, f := range files {
 		flags[f.pathKey] = f.flagValue
@@ -122,6 +115,31 @@ func writeFiles(networkID uint32, genesis []byte, nodeRootDir string, nodeConfig
 	return flags, nil
 }
 
+func writeConfigFile(nodeRootDir string, nodeConfig *node.Config, flags map[string]string) (string, error) {
+	if len(nodeConfig.ConfigFile) != 0 {
+		newFlags := map[string]interface{}{}
+		if err := json.Unmarshal([]byte(nodeConfig.ConfigFile), &newFlags); err != nil {
+			return "", err
+		}
+		for k, vI := range newFlags {
+			v, ok := vI.(string)
+			if !ok {
+				return "", fmt.Errorf("expected string for key %q, found %T", k, vI)
+			}
+			flags[k] = v
+		}
+	}
+	configFileBytes, err := json.MarshalIndent(flags, "", "    ")
+	if err != nil {
+		return "", err
+	}
+	configFilePath := filepath.Join(nodeRootDir, "configs", configFileName)
+	if err := createFileAndWrite(configFilePath, configFileBytes); err != nil {
+		return "", err
+	}
+	return configFilePath, nil
+}
+
 // getConfigEntry returns an entry in the config file if it is found, otherwise returns the default value
 func getConfigEntry(
 	nodeConfigFlags map[string]interface{},

local/network.go

@@ -1115,10 +1115,14 @@ func (ln *localNetwork) buildArgs(
 	// old avago versions
 	flagsForAvagoVersion := getFlagsForAvagoVersion(nodeSemVer, flags)
 
+	configFilePath, err := writeConfigFile(dataDir, nodeConfig, flagsForAvagoVersion)
+	if err != nil {
+		return buildArgsReturn{}, err
+	}
+
 	// create args
-	args := []string{}
-	for k, v := range flagsForAvagoVersion {
-		args = append(args, fmt.Sprintf("--%s=%s", k, v))
+	args := []string{
+		fmt.Sprintf("--%s=%s", config.ConfigFileKey, configFilePath),
 	}
 
 	return buildArgsReturn{

local/snapshot.go

@@ -15,7 +15,6 @@ import (
 	"github.com/ava-labs/avalanche-network-runner/utils"
 	"github.com/ava-labs/avalanchego/config"
 	"github.com/ava-labs/avalanchego/ids"
-	"github.com/ava-labs/avalanchego/utils/constants"
 	"github.com/ava-labs/avalanchego/utils/logging"
 	dircopy "github.com/otiai10/copy"
 	"golang.org/x/exp/maps"
@@ -125,14 +124,14 @@ func (ln *localNetwork) SaveSnapshot(ctx context.Context, snapshotName string) (
 	}
 	// keep copy of node info that will be removed by stop
 	nodesConfig := map[string]node.Config{}
-	nodesDBDir := map[string]string{}
+	nodesDataDir := map[string]string{}
 	for nodeName, node := range ln.nodes {
 		nodeConfig := node.config
 		// depending on how the user generated the config, different nodes config flags
 		// may point to the same map, so we made a copy to avoid always modifying the same value
 		nodeConfig.Flags = maps.Clone(nodeConfig.Flags)
 		nodesConfig[nodeName] = nodeConfig
-		nodesDBDir[nodeName] = node.GetDbDir()
+		nodesDataDir[nodeName] = node.GetDataDir()
 	}
 	// we change nodeConfig.Flags so as to preserve in snapshot the current node ports
 	for nodeName, nodeConfig := range nodesConfig {
@@ -162,19 +161,17 @@ func (ln *localNetwork) SaveSnapshot(ctx context.Context, snapshotName string) (
 		return "", err
 	}
 	// create main snapshot dirs
-	snapshotDBDir := filepath.Join(snapshotDir, defaultDBSubdir)
-	if err := os.MkdirAll(snapshotDBDir, os.ModePerm); err != nil {
+	if err := os.MkdirAll(snapshotDir, os.ModePerm); err != nil {
 		return "", err
 	}
 	// save db
 	for _, nodeConfig := range nodesConfig {
-		sourceDBDir, ok := nodesDBDir[nodeConfig.Name]
+		sourceDataDir, ok := nodesDataDir[nodeConfig.Name]
 		if !ok {
-			return "", fmt.Errorf("failure obtaining db path for node %q", nodeConfig.Name)
+			return "", fmt.Errorf("failure obtaining datadir path for node %q", nodeConfig.Name)
 		}
-		sourceDBDir = filepath.Join(sourceDBDir, constants.NetworkName(ln.networkID))
-		targetDBDir := filepath.Join(filepath.Join(snapshotDBDir, nodeConfig.Name), constants.NetworkName(ln.networkID))
-		if err := dircopy.Copy(sourceDBDir, targetDBDir); err != nil {
+		targetDataDir := filepath.Join(snapshotDir, nodeConfig.Name)
+		if err := dircopy.Copy(sourceDataDir, targetDataDir); err != nil {
 			return "", fmt.Errorf("failure saving node %q db dir: %w", nodeConfig.Name, err)
 		}
 	}