feat: use autocli for comet commands (backport #17389) (#17405)

Co-authored-by: Julien Robert <julien@rbrt.fr>

CHANGELOG.md

@@ -46,6 +46,8 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Improvements
 
+* (cli) [#17389](https://github.com/cosmos/cosmos-sdk/pull/17389) gRPC CometBFT commands have been added under `<aapd> q consensus comet`. CometBFT commands placement in the SDK has been simplified. See the exhaustive list below.
+    * `client/rpc.StatusCommand()` is now at `server.StatusCommand()`
 * (cli) [#17187](https://github.com/cosmos/cosmos-sdk/pull/17187) Do not use `ctx.PrintObjectLegacy` in commands anymore.
     * `<appd> q gov proposer [proposal-id]` now returns a proposal id as int instead of string.
 * (testutil) [#17216](https://github.com/cosmos/cosmos-sdk/issues/17216) Add `DefaultContextWithKeys` to `testutil` package.

client/grpc/cmtservice/autocli.go

@@ -0,0 +1,71 @@
+package cmtservice
+
+import (
+	autocliv1 "cosmossdk.io/api/cosmos/autocli/v1"
+	cmtv1beta1 "cosmossdk.io/api/cosmos/base/tendermint/v1beta1"
+)
+
+var CometBFTAutoCLIDescriptor = &autocliv1.ServiceCommandDescriptor{
+	Service: cmtv1beta1.Service_ServiceDesc.ServiceName,
+	RpcCommandOptions: []*autocliv1.RpcCommandOptions{
+		{
+			RpcMethod: "GetNodeInfo",
+			Use:       "node-info",
+			Short:     "Query the current node info",
+		},
+		{
+			RpcMethod: "GetSyncing",
+			Use:       "syncing",
+			Short:     "Query node syncing status",
+		},
+		{
+			RpcMethod: "GetLatestBlock",
+			Use:       "block-latest",
+			Short:     "Query for the latest committed block",
+		},
+		{
+			RpcMethod:      "GetBlockByHeight",
+			Use:            "block-by-height [height]",
+			Short:          "Query for a committed block by height",
+			Long:           "Query for a specific committed block using the CometBFT RPC `block_by_height` method",
+			PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "height"}},
+		},
+		{
+			RpcMethod: "GetLatestValidatorSet",
+			Use:       "validator-set",
+			Alias:     []string{"validator-set-latest", "comet-validator-set", "cometbft-validator-set", "tendermint-validator-set"},
+			Short:     "Query for the latest validator set",
+		},
+		{
+			RpcMethod:      "GetValidatorSetByHeight",
+			Use:            "validator-set-by-height [height]",
+			Short:          "Query for a validator set by height",
+			PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "height"}},
+		},
+		{
+			RpcMethod: "ABCIQuery",
+			Skip:      true,
+		},
+	},
+}
+
+// NewCometBFTCommands is a fake `appmodule.Module` to be considered as a module
+// and be added in AutoCLI.
+func NewCometBFTCommands() *cometModule { //nolint:revive // fake module and limiting import of core
+	return &cometModule{}
+}
+
+type cometModule struct{}
+
+func (m cometModule) IsOnePerModuleType() {}
+func (m cometModule) IsAppModule()        {}
+
+func (m cometModule) Name() string {
+	return "comet"
+}
+
+func (m cometModule) AutoCLIOptions() *autocliv1.ModuleOptions {
+	return &autocliv1.ModuleOptions{
+		Query: CometBFTAutoCLIDescriptor,
+	}
+}

client/grpc/cmtservice/block.go

@@ -10,7 +10,7 @@ import (
 )
 
 func getBlockHeight(ctx context.Context, clientCtx client.Context) (int64, error) {
-	status, err := getNodeStatus(ctx, clientCtx)
+	status, err := GetNodeStatus(ctx, clientCtx)
 	if err != nil {
 		return 0, err
 	}

client/grpc/cmtservice/service.go

@@ -49,7 +49,7 @@ func NewQueryServer(
 
 // GetSyncing implements ServiceServer.GetSyncing
 func (s queryServer) GetSyncing(ctx context.Context, _ *GetSyncingRequest) (*GetSyncingResponse, error) {
-	status, err := getNodeStatus(ctx, s.clientCtx)
+	status, err := GetNodeStatus(ctx, s.clientCtx)
 	if err != nil {
 		return nil, err
 	}
@@ -189,7 +189,7 @@ func ValidatorsOutput(ctx context.Context, clientCtx client.Context, height *int
 
 // GetNodeInfo implements ServiceServer.GetNodeInfo
 func (s queryServer) GetNodeInfo(ctx context.Context, _ *GetNodeInfoRequest) (*GetNodeInfoResponse, error) {
-	status, err := getNodeStatus(ctx, s.clientCtx)
+	status, err := GetNodeStatus(ctx, s.clientCtx)
 	if err != nil {
 		return nil, err
 	}

client/grpc/cmtservice/status.go

@@ -8,7 +8,8 @@ import (
 	"github.com/cosmos/cosmos-sdk/client"
 )
 
-func getNodeStatus(ctx context.Context, clientCtx client.Context) (*coretypes.ResultStatus, error) {
+// GetNodeStatus returns the status of the node.
+func GetNodeStatus(ctx context.Context, clientCtx client.Context) (*coretypes.ResultStatus, error) {
 	node, err := clientCtx.GetNode()
 	if err != nil {
 		return &coretypes.ResultStatus{}, err

client/grpc/cmtservice/status_test.go

@@ -0,0 +1,30 @@
+package cmtservice_test
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/cosmos/cosmos-sdk/server"
+	clitestutil "github.com/cosmos/cosmos-sdk/testutil/cli"
+	"github.com/cosmos/cosmos-sdk/testutil/network"
+)
+
+func TestStatusCommand(t *testing.T) {
+	cfg, err := network.DefaultConfigWithAppConfig(network.MinimumAppConfig())
+	require.NoError(t, err)
+
+	network, err := network.New(t, t.TempDir(), cfg)
+	require.NoError(t, err)
+	require.NoError(t, network.WaitForNextBlock())
+
+	val0 := network.Validators[0]
+	cmd := server.StatusCommand()
+
+	out, err := clitestutil.ExecTestCLICmd(val0.ClientCtx, cmd, []string{})
+	require.NoError(t, err)
+
+	// Make sure the output has the validator moniker.
+	require.Contains(t, out.String(), fmt.Sprintf("\"moniker\":\"%s\"", val0.Moniker))
+}

client/rpc/rpc_test.go

@@ -11,8 +11,6 @@ import (
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/metadata"
 
-	"github.com/cosmos/cosmos-sdk/client/rpc"
-	clitestutil "github.com/cosmos/cosmos-sdk/testutil/cli"
 	"github.com/cosmos/cosmos-sdk/testutil/network"
 	"github.com/cosmos/cosmos-sdk/testutil/testdata"
 	"github.com/cosmos/cosmos-sdk/types/address"
@@ -44,17 +42,6 @@ func (s *IntegrationTestSuite) TearDownSuite() {
 	s.network.Cleanup()
 }
 
-func (s *IntegrationTestSuite) TestStatusCommand() {
-	val0 := s.network.Validators[0]
-	cmd := rpc.StatusCommand()
-
-	out, err := clitestutil.ExecTestCLICmd(val0.ClientCtx, cmd, []string{})
-	s.Require().NoError(err)
-
-	// Make sure the output has the validator moniker.
-	s.Require().Contains(out.String(), fmt.Sprintf("\"moniker\":\"%s\"", val0.Moniker))
-}
-
 func (s *IntegrationTestSuite) TestCLIQueryConn() {
 	s.T().Skip("data race in comet is causing this to fail")
 	var header metadata.MD

client/v2/README.md

@@ -177,6 +177,16 @@ https://github.com/cosmos/cosmos-sdk/blob/fa4d87ef7e6d87aaccc94c337ffd2fe90fcb7a
 
 If not set to true, `AutoCLI` will not generate commands for the module if there are already commands registered for the module (when `GetTxCmd()` or `GetTxCmd()` are defined).
 
+### Use AutoCLI for non module commands
+
+It is possible to use `AutoCLI` for non module commands. The trick is still to implement the `appmodule.Module` interface and append it to the `appOptions.ModuleOptions` map.
+
+For example, here is how the SDK does it for `cometbft` gRPC commands:
+
+```go reference
+https://github.com/cosmos/cosmos-sdk/blob/julien/autocli-comet/client/grpc/cmtservice/autocli.go#L52-L71
+```
+
 ## Summary
 
 `autocli` let you generate CLI to your Cosmos SDK-based applications without any cobra boilerplate. It allows you to easily generate CLI commands and flags from your protobuf messages, and provides many options for customising the behavior of your CLI application.

client/v2/autocli/flags.go

@@ -0,0 +1,3 @@
+package autocli
+
+var flagNoIndent = "no-indent"

client/v2/autocli/msg.go

@@ -104,6 +104,10 @@ func (b *Builder) BuildMsgMethodCommand(descriptor protoreflect.MethodDescriptor
 	}
 
 	cmd, err := b.buildMethodCommandCommon(descriptor, options, func(cmd *cobra.Command, input protoreflect.Message) error {
+		if noIdent, _ := cmd.Flags().GetBool(flagNoIndent); noIdent {
+			jsonMarshalOptions.Indent = ""
+		}
+
 		bz, err := jsonMarshalOptions.Marshal(input.Interface())
 		if err != nil {
 			return err
@@ -114,6 +118,8 @@ func (b *Builder) BuildMsgMethodCommand(descriptor protoreflect.MethodDescriptor
 
 	if b.AddTxConnFlags != nil {
 		b.AddTxConnFlags(cmd)
+
+		cmd.Flags().BoolP(flagNoIndent, "", false, "Do not indent JSON output")
 	}
 
 	return cmd, err

client/v2/autocli/query.go

@@ -110,6 +110,10 @@ func (b *Builder) BuildQueryMethodCommand(descriptor protoreflect.MethodDescript
 	}
 
 	cmd, err := b.buildMethodCommandCommon(descriptor, options, func(cmd *cobra.Command, input protoreflect.Message) error {
+		if noIdent, _ := cmd.Flags().GetBool(flagNoIndent); noIdent {
+			jsonMarshalOptions.Indent = ""
+		}
+
 		clientConn, err := getClientConn(cmd)
 		if err != nil {
 			return err
@@ -134,6 +138,8 @@ func (b *Builder) BuildQueryMethodCommand(descriptor protoreflect.MethodDescript
 
 	if b.AddQueryConnFlags != nil {
 		b.AddQueryConnFlags(cmd)
+
+		cmd.Flags().BoolP(flagNoIndent, "", false, "Do not indent JSON output")
 	}
 
 	return cmd, nil

client/v2/autocli/testdata/help-deprecated-msg.golden

@@ -37,6 +37,7 @@ Flags:
       --keyring-backend string                                               Select keyring's backend (os|file|kwallet|pass|test|memory) (default "os")
       --keyring-dir string                                                   The client Keyring directory; if omitted, the default 'home' directory will be used
       --ledger                                                               Use a connected Ledger device
+      --no-indent                                                            Do not indent JSON output
       --node string                                                          <host>:<port> to CometBFT rpc interface for this chain (default "tcp://localhost:26657")
       --note string                                                          Note to add a description to the transaction (previously --memo)
       --offline                                                              Offline mode (does not allow any online functionality)

client/v2/autocli/testdata/help-deprecated.golden

@@ -26,6 +26,7 @@ Flags:
       --map-string-coin map[string]cosmos.base.v1beta1.Coin                  
       --map-string-string stringToString                                      (default [])
       --map-string-uint32 stringToUint32                                     
+      --no-indent                                                            Do not indent JSON output
       --node string                                                          <host>:<port> to CometBFT RPC interface for this chain (default "tcp://localhost:26657")
   -o, --output string                                                        Output format (text|json) (default "text")
       --page-count-total                                                     

client/v2/autocli/testdata/help-echo-msg.golden

@@ -41,6 +41,7 @@ Flags:
       --keyring-backend string                                               Select keyring's backend (os|file|kwallet|pass|test|memory) (default "os")
       --keyring-dir string                                                   The client Keyring directory; if omitted, the default 'home' directory will be used
       --ledger                                                               Use a connected Ledger device
+      --no-indent                                                            Do not indent JSON output
       --node string                                                          <host>:<port> to CometBFT rpc interface for this chain (default "tcp://localhost:26657")
       --note string                                                          Note to add a description to the transaction (previously --memo)
       --offline                                                              Offline mode (does not allow any online functionality)

client/v2/autocli/testdata/help-echo.golden

@@ -32,6 +32,7 @@ Flags:
       --map-string-coin map[string]cosmos.base.v1beta1.Coin                  some map of string to coin
       --map-string-string stringToString                                     some map of string to string (default [])
       --map-string-uint32 stringToUint32                                     some map of string to int32
+      --no-indent                                                            Do not indent JSON output
       --node string                                                          <host>:<port> to CometBFT RPC interface for this chain (default "tcp://localhost:26657")
   -o, --output string                                                        Output format (text|json) (default "text")
       --page-count-total                                                     

runtime/autocli.go

@@ -7,33 +7,35 @@ import (
 )
 
 func (m appModule) AutoCLIOptions() *autocliv1.ModuleOptions {
-	return &autocliv1.ModuleOptions{Query: &autocliv1.ServiceCommandDescriptor{
-		Service: appv1alpha1.Query_ServiceDesc.ServiceName,
-		RpcCommandOptions: []*autocliv1.RpcCommandOptions{
-			{
-				RpcMethod: "Config",
-				Short:     "Queries the current app config",
+	return &autocliv1.ModuleOptions{
+		Query: &autocliv1.ServiceCommandDescriptor{
+			Service: appv1alpha1.Query_ServiceDesc.ServiceName,
+			RpcCommandOptions: []*autocliv1.RpcCommandOptions{
+				{
+					RpcMethod: "Config",
+					Short:     "Query the current app config",
+				},
 			},
-		},
-		SubCommands: map[string]*autocliv1.ServiceCommandDescriptor{
-			"autocli": {
-				Service: autocliv1.Query_ServiceDesc.ServiceName,
-				RpcCommandOptions: []*autocliv1.RpcCommandOptions{
-					{
-						RpcMethod: "AppOptions",
-						Short:     "Queries custom autocli options",
+			SubCommands: map[string]*autocliv1.ServiceCommandDescriptor{
+				"autocli": {
+					Service: autocliv1.Query_ServiceDesc.ServiceName,
+					RpcCommandOptions: []*autocliv1.RpcCommandOptions{
+						{
+							RpcMethod: "AppOptions",
+							Short:     "Query the custom autocli options",
+						},
 					},
 				},
-			},
-			"reflection": {
-				Service: reflectionv1.ReflectionService_ServiceDesc.ServiceName,
-				RpcCommandOptions: []*autocliv1.RpcCommandOptions{
-					{
-						RpcMethod: "FileDescriptors",
-						Short:     "Queries the app's protobuf file descriptors",
+				"reflection": {
+					Service: reflectionv1.ReflectionService_ServiceDesc.ServiceName,
+					RpcCommandOptions: []*autocliv1.RpcCommandOptions{
+						{
+							RpcMethod: "FileDescriptors",
+							Short:     "Query the app's protobuf file descriptors",
+						},
 					},
 				},
 			},
 		},
-	}}
+	}
 }