rpk: add error for unknown command execution #18650
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Cobra won't recognize unknown commands unless cobra.NoArg is set as an Arg validation parameter in the command definition. This means that running 'rpk cluster unknowncommand' won't return a 'unknown command' error, therefore, exit as a successful command execution. Now, cobra will return an 'unknown error' and exit with code 1.
r-vasquez
changed the title
twmb
approved these changes
May 24, 2024
|
Another option rather than walking is to add a test that fails if Args is empty. <-This may be better for the future, to enforce at code-writing-time that all new commands have Args carefully chosen to be NoArgs vs. something else. |
|
But this is good too |
|
Going ahead with this one since adding a test like this would force commands with optional arguments to have: cobra.MinimumArgs(0) which can be confusing. We can revisit this back in the future since adding it would be fairly easy. |
|
/backport v24.1.x |
This was referenced May 27, 2024
r-vasquez
added a commit
to r-vasquez/redpanda
that referenced
this pull request
May 30, 2024
In redpanda-data#18650 we added Arg validations for every comman and an automatic "walk" through the command space to add cobra.NoArgs. Plugins were not taken into account, this commit explicitly set the cobra.MinimumArg(0) to avoid adding "NoArgs" on execution.
7 tasks
vbotbuildovich
pushed a commit
to vbotbuildovich/redpanda
that referenced
this pull request
May 30, 2024
In redpanda-data#18650 we added Arg validations for every comman and an automatic "walk" through the command space to add cobra.NoArgs. Plugins were not taken into account, this commit explicitly set the cobra.MinimumArg(0) to avoid adding "NoArgs" on execution. (cherry picked from commit 0c9a20b)
WillemKauf
pushed a commit
to WillemKauf/redpanda
that referenced
this pull request
May 31, 2024
In redpanda-data#18650 we added Arg validations for every comman and an automatic "walk" through the command space to add cobra.NoArgs. Plugins were not taken into account, this commit explicitly set the cobra.MinimumArg(0) to avoid adding "NoArgs" on execution.
Lazin
pushed a commit
to Lazin/redpanda
that referenced
this pull request
Jun 1, 2024
In redpanda-data#18650 we added Arg validations for every comman and an automatic "walk" through the command space to add cobra.NoArgs. Plugins were not taken into account, this commit explicitly set the cobra.MinimumArg(0) to avoid adding "NoArgs" on execution.
Lazin
pushed a commit
to Lazin/redpanda
that referenced
this pull request
Jun 12, 2024
In redpanda-data#18650 we added Arg validations for every comman and an automatic "walk" through the command space to add cobra.NoArgs. Plugins were not taken into account, this commit explicitly set the cobra.MinimumArg(0) to avoid adding "NoArgs" on execution.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Cobra won't recognize unknown commands unless
cobra.NoArg is set as an Arg validation parameter
in the command definition.
This means that running 'rpk cluster unknowncommand'
won't return an 'unknown command' error, therefore,
exit as a successful command execution.
See: spf13/cobra#706
Now, cobra will return an 'unknown error' and exit
with code 1.
Fixes #18627
Backports Required
Release Notes
Improvements