fix: load config defaults if not specified in existing config

contribs/gnodev/go.mod

@@ -11,6 +11,7 @@ require (
 )
 
 require (
+	dario.cat/mergo v1.0.0 // indirect
 	github.com/btcsuite/btcd/btcec/v2 v2.3.2 // indirect
 	github.com/btcsuite/btcd/btcutil v1.1.3 // indirect
 	github.com/cespare/xxhash v1.1.0 // indirect

contribs/gnokeykc/go.mod

@@ -10,6 +10,7 @@ require (
 )
 
 require (
+	dario.cat/mergo v1.0.0 // indirect
 	github.com/alessio/shellescape v1.4.1 // indirect
 	github.com/btcsuite/btcd/btcec/v2 v2.3.2 // indirect
 	github.com/btcsuite/btcd/btcutil v1.1.3 // indirect

gno.land/cmd/gnoland/start.go

@@ -190,7 +190,7 @@ func execStart(c *startCfg, io commands.IO) error {
 		cfg, loadCfgErr = config.LoadConfigFile(c.nodeConfigPath)
 	} else {
 		// Load the default node configuration
-		cfg, loadCfgErr = config.LoadOrMakeConfigWithOptions(dataDir, nil)
+		cfg, loadCfgErr = config.LoadOrMakeConfigWithOptions(dataDir)
 	}
 
 	if loadCfgErr != nil {

go.mod

@@ -40,6 +40,8 @@ require (
 	gopkg.in/yaml.v3 v3.0.1
 )
 
+require dario.cat/mergo v1.0.0
+
 require (
 	github.com/btcsuite/btcd/btcec/v2 v2.3.2
 	github.com/btcsuite/btcd/chaincfg/chainhash v1.0.2 // indirect

misc/loop/go.mod

@@ -8,6 +8,7 @@ require (
 )
 
 require (
+	dario.cat/mergo v1.0.0 // indirect
 	github.com/btcsuite/btcd/btcec/v2 v2.3.2 // indirect
 	github.com/btcsuite/btcd/btcutil v1.1.3 // indirect
 	github.com/cespare/xxhash v1.1.0 // indirect

tm2/pkg/bft/blockchain/reactor_test.go

@@ -6,8 +6,6 @@ import (
 	"testing"
 	"time"
 
-	"github.com/stretchr/testify/assert"
-
 	abci "github.com/gnolang/gno/tm2/pkg/bft/abci/types"
 	cfg "github.com/gnolang/gno/tm2/pkg/bft/config"
 	"github.com/gnolang/gno/tm2/pkg/bft/mempool/mock"
@@ -21,6 +19,7 @@ import (
 	"github.com/gnolang/gno/tm2/pkg/log"
 	"github.com/gnolang/gno/tm2/pkg/p2p"
 	"github.com/gnolang/gno/tm2/pkg/testutils"
+	"github.com/stretchr/testify/assert"
 )
 
 var config *cfg.Config

tm2/pkg/bft/config/config.go

@@ -5,6 +5,7 @@
 	"os"
 	"path/filepath"
 
+	"dario.cat/mergo"
 	abci "github.com/gnolang/gno/tm2/pkg/bft/abci/types"
 	cns "github.com/gnolang/gno/tm2/pkg/bft/consensus/config"
 	mem "github.com/gnolang/gno/tm2/pkg/bft/mempool/config"
@@ -20,7 +21,7 @@
 	// Top level options use an anonymous struct
 	BaseConfig `toml:",squash"`
 
-	// Options for services
+	// Option for services
 	RPC          *rpc.RPCConfig       `toml:"rpc"`
 	P2P          *p2p.P2PConfig       `toml:"p2p"`
 	Mempool      *mem.MempoolConfig   `toml:"mempool"`
@@ -40,37 +41,62 @@
 	}
 }
 
-type ConfigOptions func(cfg *Config)
+type Option func(cfg *Config)
 
 // LoadOrMakeConfigWithOptions loads configuration or saves one
 // made by modifying the default config with override options
-func LoadOrMakeConfigWithOptions(root string, options ConfigOptions) (*Config, error) {
-	var cfg *Config
-
-	configPath := join(root, defaultConfigFilePath)
+func LoadOrMakeConfigWithOptions(root string, opts ...Option) (*Config, error) {
+	// Initialize the config as default
+	var (
+		cfg        = DefaultConfig()
+		configPath = join(root, defaultConfigFilePath)
+	)
+
+	// Check if the config exists
 	if osm.FileExists(configPath) {
-		var loadErr error
-
 		// Load the configuration
-		if cfg, loadErr = LoadConfigFile(configPath); loadErr != nil {
+		loadedCfg, loadErr := LoadConfigFile(configPath)
+		if loadErr != nil {
 			return nil, loadErr
 		}
 
-		cfg.SetRootDir(root)
-		cfg.EnsureDirs()
-	} else {
-		cfg = DefaultConfig()
-		if options != nil {
-			options(cfg)
+		// Merge the loaded config with the default values
+		if err := mergo.Merge(loadedCfg, cfg); err != nil {
+			return nil, err
 		}
-		cfg.SetRootDir(root)
-		cfg.EnsureDirs()
-		WriteConfigFile(configPath, cfg)
 
-		// Validate the configuration
-		if validateErr := cfg.ValidateBasic(); validateErr != nil {
-			return nil, fmt.Errorf("unable to validate config, %w", validateErr)
+		// Set the root directory
+		loadedCfg.SetRootDir(root)
+
+		// Make sure the directories are initialized
+		if err := loadedCfg.EnsureDirs(); err != nil {
+			return nil, err
 		}
+
+		return loadedCfg, nil
+	}
+
+	// Config doesn't exist, create it
+	// from the default one
+	for _, opt := range opts {
+		opt(cfg)
+	}
+
+	cfg.SetRootDir(root)
+
+	// Make sure the directories are initialized
+	if err := cfg.EnsureDirs(); err != nil {
+		return nil, err
+	}
+
+	// Validate the configuration
+	if validateErr := cfg.ValidateBasic(); validateErr != nil {
+		return nil, fmt.Errorf("unable to validate config, %w", validateErr)
+	}
+
+	// Save the config
+	if err := WriteConfigFile(configPath, cfg); err != nil {
+		return nil, err
 	}
 
 	return cfg, nil
@@ -79,7 +105,7 @@
 // TestConfig returns a configuration that can be used for testing
 func TestConfig() *Config {
 	return &Config{
-		BaseConfig:   TestBaseConfig(),
+		BaseConfig:   testBaseConfig(),
 		RPC:          rpc.TestRPCConfig(),
 		P2P:          p2p.TestP2PConfig(),
 		Mempool:      mem.TestMempoolConfig(),
@@ -95,21 +121,27 @@
 	cfg.P2P.RootDir = root
 	cfg.Mempool.RootDir = root
 	cfg.Consensus.RootDir = root
+
 	return cfg
 }
 
 // EnsureDirs ensures default directories in root dir (and root dir).
-func (cfg *Config) EnsureDirs() {
+func (cfg *Config) EnsureDirs() error {
 	rootDir := cfg.BaseConfig.RootDir
+
 	if err := osm.EnsureDir(rootDir, DefaultDirPerm); err != nil {
-		panic(err.Error())
+		return fmt.Errorf("no root directory, %w", err)
 	}
+
 	if err := osm.EnsureDir(filepath.Join(rootDir, defaultConfigDir), DefaultDirPerm); err != nil {
-		panic(err.Error())
+		return fmt.Errorf("no config directory, %w", err)
 	}
+
 	if err := osm.EnsureDir(filepath.Join(rootDir, defaultDataDir), DefaultDirPerm); err != nil {
-		panic(err.Error())
+		return fmt.Errorf("no data directory, %w", err)
 	}
+
+	return nil
 }
 
 // ValidateBasic performs basic validation (checking param bounds, etc.) and
@@ -255,8 +287,8 @@
 	}
 }
 
-// TestBaseConfig returns a base configuration for testing a Tendermint node
-func TestBaseConfig() BaseConfig {
+// testBaseConfig returns a base configuration for testing a Tendermint node
+func testBaseConfig() BaseConfig {
 	cfg := DefaultBaseConfig()
 	cfg.chainID = "tendermint_test"
 	cfg.ProxyApp = "mock://kvstore"

tm2/pkg/bft/config/config_test.go

@@ -0,0 +1,90 @@
+package config
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestConfig_LoadOrMakeConfigWithOptions(t *testing.T) {
+	t.Parallel()
+
+	t.Run("existing configuration", func(t *testing.T) {
+		t.Parallel()
+
+		// Provide an empty directory
+		cfgDir := t.TempDir()
+		cfgPath := join(cfgDir, defaultConfigFilePath)
+
+		// Create a default config
+		cfg := DefaultConfig()
+		cfg.SetRootDir(cfgDir)
+
+		// Make an incremental changes
+		cfg.Moniker = "custom monkier"
+
+		// Make sure the cfg paths are initialized
+		require.NoError(t, cfg.EnsureDirs())
+
+		// Write the config
+		require.NoError(t, WriteConfigFile(cfgPath, cfg))
+
+		// Load the config
+		loadedCfg, loadErr := LoadOrMakeConfigWithOptions(cfgDir)
+		require.NoError(t, loadErr)
+
+		assert.Equal(t, cfg, loadedCfg)
+	})
+
+	t.Run("no existing config", func(t *testing.T) {
+		t.Parallel()
+
+		// Provide an empty directory
+		cfgDir := t.TempDir()
+		cfgPath := join(cfgDir, defaultConfigFilePath)
+
+		cfg, err := LoadOrMakeConfigWithOptions(cfgDir)
+		require.NoError(t, err)
+
+		// Make sure the returned cfg is the default one
+		expectedCfg := DefaultConfig()
+		expectedCfg.SetRootDir(cfgDir)
+
+		assert.Equal(t, expectedCfg, cfg)
+
+		// Make sure the returned config was saved
+		loadedCfg, loadErr := LoadConfigFile(cfgPath)
+		require.NoError(t, loadErr)
+
+		loadedCfg.SetRootDir(cfgDir)
+
+		assert.Equal(t, cfg, loadedCfg)
+	})
+
+	t.Run("no existing config, with options", func(t *testing.T) {
+		t.Parallel()
+
+		monkier := "dummy monkier"
+
+		// Provide an empty directory
+		cfgDir := t.TempDir()
+		cfgPath := join(cfgDir, defaultConfigFilePath)
+
+		cfg, err := LoadOrMakeConfigWithOptions(
+			cfgDir,
+			func(cfg *Config) {
+				cfg.BaseConfig.Moniker = monkier
+			},
+		)
+		require.NoError(t, err)
+
+		// Make sure the returned config was saved
+		loadedCfg, loadErr := LoadConfigFile(cfgPath)
+		require.NoError(t, loadErr)
+
+		loadedCfg.SetRootDir(cfgDir)
+
+		assert.Equal(t, cfg, loadedCfg)
+	})
+}