From f303b6e054f866cfd53dde02fb3784b733907729 Mon Sep 17 00:00:00 2001
From: Vladislav Sukhin <vladislav@kubeshop.io>
Date: Fri, 11 Oct 2024 13:57:33 +0300
Subject: [PATCH] feat: [TKC-2684] docker image version (#5918)

* feat: docker image version

Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io>

* fix: format json

Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io>

* fix: pass docker_image_version arg

Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io>

---------

Signed-off-by: Vladislav Sukhin <vladislav@kubeshop.io>
---
 .github/workflows/release-dev.yaml       |  1 +
 .github/workflows/release.yaml           |  1 +
 api/v1/testkube.yaml                     |  4 ++
 build/kind/entrypoint.sh                 | 62 ++++++++++++------------
 build/kind/kind.Dockerfile               |  2 +
 cmd/api-server/main.go                   |  1 +
 internal/app/api/v1/handlers.go          |  1 +
 internal/app/api/v1/server.go            |  3 ++
 internal/config/config.go                |  1 +
 pkg/api/v1/testkube/model_server_info.go |  2 +
 pkg/telemetry/payload.go                 | 25 ++++------
 pkg/telemetry/sender_sio.go              |  2 +-
 12 files changed, 58 insertions(+), 47 deletions(-)

diff --git a/.github/workflows/release-dev.yaml b/.github/workflows/release-dev.yaml
index 828a0891571..7e61339e28d 100644
--- a/.github/workflows/release-dev.yaml
+++ b/.github/workflows/release-dev.yaml
@@ -162,6 +162,7 @@ jobs:
             segmentio_key=${{secrets.TESTKUBE_SEGMENTIO_KEY}}
             ga_id=${{secrets.TESTKUBE_CLI_GA_MEASUREMENT_ID}}
             ga_secret=${{secrets.TESTKUBE_CLI_GA_MEASUREMENT_SECRET}}
+            docker_image_version=${{steps.tag.outputs.tag}}
           context: build/kind
           file: build/kind/kind.Dockerfile
           platforms: linux/amd64,linux/arm64/v8
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
index cb3516832f8..b59e50e038d 100644
--- a/.github/workflows/release.yaml
+++ b/.github/workflows/release.yaml
@@ -152,6 +152,7 @@ jobs:
             segmentio_key=${{secrets.TESTKUBE_SEGMENTIO_KEY}}
             ga_id=${{secrets.TESTKUBE_CLI_GA_MEASUREMENT_ID}}
             ga_secret=${{secrets.TESTKUBE_CLI_GA_MEASUREMENT_SECRET}}
+            docker_image_version=${{steps.tag.outputs.tag}}
           context: build/kind
           file: build/kind/kind.Dockerfile
           platforms: linux/amd64,linux/arm64
diff --git a/api/v1/testkube.yaml b/api/v1/testkube.yaml
index 88291fa5f42..6b9a3a63777 100644
--- a/api/v1/testkube.yaml
+++ b/api/v1/testkube.yaml
@@ -6217,6 +6217,10 @@ components:
           items:
             type: string
             example: my-namespace
+        dockerImageVersion:
+          type: string
+          description: docker image version
+          example: "2.1.2"
 
     Repository:
       description: repository representation for tests in git repositories
diff --git a/build/kind/entrypoint.sh b/build/kind/entrypoint.sh
index de2ee74779b..c1b6f3b2b85 100644
--- a/build/kind/entrypoint.sh
+++ b/build/kind/entrypoint.sh
@@ -69,21 +69,21 @@ send_event_to_segment() {
   # Prepare the JSON payload
   local payload=$(cat <<EOF
 {
-  "userId":          "$machine_id",
-  "event":           "$event",
+  "userId":               "$machine_id",
+  "event":                "$event",
   "properties": {
-    "name":          "testkube-api-server",
-    "version":       "$version",
-    "arch":          "$arch",
-    "os":            "$os",
-    "eventCategory": "api",
-    "containerEnv":  "docker",
-    "contextType":   "agent",
-    "machineId":     "$machine_id",
-    "clusterType":   "kind",
-    "errorType":     "$error_type",
-    "errorCode":     "$error_code",
-    "agentKey":      "$AGENT_KEY"
+    "name":               "testkube-api-server",
+    "version":            "$version",
+    "arch":               "$arch",
+    "os":                 "$os",
+    "eventCategory":      "api",
+    "contextType":        "agent",
+    "machineId":          "$machine_id",
+    "clusterType":        "kind",
+    "errorType":          "$error_type",
+    "errorCode":          "$error_code",
+    "agentKey":           "$AGENT_KEY",
+    "dockerImageVersion": "$DOCKER_IMAGE_VERSION"
   },
   "context": {
     "app": {
@@ -117,26 +117,26 @@ send_event_to_ga() {
   # Prepare the JSON payload
   local payload=$(cat <<EOF
 {
-  "client_id":            "$machine_id",
-  "user_id":              "$machine_id",
+  "client_id":                 "$machine_id",
+  "user_id":                   "$machine_id",
   "events": [{
-    "name":               "$event",
+    "name":                    "$event",
     "params": {
-      "event_count":      1,
-      "event_category":   "api",
-      "app_version":      "$version",
-      "app_name":         "testkube-api-server",
-      "machine_id":       "$machine_id",
-      "operating_system": "$os",
-      "architecture":     "$arch",
+      "event_count":            1,
+      "event_category":         "api",
+      "app_version":            "$version",
+      "app_name":               "testkube-api-server",
+      "machine_id":             "$machine_id",
+      "operating_system":       "$os",
+      "architecture":           "$arch",
       "context": {
-        "container_env":  "docker",
-        "type":           "agent"
+        "docker_image_version": "$DOCKER_IMAGE_VERSION",
+        "type":                 "agent"
       },
-      "cluster_type":     "kind",
-      "error_type":       "$error_type",
-      "error_code":       "$error_code",
-      "agent_key":        "$AGENT_KEY"
+      "cluster_type":           "kind",
+      "error_type":             "$error_type",
+      "error_code":             "$error_code",
+      "agent_key":              "$AGENT_KEY"
     }
   }]
 }
@@ -226,7 +226,7 @@ else
 
   # Step 7: Install Testkube using Helm
   log "Installing Testkube via Helm..."
-  helm install testkube testkube/testkube --namespace testkube --create-namespace  --set testkube-api.cloud.key=$AGENT_KEY --set testkube-api.minio.enabled=false --set mongodb.enabled=false --set testkube-dashboard.enabled=false --set testkube-api.cloud.url=$CLOUD_URL --set testkube-api.containerEnv=docker
+  helm install testkube testkube/testkube --namespace testkube --create-namespace  --set testkube-api.cloud.key=$AGENT_KEY --set testkube-api.minio.enabled=false --set mongodb.enabled=false --set testkube-dashboard.enabled=false --set testkube-api.cloud.url=$CLOUD_URL --set testkube-api.dockerImageVersion=$DOCKER_IMAGE_VERSION
   if [ $? -ne 0 ]; then
     log "Testkube installation failed."
     send_telenetry "docker_installation_failed" "helm_error" "Testkube installation failed"
diff --git a/build/kind/kind.Dockerfile b/build/kind/kind.Dockerfile
index 945e5b9a1cf..e2a4d53e20a 100644
--- a/build/kind/kind.Dockerfile
+++ b/build/kind/kind.Dockerfile
@@ -34,6 +34,8 @@ ARG ga_id
 ENV GA_ID=$ga_id
 ARG ga_secret
 ENV GA_SECRET=$ga_secret
+ARG docker_image_version
+ENV DOCKER_IMAGE_VERSION=$docker_image_version
 
 # Step 8: Set Docker entry point for DIND (Docker-in-Docker)
 ENTRYPOINT ["tini", "--", "/usr/local/bin/entrypoint.sh"]
diff --git a/cmd/api-server/main.go b/cmd/api-server/main.go
index 8fa37a246db..f963f675a9b 100644
--- a/cmd/api-server/main.go
+++ b/cmd/api-server/main.go
@@ -651,6 +651,7 @@ func main() {
 		subscriptionChecker,
 		serviceAccountNames,
 		envs,
+		cfg.TestkubeDockerImageVersion,
 	)
 
 	if mode == common.ModeAgent {
diff --git a/internal/app/api/v1/handlers.go b/internal/app/api/v1/handlers.go
index f0cbd2f460e..cdcf2974d44 100644
--- a/internal/app/api/v1/handlers.go
+++ b/internal/app/api/v1/handlers.go
@@ -91,6 +91,7 @@ func (s *TestkubeAPI) InfoHandler() fiber.Handler {
 				LogsV2: s.featureFlags.LogsV2,
 			},
 			ExecutionNamespaces: executionNamespaces,
+			DockerImageVersion:  s.dockerImageVersion,
 		})
 	}
 }
diff --git a/internal/app/api/v1/server.go b/internal/app/api/v1/server.go
index 9f52d2b0646..7a96669aa32 100644
--- a/internal/app/api/v1/server.go
+++ b/internal/app/api/v1/server.go
@@ -108,6 +108,7 @@ func NewTestkubeAPI(
 	subscriptionChecker checktcl.SubscriptionChecker,
 	serviceAccountNames map[string]string,
 	envs map[string]string,
+	dockerImageVersion string,
 ) TestkubeAPI {
 
 	var httpConfig server.Config
@@ -165,6 +166,7 @@ func NewTestkubeAPI(
 		LabelSources:                common.Ptr(make([]LabelSource, 0)),
 		ServiceAccountNames:         serviceAccountNames,
 		Envs:                        envs,
+		dockerImageVersion:          dockerImageVersion,
 	}
 }
 
@@ -214,6 +216,7 @@ type TestkubeAPI struct {
 	LabelSources                *[]LabelSource
 	ServiceAccountNames         map[string]string
 	Envs                        map[string]string
+	dockerImageVersion          string
 }
 
 type storageParams struct {
diff --git a/internal/config/config.go b/internal/config/config.go
index 01772cf1313..7451e6d5be9 100644
--- a/internal/config/config.go
+++ b/internal/config/config.go
@@ -116,6 +116,7 @@ type Config struct {
 	TestkubeDefaultStorageClassName  string        `envconfig:"TESTKUBE_DEFAULT_STORAGE_CLASS_NAME" default:""`
 	GlobalWorkflowTemplateName       string        `envconfig:"TESTKUBE_GLOBAL_WORKFLOW_TEMPLATE_NAME" default:""`
 	EnableK8sEvents                  bool          `envconfig:"ENABLE_K8S_EVENTS" default:"true"`
+	TestkubeDockerImageVersion       string        `envconfig:"TESTKUBE_DOCKER_IMAGE_VERSION" default:""`
 
 	// DEPRECATED: Use TestkubeProAPIKey instead
 	TestkubeCloudAPIKey string `envconfig:"TESTKUBE_CLOUD_API_KEY" default:""`
diff --git a/pkg/api/v1/testkube/model_server_info.go b/pkg/api/v1/testkube/model_server_info.go
index ca90186996c..812160852fb 100644
--- a/pkg/api/v1/testkube/model_server_info.go
+++ b/pkg/api/v1/testkube/model_server_info.go
@@ -37,4 +37,6 @@ type ServerInfo struct {
 	Features              *Features     `json:"features,omitempty"`
 	// execution namespaces
 	ExecutionNamespaces []string `json:"executionNamespaces,omitempty"`
+	// docker image version
+	DockerImageVersion string `json:"dockerImageVersion,omitempty"`
 }
diff --git a/pkg/telemetry/payload.go b/pkg/telemetry/payload.go
index 5b8a3a3677c..c7e4ab179d3 100644
--- a/pkg/telemetry/payload.go
+++ b/pkg/telemetry/payload.go
@@ -10,8 +10,7 @@ import (
 )
 
 const (
-	runContextAgent        = "agent"
-	containerEnvKubernetes = "kubernetes"
+	runContextAgent = "agent"
 )
 
 type Params struct {
@@ -89,10 +88,10 @@ type RunParams struct {
 }
 
 type RunContext struct {
-	Type           string
-	OrganizationId string
-	EnvironmentId  string
-	ContainerEnv   string
+	Type               string
+	OrganizationId     string
+	EnvironmentId      string
+	DockerImageVersion string
 }
 
 type WorkflowParams struct {
@@ -345,18 +344,14 @@ func AnonymizeHost(host string) string {
 func getAgentContext() RunContext {
 	orgID := utils.GetEnvVarWithDeprecation("TESTKUBE_PRO_ORG_ID", "TESTKUBE_CLOUD_ORG_ID", "")
 	envID := utils.GetEnvVarWithDeprecation("TESTKUBE_PRO_ENV_ID", "TESTKUBE_CLOUD_ENV_ID", "")
-	containerEnv := os.Getenv("TESTKUBE_CONTAINER_ENV")
-	if containerEnv == "" {
-		containerEnv = containerEnvKubernetes
-	}
-
+	dockerImageVersion := os.Getenv("TESTKUBE_DOCKER_IMAGE_VERSION")
 	if orgID == "" || envID == "" {
 		return RunContext{}
 	}
 	return RunContext{
-		Type:           runContextAgent,
-		EnvironmentId:  envID,
-		OrganizationId: orgID,
-		ContainerEnv:   containerEnv,
+		Type:               runContextAgent,
+		EnvironmentId:      envID,
+		OrganizationId:     orgID,
+		DockerImageVersion: dockerImageVersion,
 	}
 }
diff --git a/pkg/telemetry/sender_sio.go b/pkg/telemetry/sender_sio.go
index bb0a757ef6e..e7e69c0fa9f 100644
--- a/pkg/telemetry/sender_sio.go
+++ b/pkg/telemetry/sender_sio.go
@@ -90,7 +90,7 @@ func mapProperties(name string, params Params) analytics.Properties {
 		Set("clusterId", params.ClusterID).
 		Set("eventCategory", params.EventCategory).
 		Set("host", params.Host).
-		Set("containerEnv", params.Context.ContainerEnv).
+		Set("dockerImageVersion", params.Context.DockerImageVersion).
 		Set("contextType", params.Context.Type).
 		Set("cloudOrganizationId", params.Context.OrganizationId).
 		Set("cloudEnvironmentId", params.Context.EnvironmentId).