Merge pull request #107 from thin-edge/feat-add-name-labels

feat(internal): improvements to internal cli tools

Author: reubenmiller

cli/tools/cmd.go

@@ -16,6 +16,7 @@ func NewToolsCommand(cmdCli cli.Cli) *cobra.Command {
 		NewContainerCloneCommand(cmdCli),
 		NewContainerLogsCommand(cmdCli),
 		NewContainerRunInContextCommand(cmdCli),
+		NewContainerRemoveCommand(cmdCli),
 	)
 	return cmd
 }

cli/tools/container_clone.go

@@ -22,6 +22,7 @@ type ContainerCloneCommand struct {
 	CommandContext cli.Cli
 
 	// Options
+	ForkName       string
 	ForceUpdate    bool
 	Fork           bool
 	WaitForExit    bool
@@ -64,6 +65,7 @@ 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().StringVar(&command.ForkName, "fork-name", "", "Container name to use for the fork")
 	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")
 
@@ -208,6 +210,9 @@ func (c *ContainerCloneCommand) RunE(cmd *cobra.Command, args []string) error {
 		slog.Info("Forking container.", "command", strings.Join(forkCmd, " "))
 
 		cloneOptions := container.CloneOptions{
+			// Fork container name. If blank then a random name will be used
+			Name: c.ForkName,
+
 			Cmd: forkCmd,
 
 			// Use the new image, so that fixes can be delivered in the new image

cli/tools/container_remove.go

@@ -0,0 +1,62 @@
+/*
+Copyright © 2024 thin-edge.io <[email protected]>
+*/
+package tools
+
+import (
+	"context"
+	"errors"
+	"log/slog"
+
+	"github.com/spf13/cobra"
+	"github.com/thin-edge/tedge-container-plugin/pkg/cli"
+	"github.com/thin-edge/tedge-container-plugin/pkg/container"
+)
+
+type ContainerRemoveCommand struct {
+	*cobra.Command
+
+	CommandContext cli.Cli
+
+	// Options
+	Tail       string
+	Since      string
+	Until      string
+	Timestamps bool
+	Follow     bool
+	Details    bool
+}
+
+// NewContainerLogsCommand creates a new container remove command
+func NewContainerRemoveCommand(ctx cli.Cli) *cobra.Command {
+	command := &ContainerLogsCommand{
+		CommandContext: ctx,
+	}
+	cmd := &cobra.Command{
+		Use:          "container-remove [OPTIONS] CONTAINER...",
+		Short:        "Remove a container (stopping if necessary)",
+		RunE:         command.RunE,
+		Args:         cobra.ArbitraryArgs,
+		SilenceUsage: true,
+	}
+	command.Command = cmd
+	return cmd
+}
+
+func (c *ContainerRemoveCommand) RunE(cmd *cobra.Command, args []string) error {
+	slog.Debug("Executing", "cmd", cmd.CalledAs(), "args", args)
+
+	containerCli, err := container.NewContainerClient()
+	if err != nil {
+		return err
+	}
+
+	ctx := context.Background()
+
+	errs := make([]error, 0)
+	for _, name := range args {
+		errs = append(errs, containerCli.StopRemoveContainer(ctx, name))
+	}
+
+	return errors.Join(errs...)
+}

cli/tools/run_context.go

@@ -15,6 +15,7 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/thin-edge/tedge-container-plugin/pkg/cli"
 	"github.com/thin-edge/tedge-container-plugin/pkg/container"
+	"github.com/thin-edge/tedge-container-plugin/pkg/random"
 )
 
 type ContainerRunInContextCommand struct {
@@ -29,6 +30,7 @@ type ContainerRunInContextCommand struct {
 	AutoRemove  bool
 	Entrypoint  string
 	Labels      []string
+	NamePrefix  string
 }
 
 // NewRunRemoteAccessCommand creates a new c8y remote access command
@@ -46,6 +48,7 @@ func NewContainerRunInContextCommand(ctx cli.Cli) *cobra.Command {
 	cmd.Flags().StringVar(&command.ContainerID, "container", "", "Container to clone. Either container id or name. By default the container id of the current container will be used")
 	cmd.Flags().StringVar(&command.Image, "image", "", "Container image")
 	cmd.Flags().StringVar(&command.Entrypoint, "entrypoint", "", "Overwrite the default ENTRYPOINT of the image")
+	cmd.Flags().StringVar(&command.NamePrefix, "name-prefix", "", "Prefix to be added when generating the name. If left blank then the default will be used")
 	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")
@@ -155,7 +158,13 @@ func (c *ContainerRunInContextCommand) RunE(cmd *cobra.Command, args []string) e
 	// Copy network config
 	networkConfig := container.CloneNetworkConfig(currentContainer.NetworkSettings)
 
-	nextContainer, createErr := containerCli.Client.ContainerCreate(ctx, clonedConfig, hostConfig, networkConfig, nil, "")
+	// container name
+	containerName := "" // default. let docker create a random name
+	if c.NamePrefix != "" {
+		containerName = c.NamePrefix + "_" + random.String(8)
+	}
+
+	nextContainer, createErr := containerCli.Client.ContainerCreate(ctx, clonedConfig, hostConfig, networkConfig, nil, containerName)
 
 	if createErr != nil {
 		slog.Warn("Failed to create container.", "err", createErr)

pkg/container/container.go

@@ -960,6 +960,7 @@ func (c *ContainerClient) ContainerLogs(ctx context.Context, w io.Writer, contai
 }
 
 type CloneOptions struct {
+	Name         string
 	Image        string
 	HealthyAfter time.Duration
 	StopAfter    time.Duration
@@ -1195,11 +1196,11 @@ func (c *ContainerClient) Fork(ctx context.Context, currentContainer types.Conta
 	if cloneOptions.Image == "" {
 		cloneOptions.Image = currentContainer.Config.Image
 	}
+
+	cloneOptions.Labels["io.tedge.fork"] = "1"
+	cloneOptions.Labels["io.tedge.forked.name"] = currentContainer.Name
+
 	containerConfig := CloneContainerConfig(currentContainer.Config, cloneOptions)
-	labels := make(map[string]string)
-	labels["io.tedge.fork"] = "1"
-	labels["io.tedge.forked.name"] = currentContainer.Name
-	containerConfig.Labels = labels
 
 	hostConfig := CloneHostConfig(currentContainer.HostConfig, cloneOptions)
 
@@ -1213,7 +1214,13 @@ func (c *ContainerClient) Fork(ctx context.Context, currentContainer types.Conta
 	networkConfig := CloneNetworkConfig(currentContainer.NetworkSettings)
 	slog.Info("Forking container.", "new_image", containerConfig.Image, "from_id", currentContainer.ID)
 
-	resp, respErr := c.Client.ContainerCreate(ctx, containerConfig, hostConfig, networkConfig, nil, "")
+	if cloneOptions.Name != "" {
+		if err := c.StopRemoveContainer(ctx, cloneOptions.Name); err != nil {
+			return err
+		}
+	}
+
+	resp, respErr := c.Client.ContainerCreate(ctx, containerConfig, hostConfig, networkConfig, nil, cloneOptions.Name)
 	if respErr != nil {
 		return respErr
 	}

pkg/random/random.go

@@ -0,0 +1,24 @@
+package random
+
+import (
+	"math/rand"
+	"time"
+)
+
+const charset = "abcdefghijklmnopqrstuvwxyz" +
+	"ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
+
+var seededRand *rand.Rand = rand.New(
+	rand.NewSource(time.Now().UnixNano()))
+
+func StringWithCharset(length int, charset string) string {
+	b := make([]byte, length)
+	for i := range b {
+		b[i] = charset[seededRand.Intn(len(charset))]
+	}
+	return string(b)
+}
+
+func String(length int) string {
+	return StringWithCharset(length, charset)
+}