generate: add hooks related env options

Signed-off-by: Ma Shimiao <[email protected]>

Author: Ma Shimiao

cmd/oci-runtime-tool/generate.go

@@ -21,8 +21,14 @@ var generateFlags = []cli.Flag{
 	cli.StringSliceFlag{Name: "env", Usage: "add environment variable e.g. key=value"},
 	cli.StringSliceFlag{Name: "env-file", Usage: "read in a file of environment variables"},
 	cli.StringSliceFlag{Name: "hooks-poststart", Usage: "set command to run in poststart hooks"},
+	cli.StringSliceFlag{Name: "hooks-poststart-env", Usage: "set environment variables for commands to run in poststart hooks"},
+	cli.StringSliceFlag{Name: "hooks-poststart-timeout", Usage: "set timeout for commands to run in poststart hooks"},
 	cli.StringSliceFlag{Name: "hooks-poststop", Usage: "set command to run in poststop hooks"},
+	cli.StringSliceFlag{Name: "hooks-poststop-env", Usage: "set environment variables for commands to run in poststop hooks"},
+	cli.StringSliceFlag{Name: "hooks-poststop-timeout", Usage: "set timeout for commands to run in poststop hooks"},
 	cli.StringSliceFlag{Name: "hooks-prestart", Usage: "set command to run in prestart hooks"},
+	cli.StringSliceFlag{Name: "hooks-prestart-env", Usage: "set environment variables for commands to run in prestart hooks"},
+	cli.StringSliceFlag{Name: "hooks-prestart-timeout", Usage: "set timeout for commands to run in prestart hooks"},
 	cli.StringFlag{Name: "hostname", Usage: "hostname value for the container"},
 	cli.StringSliceFlag{Name: "label", Usage: "add annotations to the configuration e.g. key=value"},
 	cli.StringFlag{Name: "linux-apparmor", Usage: "specifies the the apparmor profile for the container"},
@@ -75,12 +81,6 @@ var generateFlags = []cli.Flag{
 	cli.StringSliceFlag{Name: "mount-bind", Usage: "bind mount directories src:dest[:options...]"},
 	cli.StringFlag{Name: "mount-cgroups", Value: "no", Usage: "mount cgroups (rw,ro,no)"},
 	cli.StringFlag{Name: "output", Usage: "output file (defaults to stdout)"},
-	cli.StringSliceFlag{Name: "poststart", Usage: "set command to run in poststart hooks"},
-	cli.StringSliceFlag{Name: "poststart-timeout", Usage: "set timeout for commands to run in poststart hooks"},
-	cli.StringSliceFlag{Name: "poststop", Usage: "set command to run in poststop hooks"},
-	cli.StringSliceFlag{Name: "poststop-timeout", Usage: "set timeout for commands to run in poststop hooks"},
-	cli.StringSliceFlag{Name: "prestart", Usage: "set command to run in prestart hooks"},
-	cli.StringSliceFlag{Name: "prestart-timeout", Usage: "set timeout for commands to run in prestart hooks"},
 	cli.BoolFlag{Name: "privileged", Usage: "enable privileged container settings"},
 	cli.StringSliceFlag{Name: "process-cap-add", Usage: "add Linux capabilities"},
 	cli.StringSliceFlag{Name: "process-cap-drop", Usage: "drop Linux capabilities"},
@@ -338,27 +338,34 @@ func setupSpec(g *generate.Generator, context *cli.Context) error {
 		}
 	}
 
-<<<<<<< HEAD
-	if context.IsSet("hooks-prestart") {
-		preStartHooks := context.StringSlice("hooks-prestart")
-		for _, hook := range preStartHooks {
-			path, args, err := parseHook(hook)
-=======
-	if context.IsSet("poststart") {
-		postStartHooks := context.StringSlice("poststart")
+	if context.IsSet("hooks-poststart") {
+		postStartHooks := context.StringSlice("hooks-poststart")
 		for _, hook := range postStartHooks {
-			path, args := parseHook(hook)
+			path, args, err := parseHook(hook)
+			if err != nil {
+				return err
+			}
 			g.AddPostStartHook(path, args)
 		}
 	}
 
-	if context.IsSet("poststart-timeout") {
-		postStartTimeouts := context.StringSlice("poststart-timeout")
+	if context.IsSet("hooks-poststart-env") {
+		postStartEnvs := context.StringSlice("hooks-poststart-env")
+		for _, postStartEnv := range postStartEnvs {
+			path, env, err := parseHookEnv(postStartEnv)
+			if err != nil {
+				return nil
+			}
+			g.AddPostStartHookEnv(path, env)
+		}
+	}
+
+	if context.IsSet("hooks-poststart-timeout") {
+		postStartTimeouts := context.StringSlice("hooks-poststart-timeout")
 		for _, postStartTimeout := range postStartTimeouts {
 			path, timeout, err := parseHookTimeout(postStartTimeout)
->>>>>>> generate: add timeout options for hooks
 			if err != nil {
-				return nil
+				return err
 			}
 			g.AddPostStartHookTimeout(path, timeout)
 		}
@@ -375,34 +382,52 @@ func setupSpec(g *generate.Generator, context *cli.Context) error {
 		}
 	}
 
-<<<<<<< HEAD
-	if context.IsSet("hooks-poststart") {
-		postStartHooks := context.StringSlice("hooks-poststart")
-		for _, hook := range postStartHooks {
-			path, args, err := parseHook(hook)
-=======
-	if context.IsSet("poststop-timeout") {
-		postStopTimeouts := context.StringSlice("poststop-timeout")
+	if context.IsSet("hooks-poststop-env") {
+		postStopEnvs := context.StringSlice("hooks-poststop-env")
+		for _, postStopEnv := range postStopEnvs {
+			path, env, err := parseHookEnv(postStopEnv)
+			if err != nil {
+				return nil
+			}
+			g.AddPostStopHookEnv(path, env)
+		}
+	}
+
+	if context.IsSet("hooks-poststop-timeout") {
+		postStopTimeouts := context.StringSlice("hooks-poststop-timeout")
 		for _, postStopTimeout := range postStopTimeouts {
 			path, timeout, err := parseHookTimeout(postStopTimeout)
->>>>>>> generate: add timeout options for hooks
 			if err != nil {
 				return nil
 			}
 			g.AddPostStopHookTimeout(path, timeout)
 		}
 	}
 
-	if context.IsSet("prestart") {
-		preStartHooks := context.StringSlice("prestart")
+	if context.IsSet("hooks-prestart") {
+		preStartHooks := context.StringSlice("hooks-prestart")
 		for _, hook := range preStartHooks {
-			path, args := parseHook(hook)
+			path, args, err := parseHook(hook)
+			if err != nil {
+				return nil
+			}
 			g.AddPreStartHook(path, args)
 		}
 	}
 
-	if context.IsSet("prestart-timeout") {
-		preStartTimeouts := context.StringSlice("prestart-timeout")
+	if context.IsSet("hooks-prestart-env") {
+		preStartEnvs := context.StringSlice("hooks-prestart-env")
+		for _, preStartEnv := range preStartEnvs {
+			path, env, err := parseHookEnv(preStartEnv)
+			if err != nil {
+				return nil
+			}
+			g.AddPreStartHookEnv(path, env)
+		}
+	}
+
+	if context.IsSet("hooks-prestart-timeout") {
+		preStartTimeouts := context.StringSlice("hooks-prestart-timeout")
 		for _, preStartTimeout := range preStartTimeouts {
 			path, timeout, err := parseHookTimeout(preStartTimeout)
 			if err != nil {
@@ -688,6 +713,17 @@ func parseHook(s string) (string, []string, error) {
 	return path, args, nil
 }
 
+func parseHookEnv(s string) (string, []string, error) {
+	parts := strings.Split(s, ":")
+	envs := []string{}
+	if len(parts) < 2 {
+		return "", envs, fmt.Errorf("invalid format: %s", s)
+	}
+	envs = parts[1:]
+
+	return parts[0], envs, nil
+}
+
 func parseHookTimeout(s string) (string, int, error) {
 	parts := strings.Split(s, ":")
 	if len(parts) != 2 {

completions/bash/oci-runtime-tool

@@ -308,8 +308,14 @@ _oci-runtime-tool_generate() {
 		--env
 		--env-file
 		--hooks-poststart
+		--hooks-poststart-env
+		--hooks-poststart-timeout
 		--hooks-poststop
+		--hooks-poststop-env
+		--hooks-poststop-timeout
 		--hooks-prestart
+		--hooks-prestart-env
+		--hooks-prestart-timeout
 		--hostname
 		--label
 		--linux-apparmor
@@ -357,15 +363,6 @@ _oci-runtime-tool_generate() {
 		--mount-bind
 		--mount-cgroups
 		--output
-		--poststart
-		--poststart-env
-		--poststart-timeout
-		--poststop
-		--poststop-env
-		--poststop-timeout
-		--prestart
-		--prestart-env
-		--prestart-timeout
 		--process-cap-add
 		--process-cap-drop
 		--process-consolesize

generate/generate.go

@@ -747,6 +747,17 @@ func (g *Generator) AddPreStartHook(path string, args []string) {
 	g.spec.Hooks.Prestart = append(g.spec.Hooks.Prestart, hook)
 }
 
+// AddPreStartHookEnv adds envs of a prestart hook into g.spec.Hooks.Prestart.
+func (g *Generator) AddPreStartHookEnv(path string, envs []string) {
+	g.initSpec()
+	for i, hook := range g.spec.Hooks.Prestart {
+		if hook.Path == path {
+			g.spec.Hooks.Prestart[i].Env = envs
+			return
+		}
+	}
+}
+
 // AddPreStartHookTimeout adds timeout of a prestart hook into g.spec.Hooks.Prestart.
 func (g *Generator) AddPreStartHookTimeout(path string, timeout int) {
 	g.initSpec()
@@ -776,7 +787,18 @@ func (g *Generator) AddPostStopHook(path string, args []string) {
 	g.spec.Hooks.Poststop = append(g.spec.Hooks.Poststop, hook)
 }
 
-// AddPostStopHookTimeout adds timeout of a poststop hook into g.spec.Hooks.Postsop.
+// AddPostStopHookEnv adds envs of a poststop hook into g.spec.Hooks.Poststop.
+func (g *Generator) AddPostStopHookEnv(path string, envs []string) {
+	g.initSpec()
+	for i, hook := range g.spec.Hooks.Poststop {
+		if hook.Path == path {
+			g.spec.Hooks.Poststop[i].Env = envs
+			return
+		}
+	}
+}
+
+// AddPostStopHookTimeout adds timeout of a poststop hook into g.spec.Hooks.Poststop.
 func (g *Generator) AddPostStopHookTimeout(path string, timeout int) {
 	g.initSpec()
 	for i, hook := range g.spec.Hooks.Poststop {
@@ -805,6 +827,17 @@ func (g *Generator) AddPostStartHook(path string, args []string) {
 	g.spec.Hooks.Poststart = append(g.spec.Hooks.Poststart, hook)
 }
 
+// AddPostStartHookEnv adds envs of a poststart hook into g.spec.Hooks.Poststart.
+func (g *Generator) AddPostStartHookEnv(path string, envs []string) {
+	g.initSpec()
+	for i, hook := range g.spec.Hooks.Poststart {
+		if hook.Path == path {
+			g.spec.Hooks.Poststart[i].Env = envs
+			return
+		}
+	}
+}
+
 // AddPostStartHookTimeout adds timeout of a poststart hook into g.spec.Hooks.Poststart.
 func (g *Generator) AddPostStartHookTimeout(path string, timeout int) {
 	g.initSpec()

man/oci-runtime-tool-generate.1.md

@@ -47,16 +47,40 @@ read the configuration from `config.json`.
   gets launched but after the container environment and main process has been
   created.
 
+**--hooks-poststart-env**=[]
+  Set environment variables for commands in poststart hooks, format is CMD:ENV. e.g. --hooks-poststart-env=/bin/test:key=value
+  This option can be specified multiple times. When same CMD specified over once, the last one make sense.
+
+**--hooks-poststart-timeout**=[]
+  Set timeout for commands in poststart hooks, format is CMD:TIMEOUT. e.g. --hooks-poststart-timeout=/bin/test:5
+  This option can be specified multiple times. When same CMD specified over once, the last one make sense.
+
 **--hooks-poststop**=CMD[:ARGS...]
   Set command to run in poststop hooks. Can be specified multiple times.
   The multiple commands will be run in order after the container process
   is stopped.
 
+**--hook-poststop-env**=[]
+  Set environment variables for commands in poststop hooks, format is CMD:ENV. e.g. --hooks-poststop-env=/bin/test:key=value
+  This option can be specified multiple times. When same CMD specified over once, the last one make sense.
+
+**--hooks-poststop-timeout**=[]
+  Set timeout for commands in poststop hooks, format is CMD:TIMEOUT. e.g. --hooks-poststop-timeout=/bin/test:5
+  This option can be specified multiple times. When same CMD specified over once, the last one make sense.
+
 **--hooks-prestart**=CMD[:ARGS...]
   Set command to run in prestart hooks. Can be specified multiple times.
   The multiple commands will be run in order after the container process
   has been created but before it executes the user-configured code.
 
+**--hooks-prestart-env**=[]
+  Set environment variables for commands in prestart hooks, format is CMD:ENV. e.g. --hooks-prestart-env=/bin/test:key=value
+  This option can be specified multiple times. When same CMD specified over once, the last one make sense.
+
+**--hooks-prestart-timeout**=[]
+  Set timeout for commands in prestart hooks, format is CMD:TIMEOUT. e.g. --hooks-prestart-timeout=/bin/test:5
+  This option can be specified multiple times. When same CMD specified over once, the last one make sense.
+
 **--label**=[]
   Add annotations to the configuration e.g. key=value.
   Currently, key containing equals sign is not supported.
@@ -266,46 +290,6 @@ read the configuration from `config.json`.
   file at *PATH* (overwriting the existing content if a file already
   exists at *PATH*).
 
-**--poststart**=CMD[:ARGS...]
-  Set command to run in poststart hooks. Can be specified multiple times.
-  The multiple commands will be run in order before the container process
-  gets launched but after the container environment and main process has been
-  created.
-
-**--poststart-env**=[]
-  Set environment variables for commands in poststart hooks, format is CMD:ENV. e.g. --poststart-env=/bin/test:key=value
-  This option can be specified multiple times. When same CMD specified over once, the last one make sense.
-
-**--poststart-timeout**=[]
-  Set timeout for commands in poststart hooks, format is CMD:TIMEOUT. e.g. --poststart-timeout=/bin/test:5
-  This option can be specified multiple times. When same CMD specified over once, the last one make sense.
-
-**--poststop**=CMD[:ARGS...]
-  Set command to run in poststop hooks. Can be specified multiple times.
-  The multiple commands will be run in order after the container process
-  is stopped.
-
-**--poststop-env**=[]
-  Set environment variables for commands in poststop hooks, format is CMD:ENV. e.g. --poststop-env=/bin/test:key=value
-  This option can be specified multiple times. When same CMD specified over once, the last one make sense.
-
-**--poststop-timeout**=[]
-  Set timeout for commands in poststop hooks, format is CMD:TIMEOUT. e.g. --poststop-timeout=/bin/test:5
-  This option can be specified multiple times. When same CMD specified over once, the last one make sense.
-
-**--prestart**=CMD[:ARGS...]
-  Set command to run in prestart hooks. Can be specified multiple times.
-  The multiple commands will be run in order after the container process
-  has been created but before it executes the user-configured code.
-
-**--prestart-env**=[]
-  Set environment variables for commands in poststop hooks, format is CMD:ENV. e.g. --prestart-env=/bin/test:key=value
-  This option can be specified multiple times. When same CMD specified over once, the last one make sense.
-
-**--prestart-timeout**=[]
-  Set timeout for commands in prestart hooks, format is CMD:TIMEOUT. e.g. --prestart-timeout=/bin/test:5
-  This option can be specified multiple times. When same CMD specified over once, the last one make sense.
-
 **--privileged**=true|false
   Give extended privileges to this container. The default is *false*.