Bugfix: deny empty positional arguments in all commands #312
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
We expected this function to be provided by Cobra, but it does not make that check. So, before the some commands accepting positional arguments allowed values like "" or ''. These are affectively empty strings, that is equivalent to no value in all or commands. As a matter of fact, some commands were panicking on this, some failing on API level with 400, 401, 404, 405, or 500 errors. The exact error which happened seems quite random. In the worst case this could lead to bad behavior, although I found no such use case. This disallows erroneous (empty) positional arguments once and for all commands. All (random) misbehaving commands I tried are now fixed. Signed-off-by: Volodymyr Khoroz <volodymyr.khoroz@foundries.io>
|
A fix is a bit more complex because of spf13/cobra#216 & spf13/cobra#252 |
|
If Cobra mainteiners accept this fix: spf13/cobra#2044 - the workaround may be removed. |
doanac
approved these changes
Oct 13, 2023
vkhoroz
added a commit
that referenced
this pull request
Nov 14, 2023
We upgraded cobra to 1.8.0 with #329. So we can use its fix for persistent hooks traversal spf13/cobra#2044, instead of our workaround for it from #312. Signed-off-by: Volodymyr Khoroz <volodymyr.khoroz@foundries.io>
vkhoroz
added a commit
that referenced
this pull request
Nov 14, 2023
We upgraded cobra to 1.8.0 with #329. So we can use its fix for persistent hooks traversal spf13/cobra#2044, instead of our workaround for it from #312. Signed-off-by: Volodymyr Khoroz <volodymyr.khoroz@foundries.io>
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.
We expected this function to be provided by Cobra, but it does not make that check. So, before the some commands accepting positional arguments allowed values like "" or ''. These are affectively empty strings, that is equivalent to no value in all or commands.
As a matter of fact, some commands were panicking on this, some failing on API level with 400, 401, 404, 405, or 500 errors. The exact error which happened seems quite random. In the worst case this could lead to bad behavior, although I found no such use case.
This disallows erroneous (empty) positional arguments once and for all commands. All (random) misbehaving commands I tried are now fixed.