chore(debug): clean up code

Co-authored-by: Sindre Rødseth Hansen <[email protected]>
Co-authored-by: Carl Hedgren <[email protected]>

Author: 3 people

cmd/debugcmd/debugcmd.go

@@ -2,14 +2,14 @@ package debugcmd
 
 import (
 	"fmt"
+	"k8s.io/client-go/kubernetes"
 
 	"github.com/nais/cli/pkg/debug"
 	"github.com/nais/cli/pkg/k8s"
 	"github.com/urfave/cli/v2"
 )
 
 const (
-	namespaceFlagName = "namespace"
 	contextFlagName   = "context"
 	debugImageDefault = "europe-north1-docker.pkg.dev/nais-io/nais/images/debug:latest"
 )
@@ -18,7 +18,9 @@ func Command() *cli.Command {
 	return &cli.Command{
 		Name:      "debug",
 		Usage:     "Create and attach to a debug container",
-		ArgsUsage: "appname",
+		ArgsUsage: "workloadname [namespace]",
+		Description: "Create and attach to a debug container to your specified workload in the current namespace or a specified namespace to \n" +
+			"debug your workload. The debug container is based on the debug image '" + debugImageDefault + "'.",
 		Subcommands: []*cli.Command{
 			tidyCommand(),
 		},
@@ -34,13 +36,7 @@ func Command() *cli.Command {
 		},
 		Action: func(cCtx *cli.Context) error {
 			cfg := makeConfig(cCtx)
-			cluster := cCtx.String(contextFlagName)
-			client := k8s.SetupControllerRuntimeClient(k8s.WithKubeContext(cluster))
-			if cfg.Namespace == "" {
-				cfg.Namespace = client.CurrentNamespace
-			}
-
-			clientset, err := k8s.SetupClientGo(cluster)
+			clientset, err := setupClient(cfg, cCtx)
 			if err != nil {
 				return err
 			}
@@ -54,6 +50,21 @@ func Command() *cli.Command {
 	}
 }
 
+func setupClient(cfg *debug.Config, cCtx *cli.Context) (kubernetes.Interface, error) {
+	cluster := cCtx.String(contextFlagName)
+	client := k8s.SetupControllerRuntimeClient(k8s.WithKubeContext(cluster))
+	if cfg.Namespace == "" {
+		cfg.Namespace = client.CurrentNamespace
+	}
+
+	clientset, err := k8s.SetupClientGo(cluster)
+	if err != nil {
+		return nil, err
+	}
+	return clientset, nil
+
+}
+
 func kubeConfigFlag() *cli.StringFlag {
 	return &cli.StringFlag{
 		Name:        contextFlagName,
@@ -63,13 +74,13 @@ func kubeConfigFlag() *cli.StringFlag {
 	}
 }
 
-func makeConfig(cCtx *cli.Context) debug.Config {
+func makeConfig(cCtx *cli.Context) *debug.Config {
 	appName := cCtx.Args().First()
 	namespace := cCtx.Args().Get(1)
 
-	return debug.Config{
-		AppName:    appName,
-		Namespace:  namespace,
-		DebugImage: debugImageDefault,
+	return &debug.Config{
+		WorkloadName: appName,
+		Namespace:    namespace,
+		DebugImage:   debugImageDefault,
 	}
 }

cmd/debugcmd/tidycmd.go

@@ -4,15 +4,15 @@ import (
 	"fmt"
 
 	"github.com/nais/cli/pkg/debug"
-	"github.com/nais/cli/pkg/k8s"
 	"github.com/urfave/cli/v2"
 )
 
 func tidyCommand() *cli.Command {
 	return &cli.Command{
-		Name:      "tidy",
-		Usage:     "Clean up ephemeral containers and debug pods",
-		ArgsUsage: "appname",
+		Name:        "tidy",
+		Usage:       "Clean up debug containers and debug pods from your workload",
+		Description: "Remove debug containers created by the debug command, the pods will be deleted automatically",
+		ArgsUsage:   "workloadname [namespace]",
 		Flags: []cli.Flag{
 			kubeConfigFlag(),
 		},
@@ -25,15 +25,7 @@ func tidyCommand() *cli.Command {
 		},
 		Action: func(cCtx *cli.Context) error {
 			cfg := makeConfig(cCtx)
-			cluster := cCtx.String(contextFlagName)
-			namespace := cCtx.String(namespaceFlagName)
-			client := k8s.SetupControllerRuntimeClient(k8s.WithKubeContext(cluster))
-			cfg.Namespace = client.CurrentNamespace
-			if namespace != "" {
-				cfg.Namespace = namespace
-			}
-
-			clientset, err := k8s.SetupClientGo(cluster)
+			clientset, err := setupClient(cfg, cCtx)
 			if err != nil {
 				return err
 			}

pkg/debug/debug.go

@@ -16,33 +16,33 @@ import (
 type Debug struct {
 	ctx    context.Context
 	client kubernetes.Interface
-	cfg    Config
+	cfg    *Config
 }
 
 type Config struct {
-	Namespace  string
-	Context    string
-	AppName    string
-	DebugImage string
+	Namespace    string
+	Context      string
+	WorkloadName string
+	DebugImage   string
 }
 
-func Setup(client kubernetes.Interface, cfg Config) *Debug {
+func Setup(client kubernetes.Interface, cfg *Config) *Debug {
 	return &Debug{
 		ctx:    context.Background(),
 		client: client,
 		cfg:    cfg,
 	}
 }
 
-func (d *Debug) getPods() (*core_v1.PodList, error) {
+func (d *Debug) getPodsForWorkload() (*core_v1.PodList, error) {
 	var podList *core_v1.PodList
 	var err error
 	podList, err = d.client.CoreV1().Pods(d.cfg.Namespace).List(d.ctx, metav1.ListOptions{
-		LabelSelector: fmt.Sprintf("app.kubernetes.io/name=%s", d.cfg.AppName),
+		LabelSelector: fmt.Sprintf("app.kubernetes.io/name=%s", d.cfg.WorkloadName),
 	})
 	if len(podList.Items) == 0 {
 		podList, err = d.client.CoreV1().Pods(d.cfg.Namespace).List(d.ctx, metav1.ListOptions{
-			LabelSelector: fmt.Sprintf("app=%s", d.cfg.AppName),
+			LabelSelector: fmt.Sprintf("app=%s", d.cfg.WorkloadName),
 		})
 	}
 	if err != nil {
@@ -76,11 +76,13 @@ func (d *Debug) debugPod(podName string) error {
 		return fmt.Errorf("command failed: %v", err)
 	}
 
+	fmt.Printf("Run 'nais debug tidy %s' to clean up debug containers, this will delete pod(s) with debug containers \n", d.cfg.WorkloadName)
+
 	return nil
 }
 
 func (d *Debug) Debug() error {
-	pods, err := d.getPods()
+	pods, err := d.getPodsForWorkload()
 	if err != nil {
 		return err
 	}

pkg/debug/tidy.go

@@ -1,6 +1,7 @@
 package debug
 
 import (
+	"errors"
 	"fmt"
 	"strings"
 
@@ -9,7 +10,7 @@ import (
 )
 
 func (d *Debug) Tidy() error {
-	pods, err := d.getPods()
+	pods, err := d.getPodsForWorkload()
 	if err != nil {
 		return err
 	}
@@ -20,24 +21,25 @@ func (d *Debug) Tidy() error {
 	}
 
 	if len(podNames) == 0 {
-		fmt.Println("No pods found.")
+		fmt.Println("No pods found")
 		return nil
 	}
 
-	deleted := 0
+	epHConTotal := 0
 	for _, pod := range pods.Items {
 		if len(pod.Spec.EphemeralContainers) == 0 {
 			continue
 		}
 
+		epHConTotal += len(pod.Spec.EphemeralContainers)
 		prompt := promptui.Prompt{
-			Label:     fmt.Sprintf("Do you want to delete pod %s", pod.Name),
+			Label:     fmt.Sprintf("Pod '%s' contains '%d' debug container(s), do you want to clean up", pod.Name, len(pod.Spec.EphemeralContainers)),
 			IsConfirm: true,
 		}
 
 		answer, err := prompt.Run()
 		if err != nil {
-			if err == promptui.ErrAbort {
+			if errors.Is(err, promptui.ErrAbort) {
 				fmt.Printf("Skipping deletion for pod: %s\n", pod.Name)
 				continue
 			}
@@ -50,16 +52,15 @@ func (d *Debug) Tidy() error {
 			if err := d.client.CoreV1().Pods(d.cfg.Namespace).Delete(d.ctx, pod.Name, metav1.DeleteOptions{}); err != nil {
 				fmt.Printf("Failed to delete pod %s: %v\n", pod.Name, err)
 			} else {
-				deleted++
 				fmt.Println("Deleted pod:", pod.Name)
 			}
 		} else {
 			fmt.Println("Skipped pod:", pod.Name)
 		}
 	}
 
-	if deleted == 0 {
-		fmt.Println("No pods with ephemeral containers found.")
+	if epHConTotal == 0 {
+		fmt.Printf("Workload '%s' does not contain any debug containers\n", d.cfg.WorkloadName)
 	}
 	return nil
 }