feat(internal): allow users to add labels when cloning container or running in context

Author: reubenmiller

cli/tools/container_clone.go

@@ -35,6 +35,8 @@ type ContainerCloneCommand struct {
 	AddHost        []string
 	Env            []string
 	Entrypoint     string
+	ForkLabels     []string
+	Labels         []string
 }
 
 // NewContainerCloneCommand creates a new container clone command
@@ -62,6 +64,8 @@ func NewContainerCloneCommand(ctx cli.Cli) *cobra.Command {
 	cmd.Flags().BoolVar(&command.WaitForExit, "wait-for-exit", false, "Wait for the container to stop/exit before updating")
 	cmd.Flags().BoolVar(&command.CheckForUpdate, "check", false, "Only check if an update is necessary, don't perform the update")
 	cmd.Flags().StringVar(&command.Entrypoint, "entrypoint", "", "Change the container entrypoint when cloning the container")
+	cmd.Flags().StringSliceVarP(&command.Labels, "label", "l", []string{}, "Set meta data on the new container")
+	cmd.Flags().StringSliceVar(&command.ForkLabels, "fork-label", []string{}, "Set meta data on a the forked container")
 
 	command.Command = cmd
 	return cmd
@@ -180,6 +184,10 @@ func (c *ContainerCloneCommand) RunE(cmd *cobra.Command, args []string) error {
 			forkCmd = append(forkCmd, "--rm")
 		}
 
+		for _, v := range c.Labels {
+			forkCmd = append(forkCmd, "--label", v)
+		}
+
 		for _, v := range c.AddHost {
 			forkCmd = append(forkCmd, "--add-host", v)
 		}
@@ -210,6 +218,9 @@ func (c *ContainerCloneCommand) RunE(cmd *cobra.Command, args []string) error {
 
 			// Ensure ports don't conflict with any other containers
 			IgnorePorts: true,
+
+			// Labels for the forked container
+			Labels: container.FormatLabels(c.ForkLabels),
 		}
 
 		return containerCli.Fork(context.Background(), currentContainer, cloneOptions)
@@ -231,5 +242,6 @@ func (c *ContainerCloneCommand) RunE(cmd *cobra.Command, args []string) error {
 		ExtraHosts:   c.AddHost,
 		Entrypoint:   entrypoint,
 		Cmd:          containerCmd,
+		Labels:       container.FormatLabels(c.Labels),
 	})
 }

cli/tools/run_context.go

@@ -28,6 +28,7 @@ type ContainerRunInContextCommand struct {
 	Env         []string
 	AutoRemove  bool
 	Entrypoint  string
+	Labels      []string
 }
 
 // NewRunRemoteAccessCommand creates a new c8y remote access command
@@ -47,6 +48,7 @@ func NewContainerRunInContextCommand(ctx cli.Cli) *cobra.Command {
 	cmd.Flags().StringVar(&command.Entrypoint, "entrypoint", "", "Overwrite the default ENTRYPOINT of the image")
 	cmd.Flags().StringSliceVarP(&command.Env, "env", "e", []string{}, "Set environment variables")
 	cmd.Flags().BoolVar(&command.AutoRemove, "rm", false, "Auto remove the closed container on exit")
+	cmd.Flags().StringSliceVarP(&command.Labels, "label", "l", []string{}, "Set meta data on a container")
 
 	command.Command = cmd
 	return cmd
@@ -140,6 +142,7 @@ func (c *ContainerRunInContextCommand) RunE(cmd *cobra.Command, args []string) e
 		Entrypoint:  entrypoint,
 		Cmd:         containerCmd,
 		IgnorePorts: true,
+		Labels:      container.FormatLabels(c.Labels),
 	}
 
 	// Container config

pkg/container/container.go

@@ -971,6 +971,7 @@ type CloneOptions struct {
 	Cmd          strslice.StrSlice
 	Entrypoint   strslice.StrSlice
 	IgnorePorts  bool
+	Labels       map[string]string
 }
 
 func FormatContainerName(v string) string {
@@ -1268,6 +1269,11 @@ func CloneContainerConfig(ref *container.Config, opts CloneOptions) *container.C
 	if opts.Image != "" {
 		clonedConfig.Image = opts.Image
 	}
+
+	for label, value := range opts.Labels {
+		clonedConfig.Labels[label] = value
+	}
+
 	clonedConfig.Env = append(clonedConfig.Env, opts.Env...)
 	return clonedConfig
 }
@@ -1330,3 +1336,13 @@ func CloneNetworkConfig(ref *types.NetworkSettings) *network.NetworkingConfig {
 	}
 	return networkConfig
 }
+
+func FormatLabels(labels []string) map[string]string {
+	labelMap := make(map[string]string)
+	for _, label := range labels {
+		if name, value, found := strings.Cut(label, "="); found {
+			labelMap[name] = value
+		}
+	}
+	return labelMap
+}

tests/operations-clone.robot

@@ -27,11 +27,14 @@ Clone Existing Container
     Create Container    app2    docker.io/library/httpd:2.4
     ${prev_container_id}=    DeviceLibrary.Execute Command    cmd=sudo tedge-container engine docker container inspect app2 --format "{{.Id}}"
 
-    DeviceLibrary.Execute Command    sudo tedge-container tools container-clone --container app2 --force
+    DeviceLibrary.Execute Command    cmd=sudo tedge-container tools container-clone --container app2 --force --label io.thin-edge.last_id=${prev_container_id}
 
     ${next_container_id}=    DeviceLibrary.Execute Command    cmd=sudo tedge-container engine docker inspect app2 --format "{{.Id}}"
     Should Not Be Equal    ${next_container_id}    ${prev_container_id}
 
+    ${label_prev_id}=    DeviceLibrary.Execute Command    cmd=sudo tedge-container engine docker inspect app2 --format '{{ index .Config.Labels "io.thin-edge.last_id" }}'
+    Should Be Equal    ${label_prev_id}    ${prev_container_id}
+
 Clone Existing Container by Timeout Whilst Waiting For Exit
     Create Container    app3    docker.io/library/httpd:2.4
     ${prev_container_id}=    DeviceLibrary.Execute Command    cmd=sudo tedge-container engine docker container inspect app3 --format "{{.Id}}"