feat: add auto-cli customization options #11763

aaronc · 2022-04-25T17:42:58Z

Description

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

confirmed the correct type prefix in the PR title
confirmed ! in the type prefix if API or client breaking change
confirmed all author checklist items have been addressed
reviewed state machine logic
reviewed API design and naming
reviewed documentation is accurate
reviewed tests and test coverage
manually tested (if applicable)

github-actions · 2022-06-10T00:04:47Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

…2-proto-options

codecov · 2022-09-08T16:05:12Z

Codecov Report

Merging #11763 (b2e212a) into main (97a77a4) will decrease coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main   #11763      +/-   ##
==========================================
- Coverage   53.92%   53.89%   -0.03%     
==========================================
  Files         653      648       -5     
  Lines       55497    55342     -155     
==========================================
- Hits        29926    29827      -99     
+ Misses      23176    23130      -46     
+ Partials     2395     2385      -10

Impacted Files	Coverage Δ
x/group/keeper/keeper.go	`56.25% <0.00%> (-0.40%)`	⬇️
tx/textual/valuerenderer/valuerenderer.go
tx/textual/valuerenderer/bytes.go
tx/textual/valuerenderer/int.go
tx/textual/valuerenderer/timestamp.go
tx/textual/valuerenderer/dec.go
x/staking/simulation/operations.go	`75.91% <0.00%> (+1.37%)`	⬆️
crypto/keys/internal/ecdsa/privkey.go	`83.01% <0.00%> (+1.88%)`	⬆️
x/distribution/simulation/operations.go	`90.32% <0.00%> (+9.67%)`	⬆️

ValarDragon · 2022-09-08T16:14:45Z

proto/cosmos/bank/v1beta1/cli.yaml

+tx:
+  service: cosmos.bank.v1beta1.Msg
+  method_options:
+    Send:
+      field_options:
+        from_address:
+          position: 0
+        to_address:
+          position: 1
+        amount:
+          position: 2


Really nice! Perhaps a different syntax is what I'd first pass think, but I'm happy either way

Suggested change

tx:

service: cosmos.bank.v1beta1.Msg

method_options:

Send:

field_options:

from_address:

position: 0

to_address:

position: 1

amount:

position: 2

send:

proto_msg: cosmos.bank.v1beta1.MsgSend

short_example: send {from} {to} {amount}

long_example: send osmo1myAddr... osmo1toAddr... 1osmo

args:

from:

proto_field: "from_address"

to:

proto_field: 1 # highlights that we can mix field number or strings here

amount:

multi_arg_parse: # highlights that can span across multiple args

# we can skip proto_field if name is same as name of proto field

Looking at this, theres not really any difference in CLI specification, beyond how the top level looks, and generalizing the position arg to instead proto_field.

I see what you're getting at, but the paradigm this works on is based on doing something by default with each method and field and then allowing customization on top of that. So the code starts with the ServiceDescriptor, iterates over each method and checks if it got customized. Maybe that's counter-intuitive, but much easier to manage implementation-wise. Okay if we leave that part as is?

I can definitely add something for varargs (assuming that's what you mean by multi_arg_parse?)

alexanderbez · 2022-09-08T18:37:33Z

proto/cosmos/bank/v1beta1/cli.yaml

+  method_options:
+    Send:
+      use: send [from_key_or_address] [to_address] [amount...]
+      field_options:


why is this called field_options? Should be args or argument. Also, how do we handle flags?

This is all based on protobuf services, methods, fields, etc. By default all fields become flags. This let's us customize that. I'll try to be more descriptive in the doc strings

…o aaronc/cli-v2-proto-options

aaronc · 2022-09-08T20:42:47Z

@ValarDragon @alexanderbez I change the design based on your feedback and attempted to make this more CLI-centric rather than protobuf-centric. Is this approach more intutive?

aaronc · 2022-09-09T01:16:20Z

scripts/protocgen.sh

@@ -11,7 +11,7 @@ cd proto
 proto_dirs=$(find ./cosmos -path -prune -o -name '*.proto' -print0 | xargs -0 -n1 dirname | sort | uniq)
 for dir in $proto_dirs; do
  for file in $(find "${dir}" -maxdepth 1 -name '*.proto'); do
-    if grep "option go_package" $file &> /dev/null ; then
+    if grep "option go_package.*(?!cosmos-sdk/api)" $file &> /dev/null ; then


this is to skip gogo generation for files which are natively generated with pulsar

nit: I would add a comment above the statement describing what is going on.

alexanderbez · 2022-09-09T13:45:17Z

scripts/protocgen.sh

@@ -11,7 +11,7 @@ cd proto
 proto_dirs=$(find ./cosmos -path -prune -o -name '*.proto' -print0 | xargs -0 -n1 dirname | sort | uniq)
 for dir in $proto_dirs; do
  for file in $(find "${dir}" -maxdepth 1 -name '*.proto'); do
-    if grep "option go_package" $file &> /dev/null ; then
+    if grep "option go_package.*(?!cosmos-sdk/api)" $file &> /dev/null ; then


nit: I would add a comment above the statement describing what is going on.

client/v2/cli/testdata/bank_example.yaml

aaronc · 2022-09-12T13:39:20Z

client/v2/cli/testdata/bank_example.yaml

+        # flag_options is a map of proto field names to customization options
+        denom:
+          shorthand: d
+          usage: the denom to query


☝️ @alexanderbez here is a contrived example of flag_options. what do you think?

* feat(cli/v2): add command & flag proto options * WIP * docs * update * change name to use * update use * rename to autocli * updates * switch to (hopefully) more intuitive design * docs * updates * updates * add flag_options example

github-actions bot added C:CLI Type: Build labels Apr 25, 2022

feat(cli/v2): add command & flag proto options

9973620

aaronc force-pushed the aaronc/cli-v2-proto-options branch from efa51e7 to 9973620 Compare April 25, 2022 17:45

github-actions bot removed the C:CLI label Apr 25, 2022

aaronc mentioned this pull request Apr 25, 2022

feat(cli): dynamically generate query CLI commands #11725

Merged

19 tasks

github-actions bot added the stale label Jun 10, 2022

github-actions bot closed this Jun 17, 2022

aaronc added 2 commits September 8, 2022 11:19

WIP

83ae242

Merge branch 'main' of github.com:cosmos/cosmos-sdk into aaronc/cli-v…

d668b63

…2-proto-options

aaronc reopened this Sep 8, 2022

github-actions bot added the Type: Build label Sep 8, 2022

docs

4af9ad7

aaronc mentioned this pull request Sep 8, 2022

EPIC: AutoCLI & hubl #11775

Closed

33 tasks

update

54ccadf

ValarDragon reviewed Sep 8, 2022

View reviewed changes

aaronc added 3 commits September 8, 2022 13:17

change name to use

a733186

update use

3867e31

rename to autocli

a18569d

alexanderbez reviewed Sep 8, 2022

View reviewed changes

aaronc changed the title ~~feat(cli/v2): add command & flag proto options~~ feat: add auto-cli customization options Sep 8, 2022

aaronc and others added 5 commits September 8, 2022 16:20

updates

2afd8d3

switch to (hopefully) more intuitive design

69c1323

Merge branch 'main' into aaronc/cli-v2-proto-options

b182e5a

docs

e03134f

Merge remote-tracking branch 'origin/aaronc/cli-v2-proto-options' int…

b148c19

…o aaronc/cli-v2-proto-options

github-actions bot removed the stale label Sep 9, 2022

aaronc added 2 commits September 8, 2022 21:15

updates

b67fee6

updates

9734ce4

github-actions bot added the C:CLI label Sep 9, 2022

aaronc commented Sep 9, 2022

View reviewed changes

Merge branch 'main' into aaronc/cli-v2-proto-options

c73b1d1

aaronc marked this pull request as ready for review September 9, 2022 01:16

aaronc requested review from a team as code owners September 9, 2022 01:16

alexanderbez reviewed Sep 9, 2022

View reviewed changes

add flag_options example

189ca8b

aaronc commented Sep 12, 2022

View reviewed changes

Merge branch 'main' into aaronc/cli-v2-proto-options

beb9469

alexanderbez approved these changes Sep 12, 2022

View reviewed changes

Merge branch 'main' into aaronc/cli-v2-proto-options

b2e212a

tac0turtle approved these changes Sep 12, 2022

View reviewed changes

aaronc enabled auto-merge (squash) September 12, 2022 15:47

aaronc merged commit b41fd3f into main Sep 12, 2022

aaronc deleted the aaronc/cli-v2-proto-options branch September 12, 2022 15:51

aaronc mentioned this pull request Sep 13, 2022

feat: implement autocli customization #13251

Merged

19 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add auto-cli customization options #11763

feat: add auto-cli customization options #11763

aaronc commented Apr 25, 2022 •

edited

Loading

github-actions bot commented Jun 10, 2022

codecov bot commented Sep 8, 2022 •

edited

Loading

ValarDragon Sep 8, 2022 •

edited

Loading

ValarDragon Sep 8, 2022 •

edited

Loading

aaronc Sep 8, 2022 •

edited

Loading

alexanderbez Sep 8, 2022

aaronc Sep 8, 2022

aaronc commented Sep 8, 2022

aaronc Sep 9, 2022

alexanderbez Sep 9, 2022

alexanderbez Sep 9, 2022

aaronc Sep 12, 2022

feat: add auto-cli customization options #11763

feat: add auto-cli customization options #11763

Conversation

aaronc commented Apr 25, 2022 • edited Loading

Description

Author Checklist

Reviewers Checklist

github-actions bot commented Jun 10, 2022

codecov bot commented Sep 8, 2022 • edited Loading

Codecov Report

ValarDragon Sep 8, 2022 • edited Loading

Choose a reason for hiding this comment

ValarDragon Sep 8, 2022 • edited Loading

Choose a reason for hiding this comment

aaronc Sep 8, 2022 • edited Loading

Choose a reason for hiding this comment

alexanderbez Sep 8, 2022

Choose a reason for hiding this comment

aaronc Sep 8, 2022

Choose a reason for hiding this comment

aaronc commented Sep 8, 2022

aaronc Sep 9, 2022

Choose a reason for hiding this comment

alexanderbez Sep 9, 2022

Choose a reason for hiding this comment

alexanderbez Sep 9, 2022

Choose a reason for hiding this comment

aaronc Sep 12, 2022

Choose a reason for hiding this comment

aaronc commented Apr 25, 2022 •

edited

Loading

codecov bot commented Sep 8, 2022 •

edited

Loading

ValarDragon Sep 8, 2022 •

edited

Loading

ValarDragon Sep 8, 2022 •

edited

Loading

aaronc Sep 8, 2022 •

edited

Loading