beenull/moby
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

api: ValidateRestartPolicy: improve errors for invalid policies

Browse source 
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>
This commit is contained in:
Sebastiaan van Stijn 2023-08-28 12:45:36 +02:00
parent 8569e8684f
commit f6f6c32138
No known key found for this signature in database
GPG key ID: 76698F39D527CE8C
3 changed files with 15 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
api/types/container/hostconfig.go
View file

@ -320,7 +320,11 @@ func ValidateRestartPolicy(policy RestartPolicy) error {
switch policy.Name { switch policy.Name {
case RestartPolicyAlways, RestartPolicyUnlessStopped, RestartPolicyDisabled: case RestartPolicyAlways, RestartPolicyUnlessStopped, RestartPolicyDisabled:
if policy.MaximumRetryCount != 0 { if policy.MaximumRetryCount != 0 {
return &errInvalidParameter{fmt.Errorf("invalid restart policy: maximum retry count cannot be used with restart policy '%s'", policy.Name)} msg := "invalid restart policy: maximum retry count can only be used with 'on-failure'"
if policy.MaximumRetryCount < 0 {
msg += " and cannot be negative"
}
return &errInvalidParameter{fmt.Errorf(msg)}
} }
return nil return nil
case RestartPolicyOnFailure: case RestartPolicyOnFailure:
@ -334,7 +338,7 @@ func ValidateRestartPolicy(policy RestartPolicy) error {
// backward-compatibility. // backward-compatibility.
return nil return nil
default: default:
return &errInvalidParameter{fmt.Errorf("invalid restart policy: '%s'", policy.Name)} return &errInvalidParameter{fmt.Errorf("invalid restart policy: unknown policy '%s'; use one of '%s', '%s', '%s', or '%s'", policy.Name, RestartPolicyDisabled, RestartPolicyAlways, RestartPolicyOnFailure, RestartPolicyUnlessStopped)}
} }
} }

16
api/types/container/hostconfig_test.go
View file

@ -35,12 +35,12 @@ func TestValidateRestartPolicy(t *testing.T) {
{ {
name: "always with MaxRestartCount", name: "always with MaxRestartCount",
input: RestartPolicy{Name: RestartPolicyAlways, MaximumRetryCount: 123}, input: RestartPolicy{Name: RestartPolicyAlways, MaximumRetryCount: 123},
expectedErr: "invalid restart policy: maximum retry count cannot be used with restart policy 'always'", expectedErr: "invalid restart policy: maximum retry count can only be used with 'on-failure'",
}, },
{ {
name: "always with negative MaxRestartCount", name: "always with negative MaxRestartCount",
input: RestartPolicy{Name: RestartPolicyAlways, MaximumRetryCount: -123}, input: RestartPolicy{Name: RestartPolicyAlways, MaximumRetryCount: -123},
expectedErr: "invalid restart policy: maximum retry count cannot be used with restart policy 'always'", expectedErr: "invalid restart policy: maximum retry count can only be used with 'on-failure' and cannot be negative",
}, },
{ {
name: "unless-stopped", name: "unless-stopped",
@ -49,12 +49,12 @@ func TestValidateRestartPolicy(t *testing.T) {
{ {
name: "unless-stopped with MaxRestartCount", name: "unless-stopped with MaxRestartCount",
input: RestartPolicy{Name: RestartPolicyUnlessStopped, MaximumRetryCount: 123}, input: RestartPolicy{Name: RestartPolicyUnlessStopped, MaximumRetryCount: 123},
expectedErr: "invalid restart policy: maximum retry count cannot be used with restart policy 'unless-stopped'", expectedErr: "invalid restart policy: maximum retry count can only be used with 'on-failure'",
}, },
{ {
name: "unless-stopped with negative MaxRestartCount", name: "unless-stopped with negative MaxRestartCount",
input: RestartPolicy{Name: RestartPolicyUnlessStopped, MaximumRetryCount: -123}, input: RestartPolicy{Name: RestartPolicyUnlessStopped, MaximumRetryCount: -123},
expectedErr: "invalid restart policy: maximum retry count cannot be used with restart policy 'unless-stopped'", expectedErr: "invalid restart policy: maximum retry count can only be used with 'on-failure' and cannot be negative",
}, },
{ {
name: "disabled", name: "disabled",
@ -63,12 +63,12 @@ func TestValidateRestartPolicy(t *testing.T) {
{ {
name: "disabled with MaxRestartCount", name: "disabled with MaxRestartCount",
input: RestartPolicy{Name: RestartPolicyDisabled, MaximumRetryCount: 123}, input: RestartPolicy{Name: RestartPolicyDisabled, MaximumRetryCount: 123},
expectedErr: "invalid restart policy: maximum retry count cannot be used with restart policy 'no'", expectedErr: "invalid restart policy: maximum retry count can only be used with 'on-failure'",
}, },
{ {
name: "disabled with negative MaxRestartCount", name: "disabled with negative MaxRestartCount",
input: RestartPolicy{Name: RestartPolicyDisabled, MaximumRetryCount: -123}, input: RestartPolicy{Name: RestartPolicyDisabled, MaximumRetryCount: -123},
expectedErr: "invalid restart policy: maximum retry count cannot be used with restart policy 'no'", expectedErr: "invalid restart policy: maximum retry count can only be used with 'on-failure' and cannot be negative",
}, },
{ {
name: "on-failure", name: "on-failure",
@ -85,8 +85,8 @@ func TestValidateRestartPolicy(t *testing.T) {
}, },
{ {
name: "unknown policy", name: "unknown policy",
input: RestartPolicy{Name: "I do not exist"}, input: RestartPolicy{Name: "unknown"},
expectedErr: "invalid restart policy: 'I do not exist'", expectedErr: "invalid restart policy: unknown policy 'unknown'; use one of 'no', 'always', 'on-failure', or 'unless-stopped'",
}, },
} }

2
integration-cli/docker_api_containers_test.go
View file

@ -758,7 +758,7 @@ func (s *DockerAPISuite) TestContainerAPIRestartPolicyRetryMismatch(c *testing.T
b, err := request.ReadBody(body) b, err := request.ReadBody(body)
assert.NilError(c, err) assert.NilError(c, err)
assert.Assert(c, strings.Contains(string(b[:]), "maximum retry count cannot be used with restart policy")) assert.Assert(c, strings.Contains(string(b[:]), "invalid restart policy: maximum retry count can only be used with 'on-failure'"))
} }
func (s *DockerAPISuite) TestContainerAPIRestartPolicyNegativeRetryCount(c *testing.T) { func (s *DockerAPISuite) TestContainerAPIRestartPolicyNegativeRetryCount(c *testing.T) {