x/upgrade: Refactor CLI to use protobuf query by amaury1093 · Pull Request #6623 · cosmos/cosmos-sdk

amaury1093 · 2020-07-07T12:41:18Z

Description

refactor CLI to use protobuf query
refactor gRPC test to use test suite

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the module structure standards.
Wrote unit and integration tests
Updated relevant documentation (docs/) or specification (x/<module>/spec/)
Added relevant godoc comments.
Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
Re-reviewed Files changed in the Github PR explorer
Review Codecov Report in the comment section below once CI passes

codecov · 2020-07-07T12:44:31Z

Codecov Report

Merging #6623 into master will increase coverage by 0.02%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##           master    #6623      +/-   ##
==========================================
+ Coverage   57.50%   57.52%   +0.02%     
==========================================
  Files         500      500              
  Lines       30024    30013      -11     
==========================================
+ Hits        17264    17266       +2     
+ Misses      11515    11503      -12     
+ Partials     1245     1244       -1

amaury1093 · 2020-07-07T12:42:42Z

x/upgrade/client/cli/query.go

-// GetPlanCmd returns the query upgrade plan command
-func GetPlanCmd(storeName string, cdc *codec.Codec) *cobra.Command {
+// GetCurrentPlanCmd returns the query upgrade plan command
+func GetCurrentPlanCmd(clientCtx client.Context) *cobra.Command {


note: just a rename to follow same convention everywhere in x/upgrade: *CurrentPlan* and *AppliedPlan*

amaury1093 · 2020-07-07T12:43:47Z

x/upgrade/client/cli/query.go


 			// always output json as Header is unreable in toml ([]byte is a long list of numbers)
-			bz, err = cdc.MarshalJSONIndent(headers.BlockMetas[0], "", "  ")
+			bz, err := clientCtx.Codec.MarshalJSONIndent(headers.BlockMetas[0], "", "  ")


didn't find BlockMetas in tm's proto files, so not using protobuf here

alexanderbez

Hi @amaurymartiny, thanks for contributing! Since we're modifying the commands and some tests here, we may as well update x/upgrade to follow in-process integration tests (#6423). Otherwise, some of the work you have here would get wiped out in a few days.

Is this something you think you can tackle? x/bank has already been upgraded so you can follow that as an easy example.

amaury1093 · 2020-07-07T13:20:50Z

sounds good, I'll do that in this PR

x/upgrade/keeper/grpc_query_test.go

aaronc · 2020-07-07T13:22:33Z

Hi @amaurymartiny, thanks for contributing! Since we're modifying the commands and some tests here, we may as well update x/upgrade to follow in-process integration tests (#6423). Otherwise, some of the work you have here would get wiped out in a few days.

Is this something you think you can tackle? x/bank has already been upgraded so you can follow that as an easy example.

@alexanderbez currently there are no integration tests (AFAIK) for the upgrade module. I think it would be great if we did but this is actually pretty involved and would likely only make sense by building actual binaries (not the in-process test suite) and using cosmosd. The tests that are here are just unit tests I believe and for better or worse we may need to leave the upgrade CLI untested for now.

alexanderbez · 2020-07-07T15:08:53Z

@aaronc regardless of what is tested, it still needs to be refactored. Namely,

client.Context is no longer an argument to the command constructor
Remove all queryClient := types.NewQueryClient(clientCtx.Init()) calls (or any New* Init* calls)

amaury1093 · 2020-07-07T16:00:44Z

@alexanderbez I'd love a pointer on how to move this PR forward.

client.Context is no longer an argument to the command constructor

Remove all queryClient := types.NewQueryClient(clientCtx.Init()) calls (or any New* Init* calls)

Had a look in x/bank, and it uses client.Context and defines queryClient; i was trying to do sthg similar here.

cosmos-sdk/x/bank/client/cli/query.go

Line 25 in b4a027c

func GetQueryCmd(clientCtx client.Context) *cobra.Command {

The tests I'm refactoring here are keeper unit tests, I believe they are not relevant to #6423.

alexanderbez · 2020-07-07T16:07:13Z

The tests I'm refactoring here are keeper unit tests, I believe they are not relevant to #6423.

Indeed, my mistake, it's not relevant. But the changes required I laid out in #6623 (comment).

As you can tell from x/bank, it no longer takes a client.Context argument. You'll need to do the same. Instead, it gets the context from clientCtx := client.GetClientContextFromCmd(cmd). This is all you need to do.

fedekunze

LGTM @amaurymartiny. Minor comments

x/upgrade/module.go

x/upgrade/client/cli/query.go

…nto am-cli-upgrade

fedekunze · 2020-07-08T09:14:27Z

x/upgrade/client/cli/tx.go

+}
+
 // NewCmdSubmitUpgradeProposal implements a command handler for submitting a software upgrade proposal transaction.
 func NewCmdSubmitUpgradeProposal(clientCtx client.Context) *cobra.Command {


This still needs to be updated: see #6639 for reference

I actually went down this path, but it requires a bigger refactor:

x/gov has a CLIHandlerFn that takes client.Context as arg

x/distribution, x/params & x/upgrade use this handler. But PRs are still pending for using Protobuf: x/params: query gRPC service #6585 x/distribution: gRPC query service #6600, didn't want to interfere too much

what I propose:

leave this PR scoped to x/upgrade, as initially intended

I'll take care of one follow-up PR to refactor all x/{distribution,params,upgrade} at once once those PRs are merged

…nto am-cli-upgrade

alexanderbez

LGTM! Left two minor comments.

x/upgrade/client/cli/query.go

…nto am-cli-upgrade

alexanderbez

ACK 🎉

x/upgrade: Refactor CLI to use protobuf query

323531a

amaury1093 commented Jul 7, 2020

View reviewed changes

amaury1093 added the C:x/upgrade label Jul 7, 2020

amaury1093 marked this pull request as ready for review July 7, 2020 12:52

amaury1093 requested review from aaronc, alessio, alexanderbez, clevinson, fedekunze and jgimeno as code owners July 7, 2020 12:52

Import lint

72d0f2d

alexanderbez suggested changes Jul 7, 2020

View reviewed changes

fedekunze suggested changes Jul 7, 2020

View reviewed changes

x/upgrade/keeper/grpc_query_test.go Outdated Show resolved Hide resolved

x/upgrade/keeper/grpc_query_test.go Outdated Show resolved Hide resolved

amaury1093 added 2 commits July 7, 2020 16:05

Use table tests

c45824c

Small tweak in setup

3d60e63

amaury1093 added 2 commits July 7, 2020 18:45

Address bez cli refactor

25cae9c

Merge branch 'master' into am-cli-upgrade

8a4e906

fedekunze reviewed Jul 7, 2020

View reviewed changes

x/upgrade/module.go Outdated Show resolved Hide resolved

x/upgrade/client/cli/query.go Show resolved Hide resolved

amaury1093 marked this pull request as draft July 7, 2020 18:25

amaury1093 added 5 commits July 7, 2020 20:39

Address fede's review

2ee9adb

Remove useless func args

025f6d4

Merge branch 'am-cli-upgrade' of ssh://github.com/cosmos/cosmos-sdk i…

e8eadd6

…nto am-cli-upgrade

Merge branch 'master' into am-cli-upgrade

3c1321d

Add back clientCtx to tx command

50b9c5c

fedekunze requested a review from alexanderbez July 8, 2020 07:37

amaury1093 and others added 2 commits July 8, 2020 10:50

Update docs

3fb0ea6

Merge branch 'master' into am-cli-upgrade

7ab6094

fedekunze suggested changes Jul 8, 2020

View reviewed changes

amaury1093 added 2 commits July 8, 2020 11:24

Small refactor

9c005a8

Merge branch 'am-cli-upgrade' of ssh://github.com/cosmos/cosmos-sdk i…

225cb55

…nto am-cli-upgrade

aaronc mentioned this pull request Jul 8, 2020

Query Protobuf Migration #5921

Closed

43 tasks

fedekunze approved these changes Jul 8, 2020

View reviewed changes

Merge branch 'master' into am-cli-upgrade

144a2a8

fedekunze added the automerge label Jul 8, 2020

mergify bot added 9 commits July 8, 2020 11:13

Merge branch 'master' into am-cli-upgrade

1ad236a

Merge branch 'master' into am-cli-upgrade

1610974

Merge branch 'master' into am-cli-upgrade

21c369a

Merge branch 'master' into am-cli-upgrade

820790e

Merge branch 'master' into am-cli-upgrade

3ecfb9b

Merge branch 'master' into am-cli-upgrade

bd52bea

Merge branch 'master' into am-cli-upgrade

3225d18

Merge branch 'master' into am-cli-upgrade

293dba8

Merge branch 'master' into am-cli-upgrade

6767917

alexanderbez suggested changes Jul 8, 2020

View reviewed changes

x/upgrade/client/cli/query.go Outdated Show resolved Hide resolved

x/upgrade/client/cli/query.go Outdated Show resolved Hide resolved

mergify bot and others added 3 commits July 8, 2020 20:01

Merge branch 'master' into am-cli-upgrade

6435cef

remove Init()

982c573

Merge branch 'am-cli-upgrade' of ssh://github.com/cosmos/cosmos-sdk i…

2a821ce

…nto am-cli-upgrade

fedekunze requested a review from alexanderbez July 8, 2020 21:35

alexanderbez approved these changes Jul 8, 2020

View reviewed changes

mergify bot merged commit f8df05f into master Jul 8, 2020

mergify bot deleted the am-cli-upgrade branch July 8, 2020 22:00

amaury1093 mentioned this pull request Jul 9, 2020

x/{gov,params,upgrade,distribution} CLI: In-Process test & use grpc query service #6664

Merged

20 tasks

clevinson added this to the v0.40 [Stargate] milestone Jul 9, 2020

clevinson linked an issue Jul 9, 2020 that may be closed by this pull request

Query Protobuf Migration #5921

Closed

43 tasks

Conversation

amaury1093 commented Jul 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

codecov bot commented Jul 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

amaury1093 Jul 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

amaury1093 Jul 7, 2020

Choose a reason for hiding this comment

Uh oh!

alexanderbez left a comment

Choose a reason for hiding this comment

Uh oh!

amaury1093 commented Jul 7, 2020

Uh oh!

Uh oh!

Uh oh!

aaronc commented Jul 7, 2020

Uh oh!

alexanderbez commented Jul 7, 2020

Uh oh!

amaury1093 commented Jul 7, 2020

Uh oh!

alexanderbez commented Jul 7, 2020

Uh oh!

fedekunze left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

fedekunze Jul 8, 2020

Choose a reason for hiding this comment

Uh oh!

amaury1093 Jul 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexanderbez left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

alexanderbez left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

amaury1093 commented Jul 7, 2020 •

edited

Loading

codecov bot commented Jul 7, 2020 •

edited

Loading

amaury1093 Jul 7, 2020 •

edited

Loading

amaury1093 Jul 8, 2020 •

edited

Loading