R4R: Reorganize CLI command structure. (#2728)

* Reorganize CLI command structure. Fixes #2575
cosmos · Nov 13, 2018 · 12ad39e · 12ad39e
2 parents a4e5d8e + 17c119d
commit 12ad39e
Show file tree

Hide file tree

Showing 11 changed files with 229 additions and 146 deletions.
diff --git a/PENDING.md b/PENDING.md
@@ -5,6 +5,7 @@ BREAKING CHANGES
 * Gaia REST API (`gaiacli advanced rest-server`)
 
 * Gaia CLI  (`gaiacli`)
+  * [cli] [\#2728](https://github.com/cosmos/cosmos-sdk/pull/2728) Seperate `tx` and `query` subcommands by module
   * [cli] [\#2727](https://github.com/cosmos/cosmos-sdk/pull/2727) Fix unbonding command flow
   * [cli] [\#2786](https://github.com/cosmos/cosmos-sdk/pull/2786) Fix redelegation command flow
 

diff --git a/client/config.go b/client/config.go
@@ -3,20 +3,20 @@ package client
 import (
 	"bufio"
 	"fmt"
+	"io/ioutil"
+	"os"
+	"path"
+
 	"github.com/cosmos/cosmos-sdk/types"
 	"github.com/mitchellh/go-homedir"
 	"github.com/pelletier/go-toml"
 	"github.com/spf13/cobra"
-	"io/ioutil"
-	"os"
-	"path"
 )
 
 type cliConfig struct {
 	Home      string `toml:"home"`
 	ChainID   string `toml:"chain_id"`
 	TrustNode bool   `toml:"trust_node"`
-	Encoding  string `toml:"encoding"`
 	Output    string `toml:"output"`
 	Node      string `toml:"node"`
 	Trace     bool   `toml:"trace"`
@@ -41,23 +41,24 @@ func runConfigCmd(cmd *cobra.Command, args []string) error {
 	}
 
 	stdin := BufferStdin()
+
 	gaiaCLIHome, err := handleGaiaCLIHome(home, stdin)
 	if err != nil {
 		return err
 	}
+
 	node, err := handleNode(stdin)
 	if err != nil {
 		return err
 	}
+
 	trustNode, err := handleTrustNode(stdin)
 	if err != nil {
 		return err
 	}
 
-	encoding := "btc"
-	output := "text"
-	var chainID string
-	chainID, err = types.DefaultChainID()
+	chainID, err := types.DefaultChainID()
+
 	if err != nil {
 		fmt.Println("Couldn't populate ChainID, so using an empty one.")
 	}
@@ -66,8 +67,7 @@ func runConfigCmd(cmd *cobra.Command, args []string) error {
 		Home:      gaiaCLIHome,
 		ChainID:   chainID,
 		TrustNode: trustNode,
-		Encoding:  encoding,
-		Output:    output,
+		Output:    "text",
 		Node:      node,
 		Trace:     false,
 	}

diff --git a/client/rpc/root.go b/client/rpc/root.go
@@ -22,15 +22,8 @@ func todoNotImplemented(_ *cobra.Command, _ []string) error {
 	return errors.New("todo: Command not yet implemented")
 }
 
-// AddCommands adds a number of rpc-related subcommands
-func AddCommands(cmd *cobra.Command) {
-	cmd.AddCommand(
-		initClientCommand(),
-		statusCommand(),
-	)
-}
-
-func initClientCommand() *cobra.Command {
+// InitClientCommand initializes client commands
+func InitClientCommand() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "init",
 		Short: "Initialize light client",

diff --git a/client/rpc/status.go b/client/rpc/status.go
@@ -14,7 +14,8 @@ import (
 	ctypes "github.com/tendermint/tendermint/rpc/core/types"
 )
 
-func statusCommand() *cobra.Command {
+// StatusCommand returns the status of the network
+func StatusCommand() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "status",
 		Short: "Query remote node for status",

diff --git a/client/tx/root.go b/client/tx/root.go
@@ -2,20 +2,11 @@ package tx
 
 import (
 	"github.com/gorilla/mux"
-	"github.com/spf13/cobra"
 
 	"github.com/cosmos/cosmos-sdk/client/context"
 	"github.com/cosmos/cosmos-sdk/codec"
 )
 
-// AddCommands adds a number of tx-query related subcommands
-func AddCommands(cmd *cobra.Command, cdc *codec.Codec) {
-	cmd.AddCommand(
-		SearchTxCmd(cdc),
-		QueryTxCmd(cdc),
-	)
-}
-
 // register REST routes
 func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router, cdc *codec.Codec) {
 	r.HandleFunc("/txs/{hash}", QueryTxRequestHandlerFn(cdc, cliCtx)).Methods("GET")

diff --git a/cmd/gaia/cli_test/cli_test.go b/cmd/gaia/cli_test/cli_test.go
@@ -237,7 +237,7 @@ func TestGaiaCLICreateValidator(t *testing.T) {
 	initialPool.BondedTokens = initialPool.BondedTokens.Add(sdk.NewDec(100)) // Delegate tx on GaiaAppGenState
 
 	// create validator
-	cvStr := fmt.Sprintf("gaiacli tx create-validator %v", flags)
+	cvStr := fmt.Sprintf("gaiacli tx stake create-validator %v", flags)
 	cvStr += fmt.Sprintf(" --from=%s", "bar")
 	cvStr += fmt.Sprintf(" --pubkey=%s", barCeshPubKey)
 	cvStr += fmt.Sprintf(" --amount=%v", fmt.Sprintf("2%s", stakeTypes.DefaultBondDenom))
@@ -268,12 +268,12 @@ func TestGaiaCLICreateValidator(t *testing.T) {
 	barAcc = executeGetAccount(t, fmt.Sprintf("gaiacli query account %s %v", barAddr, flags))
 	require.Equal(t, int64(8), barAcc.GetCoins().AmountOf(stakeTypes.DefaultBondDenom).Int64(), "%v", barAcc)
 
-	validator := executeGetValidator(t, fmt.Sprintf("gaiacli query validator %s --output=json %v", sdk.ValAddress(barAddr), flags))
+	validator := executeGetValidator(t, fmt.Sprintf("gaiacli query stake validator %s --output=json %v", sdk.ValAddress(barAddr), flags))
 	require.Equal(t, validator.OperatorAddr, sdk.ValAddress(barAddr))
 	require.True(sdk.DecEq(t, sdk.NewDec(2), validator.Tokens))
 
 	// unbond a single share
-	unbondStr := fmt.Sprintf("gaiacli tx unbond begin %v", flags)
+	unbondStr := fmt.Sprintf("gaiacli tx stake unbond begin %v", flags)
 	unbondStr += fmt.Sprintf(" --from=%s", "bar")
 	unbondStr += fmt.Sprintf(" --validator=%s", sdk.ValAddress(barAddr))
 	unbondStr += fmt.Sprintf(" --shares-amount=%v", "1")
@@ -286,19 +286,19 @@ func TestGaiaCLICreateValidator(t *testing.T) {
 	barAcc = executeGetAccount(t, fmt.Sprintf("gaiacli query account %v %v", barCech, flags))
 	require.Equal(t, int64(9), barAcc.GetCoins().AmountOf(stakeTypes.DefaultBondDenom).Int64(), "%v", barAcc)
 	*/
-	validator = executeGetValidator(t, fmt.Sprintf("gaiacli query validator %s --output=json %v", sdk.ValAddress(barAddr), flags))
+	validator = executeGetValidator(t, fmt.Sprintf("gaiacli query stake validator %s --output=json %v", sdk.ValAddress(barAddr), flags))
 	require.Equal(t, "1.0000000000", validator.Tokens.String())
 
 	validatorUbds := executeGetValidatorUnbondingDelegations(t,
-		fmt.Sprintf("gaiacli query unbonding-delegations-from %s --output=json %v",
+		fmt.Sprintf("gaiacli query stake unbonding-delegations-from %s --output=json %v",
 			sdk.ValAddress(barAddr), flags))
 	require.Len(t, validatorUbds, 1)
 	require.Equal(t, "1", validatorUbds[0].Balance.Amount.String())
 
-	params := executeGetParams(t, fmt.Sprintf("gaiacli query parameters --output=json %v", flags))
+	params := executeGetParams(t, fmt.Sprintf("gaiacli query stake parameters --output=json %v", flags))
 	require.True(t, defaultParams.Equal(params))
 
-	pool := executeGetPool(t, fmt.Sprintf("gaiacli query pool --output=json %v", flags))
+	pool := executeGetPool(t, fmt.Sprintf("gaiacli query stake pool --output=json %v", flags))
 	require.Equal(t, initialPool.BondedTokens, pool.BondedTokens)
 }
 
@@ -318,11 +318,11 @@ func TestGaiaCLISubmitProposal(t *testing.T) {
 	fooAcc := executeGetAccount(t, fmt.Sprintf("gaiacli query account %s %v", fooAddr, flags))
 	require.Equal(t, int64(50), fooAcc.GetCoins().AmountOf(stakeTypes.DefaultBondDenom).Int64())
 
-	proposalsQuery, _ := tests.ExecuteT(t, fmt.Sprintf("gaiacli query proposals %v", flags), "")
+	proposalsQuery, _ := tests.ExecuteT(t, fmt.Sprintf("gaiacli query gov proposals %v", flags), "")
 	require.Equal(t, "No matching proposals found", proposalsQuery)
 
 	// submit a test proposal
-	spStr := fmt.Sprintf("gaiacli tx submit-proposal %v", flags)
+	spStr := fmt.Sprintf("gaiacli tx gov submit-proposal %v", flags)
 	spStr += fmt.Sprintf(" --from=%s", "foo")
 	spStr += fmt.Sprintf(" --deposit=%s", fmt.Sprintf("5%s", stakeTypes.DefaultBondDenom))
 	spStr += fmt.Sprintf(" --type=%s", "Text")
@@ -349,19 +349,19 @@ func TestGaiaCLISubmitProposal(t *testing.T) {
 	fooAcc = executeGetAccount(t, fmt.Sprintf("gaiacli query account %s %v", fooAddr, flags))
 	require.Equal(t, int64(45), fooAcc.GetCoins().AmountOf(stakeTypes.DefaultBondDenom).Int64())
 
-	proposal1 := executeGetProposal(t, fmt.Sprintf("gaiacli query proposal --proposal-id=1 --output=json %v", flags))
+	proposal1 := executeGetProposal(t, fmt.Sprintf("gaiacli query gov proposal --proposal-id=1 --output=json %v", flags))
 	require.Equal(t, uint64(1), proposal1.GetProposalID())
 	require.Equal(t, gov.StatusDepositPeriod, proposal1.GetStatus())
 
-	proposalsQuery, _ = tests.ExecuteT(t, fmt.Sprintf("gaiacli query proposals %v", flags), "")
+	proposalsQuery, _ = tests.ExecuteT(t, fmt.Sprintf("gaiacli query gov proposals %v", flags), "")
 	require.Equal(t, "  1 - Test", proposalsQuery)
 
 	deposit := executeGetDeposit(t,
-		fmt.Sprintf("gaiacli query deposit --proposal-id=1 --depositer=%s --output=json %v",
+		fmt.Sprintf("gaiacli query gov deposit --proposal-id=1 --depositer=%s --output=json %v",
 			fooAddr, flags))
 	require.Equal(t, int64(5), deposit.Amount.AmountOf(stakeTypes.DefaultBondDenom).Int64())
 
-	depositStr := fmt.Sprintf("gaiacli tx deposit %v", flags)
+	depositStr := fmt.Sprintf("gaiacli tx gov deposit %v", flags)
 	depositStr += fmt.Sprintf(" --from=%s", "foo")
 	depositStr += fmt.Sprintf(" --deposit=%s", fmt.Sprintf("10%s", stakeTypes.DefaultBondDenom))
 	depositStr += fmt.Sprintf(" --proposal-id=%s", "1")
@@ -381,22 +381,23 @@ func TestGaiaCLISubmitProposal(t *testing.T) {
 
 	// test query deposit
 	deposits := executeGetDeposits(t,
-		fmt.Sprintf("gaiacli query deposits --proposal-id=1 --output=json %v", flags))
+		fmt.Sprintf("gaiacli query gov deposits --proposal-id=1 --output=json %v", flags))
 	require.Len(t, deposits, 1)
 	require.Equal(t, int64(15), deposits[0].Amount.AmountOf(stakeTypes.DefaultBondDenom).Int64())
 
 	deposit = executeGetDeposit(t,
-		fmt.Sprintf("gaiacli query deposit --proposal-id=1 --depositer=%s --output=json %v",
+		fmt.Sprintf("gaiacli query gov deposit --proposal-id=1 --depositer=%s --output=json %v",
 			fooAddr, flags))
 	require.Equal(t, int64(15), deposit.Amount.AmountOf(stakeTypes.DefaultBondDenom).Int64())
 
 	fooAcc = executeGetAccount(t, fmt.Sprintf("gaiacli query account %s %v", fooAddr, flags))
+
 	require.Equal(t, int64(35), fooAcc.GetCoins().AmountOf(stakeTypes.DefaultBondDenom).Int64())
-	proposal1 = executeGetProposal(t, fmt.Sprintf("gaiacli query proposal --proposal-id=1 --output=json %v", flags))
+	proposal1 = executeGetProposal(t, fmt.Sprintf("gaiacli query gov proposal --proposal-id=1 --output=json %v", flags))
 	require.Equal(t, uint64(1), proposal1.GetProposalID())
 	require.Equal(t, gov.StatusVotingPeriod, proposal1.GetStatus())
 
-	voteStr := fmt.Sprintf("gaiacli tx vote %v", flags)
+	voteStr := fmt.Sprintf("gaiacli tx gov vote %v", flags)
 	voteStr += fmt.Sprintf(" --from=%s", "foo")
 	voteStr += fmt.Sprintf(" --proposal-id=%s", "1")
 	voteStr += fmt.Sprintf(" --option=%s", "Yes")
@@ -414,23 +415,23 @@ func TestGaiaCLISubmitProposal(t *testing.T) {
 	executeWrite(t, voteStr, app.DefaultKeyPass)
 	tests.WaitForNextNBlocksTM(2, port)
 
-	vote := executeGetVote(t, fmt.Sprintf("gaiacli query vote --proposal-id=1 --voter=%s --output=json %v", fooAddr, flags))
+	vote := executeGetVote(t, fmt.Sprintf("gaiacli query gov vote --proposal-id=1 --voter=%s --output=json %v", fooAddr, flags))
 	require.Equal(t, uint64(1), vote.ProposalID)
 	require.Equal(t, gov.OptionYes, vote.Option)
 
-	votes := executeGetVotes(t, fmt.Sprintf("gaiacli query votes --proposal-id=1 --output=json %v", flags))
+	votes := executeGetVotes(t, fmt.Sprintf("gaiacli query gov votes --proposal-id=1 --output=json %v", flags))
 	require.Len(t, votes, 1)
 	require.Equal(t, uint64(1), votes[0].ProposalID)
 	require.Equal(t, gov.OptionYes, votes[0].Option)
 
-	proposalsQuery, _ = tests.ExecuteT(t, fmt.Sprintf("gaiacli query proposals --status=DepositPeriod %v", flags), "")
+	proposalsQuery, _ = tests.ExecuteT(t, fmt.Sprintf("gaiacli query gov proposals --status=DepositPeriod %v", flags), "")
 	require.Equal(t, "No matching proposals found", proposalsQuery)
 
-	proposalsQuery, _ = tests.ExecuteT(t, fmt.Sprintf("gaiacli query proposals --status=VotingPeriod %v", flags), "")
+	proposalsQuery, _ = tests.ExecuteT(t, fmt.Sprintf("gaiacli query gov proposals --status=VotingPeriod %v", flags), "")
 	require.Equal(t, "  1 - Test", proposalsQuery)
 
 	// submit a second test proposal
-	spStr = fmt.Sprintf("gaiacli tx submit-proposal %v", flags)
+	spStr = fmt.Sprintf("gaiacli tx gov submit-proposal %v", flags)
 	spStr += fmt.Sprintf(" --from=%s", "foo")
 	spStr += fmt.Sprintf(" --deposit=%s", fmt.Sprintf("5%s", stakeTypes.DefaultBondDenom))
 	spStr += fmt.Sprintf(" --type=%s", "Text")
@@ -440,7 +441,7 @@ func TestGaiaCLISubmitProposal(t *testing.T) {
 	executeWrite(t, spStr, app.DefaultKeyPass)
 	tests.WaitForNextNBlocksTM(2, port)
 
-	proposalsQuery, _ = tests.ExecuteT(t, fmt.Sprintf("gaiacli query proposals --limit=1 %v", flags), "")
+	proposalsQuery, _ = tests.ExecuteT(t, fmt.Sprintf("gaiacli query gov proposals --limit=1 %v", flags), "")
 	require.Equal(t, "  2 - Apples", proposalsQuery)
 }
 
@@ -553,7 +554,6 @@ func TestGaiaCLIConfig(t *testing.T) {
 	config, err := ioutil.ReadFile(path.Join(gaiacliHome, "config", "config.toml"))
 	require.NoError(t, err)
 	expectedConfig := fmt.Sprintf(`chain_id = "%s"
-encoding = "btc"
 home = "%s"
 node = "%s"
 output = "text"
@@ -572,7 +572,6 @@ trust_node = true
 
 	// ensure it works without an initialized gaiad state
 	expectedConfig = fmt.Sprintf(`chain_id = ""
-encoding = "btc"
 home = "%s"
 node = "%s"
 output = "text"