feat: [TKC-2683] run docker agent command (#5921)

* feat: run docker agent command Signed-off-by: Vladislav Sukhin <[email protected]> * fix: docker image parameter Signed-off-by: Vladislav Sukhin <[email protected]> * feat: docker agent run command Signed-off-by: Vladislav Sukhin <[email protected]> * fix: use verbose flag Signed-off-by: Vladislav Sukhin <[email protected]> * feat: docker upgrade command Signed-off-by: Vladislav Sukhin <[email protected]> * fix: pass docker image version Signed-off-by: Vladislav Sukhin <[email protected]> * fix: missed operand Signed-off-by: Vladislav Sukhin <[email protected]> * fix: remove tag prefix Signed-off-by: Vladislav Sukhin <[email protected]> * fix: return errors Signed-off-by: Vladislav Sukhin <[email protected]> * fix: prepare latest version tag Signed-off-by: Vladislav Sukhin <[email protected]> --------- Signed-off-by: Vladislav Sukhin <[email protected]>
kubeshop · Oct 14, 2024 · 5d3302f · 5d3302f
1 parent e2ef0dc
commit 5d3302f
Show file tree

Hide file tree

Showing 12 changed files with 522 additions and 80 deletions.
diff --git a/build/kind/entrypoint.sh b/build/kind/entrypoint.sh
@@ -168,14 +168,14 @@ send_telenetry "docker_installation_started"
 
 # Check if agent key is provided
 if [ -z "$AGENT_KEY" ]; then
-  log "Please provide AGENT_KEY env var"
+  log "Testkube installation failed. Please provide AGENT_KEY env var"
   send_telenetry "docker_installation_failed" "parameter_not_found" "agent key is empty"
   exit 1
 fi
 
 # Check if cloud url is provided
 if [ -z "$CLOUD_URL" ]; then
-  log "Please provide CLOUD_URL env var"
+  log "Testkube installation failed. Please provide CLOUD_URL env var"
   send_telenetry "docker_installation_failed" "parameter_not_found" "cloud url is empty"
   exit 1
 fi
@@ -219,7 +219,7 @@ else
   log "Creating Kubernetes cluster using Kind (Kubernetes v1.31.0)..."
   kind create cluster --name testkube-cluster --image kindest/node:v1.31.0 --wait 5m
   if [ $? -ne 0 ]; then
-    log "Failed to create Kind cluster."
+    log "Testkube installation failed. Couldn't create Kind cluster."
     send_telenetry "docker_installation_failed" "kind_error" "Kind cluster was not created"
     exit 1
   fi
@@ -228,7 +228,7 @@ else
   log "Verifying cluster is up..."
   kubectl cluster-info
   if [ $? -ne 0 ]; then
-    log "Failed to verify cluster."
+    log "Testkube installation failed. Couldn't verify cluster."
     send_telenetry "docker_installation_failed" "kind_error" "Kind cluster is nor accessible"
     exit 1
   fi
@@ -258,7 +258,7 @@ else
 
     # Check if there are any pods in the Testkube namespace
     if [ -z "$pod_status" ]; then
-      log "No pods found in testkube namespace."
+      log "Testkube installation failed. No pods found in testkube namespace."
       send_telenetry "docker_installation_failed" "tetkube_error" "No pods found in testkube namespace"
       exit 1
     fi
@@ -307,7 +307,7 @@ else
   done
 
   if [ $counter -eq 15 ]; then
-    log "Testkube validation failed."
+    log "Testkube installation failed."
     send_telenetry "docker_installation_failed" "tetkube_error" "Testkube pods are not up and running"
     exit 1
   fi
@@ -317,7 +317,7 @@ else
   log "Creating and running Testkube k6 Test Workflow..."
   kubectl apply -f /examples/k6.yaml -n testkube
 
-  log "Testkube installation successful!"
+  log "Testkube installation succeed!"
   log "You can now use Testkube in your Kind Kubernetes cluster."
   send_telenetry "docker_installation_succeed"
 fi

diff --git a/cmd/kubectl-testkube/commands/common/errors.go b/cmd/kubectl-testkube/commands/common/errors.go
@@ -27,13 +27,23 @@ const (
 	TKErrConfigInitFailed ErrorCode = "TKERR-1201"
 	// TKErrInvalidInstallConfig is returned when invalid configuration is supplied when installing or upgrading.
 	TKErrInvalidInstallConfig ErrorCode = "TKERR-1202"
+	// TKErrInvalidDockerConfig is returned when docker client configuration is invalid.
+	TKErrInvalidDockerConfig ErrorCode = "TKERR-1203"
 
 	// TKERR-13xx errors are related to install operations.
 
 	// TKErrHelmCommandFailed is returned when a helm command fails.
 	TKErrHelmCommandFailed ErrorCode = "TKERR-1301"
-	// TKErrKubectlCommandFailed is returned when a kubectl command fail.
+	// TKErrKubectlCommandFailed is returned when a kubectl command fails.
 	TKErrKubectlCommandFailed ErrorCode = "TKERR-1302"
+	// TKErrDockerCommandFailed is returned when a docker command fails.
+	TKErrDockerCommandFailed ErrorCode = "TKERR-1303"
+	// TKErrDockerLogStreamingFailed is returned when a docker log streaming fails.
+	TKErrDockerLogStreamingFailed ErrorCode = "TKERR-1304"
+	// TKErrDockerLogReadingFailed is returned when a docker log reading fails.
+	TKErrDockerLogReadingFailed ErrorCode = "TKERR-1305"
+	// TKErrDockerInstallationFailed is returned when a docker installation fails.
+	TKErrDockerInstallationFailed ErrorCode = "TKERR-1306"
 
 	// TKErrCleanOldMigrationJobFailed is returned in case of issues with old migration jobs.
 	TKErrCleanOldMigrationJobFailed ErrorCode = "TKERR-1401"

diff --git a/cmd/kubectl-testkube/commands/common/helper.go b/cmd/kubectl-testkube/commands/common/helper.go
@@ -1,12 +1,18 @@
 package common
 
 import (
+	"bufio"
 	"context"
+	"encoding/json"
 	"fmt"
+	"io"
+	"net/http"
 	"os/exec"
 	"strings"
 	"time"
 
+	"github.com/docker/docker/api/types/container"
+	"github.com/docker/docker/client"
 	"github.com/pkg/errors"
 	"github.com/skratchdot/open-golang/open"
 	"github.com/spf13/cobra"
@@ -38,8 +44,10 @@ type HelmOptions struct {
 }
 
 const (
-	github = "GitHub"
-	gitlab = "GitLab"
+	github                = "GitHub"
+	gitlab                = "GitLab"
+	dockerDaemonPrefixLen = 8
+	latestReleaseUrl      = "https://api.github.com/repos/kubeshop/testkube/releases/latest"
 )
 
 func (o HelmOptions) GetApiURI() string {
@@ -292,7 +300,7 @@ func PopulateHelmFlags(cmd *cobra.Command, options *HelmOptions) {
 	cmd.Flags().BoolVar(&options.EmbeddedNATS, "embedded-nats", false, "embedded NATS server in agent")
 }
 
-func PopulateLoginDataToContext(orgID, envID, token, refreshToken string, options HelmOptions, cfg config.Data) error {
+func PopulateLoginDataToContext(orgID, envID, token, refreshToken, dockerContainerName string, options HelmOptions, cfg config.Data) error {
 	if options.Master.AgentToken != "" {
 		cfg.CloudContext.AgentKey = options.Master.AgentToken
 	}
@@ -315,6 +323,7 @@ func PopulateLoginDataToContext(orgID, envID, token, refreshToken string, option
 	if refreshToken != "" {
 		cfg.CloudContext.RefreshToken = refreshToken
 	}
+	cfg.CloudContext.DockerContainerName = dockerContainerName
 
 	cfg, err := PopulateOrgAndEnvNames(cfg, orgID, envID, options.Master.URIs.Api)
 	if err != nil {
@@ -759,3 +768,207 @@ func UiGetNamespace(cmd *cobra.Command, defaultNamespace string) string {
 
 	return namespace
 }
+
+func RunDockerCommand(args []string) (output string, cliErr *CLIError) {
+	out, err := process.Execute("docker", args...)
+	if err != nil {
+		return "", NewCLIError(
+			TKErrDockerCommandFailed,
+			"Docker command failed",
+			"Check is the Docker service installed and running on your computer by executing 'docker info' ",
+			err,
+		)
+	}
+	return string(out), nil
+}
+
+func DockerRunTestkubeAgent(options HelmOptions, cfg config.Data, dockerContainerName, dockerImage string) *CLIError {
+	// use config if set
+	if cfg.CloudContext.AgentKey != "" && options.Master.AgentToken == "" {
+		options.Master.AgentToken = cfg.CloudContext.AgentKey
+	}
+
+	if options.Master.AgentToken == "" {
+		return NewCLIError(
+			TKErrInvalidInstallConfig,
+			"Invalid install config",
+			"Provide the agent token by setting the '--agent-token' flag",
+			errors.New("agent key is required"))
+	}
+
+	args := prepareTestkubeProDockerArgs(options, dockerContainerName, dockerImage)
+	output, err := RunDockerCommand(args)
+	if err != nil {
+		return err
+	}
+
+	ui.Debug("Docker command output:")
+	ui.Debug("Arguments", args...)
+
+	ui.Debug("Docker run testkube output", output)
+
+	return nil
+}
+
+// prepareTestkubeProDockerArgs prepares docker arguments for Testkube Pro running.
+func prepareTestkubeProDockerArgs(options HelmOptions, dockerContainerName, dockerImage string) []string {
+	args := []string{
+		"run",
+		"--name", dockerContainerName,
+		"--privileged",
+		"-d",
+		"-e", "CLOUD_URL=" + options.Master.URIs.Agent,
+		"-e", "AGENT_KEY=" + options.Master.AgentToken,
+		dockerImage,
+	}
+
+	return args
+}
+
+// prepareTestkubeUpgradeDockerArgs prepares docker arguments for Testkube Upgrade running.
+func prepareTestkubeUpgradeDockerArgs(options HelmOptions, dockerContainerName, latestVersion string) []string {
+	args := []string{
+		"exec",
+		dockerContainerName,
+		"helm",
+		"upgrade",
+		// These arguments are similar to Docker entrypoint script
+		"testkube",
+		"testkube/testkube",
+		"--namespace",
+		"testkube",
+		"--set",
+		"testkube-api.minio.enabled=false",
+		"--set",
+		"mongodb.enabled=false",
+		"--set",
+		"testkube-dashboard.enabled=false",
+		"--set",
+		"testkube-api.cloud.key=" + options.Master.AgentToken,
+		"--set",
+		"testkube-api.cloud.url=" + options.Master.URIs.Agent,
+		"--set",
+		"testkube-api.dockerImageVersion=" + latestVersion,
+	}
+
+	return args
+}
+
+func StreamDockerLogs(dockerContainerName string) *CLIError {
+	// Create a Docker client
+	cli, err := client.NewClientWithOpts(client.FromEnv, client.WithAPIVersionNegotiation())
+	if err != nil {
+		return NewCLIError(
+			TKErrInvalidDockerConfig,
+			"Invalid docker config",
+			"Check your environment variables used to connect to Docker daemon",
+			err)
+	}
+
+	ctx := context.Background()
+	// Set options to stream logs and show both stdout and stderr logs
+	opts := container.LogsOptions{
+		ShowStdout: true,
+		ShowStderr: true,
+		Follow:     true, // Follow logs in real-time
+		Timestamps: false,
+	}
+
+	// Fetch logs from the container
+	logs, err := cli.ContainerLogs(ctx, dockerContainerName, opts)
+	if err != nil {
+		return NewCLIError(
+			TKErrDockerLogStreamingFailed,
+			"Docker log streaming failed",
+			"Check that your Testkube Docker Agent container is up and runnning",
+			err)
+	}
+	defer logs.Close()
+
+	// Use a buffered scanner to read the logs line by line
+	scanner := bufio.NewScanner(logs)
+	for scanner.Scan() {
+		line := scanner.Bytes()
+		if len(line) > dockerDaemonPrefixLen {
+			line = line[dockerDaemonPrefixLen:]
+		}
+
+		if ui.IsVerbose() {
+			fmt.Println(string(line)) // Optional: print logs to console
+		}
+
+		if strings.Contains(string(line), "Testkube installation succeed") {
+			break
+		}
+
+		if strings.Contains(string(line), "Testkube installation failed") {
+			return NewCLIError(
+				TKErrDockerInstallationFailed,
+				"Docker installation failed",
+				"Check logs of your Testkube Docker Agent container",
+				errors.New(string(line)))
+		}
+	}
+
+	if err := scanner.Err(); err != nil {
+		return NewCLIError(
+			TKErrDockerLogReadingFailed,
+			"Docker log reading failed",
+			"Check logs of your Testkube Docker Agent container",
+			err)
+	}
+
+	return nil
+}
+
+func DockerUpgradeTestkubeAgent(options HelmOptions, latestVersion string, cfg config.Data) *CLIError {
+	// use config if set
+	if cfg.CloudContext.AgentKey != "" && options.Master.AgentToken == "" {
+		options.Master.AgentToken = cfg.CloudContext.AgentKey
+	}
+
+	if options.Master.AgentToken == "" {
+		return NewCLIError(
+			TKErrInvalidInstallConfig,
+			"Invalid install config",
+			"Provide the agent token by setting the '--agent-token' flag",
+			errors.New("agent key is required"))
+	}
+
+	args := prepareTestkubeUpgradeDockerArgs(options, cfg.CloudContext.DockerContainerName, latestVersion)
+	output, err := RunDockerCommand(args)
+	if err != nil {
+		return err
+	}
+
+	ui.Debug("Docker command output:")
+	ui.Debug("Arguments", args...)
+
+	ui.Debug("Docker run testkube output", output)
+
+	return nil
+}
+
+type releaseMetadata struct {
+	TagName string `json:"tag_name"`
+}
+
+func GetLatestVersion() (string, error) {
+	resp, err := http.Get(latestReleaseUrl)
+	if err != nil {
+		return "", err
+	}
+	defer resp.Body.Close()
+
+	data, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return "", err
+	}
+
+	var metadata releaseMetadata
+	if err := json.Unmarshal(data, &metadata); err != nil {
+		return "", err
+	}
+
+	return strings.TrimPrefix(metadata.TagName, "v"), nil
+}
diff --git a/cmd/kubectl-testkube/commands/pro.go b/cmd/kubectl-testkube/commands/pro.go
@@ -19,6 +19,7 @@ func NewProCmd() *cobra.Command {
 	cmd.AddCommand(pro.NewDisconnectCmd())
 	cmd.AddCommand(pro.NewInitCmd())
 	cmd.AddCommand(pro.NewLoginCmd())
+	cmd.AddCommand(pro.NewDockerCmd())
 
 	return cmd
 }
diff --git a/cmd/kubectl-testkube/commands/pro/connect.go b/cmd/kubectl-testkube/commands/pro/connect.go
@@ -165,7 +165,7 @@ func NewConnectCmd() *cobra.Command {
 				token, refreshToken, err = common.LoginUser(opts.Master.URIs.Auth)
 				ui.ExitOnError("user login", err)
 			}
-			err = common.PopulateLoginDataToContext(opts.Master.OrgId, opts.Master.EnvId, token, refreshToken, opts, cfg)
+			err = common.PopulateLoginDataToContext(opts.Master.OrgId, opts.Master.EnvId, token, refreshToken, "", opts, cfg)
 
 			ui.ExitOnError("Setting Pro environment context", err)