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

Jump to bottom

Fix vtctldclient's Root command to return an error on unknown command #12481

Merged
merged 3 commits into from
Feb 28, 2023
Merged

Fix vtctldclient's Root command to return an error on unknown command #12481

merged 3 commits into from
Feb 28, 2023

Conversation

ajm188
Copy link
Contributor

@ajm188 ajm188 commented Feb 26, 2023

Description

Add a Run func to vtctldclient's Root command to return an error on unknown command.

Cobra can't (and shouldn't!) be distinguish between "we didn't find a subcommand because the user made an error" and "we didn't find a subcommand because the user is trying to invoke a parent command with positional arguments", so we specify a run function (what cobra invokes when executing the command) on the root (top-level parent) and check if there are any positional arguments, which in our case we assume means the user was trying to run a subcommand that doesn't exist.

Related Issue(s)

Closes #12480.

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

Deployment Notes

@ajm188 ajm188 added this to the v16.0 milestone Feb 26, 2023
@ajm188 ajm188 requested a review from notfelineit as a code owner February 26, 2023 20:50
@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Feb 26, 2023
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Feb 26, 2023 •
edited by GuptaManan100
Loading

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a test is added or modified, there should be a documentation on top of the test to explain what the expected behavior is what the test does.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow should be required, the maintainer team should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from VTop, if used there.

GuptaManan100
GuptaManan100 reviewed Feb 27, 2023
View reviewed changes
Copy link
Member

@GuptaManan100 GuptaManan100 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a test to verify that it indeed returns an error?

@GuptaManan100 GuptaManan100 removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Feb 27, 2023
Add test
eb2bf26 
Signed-off-by: Andrew Mason <[email protected]>
@ajm188
Copy link
Contributor Author

ajm188 commented Feb 27, 2023

Can we add a test to verify that it indeed returns an error?

Done!

@GuptaManan100
Copy link
Member

Sweet! 🥇

mattlord
mattlord approved these changes Feb 28, 2023
View reviewed changes
Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

go/cmd/vtctldclient/command/root.go
Comment on lines +90 to +94
// From this we conclude that the user was trying to either run a
// command that doesn't exist (e.g. "vtctldclient delete-my-data") or
// has misspelled a legitimate command (e.g. "vtctldclient StapReplication").
// If we think this has happened, return an error, which will get
// displayed to the user in main.go along with the usage.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not something that I'm suggesting we bring in here but we could at some point use the "did you mean X" functionality that cobra provides via the command.SuggestionsMinimumDistance = X option. Maybe you explored it and there were downsides?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i never explored it but i definitely want to at some point!

flags test data
5eb96b8 
Signed-off-by: Andrew Mason <[email protected]>
@ajm188 ajm188 requested a review from deepthi as a code owner February 28, 2023 11:12
@ajm188 ajm188 merged commit cdebb7e into vitessio:main Feb 28, 2023
@ajm188 ajm188 deleted the andrew/vtctldclient-error-on-unknown-cmd branch February 28, 2023 22:03
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Feb 28, 2023

I was unable to backport this Pull Request to the following branches: release-15.0, release-16.0.

ajm188 pushed a commit to planetscale/vitess that referenced this pull request Mar 1, 2023
Fix vtctldclient's Root command to return an error on unknown comma…
3d8b4ea 
…nd (vitessio#12481)

* Add a Run func to `vtctldclient`'s Root command to return an error on unknown command

Closes vitessio#12480.

Signed-off-by: Andrew Mason <[email protected]>

* Add test

Signed-off-by: Andrew Mason <[email protected]>

* flags test data

Signed-off-by: Andrew Mason <[email protected]>

---------

Signed-off-by: Andrew Mason <[email protected]>
ajm188 pushed a commit to planetscale/vitess that referenced this pull request Mar 1, 2023
Fix vtctldclient's Root command to return an error on unknown comma…
2a449e9 
…nd (vitessio#12481)

* Add a Run func to `vtctldclient`'s Root command to return an error on unknown command

Closes vitessio#12480.

Signed-off-by: Andrew Mason <[email protected]>

* Add test

Signed-off-by: Andrew Mason <[email protected]>

* flags test data

Signed-off-by: Andrew Mason <[email protected]>

---------

Signed-off-by: Andrew Mason <[email protected]>
@ajm188 ajm188 mentioned this pull request Mar 1, 2023
Merged
4 tasks
@ajm188 ajm188 mentioned this pull request Mar 1, 2023
Merged
4 tasks
ajm188 pushed a commit that referenced this pull request Mar 1, 2023
Fix vtctldclient's Root command to return an error on unknown comma…
f520351 
…nd (#12481) (#12532)

* Add a Run func to `vtctldclient`'s Root command to return an error on unknown command

Closes #12480.



* Add test



* flags test data



---------

Signed-off-by: Andrew Mason <[email protected]>
ajm188 pushed a commit that referenced this pull request Mar 1, 2023
Fix vtctldclient's Root command to return an error on unknown comma…
7ac5c39 
…nd (#12481) (#12531)

* Add a Run func to `vtctldclient`'s Root command to return an error on unknown command

Closes #12480.



* Add test



* flags test data



---------

Signed-off-by: Andrew Mason <[email protected]>
@austenLacy austenLacy mentioned this pull request Apr 26, 2023
Merged
@austenLacy austenLacy mentioned this pull request Aug 1, 2023
Closed
@hmaurer hmaurer mentioned this pull request Mar 21, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GuptaManan100 GuptaManan100 GuptaManan100 approved these changes

@mattlord mattlord mattlord approved these changes

@notfelineit notfelineit Awaiting requested review from notfelineit

@deepthi deepthi Awaiting requested review from deepthi deepthi is a code owner

Assignees
No one assigned
Labels
Component: CLI Component: Cluster management Type: Bug
Projects
None yet
Milestone
v16.0
Development

Successfully merging this pull request may close these issues.

vtctldclient exits 0 when given invalid command
3 participants
@ajm188 @GuptaManan100 @mattlord