feat: add devbox command

cmd/kubectl-testkube/commands/root.go

@@ -16,6 +16,7 @@ import (
 	"github.com/kubeshop/testkube/cmd/kubectl-testkube/commands/common/validator"
 	"github.com/kubeshop/testkube/cmd/kubectl-testkube/commands/pro"
 	"github.com/kubeshop/testkube/cmd/kubectl-testkube/config"
+	"github.com/kubeshop/testkube/cmd/tcl/kubectl-testkube/devbox"
 	"github.com/kubeshop/testkube/pkg/telemetry"
 	"github.com/kubeshop/testkube/pkg/ui"
 )
@@ -65,6 +66,8 @@ func init() {
 	RootCmd.AddCommand(NewDockerCmd())
 	RootCmd.AddCommand(pro.NewLoginCmd())
 
+	RootCmd.AddCommand(devbox.NewDevBoxCommand())
+
 	RootCmd.SetHelpCommand(NewHelpCmd())
 }
 

cmd/tcl/devbox-mutating-webhook/main.go

@@ -0,0 +1,190 @@
+// Copyright 2024 Testkube.
+//
+// Licensed as a Testkube Pro file under the Testkube Community
+// License (the "License"); you may not use this file except in compliance with
+// the License. You may obtain a copy of the License at
+//
+//	https://github.com/kubeshop/testkube/blob/main/licenses/TCL.txt
+
+package main
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"net/http"
+	"os"
+	"os/signal"
+	"strings"
+	"syscall"
+
+	"github.com/wI2L/jsondiff"
+	admissionv1 "k8s.io/api/admission/v1"
+	corev1 "k8s.io/api/core/v1"
+
+	"github.com/kubeshop/testkube/internal/common"
+	"github.com/kubeshop/testkube/pkg/testworkflows/testworkflowprocessor/constants"
+)
+
+func main() {
+	http.HandleFunc("/health", func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(http.StatusOK)
+	})
+
+	http.HandleFunc("/mutate", func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(http.StatusOK)
+		if r.Header.Get("Content-Type") != "application/json" {
+			http.Error(w, "invalid content type", http.StatusBadRequest)
+			return
+		}
+
+		initImage := os.Args[1]
+		toolkitImage := os.Args[2]
+
+		buf := new(bytes.Buffer)
+		buf.ReadFrom(r.Body)
+		body := buf.Bytes()
+
+		if len(body) == 0 {
+			http.Error(w, "invalid request", http.StatusBadRequest)
+			return
+		}
+
+		var review admissionv1.AdmissionReview
+		if err := json.Unmarshal(body, &review); err != nil {
+			http.Error(w, fmt.Sprintf("invalid request: %s", err), http.StatusBadRequest)
+			return
+		}
+
+		if review.Request == nil {
+			http.Error(w, "invalid request: empty", http.StatusBadRequest)
+			return
+		}
+		if review.Request.Kind.Kind != "Pod" {
+			http.Error(w, fmt.Sprintf("invalid resource: %s", review.Request.Kind.Kind), http.StatusBadRequest)
+			return
+		}
+
+		pod := corev1.Pod{}
+		if err := json.Unmarshal(review.Request.Object.Raw, &pod); err != nil {
+			http.Error(w, fmt.Sprintf("invalid pod provided: %s", err), http.StatusBadRequest)
+			return
+		}
+		originalPod := pod.DeepCopy()
+
+		// Apply changes
+		if pod.Labels[constants.ResourceIdLabelName] != "" {
+			usesToolkit := false
+			for _, c := range append(pod.Spec.InitContainers, pod.Spec.Containers...) {
+				if c.Image == toolkitImage {
+					usesToolkit = true
+				}
+			}
+
+			pod.Spec.Volumes = append(pod.Spec.Volumes, corev1.Volume{
+				Name:         "devbox",
+				VolumeSource: corev1.VolumeSource{EmptyDir: &corev1.EmptyDirVolumeSource{}},
+			})
+
+			script := `
+				set -e
+				/usr/bin/mc config host add minio "http://devbox-storage:9000" "minioadmin" "minioadmin"
+				/usr/bin/mc cp --disable-multipart minio/devbox/bin/init /.tk-devbox/init || exit 1
+				chmod 777 /.tk-devbox/init
+				chmod +x /.tk-devbox/init
+				ls -lah /.tk-devbox`
+			if usesToolkit {
+				script = `
+					set -e
+					/usr/bin/mc config host add minio "http://devbox-storage:9000" "minioadmin" "minioadmin"
+					/usr/bin/mc cp --disable-multipart minio/devbox/bin/init /.tk-devbox/init || exit 1
+					/usr/bin/mc cp --disable-multipart minio/devbox/bin/toolkit /.tk-devbox/toolkit || exit 1
+					chmod 777 /.tk-devbox/init
+					chmod 777 /.tk-devbox/toolkit
+					chmod +x /.tk-devbox/init
+					chmod +x /.tk-devbox/toolkit
+					ls -lah /.tk-devbox`
+			}
+
+			pod.Spec.InitContainers = append([]corev1.Container{{
+				Name:            "devbox-init",
+				Image:           "minio/mc:latest",
+				ImagePullPolicy: corev1.PullIfNotPresent,
+				Command:         []string{"/bin/sh", "-c"},
+				Args:            []string{script},
+			}}, pod.Spec.InitContainers...)
+
+			// TODO: Handle it better, to not be ambiguous
+			pod.Annotations[constants.SpecAnnotationName] = strings.ReplaceAll(pod.Annotations[constants.SpecAnnotationName], "\"/toolkit\"", "\"/.tk-devbox/toolkit\"")
+			pod.Annotations[constants.SpecAnnotationName] = strings.ReplaceAll(pod.Annotations[constants.SpecAnnotationName], "\"/.tktw/toolkit\"", "\"/.tk-devbox/toolkit\"")
+
+			for i := range pod.Spec.InitContainers {
+				if (pod.Spec.InitContainers[i].Image == toolkitImage || pod.Spec.InitContainers[i].Image == initImage) && pod.Spec.InitContainers[i].Command[0] == "/init" {
+					pod.Spec.InitContainers[i].Command[0] = "/.tk-devbox/init"
+				}
+				if pod.Spec.InitContainers[i].Command[0] == "/.tktw/init" {
+					pod.Spec.InitContainers[i].Command[0] = "/.tk-devbox/init"
+				}
+			}
+			for i := range pod.Spec.Containers {
+				if (pod.Spec.Containers[i].Image == toolkitImage || pod.Spec.Containers[i].Image == initImage) && pod.Spec.Containers[i].Command[0] == "/init" {
+					pod.Spec.Containers[i].Command[0] = "/.tk-devbox/init"
+				}
+				if pod.Spec.Containers[i].Command[0] == "/.tktw/init" {
+					pod.Spec.Containers[i].Command[0] = "/.tk-devbox/init"
+				}
+			}
+
+			for i := range pod.Spec.InitContainers {
+				pod.Spec.InitContainers[i].VolumeMounts = append(pod.Spec.InitContainers[i].VolumeMounts, corev1.VolumeMount{
+					Name:      "devbox",
+					MountPath: "/.tk-devbox",
+				})
+			}
+			for i := range pod.Spec.Containers {
+				pod.Spec.Containers[i].VolumeMounts = append(pod.Spec.Containers[i].VolumeMounts, corev1.VolumeMount{
+					Name:      "devbox",
+					MountPath: "/.tk-devbox",
+				})
+			}
+		}
+
+		patch, err := jsondiff.Compare(originalPod, pod)
+		if err != nil {
+			http.Error(w, fmt.Sprintf("failed to build patch for changes: %s", err), http.StatusInternalServerError)
+			return
+		}
+
+		serializedPatch, err := json.Marshal(patch)
+		if err != nil {
+			http.Error(w, fmt.Sprintf("failed to serialize patch for changes: %s", err), http.StatusInternalServerError)
+			return
+		}
+
+		review.Response = &admissionv1.AdmissionResponse{
+			UID:       review.Request.UID,
+			Allowed:   true,
+			PatchType: common.Ptr(admissionv1.PatchTypeJSONPatch),
+			Patch:     serializedPatch,
+		}
+
+		serializedResponse, err := json.Marshal(review)
+		if err != nil {
+			http.Error(w, fmt.Sprintf("cannot marshal result: %s", err), http.StatusInternalServerError)
+			return
+		}
+		w.Header().Set("Content-Type", "application/json")
+		fmt.Fprintf(w, "%s", serializedResponse)
+	})
+
+	stopSignal := make(chan os.Signal, 1)
+	signal.Notify(stopSignal, syscall.SIGINT, syscall.SIGTERM)
+	go func() {
+		<-stopSignal
+		os.Exit(0)
+	}()
+
+	fmt.Println("Starting server...")
+
+	panic(http.ListenAndServeTLS(":8443", "/certs/tls.crt", "/certs/tls.key", nil))
+}

cmd/tcl/kubectl-testkube/devbox/README.md

@@ -0,0 +1,68 @@
+# Development Box - TCL Licensed
+
+This utility is used to help with development of the Agent features (like Test Workflows). 
+
+## How it works
+
+* It takes current Testkube CLI credentials and create development environment inside
+* It deploys the Agent into the current cluster
+  * Test Triggers are disabled
+  * Webhooks are disabled
+  * Legacy Tests and Test Suites are disabled
+  * It's not using Helm Chart, so default templates are not available
+* For live changes, it deploys Interceptor and Object Storage into the current cluster
+  * Object Storage stores latest binaries for the Agent, Toolkit and Init Process
+  * Interceptor loads the Toolkit and Init Process from the Object Storage into every Test Workflow Execution pod
+
+## Usage
+
+* Login to Testkube CLI, like `testkube login`
+* Run `go run cmd/kubectl-testkube/main.go devbox`
+  * It's worth to create alias for that in own `.bashrc` or `.bash_profile`
+  * It's worth to pass a devbox name, like `-n dawid`, so it's not using random name
+
+The CLI will print a dashboard link for the selected environment.
+
+## Why?
+
+It's a fast way to get live changes during the development:
+* initial deployment takes up to 60 seconds
+* continuous deployments take 1-10 seconds (depending on changes and network bandwidth)
+* the Execution performance is not much worse (it's just running single container before, that is only fetching up to 100MB from local Object Storage)
+
+## Parameters
+
+Most important parameters are `-n, --name` for devbox static name,
+and `-s, --sync` for synchronising Test Workflow and Test Workflow Template CRDs from the file system.
+
+```shell
+Usage:
+  testkube devbox [flags]
+
+Aliases:
+  devbox, dev
+
+Flags:
+      --agent-image string     base agent image (default "kubeshop/testkube-api-server:latest")
+      --init-image string      base init image (default "kubeshop/testkube-tw-init:latest")
+  -n, --name string            devbox name (default "1730107481990508000")
+  -s, --sync strings           synchronise resources at paths
+      --toolkit-image string   base toolkit image (default "kubeshop/testkube-tw-toolkit:latest")
+  -o, --open                   open dashboard in browser
+```
+
+## Example
+
+```shell
+# Initialize alias
+tk() {
+  cd ~/projects/testkube
+  go run cmd/kubectl-testkube/main.go $@
+}
+
+# Select the proper cluster to deploy the devbox
+kubectx cloud-dev
+
+# Run development box, synchronising all the Test Workflows from 'test' directory in Testkube repository
+tk devbox -n dawid -s test
+```