Use Context in Command instead of Argument + Util (#6572)

* Use context

* use PersistentPreRunE

* undo

* use init context

* Update types

* update tests

* implement tests

* Update simapp/cmd/simcli/main.go

Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>

* Update simapp/cmd/simcli/main.go

Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>

* Update x/bank/client/cli/tx.go

Co-authored-by: Alessio Treglia <alessio@tendermint.com>

* fix build

Co-authored-by: Alessio Treglia <alessio@tendermint.com>
Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>

client/cmd.go

@@ -11,6 +11,23 @@ import (
 	"github.com/cosmos/cosmos-sdk/client/flags"
 )
 
+type contextKey string
+
+// ClientContextKey defines the context key used to retrieve a client.Context from
+// a command's Context.
+const ClientContextKey = contextKey("client.context")
+
+// SetCmdClientContextHandler is to be used in a command pre-hook execution to
+// read flags that populate a Context and sets that to the command's Context.
+func SetCmdClientContextHandler(clientCtx Context, cmd *cobra.Command) (err error) {
+	clientCtx, err = ReadPersistentCommandFlags(clientCtx, cmd.Flags())
+	if err != nil {
+		return err
+	}
+
+	return SetCmdClientContext(cmd, clientCtx)
+}
+
 // ValidateCmd returns unknown command error or Help display if help flag set
 func ValidateCmd(cmd *cobra.Command, args []string) error {
 	var unknownCmd string
@@ -155,3 +172,27 @@ func ReadTxCommandFlags(clientCtx Context, flagSet *pflag.FlagSet) (Context, err
 
 	return clientCtx, nil
 }
+
+// GetClientContextFromCmd returns a Context from a command or an empty Context
+// if it has not been set.
+func GetClientContextFromCmd(cmd *cobra.Command) Context {
+	if v := cmd.Context().Value(ClientContextKey); v != nil {
+		clientCtxPtr := v.(*Context)
+		return *clientCtxPtr
+	}
+
+	return Context{}
+}
+
+// SetCmdClientContext sets a command's Context value to the provided argument.
+func SetCmdClientContext(cmd *cobra.Command, clientCtx Context) error {
+	v := cmd.Context().Value(ClientContextKey)
+	if v == nil {
+		return errors.New("client context not set")
+	}
+
+	clientCtxPtr := v.(*Context)
+	*clientCtxPtr = clientCtx
+
+	return nil
+}

client/cmd_test.go

@@ -1,12 +1,16 @@
 package client_test
 
 import (
+	"context"
+	"fmt"
+	"io/ioutil"
 	"testing"
 
 	"github.com/spf13/cobra"
 	"github.com/stretchr/testify/require"
 
 	"github.com/cosmos/cosmos-sdk/client"
+	"github.com/cosmos/cosmos-sdk/client/flags"
 )
 
 func TestValidateCmd(t *testing.T) {
@@ -50,3 +54,66 @@ func TestValidateCmd(t *testing.T) {
 		require.Equal(t, tt.wantErr, err != nil, tt.reason)
 	}
 }
+
+func TestSetCmdClientContextHandler(t *testing.T) {
+	initClientCtx := client.Context{}.WithHomeDir("/foo/bar").WithChainID("test-chain")
+
+	newCmd := func() *cobra.Command {
+		c := &cobra.Command{
+			PreRunE: func(cmd *cobra.Command, args []string) error {
+				return client.SetCmdClientContextHandler(initClientCtx, cmd)
+			},
+			RunE: func(cmd *cobra.Command, _ []string) error {
+				clientCtx := client.GetClientContextFromCmd(cmd)
+				_, err := client.ReadTxCommandFlags(clientCtx, cmd.Flags())
+				if err != nil {
+					return err
+				}
+
+				return nil
+			},
+		}
+
+		c.Flags().String(flags.FlagChainID, "", "network chain ID")
+
+		return c
+	}
+
+	testCases := []struct {
+		name            string
+		expectedContext client.Context
+		args            []string
+	}{
+		{
+			"no flags set",
+			initClientCtx,
+			[]string{},
+		},
+		{
+			"flags set",
+			initClientCtx.WithChainID("new-chain-id"),
+			[]string{
+				fmt.Sprintf("--%s=new-chain-id", flags.FlagChainID),
+			},
+		},
+	}
+
+	for _, tc := range testCases {
+		tc := tc
+
+		t.Run(tc.name, func(t *testing.T) {
+			ctx := context.Background()
+			ctx = context.WithValue(ctx, client.ClientContextKey, &client.Context{})
+
+			cmd := newCmd()
+			cmd.SetOut(ioutil.Discard)
+			cmd.SetErr(ioutil.Discard)
+			cmd.SetArgs(tc.args)
+
+			require.NoError(t, cmd.ExecuteContext(ctx))
+
+			clientCtx := client.GetClientContextFromCmd(cmd)
+			require.Equal(t, tc.expectedContext, clientCtx)
+		})
+	}
+}