config: Require strictly-positive timeout values

wking · wking · commit 851005563df9 · 2017-04-07T10:02:35.000-07:00
If the timeout value was zero, the hook would always error, and there
doesn't seem to be much point to that.  And I'm not sure what negative
timeouts would mean.  By adding this restriction, we do not limit
useful hook entries, and we give the validation code grounds to warn
users attempting to validate configs which are poorly defined or have
useless hook entries.

Removing the pointer is not strictly required, but keeps up with our
anti-pointer zero-value style (style.md) now that Go's zero-value is
clearly invalid.

Signed-off-by: W. Trevor King &lt;wking@tremily.us&gt;
diff --git a/config.md b/config.md
@@ -357,6 +357,7 @@ Hooks allow for the configuration of custom actions related to the [lifecycle](r
     * **`args`** (array of strings, OPTIONAL) with the same semantics as [IEEE Std 1003.1-2001 `execv`'s *argv*][ieee-1003.1-2001-xsh-exec].
     * **`env`** (array of strings, OPTIONAL) with the same semantics as [IEEE Std 1003.1-2001's `environ`][ieee-1003.1-2001-xbd-c8.1].
     * **`timeout`** (int, OPTIONAL) is the number of seconds before aborting the hook.
+      If set, `timeout` MUST be greater than zero.
   * **`poststart`** (array of objects, OPTIONAL) is an array of [post-start hooks](#poststart).
     Entries in the array have the same schema as pre-start entries.
   * **`poststop`** (array of objects, OPTIONAL) is an array of [post-stop hooks](#poststop).
diff --git a/schema/defs.json b/schema/defs.json
@@ -91,7 +91,8 @@
                     "$ref": "#/definitions/Env"
                 },
                 "timeout": {
-                    "type": "integer"
+                    "type": "integer",
+                    "minimum": 1
                 }
             },
             "required": [
diff --git a/specs-go/config.go b/specs-go/config.go
@@ -126,7 +126,7 @@ type Hook struct {
 	Path    string   `json:"path"`
 	Args    []string `json:"args,omitempty"`
 	Env     []string `json:"env,omitempty"`
-	Timeout *int     `json:"timeout,omitempty"`
+	Timeout int      `json:"timeout,omitempty"`
 }
 
 // Hooks for container setup and teardown

Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ type Hook struct {`
`126`	`126`	Path string `json:"path"`
`127`	`127`	Args []string `json:"args,omitempty"`
`128`	`128`	Env []string `json:"env,omitempty"`
`129`		- Timeout *int `json:"timeout,omitempty"`
	`129`	+ Timeout int `json:"timeout,omitempty"`
`130`	`130`	`}`
`131`	`131`
`132`	`132`	`// Hooks for container setup and teardown`