Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Race condition when testing CLI #2713

Merged
merged 1 commit into from
Jun 12, 2024
Merged

fix: Race condition when testing CLI #2713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 35 additions & 14 deletions cli/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,32 @@ var configFlags = map[string]string{
"no-keyring": "keyring.disabled",
}

// configDefaults contains default values for config entries.
var configDefaults = map[string]any{
"api.address": "127.0.0.1:9181",
"api.allowed-origins": []string{},
"datastore.badger.path": "data",
"datastore.maxtxnretries": 5,
"datastore.store": "badger",
"datastore.badger.valuelogfilesize": 1 << 30,
"net.p2pdisabled": false,
"net.p2paddresses": []string{"/ip4/127.0.0.1/tcp/9171"},
"net.peers": []string{},
"net.pubSubEnabled": true,
"net.relay": false,
"keyring.backend": "file",
"keyring.disabled": false,
"keyring.namespace": "defradb",
"keyring.path": "keys",
"log.caller": false,
"log.colordisabled": false,
"log.format": "text",
"log.level": "info",
"log.output": "stderr",
"log.source": false,
"log.stacktrace": false,
}

// defaultConfig returns a new config with default values.
func defaultConfig() *viper.Viper {
cfg := viper.New()
Expand All @@ -76,20 +102,18 @@ func defaultConfig() *viper.Viper {
cfg.SetConfigName("config")
cfg.SetConfigType("yaml")

cfg.SetDefault("datastore.badger.path", "data")
cfg.SetDefault("net.pubSubEnabled", true)
cfg.SetDefault("net.relay", false)
cfg.SetDefault("log.caller", false)

for key, val := range configDefaults {
cfg.SetDefault(key, val)
}
return cfg
}

// createConfig writes the default config file if one does not exist.
func createConfig(rootdir string) error {
func createConfig(rootdir string, flags *pflag.FlagSet) error {
cfg := defaultConfig()
cfg.AddConfigPath(rootdir)

if err := bindConfigFlags(cfg); err != nil {
if err := bindConfigFlags(cfg, flags); err != nil {
return err
}
// make sure rootdir exists
Expand All @@ -107,7 +131,7 @@ func createConfig(rootdir string) error {
}

// loadConfig returns a new config with values from the config in the given rootdir.
func loadConfig(rootdir string) (*viper.Viper, error) {
func loadConfig(rootdir string, flags *pflag.FlagSet) (*viper.Viper, error) {
cfg := defaultConfig()
cfg.AddConfigPath(rootdir)

Expand All @@ -120,7 +144,7 @@ func loadConfig(rootdir string) (*viper.Viper, error) {
return nil, err
}
// bind cli flags to config keys
if err := bindConfigFlags(cfg); err != nil {
if err := bindConfigFlags(cfg, flags); err != nil {
return nil, err
}

Expand Down Expand Up @@ -149,12 +173,9 @@ func loadConfig(rootdir string) (*viper.Viper, error) {
}

// bindConfigFlags binds the set of cli flags to config values.
func bindConfigFlags(cfg *viper.Viper) error {
func bindConfigFlags(cfg *viper.Viper, flags *pflag.FlagSet) error {
var errs []error
rootFlags.VisitAll(func(f *pflag.Flag) {
errs = append(errs, cfg.BindPFlag(configFlags[f.Name], f))
})
startFlags.VisitAll(func(f *pflag.Flag) {
flags.VisitAll(func(f *pflag.Flag) {
errs = append(errs, cfg.BindPFlag(configFlags[f.Name], f))
})
return errors.Join(errs...)
Expand Down
11 changes: 8 additions & 3 deletions cli/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,30 @@ import (
"path/filepath"
"testing"

"github.com/spf13/pflag"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestCreateConfig(t *testing.T) {
rootdir := t.TempDir()
err := createConfig(rootdir)
flags := pflag.NewFlagSet("test", pflag.ContinueOnError)

err := createConfig(rootdir, flags)
require.NoError(t, err)

// ensure no errors when config already exists
err = createConfig(rootdir)
err = createConfig(rootdir, flags)
require.NoError(t, err)

assert.FileExists(t, filepath.Join(rootdir, "config.yaml"))
}

func TestLoadConfigNotExist(t *testing.T) {
rootdir := t.TempDir()
cfg, err := loadConfig(rootdir)
flags := pflag.NewFlagSet("test", pflag.ContinueOnError)

cfg, err := loadConfig(rootdir, flags)
require.NoError(t, err)

assert.Equal(t, 5, cfg.GetInt("datastore.maxtxnretries"))
Expand Down
92 changes: 42 additions & 50 deletions cli/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,98 +12,90 @@

import (
"github.com/spf13/cobra"
"github.com/spf13/pflag"
)

// rootFlags is a set of persistent flags that are bound to config values.
var rootFlags = pflag.NewFlagSet("root", pflag.ContinueOnError)
func MakeRootCommand() *cobra.Command {
var cmd = &cobra.Command{
SilenceUsage: true,
Use: "defradb",
Short: "DefraDB Edge Database",
Long: `DefraDB is the edge database to power the user-centric future.

func init() {
rootFlags.String(
Start a DefraDB node, interact with a local or remote node, and much more.
`,
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
if err := setContextRootDir(cmd); err != nil {
return err

Check warning on line 28 in cli/root.go

View check run for this annotation

Codecov / codecov/patch

cli/root.go#L28 

Added line #L28 was not covered by tests
}
return setContextConfig(cmd)
},
}
// set default flag values from config
cfg := defaultConfig()
cmd.PersistentFlags().String(
"rootdir",
"",
"Directory for persistent data (default: $HOME/.defradb)",
)
rootFlags.String(
cmd.PersistentFlags().String(
"log-level",
"info",
cfg.GetString(configFlags["log-level"]),
"Log level to use. Options are debug, info, error, fatal",
)
rootFlags.String(
cmd.PersistentFlags().String(
"log-output",
"stderr",
cfg.GetString(configFlags["log-output"]),
"Log output path. Options are stderr or stdout.",
)
rootFlags.String(
cmd.PersistentFlags().String(
"log-format",
"text",
cfg.GetString(configFlags["log-format"]),
"Log format to use. Options are text or json",
)
rootFlags.Bool(
cmd.PersistentFlags().Bool(
"log-stacktrace",
false,
cfg.GetBool(configFlags["log-stacktrace"]),
"Include stacktrace in error and fatal logs",
)
rootFlags.Bool(
cmd.PersistentFlags().Bool(
"log-source",
false,
cfg.GetBool(configFlags["log-source"]),
"Include source location in logs",
)
rootFlags.String(
cmd.PersistentFlags().String(
"log-overrides",
"",
cfg.GetString(configFlags["log-overrides"]),
"Logger config overrides. Format <name>,<key>=<val>,...;<name>,...",
)
rootFlags.Bool(
cmd.PersistentFlags().Bool(
"no-log-color",
false,
cfg.GetBool(configFlags["no-log-color"]),
"Disable colored log output",
)
rootFlags.String(
cmd.PersistentFlags().String(
"url",
"127.0.0.1:9181",
cfg.GetString(configFlags["url"]),
"URL of HTTP endpoint to listen on or connect to",
)
rootFlags.String(
cmd.PersistentFlags().String(
"keyring-namespace",
"defradb",
cfg.GetString(configFlags["keyring-namespace"]),
"Service name to use when using the system backend",
)
rootFlags.String(
cmd.PersistentFlags().String(
"keyring-backend",
"file",
cfg.GetString(configFlags["keyring-backend"]),
"Keyring backend to use. Options are file or system",
)
rootFlags.String(
cmd.PersistentFlags().String(
"keyring-path",
"keys",
cfg.GetString(configFlags["keyring-path"]),
"Path to store encrypted keys when using the file backend",
)
rootFlags.Bool(
cmd.PersistentFlags().Bool(
"no-keyring",
false,
cfg.GetBool(configFlags["no-keyring"]),
"Disable the keyring and generate ephemeral keys",
)
}

func MakeRootCommand() *cobra.Command {
var cmd = &cobra.Command{
SilenceUsage: true,
Use: "defradb",
Short: "DefraDB Edge Database",
Long: `DefraDB is the edge database to power the user-centric future.

Start a DefraDB node, interact with a local or remote node, and much more.
`,
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
if err := setContextRootDir(cmd); err != nil {
return err
}
return setContextConfig(cmd)
},
}

cmd.PersistentFlags().AddFlagSet(rootFlags)

return cmd
}
104 changes: 48 additions & 56 deletions cli/start.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@

"github.com/libp2p/go-libp2p/core/peer"
"github.com/spf13/cobra"
"github.com/spf13/pflag"

"github.com/sourcenetwork/defradb/errors"
"github.com/sourcenetwork/defradb/http"
Expand All @@ -29,57 +28,6 @@
"github.com/sourcenetwork/defradb/node"
)

// startFlags is a set of persistent flags that are bound to config values.
var startFlags = pflag.NewFlagSet("start", pflag.ContinueOnError)

func init() {
startFlags.StringArray(
"peers",
[]string{},
"List of peers to connect to",
)
startFlags.Int(
"max-txn-retries",
5,
"Specify the maximum number of retries per transaction",
)
startFlags.String(
"store",
"badger",
"Specify the datastore to use (supported: badger, memory)",
)
startFlags.Int(
"valuelogfilesize",
1<<30,
"Specify the datastore value log file size (in bytes). In memory size will be 2*valuelogfilesize",
)
startFlags.StringSlice(
"p2paddr",
[]string{"/ip4/127.0.0.1/tcp/9171"},
"Listen addresses for the p2p network (formatted as a libp2p MultiAddr)",
)
startFlags.Bool(
"no-p2p",
false,
"Disable the peer-to-peer network synchronization system",
)
startFlags.StringArray(
"allowed-origins",
[]string{},
"List of origins to allow for CORS requests",
)
startFlags.String(
"pubkeypath",
"",
"Path to the public key for tls",
)
startFlags.String(
"privkeypath",
"",
"Path to the private key for tls",
)
}

func MakeStartCommand() *cobra.Command {
var cmd = &cobra.Command{
Use: "start",
Expand All @@ -91,7 +39,7 @@
return err
}
rootdir := mustGetContextRootDir(cmd)
if err := createConfig(rootdir); err != nil {
if err := createConfig(rootdir, cmd.Flags()); err != nil {

Check warning on line 42 in cli/start.go

View check run for this annotation

Codecov / codecov/patch

cli/start.go#L42 

Added line #L42 was not covered by tests
return err
}
return setContextConfig(cmd)
Expand Down Expand Up @@ -186,8 +134,52 @@
return nil
},
}

cmd.PersistentFlags().AddFlagSet(startFlags)

// set default flag values from config
cfg := defaultConfig()
cmd.PersistentFlags().StringArray(
"peers",
cfg.GetStringSlice(configFlags["peers"]),
"List of peers to connect to",
)
cmd.PersistentFlags().Int(
"max-txn-retries",
cfg.GetInt(configFlags["max-txn-retries"]),
"Specify the maximum number of retries per transaction",
)
cmd.PersistentFlags().String(
"store",
cfg.GetString(configFlags["store"]),
"Specify the datastore to use (supported: badger, memory)",
)
cmd.PersistentFlags().Int(
"valuelogfilesize",
cfg.GetInt(configFlags["valuelogfilesize"]),
"Specify the datastore value log file size (in bytes). In memory size will be 2*valuelogfilesize",
)
cmd.PersistentFlags().StringSlice(
"p2paddr",
cfg.GetStringSlice(configFlags["p2paddr"]),
"Listen addresses for the p2p network (formatted as a libp2p MultiAddr)",
)
cmd.PersistentFlags().Bool(
"no-p2p",
cfg.GetBool(configFlags["no-p2p"]),
"Disable the peer-to-peer network synchronization system",
)
cmd.PersistentFlags().StringArray(
"allowed-origins",
cfg.GetStringSlice(configFlags["allowed-origins"]),
"List of origins to allow for CORS requests",
)
cmd.PersistentFlags().String(
"pubkeypath",
cfg.GetString(configFlags["pubkeypath"]),
"Path to the public key for tls",
)
cmd.PersistentFlags().String(
"privkeypath",
cfg.GetString(configFlags["privkeypath"]),
"Path to the private key for tls",
)
return cmd
}
Loading
Loading