x/bank: convert query CLI commands to use gRPC query client (#6367)
* Convert x/bank query cli methods to use gRPC query client * WIP on x/bank cli query migration * lint * Fix integration tests * Remove Println in favor of updated PrintOutput * Add PrintOutput tests Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
This commit is contained in:
Aaron Craelius
co-authored by
Federico Kunze
Federico Kunze
parent
1c8249e26d
commit
257354dbff
+35
-44
@@ -2,6 +2,7 @@ package client
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
@@ -321,67 +322,57 @@ func (ctx Context) WithAccountRetriever(retriever AccountRetriever) Context {
|
||||
return ctx
|
||||
}
|
||||
|
||||
// Println outputs toPrint to the ctx.Output based on ctx.OutputFormat which is
|
||||
// PrintOutput outputs toPrint to the ctx.Output based on ctx.OutputFormat which is
|
||||
// either text or json. If text, toPrint will be YAML encoded. Otherwise, toPrint
|
||||
// will be JSON encoded using ctx.JSONMarshaler. An error is returned upon failure.
|
||||
func (ctx Context) Println(toPrint interface{}) error {
|
||||
var (
|
||||
out []byte
|
||||
err error
|
||||
)
|
||||
func (ctx Context) PrintOutput(toPrint interface{}) error {
|
||||
// always serialize JSON initially because proto json can't be directly YAML encoded
|
||||
out, err := ctx.JSONMarshaler.MarshalJSON(toPrint)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
switch ctx.OutputFormat {
|
||||
case "text":
|
||||
out, err = yaml.Marshal(&toPrint)
|
||||
|
||||
case "json":
|
||||
out, err = ctx.JSONMarshaler.MarshalJSON(toPrint)
|
||||
if ctx.OutputFormat == "text" {
|
||||
// handle text format by decoding and re-encoding JSON as YAML
|
||||
var j interface{}
|
||||
err = json.Unmarshal(out, &j)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
out, err = yaml.Marshal(j)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
} else if ctx.Indent {
|
||||
// To JSON indent, we re-encode the already encoded JSON given there is no
|
||||
// error. The re-encoded JSON uses the standard library as the initial encoded
|
||||
// JSON should have the correct output produced by ctx.JSONMarshaler.
|
||||
if ctx.Indent && err == nil {
|
||||
out, err = codec.MarshalIndentFromJSON(out)
|
||||
out, err = codec.MarshalIndentFromJSON(out)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
writer := ctx.Output
|
||||
// default to stdout
|
||||
if writer == nil {
|
||||
writer = os.Stdout
|
||||
}
|
||||
|
||||
_, err = writer.Write(out)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
_, err = fmt.Fprintf(ctx.Output, "%s\n", out)
|
||||
return err
|
||||
}
|
||||
|
||||
// PrintOutput prints output while respecting output and indent flags
|
||||
// NOTE: pass in marshalled structs that have been unmarshaled
|
||||
// because this function will panic on marshaling errors.
|
||||
//
|
||||
// TODO: Remove once client-side Protobuf migration has been completed.
|
||||
// ref: https://github.com/cosmos/cosmos-sdk/issues/5864
|
||||
func (ctx Context) PrintOutput(toPrint interface{}) error {
|
||||
var (
|
||||
out []byte
|
||||
err error
|
||||
)
|
||||
|
||||
switch ctx.OutputFormat {
|
||||
case "text":
|
||||
out, err = yaml.Marshal(&toPrint)
|
||||
|
||||
case "json":
|
||||
out, err = ctx.JSONMarshaler.MarshalJSON(toPrint)
|
||||
|
||||
if ctx.Indent {
|
||||
out, err = codec.MarshalIndentFromJSON(out)
|
||||
if ctx.OutputFormat != "text" {
|
||||
// append new-line for formats besides YAML
|
||||
_, err = writer.Write([]byte("\n"))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
fmt.Println(string(out))
|
||||
return nil
|
||||
}
|
||||
|
||||
|
||||
@@ -1,9 +1,14 @@
|
||||
package client_test
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"github.com/cosmos/cosmos-sdk/codec"
|
||||
"github.com/cosmos/cosmos-sdk/codec/testdata"
|
||||
"github.com/cosmos/cosmos-sdk/codec/types"
|
||||
|
||||
"github.com/cosmos/cosmos-sdk/crypto/keyring"
|
||||
sdk "github.com/cosmos/cosmos-sdk/types"
|
||||
|
||||
@@ -76,3 +81,126 @@ func TestMain(m *testing.M) {
|
||||
viper.Set(flags.FlagKeyringBackend, keyring.BackendMemory)
|
||||
os.Exit(m.Run())
|
||||
}
|
||||
|
||||
func TestContext_PrintOutput(t *testing.T) {
|
||||
ctx := client.Context{}
|
||||
|
||||
animal := &testdata.Dog{
|
||||
Size_: "big",
|
||||
Name: "Spot",
|
||||
}
|
||||
any, err := types.NewAnyWithValue(animal)
|
||||
require.NoError(t, err)
|
||||
hasAnimal := &testdata.HasAnimal{
|
||||
Animal: any,
|
||||
X: 10,
|
||||
}
|
||||
|
||||
//
|
||||
// proto
|
||||
//
|
||||
registry := testdata.NewTestInterfaceRegistry()
|
||||
ctx = ctx.WithJSONMarshaler(codec.NewProtoCodec(registry))
|
||||
|
||||
// json
|
||||
buf := &bytes.Buffer{}
|
||||
ctx = ctx.WithOutput(buf)
|
||||
ctx.OutputFormat = "json"
|
||||
ctx.Indent = false
|
||||
err = ctx.PrintOutput(hasAnimal)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t,
|
||||
`{"animal":{"@type":"/cosmos_sdk.codec.v1.Dog","size":"big","name":"Spot"},"x":"10"}
|
||||
`, string(buf.Bytes()))
|
||||
|
||||
// json indent
|
||||
buf = &bytes.Buffer{}
|
||||
ctx = ctx.WithOutput(buf)
|
||||
ctx.OutputFormat = "json"
|
||||
ctx.Indent = true
|
||||
err = ctx.PrintOutput(hasAnimal)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t,
|
||||
`{
|
||||
"animal": {
|
||||
"@type": "/cosmos_sdk.codec.v1.Dog",
|
||||
"name": "Spot",
|
||||
"size": "big"
|
||||
},
|
||||
"x": "10"
|
||||
}
|
||||
`, string(buf.Bytes()))
|
||||
|
||||
// yaml
|
||||
buf = &bytes.Buffer{}
|
||||
ctx = ctx.WithOutput(buf)
|
||||
ctx.OutputFormat = "text"
|
||||
ctx.Indent = false
|
||||
err = ctx.PrintOutput(hasAnimal)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t,
|
||||
`animal:
|
||||
'@type': /cosmos_sdk.codec.v1.Dog
|
||||
name: Spot
|
||||
size: big
|
||||
x: "10"
|
||||
`, string(buf.Bytes()))
|
||||
|
||||
//
|
||||
// amino
|
||||
//
|
||||
amino := testdata.NewTestAmino()
|
||||
ctx = ctx.WithJSONMarshaler(codec.NewAminoCodec(&codec.Codec{Amino: amino}))
|
||||
|
||||
// json
|
||||
buf = &bytes.Buffer{}
|
||||
ctx = ctx.WithOutput(buf)
|
||||
ctx.OutputFormat = "json"
|
||||
ctx.Indent = false
|
||||
err = ctx.PrintOutput(hasAnimal)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t,
|
||||
`{"type":"testdata/HasAnimal","value":{"animal":{"type":"testdata/Dog","value":{"size":"big","name":"Spot"}},"x":"10"}}
|
||||
`, string(buf.Bytes()))
|
||||
|
||||
// json indent
|
||||
buf = &bytes.Buffer{}
|
||||
ctx = ctx.WithOutput(buf)
|
||||
ctx.OutputFormat = "json"
|
||||
ctx.Indent = true
|
||||
err = ctx.PrintOutput(hasAnimal)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t,
|
||||
`{
|
||||
"type": "testdata/HasAnimal",
|
||||
"value": {
|
||||
"animal": {
|
||||
"type": "testdata/Dog",
|
||||
"value": {
|
||||
"name": "Spot",
|
||||
"size": "big"
|
||||
}
|
||||
},
|
||||
"x": "10"
|
||||
}
|
||||
}
|
||||
`, string(buf.Bytes()))
|
||||
|
||||
// yaml
|
||||
buf = &bytes.Buffer{}
|
||||
ctx = ctx.WithOutput(buf)
|
||||
ctx.OutputFormat = "text"
|
||||
ctx.Indent = false
|
||||
err = ctx.PrintOutput(hasAnimal)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t,
|
||||
`type: testdata/HasAnimal
|
||||
value:
|
||||
animal:
|
||||
type: testdata/Dog
|
||||
value:
|
||||
name: Spot
|
||||
size: big
|
||||
x: "10"
|
||||
`, string(buf.Bytes()))
|
||||
}
|
||||
|
||||
+2
-2
@@ -61,7 +61,7 @@ func GenerateTx(clientCtx client.Context, txf Factory, msgs ...sdk.Msg) error {
|
||||
return err
|
||||
}
|
||||
|
||||
return clientCtx.Println(tx.GetTx())
|
||||
return clientCtx.PrintOutput(tx.GetTx())
|
||||
}
|
||||
|
||||
// BroadcastTx attempts to generate, sign and broadcast a transaction with the
|
||||
@@ -125,7 +125,7 @@ func BroadcastTx(clientCtx client.Context, txf Factory, msgs ...sdk.Msg) error {
|
||||
return err
|
||||
}
|
||||
|
||||
return clientCtx.Println(res)
|
||||
return clientCtx.PrintOutput(res)
|
||||
}
|
||||
|
||||
// WriteGeneratedTxResponse writes a generated unsigned transaction to the
|
||||
|
||||
Reference in New Issue
Block a user