api: ValidateRestartPolicy: improve errors for invalid policies #46352
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
thaJeztah
added
area/api
status/2-code-review
kind/enhancement
thaJeztah
force-pushed
the
restart_policy_improve_error
branch
from
945e816
to
b951def
Compare
rumpl
approved these changes
Aug 28, 2023
|
Actually, I think it can be slightly more terse; reading it now, I see "restart-policy" is repeated in the error. Let me change "can only be used with the 'on-failure' restart policy" to "can only be used with 'on-failure'" |
thaJeztah
force-pushed
the
restart_policy_improve_error
branch
from
b951def
to
fdac4ea
Compare
|
Updated 👍 |
2 tasks
|
Ah, dang. Missed a test somewhere; |
Make the error message slightly clearer on "what" part is not valid,
and provide suggestions on what are acceptable values.
Before this change:
docker create --restart=always:3 busybox
Error response from daemon: invalid restart policy: maximum retry count cannot be used with restart policy 'always'
docker create --restart=always:-1 busybox
Error response from daemon: invalid restart policy: maximum retry count cannot be used with restart policy 'always'
docker create --restart=unknown busybox
Error response from daemon: invalid restart policy 'unknown'
After this change:
docker create --restart=always:3 busybox
Error response from daemon: invalid restart policy: maximum retry count can only be used with 'on-failure'
docker create --restart=always:-1 busybox
Error response from daemon: invalid restart policy: maximum retry count can only be used with 'on-failure' and cannot be negative
docker create --restart=unknown busybox
Error response from daemon: invalid restart policy: unknown policy 'unknown'; use one of 'no', 'always', 'on-failure', or 'unless-stopped'
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
thaJeztah
force-pushed
the
restart_policy_improve_error
branch
from
fdac4ea
to
f6f6c32
Compare
vvoland
approved these changes
Aug 28, 2023
| if policy.MaximumRetryCount < 0 { | ||
| msg += " and cannot be negative" | ||
| } | ||
| return &errInvalidParameter{fmt.Errorf(msg)} |
There was a problem hiding this comment.
nit:
Suggested change
| return &errInvalidParameter{fmt.Errorf(msg)} | |
| return &errInvalidParameter{errors.New(msg)} |
There was a problem hiding this comment.
Ah, yes; was considering that, but we didn't import "errors" yet, so thought I'd keep it at fmt.Errorf() 😅
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.
Make the error message slightly clearer on "what" part is not valid, and provide suggestions on what are acceptable values.
Before this change:
After this change:
- What I did
- How I did it
- How to verify it
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)