Merge pull request #455 from nais/test_debug

Test debug

Author: ybelMekk

cmd/cmd.go

@@ -4,6 +4,8 @@ import (
 	"log"
 	"os"
 
+	"github.com/nais/cli/cmd/debugcmd"
+
 	"github.com/nais/cli/cmd/aivencmd"
 	"github.com/nais/cli/cmd/devicecmd"
 	"github.com/nais/cli/cmd/kubeconfigcmd"
@@ -28,6 +30,7 @@ func commands() []*cli.Command {
 		kubeconfigcmd.Command(),
 		postgrescmd.Command(),
 		validatecmd.Command(),
+		debugcmd.Command(),
 	)
 }
 

cmd/debugcmd/debugcmd.go

@@ -0,0 +1,75 @@
+package debugcmd
+
+import (
+	"fmt"
+
+	"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"
+)
+
+func Command() *cli.Command {
+	return &cli.Command{
+		Name:      "debug",
+		Usage:     "Create and attach to a debug container",
+		ArgsUsage: "appname",
+		Subcommands: []*cli.Command{
+			tidyCommand(),
+		},
+		Flags: []cli.Flag{
+			kubeConfigFlag(),
+		},
+		Before: func(context *cli.Context) error {
+			if context.Args().Len() < 1 {
+				return fmt.Errorf("missing required arguments: %v", context.Command.ArgsUsage)
+			}
+
+			return nil
+		},
+		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)
+			if err != nil {
+				return err
+			}
+
+			dg := debug.Setup(clientset, cfg)
+			if err := dg.Debug(); err != nil {
+				return fmt.Errorf("debugging instance: %w", err)
+			}
+			return nil
+		},
+	}
+}
+
+func kubeConfigFlag() *cli.StringFlag {
+	return &cli.StringFlag{
+		Name:        contextFlagName,
+		Aliases:     []string{"c"},
+		Usage:       "The kubeconfig `CONTEXT` to use",
+		DefaultText: "The current context in your kubeconfig",
+	}
+}
+
+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,
+	}
+}

cmd/debugcmd/tidycmd.go

@@ -0,0 +1,48 @@
+package debugcmd
+
+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",
+		Flags: []cli.Flag{
+			kubeConfigFlag(),
+		},
+		Before: func(context *cli.Context) error {
+			if context.Args().Len() < 1 {
+				return fmt.Errorf("missing required arguments: %v", context.Command.ArgsUsage)
+			}
+
+			return nil
+		},
+		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)
+			if err != nil {
+				return err
+			}
+
+			dg := debug.Setup(clientset, cfg)
+			if err := dg.Tidy(); err != nil {
+				return fmt.Errorf("debugging instance: %w", err)
+			}
+			return nil
+		},
+	}
+}

go.mod

@@ -8,6 +8,7 @@ require (
 	github.com/go-logr/logr v1.4.2
 	github.com/goccy/go-yaml v1.13.2
 	github.com/mailgun/raymond/v2 v2.0.48
+	github.com/manifoldco/promptui v0.9.0
 	github.com/mitchellh/go-ps v1.0.0
 	github.com/nais/device v0.0.0-20231030073017-240e8a0234d9
 	github.com/nais/liberator v0.0.0-20241101125801-cc4bc469b422
@@ -38,6 +39,7 @@ require (
 
 require (
 	github.com/cenkalti/backoff/v4 v4.3.0 // indirect
+	github.com/chzyer/readline v1.5.1 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.22.0 // indirect
 	github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
 	github.com/klauspost/cpuid/v2 v2.2.7 // indirect

go.sum

@@ -39,6 +39,15 @@ github.com/cenkalti/backoff/v4 v4.3.0/go.mod h1:Y3VNntkOUPxTVeUxJ/G5vcM//AlwfmyY
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
 github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
 github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
+github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI=
+github.com/chzyer/logex v1.2.1 h1:XHDu3E6q+gdHgsdTPH6ImJMIp436vR6MPtH8gP05QzM=
+github.com/chzyer/logex v1.2.1/go.mod h1:JLbx6lG2kDbNRFnfkgvh4eRJRPX1QCoOIWomwysCBrQ=
+github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI=
+github.com/chzyer/readline v1.5.1 h1:upd/6fQk4src78LMRzh5vItIt361/o4uq553V8B5sGI=
+github.com/chzyer/readline v1.5.1/go.mod h1:Eh+b79XXUwfKfcPLepksvw2tcLE/Ct21YObkaSkeBlk=
+github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU=
+github.com/chzyer/test v1.0.0 h1:p3BQDXSxOhOG0P9z6/hGnII4LGiEPOYBhs8asl/fC04=
+github.com/chzyer/test v1.0.0/go.mod h1:2JlltgoNkt4TW/z9V/IzDdFaMTM2JPIi26O1pF38GC8=
 github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
 github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
 github.com/containerd/console v1.0.3 h1:lIr7SlA5PxZyMV30bDW0MGbiOPXwc63yRuCP0ARubLw=
@@ -207,6 +216,8 @@ github.com/mailgun/raymond/v2 v2.0.48 h1:5dmlB680ZkFG2RN/0lvTAghrSxIESeu9/2aeDqA
 github.com/mailgun/raymond/v2 v2.0.48/go.mod h1:lsgvL50kgt1ylcFJYZiULi5fjPBkkhNfj4KA0W54Z18=
 github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0=
 github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc=
+github.com/manifoldco/promptui v0.9.0 h1:3V4HzJk1TtXW1MTZMP7mdlwbBpIinw3HztaIlYthEiA=
+github.com/manifoldco/promptui v0.9.0/go.mod h1:ka04sppxSGFAtxX0qhlYQjISsg9mR4GWtQEhdbn6Pgg=
 github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
 github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
 github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
@@ -380,6 +391,7 @@ golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.8.0 h1:3NFvSEYkUoMifnESzZl15y791HH1qU2xm6eCJU5ZPXQ=
 golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
 golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20181122145206-62eef0e2fa9b/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
@@ -389,6 +401,7 @@ golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20211013075003-97ac67df715c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220310020820-b874c991c1a5/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220319134239-a9b59b0215f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

pkg/debug/debug.go

@@ -0,0 +1,114 @@
+package debug
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"os/exec"
+
+	"github.com/manifoldco/promptui"
+
+	core_v1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/client-go/kubernetes"
+)
+
+type Debug struct {
+	ctx    context.Context
+	client kubernetes.Interface
+	cfg    Config
+}
+
+type Config struct {
+	Namespace  string
+	Context    string
+	AppName    string
+	DebugImage string
+}
+
+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) {
+	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),
+	})
+	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),
+		})
+	}
+	if err != nil {
+		return nil, fmt.Errorf("failed to get pods: %w", err)
+	}
+	return podList, nil
+}
+
+func (d *Debug) debugPod(podName string) error {
+	cmd := exec.Command(
+		"kubectl",
+		"debug",
+		"-n", d.cfg.Namespace,
+		fmt.Sprintf("pod/%s", podName),
+		"-it",
+		"--stdin",
+		"--tty",
+		"--context", d.cfg.Context,
+		"--profile=restricted",
+		"--image", d.cfg.DebugImage)
+
+	cmd.Stdin = os.Stdin
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
+
+	if err := cmd.Start(); err != nil {
+		return fmt.Errorf("failed to start command: %v", err)
+	}
+
+	if err := cmd.Wait(); err != nil {
+		return fmt.Errorf("command failed: %v", err)
+	}
+
+	return nil
+}
+
+func (d *Debug) Debug() error {
+	pods, err := d.getPods()
+	if err != nil {
+		return err
+	}
+
+	var podNames []string
+	for _, pod := range pods.Items {
+		podNames = append(podNames, pod.Name)
+	}
+
+	if len(podNames) == 0 {
+		fmt.Println("No pods found.")
+		return nil
+	}
+
+	prompt := promptui.Select{
+		Label: "Select pod to Debug",
+		Items: podNames,
+	}
+
+	_, podName, err := prompt.Run()
+	if err != nil {
+		fmt.Printf("prompt failed %v\n", err)
+		return err
+	}
+
+	if err := d.debugPod(podName); err != nil {
+		fmt.Printf("failed to debug pod %s: %v\n", podName, err)
+	}
+
+	return nil
+}

pkg/debug/tidy.go

@@ -0,0 +1,65 @@
+package debug
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/manifoldco/promptui"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+func (d *Debug) Tidy() error {
+	pods, err := d.getPods()
+	if err != nil {
+		return err
+	}
+
+	var podNames []string
+	for _, pod := range pods.Items {
+		podNames = append(podNames, pod.Name)
+	}
+
+	if len(podNames) == 0 {
+		fmt.Println("No pods found.")
+		return nil
+	}
+
+	deleted := 0
+	for _, pod := range pods.Items {
+		if len(pod.Spec.EphemeralContainers) == 0 {
+			continue
+		}
+
+		prompt := promptui.Prompt{
+			Label:     fmt.Sprintf("Do you want to delete pod %s", pod.Name),
+			IsConfirm: true,
+		}
+
+		answer, err := prompt.Run()
+		if err != nil {
+			if err == promptui.ErrAbort {
+				fmt.Printf("Skipping deletion for pod: %s\n", pod.Name)
+				continue
+			}
+			fmt.Printf("Error reading input for pod %s: %v\n", pod.Name, err)
+			return err
+		}
+
+		// Delete pod if user confirms with "y" or "yes"
+		if strings.ToLower(answer) == "y" || strings.ToLower(answer) == "yes" {
+			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.")
+	}
+	return nil
+}