Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

x/epochs: osmocli tests migrate #3661

Merged
merged 3 commits into from
Dec 13, 2022
Merged

x/epochs: osmocli tests migrate #3661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
20a5e70
change query getters
Dec 8, 2022
1d4b583
osmocli tests for epochs
Dec 8, 2022
0df7daa
address Long
Dec 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 18 additions & 98 deletions x/epochs/client/cli/cli_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,113 +1,33 @@
package cli_test

import (
"github.com/gogo/protobuf/proto"
"github.com/stretchr/testify/suite"
"testing"

"github.com/osmosis-labs/osmosis/v13/app"
"github.com/osmosis-labs/osmosis/v13/osmoutils/osmocli"
"github.com/osmosis-labs/osmosis/v13/x/epochs/client/cli"
"github.com/osmosis-labs/osmosis/v13/x/epochs/types"

clitestutil "github.com/cosmos/cosmos-sdk/testutil/cli"
"github.com/cosmos/cosmos-sdk/testutil/network"
)

type IntegrationTestSuite struct {
suite.Suite

cfg network.Config
network *network.Network
}

func (s *IntegrationTestSuite) SetupSuite() {
s.T().Log("setting up integration test suite")

s.cfg = app.DefaultConfig()

s.network = network.New(s.T(), s.cfg)

_, err := s.network.WaitForHeight(1)
s.Require().NoError(err)
}

func (s *IntegrationTestSuite) TearDownSuite() {
s.T().Log("tearing down integration test suite")
s.network.Cleanup()
}

func (s *IntegrationTestSuite) TestGetCmdCurrentEpoch() {
val := s.network.Validators[0]

testCases := []struct {
name string
identifier string
expectErr bool
respType proto.Message
}{
{
"query weekly epoch number",
"weekly",
false, &types.QueryCurrentEpochResponse{},
func TestGetCmdCurrentEpoch(t *testing.T) {
desc, _ := cli.GetCmdCurrentEpoch()
tcs := map[string]osmocli.QueryCliTestCase[*types.QueryCurrentEpochRequest]{
"basic test": {
Cmd: "day",
ExpectedQuery: &types.QueryCurrentEpochRequest{
Identifier: "day",
},
},
{
"query unavailable epoch number",
"unavailable",
false, &types.QueryCurrentEpochResponse{},
},
}

for _, tc := range testCases {
tc := tc

s.Run(tc.name, func() {
cmd := cli.GetCmdCurrentEpoch()
clientCtx := val.ClientCtx

args := []string{
tc.identifier,
}

out, err := clitestutil.ExecTestCLICmd(clientCtx, cmd, args)
if tc.expectErr {
s.Require().Error(err)
} else {
s.Require().NoError(err, out.String())
s.Require().NoError(clientCtx.Codec.UnmarshalJSON(out.Bytes(), tc.respType), out.String())
}
})
}
osmocli.RunQueryTestCases(t, desc, tcs)
}

func (s *IntegrationTestSuite) TestGetCmdEpochsInfos() {
val := s.network.Validators[0]

testCases := []struct {
name string
expectErr bool
respType proto.Message
}{
{
"query epoch infos",
false, &types.QueryEpochsInfoResponse{},
func TestGetCmdEpochsInfo(t *testing.T) {
desc, _ := cli.GetCmdEpochInfos()
tcs := map[string]osmocli.QueryCliTestCase[*types.QueryEpochsInfoRequest]{
"basic test": {
Cmd: "",
ExpectedQuery: &types.QueryEpochsInfoRequest{},
},
}

for _, tc := range testCases {
tc := tc

s.Run(tc.name, func() {
cmd := cli.GetCmdCurrentEpoch()
clientCtx := val.ClientCtx

args := []string{}

out, err := clitestutil.ExecTestCLICmd(clientCtx, cmd, args)
if tc.expectErr {
s.Require().Error(err)
} else {
s.Require().NoError(err, out.String())
s.Require().NoError(clientCtx.Codec.UnmarshalJSON(out.Bytes(), tc.respType), out.String())
}
})
}
osmocli.RunQueryTestCases(t, desc, tcs)
}
37 changes: 14 additions & 23 deletions x/epochs/client/cli/query.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,33 +10,24 @@ import (
// GetQueryCmd returns the cli query commands for this module.
func GetQueryCmd() *cobra.Command {
cmd := osmocli.QueryIndexCmd(types.ModuleName)

cmd.AddCommand(
GetCmdEpochsInfos(),
GetCmdCurrentEpoch(),
)
osmocli.AddQueryCmd(cmd, types.NewQueryClient, GetCmdEpochInfos)
osmocli.AddQueryCmd(cmd, types.NewQueryClient, GetCmdCurrentEpoch)

return cmd
}

func GetCmdEpochsInfos() *cobra.Command {
return osmocli.SimpleQueryCmd[*types.QueryEpochsInfoRequest](
"epoch-infos",
"Query running epochInfos",
`{{.Short}}{{.ExampleHeader}}
{{.CommandPrefix}} epoch-infos
`,
types.ModuleName, types.NewQueryClient,
)
func GetCmdEpochInfos() (*osmocli.QueryDescriptor, *types.QueryEpochsInfoRequest) {
return &osmocli.QueryDescriptor{
Use: "epoch-infos",
Short: "Query running epoch infos.",
Long: `{{.Short}}{{.ExampleHeader}}
{{.CommandPrefix}}`}, &types.QueryEpochsInfoRequest{}
}

func GetCmdCurrentEpoch() *cobra.Command {
return osmocli.SimpleQueryCmd[*types.QueryCurrentEpochRequest](
"current-epoch [identifier]",
"Query current epoch by specified identifier",
`{{.Short}}{{.ExampleHeader}}
{{.CommandPrefix}} current-epoch day
`,
types.ModuleName, types.NewQueryClient,
)
func GetCmdCurrentEpoch() (*osmocli.QueryDescriptor, *types.QueryCurrentEpochRequest) {
return &osmocli.QueryDescriptor{
Use: "current-epoch",
Short: "Query current epoch by specified identifier.",
Long: `{{.Short}}{{.ExampleHeader}}
{{.CommandPrefix}} day`}, &types.QueryCurrentEpochRequest{}
}