Add client config

client/config/config.go

@@ -0,0 +1,312 @@
+package config
+
+import (
+	"fmt"
+	"io"
+	"os"
+	"strconv"
+	"errors"
+
+
+	toml "github.com/pelletier/go-toml"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+
+
+
+	"github.com/cosmos/cosmos-sdk/client/flags"
+)
+
+const (
+	flagGet = "get"
+)
+
+/*
+
+Plan:
+
+0. When the user uses the gaiacli config node command to set the node value,
+ the new value is written successfully to the ~/.gaiacli/config/config.toml
+
+1.Create $NODE_DIR/config/client.toml to hold all client-side configuration
+(e.g. keyring-backend, node, chain-id etc...)+
+
+
+2. Enable get functionality of client-side configuration
+
+get examples
+
+config keyring-backend --get //keyring-backend returns value from config file
+config with no args --get //prints default config and exits
+config invalidArg --get // returns error unknown conf key
+config keyring-backend output --get // returns error too many arguments
+
+config without arguments // just print config from config file
+
+
+3.Enable set functionality of client side configuration
+
+config keyring-backend test // sets keyring-backend = test - expected behavior
+
+config keyring-backend with no arguments // outputs default
+config invalidKey invalidValue
+
+
+*/
+
+var ErrWrongNumberOfArgs = fmt.Errorf("wrong number of arguments")
+
+
+type ClientConfig struct{
+
+	ChainID string `mapstructure:"chain-id"`
+	KeyringBackend string `mapstructure:"keyring-backend"`
+	Output string   `mapstructure:"output"`
+	Node string     `mapstructure:"node"`
+	BroadcastMode string   `mapstructure:"broadcast-mode"`
+	Trace bool `mapstructure:"trace"`
+}
+
+func DefaultClientConfig() *ClientConfig {
+	return &ClientConfig{
+		ChainID : "", 
+		KeyringBackend :"os", 
+		Output : "text", 
+		Node: "tcp://localhost:26657", 
+		BroadcastMode : "sync", 
+		Trace : false,
+	}
+}
+
+
+
+// Cmd returns a CLI command to interactively create an application CLI
+// config file.
+func Cmd(defaultCLIHome string) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "config <key> [value]",
+		Short: "Create or query an application CLI configuration file",
+		RunE:  runConfigCmd,
+		Args:  cobra.RangeArgs(0, 2),
+	}
+
+	cmd.Flags().String(flags.FlagHome, defaultCLIHome,
+		"set client's home directory for configuration")
+	cmd.Flags().Bool(flagGet, false,
+		"print configuration value or its default if unset")
+	return cmd
+}
+
+func runConfigCmd(cmd *cobra.Command, args []string) error {
+
+
+	InitConfigTemplate()
+
+	cfgPath, err := ensureConfFile(viper.GetString(flags.FlagHome))
+	if err != nil {
+		return err
+	}
+
+	getAction := viper.GetBool(flagGet)
+	if getAction && len(args) != 1 {
+		return ErrWrongNumberOfArgs
+	}
+
+	cliConfig, err := getClientConfig(cfgPath)
+	if err != nil {
+		return fmt.Errorf("Unable to get client config %v", err)
+	}
+
+
+	switch len(args) {
+	case 0:
+		// print all client config fields to sdt out
+		// TODO implement method to print out all client config fiels
+		fmt.Println(cliConfig.ChainID)
+		fmt.Println(cliConfig.KeyringBackend)
+		fmt.Println(cliConfig.Output)
+		fmt.Println(cliConfig.Node)
+		fmt.Println(cliConfig.BroadcastMode)
+		fmt.Println(cliConfig.Trace)
+
+	case 1:
+		// it's a get  
+		// TODO implement method for get
+		key := args[0]
+		switch key {
+			case "chain-id": fmt.Println(cliConfig.ChainID)
+			case "keyring-backend": fmt.Println(cliConfig.KeyringBackend)
+			case "output": fmt.Println(cliConfig.Output)
+			case "node": fmt.Println(cliConfig.Node)
+			case "broadcast-mode": fmt.Println(cliConfig.BroadcastMode)
+			case "trace": fmt.Println(cliConfig.Trace)
+			default :
+				return errUnknownConfigKey(key)
+		}
+
+	case 2:
+		// it's set
+		// TODO impement method for set
+		// TODO implement setters
+		key, value := args[0], args[1]
+		switch key {
+			case "chain-id": cliConfig.ChainID = value
+			case "keyring-backend": cliConfig.KeyringBackend = value
+			case "output": cliConfig.Output = value
+			case "node": cliConfig.Node = value
+			case "broadcast-mode": cliConfig.BroadcastMode = value
+			case "trace": 
+				boolVal, err := strconv.ParseBool(value)
+				if err != nil {
+					return err
+				}
+				cliConfig.Trace = boolVal
+			default :
+				return errUnknownConfigKey(key)
+		}
+
+	default:
+		// print error
+		return errors.New("Unknown configuration error")
+	}
+
+
+	WriteConfigFile()
+
+
+
+	return nil 
+
+
+
+
+
+
+
+
+}
+
+
+
+/*
+func runConfigCmd(cmd *cobra.Command, args []string) error {
+	cfgFile, err := ensureConfFile(viper.GetString(flags.FlagHome))
+	if err != nil {
+		return err
+	}
+
+	getAction := viper.GetBool(flagGet)
+	if getAction && len(args) != 1 {
+		return fmt.Errorf("wrong number of arguments")
+	}
+
+	// load configuration
+	tree, err := loadConfigFile(cfgFile)
+	if err != nil {
+		return err
+	}
+
+	// print the default config and exit
+	if len(args) == 0 {
+		s, err := tree.ToTomlString()
+		if err != nil {
+			return err
+		}
+		fmt.Print(s)
+		return nil
+	}
+
+	key := args[0]
+
+	// get config value for a given key
+	if getAction {
+		switch key {
+		case "chain-id", "keyring-backend", "output", "node", "broadcast-mode":
+			fmt.Println(tree.Get(key).(string))
+
+		case "trace":
+			fmt.Println(tree.Get(key).(bool))
+
+		default:
+			// do we need to print out default value here in case key is invalid?
+			if defaultValue, ok := configDefaults[key]; ok {
+				fmt.Println(tree.GetDefault(key, defaultValue).(string))
+				return nil
+			}
+
+			return errUnknownConfigKey(key)
+		}
+
+		return nil
+	}
+
+	// if we set value in configuration, the number of arguments must be 2
+	if len(args) != 2 {
+		return ErrWrongNumberOfArgs
+	}
+
+	value := args[1]
+
+	// set config value for a given key
+	switch key {
+	case "chain-id", "keyring-backend", "output", "node", "broadcast-mode":
+		tree.Set(key, value)
+
+	case "trace":
+		boolVal, err := strconv.ParseBool(value)
+		if err != nil {
+			return err
+		}
+
+		tree.Set(key, boolVal)
+
+	default:
+		return errUnknownConfigKey(key)
+	}
+
+	// save configuration to disk
+	if err := saveConfigFile(cfgFile, tree); err != nil {
+		return err
+	}
+
+	fmt.Fprintf(os.Stderr, "configuration saved to %s\n", cfgFile)
+	return nil
+}
+*/
+
+
+/*
+func loadConfigFile(cfgFile string) (*toml.Tree, error) {
+	if _, err := os.Stat(cfgFile); os.IsNotExist(err) {
+		fmt.Fprintf(os.Stderr, "%s does not exist\n", cfgFile)
+		return toml.Load(``)
+	}
+
+	bz, err := ioutil.ReadFile(cfgFile)
+	if err != nil {
+		return nil, err
+	}
+
+	tree, err := toml.LoadBytes(bz)
+	if err != nil {
+		return nil, err
+	}
+
+	return tree, nil
+}
+*/
+
+func saveConfigFile(cfgFile string, tree io.WriterTo) error {
+	fp, err := os.OpenFile(cfgFile, os.O_WRONLY|os.O_TRUNC|os.O_CREATE, 0644)
+	if err != nil {
+		return err
+	}
+	defer fp.Close()
+
+	_, err = tree.WriteTo(fp)
+	return err
+}
+
+func errUnknownConfigKey(key string) error {
+	return fmt.Errorf("unknown configuration key: %q", key)
+}

client/config/config_test.go

@@ -0,0 +1,61 @@
+package config
+
+import (
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/spf13/viper"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/cosmos/cosmos-sdk/client/flags"
+)
+
+// For https://github.com/cosmos/cosmos-sdk/issues/3899
+func Test_runConfigCmdTwiceWithShorterNodeValue(t *testing.T) {
+	// Prepare environment
+	t.Parallel()
+	configHome, cleanup := tmpDir(t)
+	defer cleanup()
+	_ = os.RemoveAll(filepath.Join(configHome, "config"))
+	viper.Set(flags.FlagHome, configHome)
+
+	// Init command config
+	cmd := Cmd(configHome)
+	assert.NotNil(t, cmd)
+
+	err := cmd.RunE(cmd, []string{"node", "tcp://localhost:26657"})
+	assert.Nil(t, err)
+
+	err = cmd.RunE(cmd, []string{"node", "--get"})
+	assert.Nil(t, err)
+
+	err = cmd.RunE(cmd, []string{"node", "tcp://local:26657"})
+	assert.Nil(t, err)
+
+	err = cmd.RunE(cmd, []string{"node", "--get"})
+	assert.Nil(t, err)
+
+	err = cmd.RunE(cmd, nil)
+	assert.Nil(t, err)
+
+	err = cmd.RunE(cmd, []string{"invalidKey", "--get"})
+	require.Equal(t, err, errUnknownConfigKey("invalidKey"))
+
+	err = cmd.RunE(cmd, []string{"invalidArg1"})
+	require.Equal(t, err, ErrWrongNumberOfArgs)
+
+	err = cmd.RunE(cmd, []string{"invalidKey", "invalidValue"})
+	require.Equal(t, err, errUnknownConfigKey("invalidKey"))
+
+	// TODO add testing of pririty environmental variable, flag and file
+
+}
+
+func tmpDir(t *testing.T) (string, func()) {
+	dir, err := ioutil.TempDir("", t.Name()+"_")
+	require.NoError(t, err)
+	return dir, func() { _ = os.RemoveAll(dir) }
+}