refactor(cli): improve CLI error handling. Fixes #1935 #13656
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
It's tricky to write unit tests for the CLI code for three main reasons: exiting on errors, lack of dependency injection, and insufficient mocks. argoproj#3917 tried to solve all of these issues, but appears to have been abandoned. I thought about trying to revive that PR, but it's been over 4 years and there's certainly going to be a ton of conflicts. I figure it's better to take a more focused, incremental approach. This PR is focused on improving error handling in the following ways: 1. Do argument validation using [cobra validators](https://cobra.dev/#positional-and-custom-arguments) instead of custom logic in the `Run` function. Besides being simpler, this leads to better error messages. 2. Replace all `Run` functions with `RunE`, which allows returning errors. This is the same approach that Argo Rollouts is taking (example: https://github.com/argoproj/argo-rollouts/blob/00e39b114849010dd96221a8db441d58e860d4d0/pkg/kubectl-argo-rollouts/cmd/abort/abort.go#L41) 3. Replace nearly all calls to `log.Fatal()`/`errors.CheckError()`/etc with error propagation. Signed-off-by: Mason Malone <mmalone@adobe.com>
MasonM
force-pushed
the
refactor-1935
branch
from
d14141c
to
1a40f65
Compare
|
Test failures are unrelated and should go away once #13660 is merged |
Signed-off-by: Mason Malone <mmalone@adobe.com>
Signed-off-by: Mason Malone <mmalone@adobe.com>
isubasinghe
requested changes
Oct 2, 2024
Signed-off-by: Mason Malone <mmalone@adobe.com>
MasonM
added a commit
to MasonM/argo-workflows
that referenced
this pull request
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 <mmalone@adobe.com>
Signed-off-by: Mason Malone <mmalone@adobe.com>
6 tasks
|
@isubasinghe Thanks for the review!
Okay, I entered #13695 to do that. I'm trying to minimize the chance of bugs by having this PR be almost pure refactoring, without any functional changes. Having the commands exit earlier on a validation error would be a functional change, which is why I split it off to a separate PR. |
MasonM
added a commit
to MasonM/argo-workflows
that referenced
this pull request
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 <mmalone@adobe.com>
isubasinghe
approved these changes
Oct 4, 2024
agilgur5
reviewed
Oct 4, 2024
There was a problem hiding this comment.
Nice work! I looked through most of it, but not all.
Agreed with how things were split as well (functional vs refactor etc)
- Do argument validation using cobra validators
Didn't know that was a thing, great!
3. Replace nearly all calls to
log.Fatal()/errors.CheckError()/etc with error propagation.
This also has the added benefit of reducing our dependence on argoproj/pkg
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.
Fixes #1935
Motivation
It's tricky to write unit tests for the CLI code because it nearly always exits on errors and there's no good way of injecting mocked dependencies. #3917 tried to solve both issues, but it appears to have been abandoned. I thought about trying to revive that PR, but it's been over 4 years and there's certainly going to be a ton of conflicts. I figure it's better to take a more focused, incremental approach.
Modifications
This PR is focused on improving error handling in the following ways:
Runfunction. Besides being simpler, this leads to better error messages.Runfunctions withRunE, which allows returning errors. This is the same approach that Argo Rollouts is taking (example)log.Fatal()/errors.CheckError()/etc with error propagation.Verification
Ran E2E tests and did some manual testing, e.g.