feat(cli): validate --output flag and refactor
#13695
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
This was referenced Oct 3, 2024
This is a follow-up to argoproj#13656 (review). Many of the CLI commands take an `--output` flag, but this wasn't being validated, and there was a lot of duplication. The duplication has led to docs getting out-of-date, e.g. `argo cluster-template get --help` says `Output format. Must be one of: json|yaml|wide`, but it accepts `name` too. This introduces a simple `EnumFlagValue` type to represent enum flags like `--output` and changes all commands with an `--output` flag to use it. This will cause Cobra to give a helpful error if you pass an invalid value, e.g.: ``` $ ./dist/argo list -o INVALID Error: invalid argument "INVALID" for "-o, --output" flag: One of: name|json|yaml|wide ``` Signed-off-by: Mason Malone <[email protected]>
MasonM
force-pushed
the
fix-validate-output-flag
branch
from
c803fd3
to
9e3c5d8
Compare
MasonM
changed the title
--output validation--output flag and refactor
|
Ah @MasonM I think merging the previous PR introduced a bunch of merge conflicts, sorry about this but could you please address these? Thanks |
Signed-off-by: Mason Malone <[email protected]>
Signed-off-by: Mason Malone <[email protected]>
|
@isubasinghe Sure, done. |
|
Looks like |
|
/retest |
isubasinghe
approved these changes
Oct 11, 2024
| @@ -28,7 +28,7 @@ argo archive list [flags] | |||
| ``` | |||
| --chunk-size int Return large lists in chunks rather than all at once. Pass 0 to disable. | |||
| -h, --help help for list | |||
| -o, --output string Output format. One of: json|yaml|wide (default "wide") | |||
| -o, --output string Output format. One of: name|json|yaml|wide (default "wide") | |||
There was a problem hiding this comment.
I was a bit confused initially but this makes sense, allows for code reuse.
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.
Motivation
This is a follow-up to #13656 (review). Many of the CLI commands take an
--outputflag, but this wasn't being validated, and there was a lot of duplication. The duplication has led to docs getting out-of-date, e.g.argo cluster-template get --helpsaysOutput format. Must be one of: json|yaml|wide, but it acceptsnametoo.Modifications
This introduces a simple
EnumFlagValuetype to represent enum flags like--outputand changes all commands with an--outputflag to use it. This will cause Cobra to give a helpful error if you pass an invalid value, e.g.:Verification
Ran E2E tests and manually ran a few commands with
./dist/argo