Merge remote-tracking branch 'origin/master' into feature/routing-sandbox#1258

nulls · nulls · commit ada80fa1de3f · 2022-09-28T18:29:15.000+03:00
diff --git a/db/test-data/agent-insert.xml b/db/test-data/agent-insert.xml
@@ -9,24 +9,28 @@
         <insert dbms="mysql" tableName="agent">
             <column name="id" value="1" />
             <column name="container_id" value="container-1" />
+            <column name="container_name" value="save-container-1" />
             <column name="execution_id" value="1" />
             <column name="version" value="1" />
         </insert>
         <insert dbms="mysql" tableName="agent">
             <column name="id" value="2" />
             <column name="container_id" value="container-2" />
+            <column name="container_name" value="save-container-2" />
             <column name="execution_id" value="1" />
             <column name="version" value="1" />
         </insert>
         <insert dbms="mysql" tableName="agent">
             <column name="id" value="3" />
             <column name="container_id" value="container-3" />
+            <column name="container_name" value="save-container-3" />
             <column name="execution_id" value="3" />
             <column name="version" value="1" />
         </insert>
         <insert dbms="mysql" tableName="agent">
             <column name="id" value="4" />
             <column name="container_id" value="container-4" />
+            <column name="container_name" value="save-container-4" />
             <column name="execution_id" value="4" />
             <column name="version" value="1" />
         </insert>
diff --git a/db/v-2/tables/agent.xml b/db/v-2/tables/agent.xml
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog
+        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+                      http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.8.xsd">
+
+    <changeSet id="add-addContainerName" author="kgevorkyan" context="dev or prod">
+        <addColumn tableName="agent">
+            <column name="container_name" type="text" defaultValue="null"/>
+        </addColumn>
+    </changeSet>
+
+
+</databaseChangeLog>
diff --git a/db/v-2/tables/db.changelog-tables.xml b/db/v-2/tables/db.changelog-tables.xml
@@ -25,6 +25,7 @@
     <include file="test.xml" relativeToChangelogFile="true"/>
     <include file="high-level-names.xml" relativeToChangelogFile="true"/>
     <include file="original-login.xml" relativeToChangelogFile="true"/>
+    <include file="agent.xml" relativeToChangelogFile="true"/>
 
     <changeSet id="02-tables" author="frolov">
         <tagDatabase tag="v2.0-tables"/>
diff --git a/save-agent/src/linuxX64Main/kotlin/com/saveourtool/save/agent/AgentConfiguration.kt b/save-agent/src/linuxX64Main/kotlin/com/saveourtool/save/agent/AgentConfiguration.kt
@@ -17,6 +17,7 @@ import kotlinx.serialization.Serializable
  * Configuration for save agent.
  *
  * @property id agent id
+ * @property name agent name
  * @property backend configuration for connection to backend
  * @property orchestrator configuration for connection to orchestrator
  * @property cliCommand a command that agent will use to run SAVE cli
@@ -31,6 +32,7 @@ import kotlinx.serialization.Serializable
 @Serializable
 data class AgentConfiguration(
     val id: String,
+    val name: String,
     val backend: BackendConfig,
     val orchestrator: OrchestratorConfig,
     val cliCommand: String = "./$SAVE_CLI_EXECUTABLE_NAME",
@@ -48,6 +50,7 @@ data class AgentConfiguration(
          */
         internal fun initializeFromEnv() = AgentConfiguration(
             id = requiredEnv(AgentEnvName.AGENT_ID),
+            name = requiredEnv(AgentEnvName.AGENT_NAME),
             backend = BackendConfig(
                 url = requiredEnv(AgentEnvName.BACKEND_URL),
             ),
diff --git a/save-agent/src/linuxX64Main/kotlin/com/saveourtool/save/agent/SaveAgent.kt b/save-agent/src/linuxX64Main/kotlin/com/saveourtool/save/agent/SaveAgent.kt
@@ -326,6 +326,7 @@ class SaveAgent(private val config: AgentConfiguration,
                         tr.resources.test.toString(),
                         pluginExecution.plugin,
                         config.id,
+                        config.name,
                         testResultStatus,
                         executionStartSeconds.value,
                         currentTime.epochSeconds,
diff --git a/save-agent/src/linuxX64Main/kotlin/com/saveourtool/save/agent/utils/Utils.kt b/save-agent/src/linuxX64Main/kotlin/com/saveourtool/save/agent/utils/Utils.kt
@@ -19,6 +19,7 @@ internal fun AgentConfiguration.updateFromEnv(): AgentConfiguration {
     logTrace("Initial agent config: $this; applying overrides from env")
     return copy(
         id = optionalEnv(AgentEnvName.AGENT_ID) ?: id,
+        name = optionalEnv(AgentEnvName.AGENT_NAME) ?: name,
         cliCommand = optionalEnv(AgentEnvName.CLI_COMMAND) ?: cliCommand,
         debug = optionalEnv(AgentEnvName.DEBUG)?.toBoolean() ?: debug,
         backend = backend.copy(
diff --git a/save-agent/src/linuxX64Test/kotlin/com/saveourtool/save/agent/SaveAgentTest.kt b/save-agent/src/linuxX64Test/kotlin/com/saveourtool/save/agent/SaveAgentTest.kt
@@ -25,6 +25,7 @@ import kotlinx.serialization.PolymorphicSerializer
 class SaveAgentTest {
     init {
         setenv(AgentEnvName.AGENT_ID.name, "agent-for-test", 1)
+        setenv(AgentEnvName.AGENT_NAME.name, "save-agent-for-test", 1)
         setenv(AgentEnvName.BACKEND_URL.name, "http://localhost:5800", 1)
         setenv(AgentEnvName.ORCHESTRATOR_URL.name, "http://localhost:5100", 1)
         setenv(AgentEnvName.CLI_COMMAND.name, "echo Doing nothing it test mode", 1)
diff --git a/save-backend/backend-api-docs.json b/save-backend/backend-api-docs.json
@@ -7218,6 +7218,9 @@
           "agentContainerId": {
             "type": "string"
           },
+          "agentContainerName": {
+            "type": "string"
+          },
           "status": {
             "type": "string",
             "enum": [
diff --git a/save-backend/src/test/kotlin/com/saveourtool/save/backend/controller/TestExecutionControllerTest.kt b/save-backend/src/test/kotlin/com/saveourtool/save/backend/controller/TestExecutionControllerTest.kt
@@ -116,6 +116,7 @@ class TestExecutionControllerTest {
             "testPath63",
             "WarnPlugin",
             "container-3",
+            "save-container-3",
             TestResultStatus.FAILED,
             DEFAULT_DATE_TEST_EXECUTION,
             DEFAULT_DATE_TEST_EXECUTION,
@@ -128,6 +129,7 @@ class TestExecutionControllerTest {
             "testPath42",
             "WarnPlugin",
             "container-3",
+            "save-container-3",
             TestResultStatus.PASSED,
             DEFAULT_DATE_TEST_EXECUTION,
             DEFAULT_DATE_TEST_EXECUTION,
@@ -173,6 +175,7 @@ class TestExecutionControllerTest {
             "test-not-exists",
             "WarnPlugin",
             "container-1",
+            "save-container-1",
             TestResultStatus.FAILED,
             DEFAULT_DATE_TEST_EXECUTION,
             DEFAULT_DATE_TEST_EXECUTION,
diff --git a/save-cloud-charts/save-cloud/Chart.lock b/save-cloud-charts/save-cloud/Chart.lock
@@ -1,7 +1,7 @@
 dependencies:
 - name: grafana
   repository: https://grafana.github.io/helm-charts
-  version: 6.38.6
+  version: 6.39.0
 - name: prometheus
   repository: https://prometheus-community.github.io/helm-charts
   version: 15.13.0
@@ -11,5 +11,5 @@ dependencies:
 - name: loki
   repository: https://grafana.github.io/helm-charts
   version: 2.16.0
-digest: sha256:70edb29c8cb9d5dffc46e0dfa53149a3cc5233cab4a738a0cf6449cd9ec77adf
-generated: "2022-09-21T10:25:38.927663819Z"
+digest: sha256:50910460dbb1f5c4e0fa48c419f474cfe1708b55b609d36dcef6fa9975655087
+generated: "2022-09-27T01:49:49.055994423Z"
diff --git a/save-cloud-common/src/commonMain/kotlin/com/saveourtool/save/agent/AgentEnvName.kt b/save-cloud-common/src/commonMain/kotlin/com/saveourtool/save/agent/AgentEnvName.kt
@@ -5,6 +5,7 @@ package com.saveourtool.save.agent
  */
 enum class AgentEnvName {
     AGENT_ID,
+    AGENT_NAME,
     BACKEND_URL,
     CLI_COMMAND,
     DEBUG,
diff --git a/save-cloud-common/src/commonMain/kotlin/com/saveourtool/save/agent/TestExecutionDto.kt b/save-cloud-common/src/commonMain/kotlin/com/saveourtool/save/agent/TestExecutionDto.kt
@@ -5,12 +5,13 @@ import com.saveourtool.save.domain.TestResultStatus
 import kotlinx.serialization.Serializable
 
 /**
+ * @property filePath
+ * @property pluginName name of a plugin which will execute test at [filePath]
  * @property agentContainerId
+ * @property agentContainerName
  * @property status
  * @property startTimeSeconds
  * @property endTimeSeconds
- * @property filePath
- * @property pluginName name of a plugin which will execute test at [filePath]
  * @property testSuiteName a name of test suite, a test from which has been executed
  * @property tags list of tags of current test
  * @property unmatched number of unmatched checks/validations in test (false negative results)
@@ -25,6 +26,7 @@ data class TestExecutionDto(
     val filePath: String,
     val pluginName: String,
     val agentContainerId: String?,
+    val agentContainerName: String?,
     val status: TestResultStatus,
     val startTimeSeconds: Long?,
     val endTimeSeconds: Long?,
diff --git a/save-cloud-common/src/commonMain/kotlin/com/saveourtool/save/entities/AgentDto.kt b/save-cloud-common/src/commonMain/kotlin/com/saveourtool/save/entities/AgentDto.kt
@@ -4,12 +4,14 @@ import kotlinx.serialization.Serializable
 
 /**
  * @property containerId id of the container, inside which the agent is running
+ * @property containerName name of the container, inside which the agent is running
  * @property executionId id of the execution, which the agent is serving
  * @property version version of save-cli [generated.SAVE_CLOUD_VERSION]
  */
 @Serializable
 data class AgentDto(
     val containerId: String,
+    val containerName: String,
     val executionId: Long,
     val version: String? = null,
 )
diff --git a/save-cloud-common/src/jvmMain/kotlin/com/saveourtool/save/entities/Agent.kt b/save-cloud-common/src/jvmMain/kotlin/com/saveourtool/save/entities/Agent.kt
@@ -7,12 +7,14 @@ import javax.persistence.ManyToOne
 
 /**
  * @property containerId id of the container, inside which the agent is running
+ * @property containerName name of the container, inside which the agent is running
  * @property execution id of the execution, which the agent is serving
  * @property version
  */
 @Entity
 class Agent(
     var containerId: String,
+    var containerName: String,
 
     @ManyToOne(fetch = FetchType.EAGER)
     @JoinColumn(name = "execution_id")
@@ -25,6 +27,7 @@ class Agent(
      */
     fun toDto(): AgentDto = AgentDto(
         containerId = containerId,
+        containerName = containerName,
         executionId = execution.requiredId(),
         version = version,
     )
@@ -36,6 +39,7 @@ class Agent(
  */
 fun AgentDto.toEntity(executionResolver: (Long) -> Execution) = Agent(
     containerId = containerId,
+    containerName = containerName,
     execution = executionResolver(executionId),
     version = version
 )
diff --git a/save-cloud-common/src/jvmMain/kotlin/com/saveourtool/save/entities/TestExecution.kt b/save-cloud-common/src/jvmMain/kotlin/com/saveourtool/save/entities/TestExecution.kt
@@ -64,6 +64,7 @@ class TestExecution(
         test.filePath,
         test.pluginName,
         agent?.containerId,
+        agent?.containerName,
         status,
         startTime?.toEpochSecond(ZoneOffset.UTC),
         endTime?.toEpochSecond(ZoneOffset.UTC),
diff --git a/save-frontend/src/main/kotlin/com/saveourtool/save/frontend/components/views/ExecutionView.kt b/save-frontend/src/main/kotlin/com/saveourtool/save/frontend/components/views/ExecutionView.kt
@@ -194,6 +194,13 @@ class ExecutionView : AbstractView<ExecutionProps, ExecutionState>(false) {
                         }
                     }
                 }
+                column(id = "agentName", header = "Agent Name") {
+                    Fragment.create {
+                        td {
+                            +"${it.value.agentContainerName}"
+                        }
+                    }
+                }
                 column(id = "agentId", header = "Agent ID") {
                     Fragment.create {
                         td {
diff --git a/save-orchestrator/src/main/kotlin/com/saveourtool/save/orchestrator/controller/AgentsController.kt b/save-orchestrator/src/main/kotlin/com/saveourtool/save/orchestrator/controller/AgentsController.kt
@@ -4,6 +4,7 @@ import com.saveourtool.save.entities.AgentDto
 import com.saveourtool.save.execution.ExecutionStatus
 import com.saveourtool.save.orchestrator.BodilessResponseEntity
 import com.saveourtool.save.orchestrator.config.ConfigProperties
+import com.saveourtool.save.orchestrator.runner.AgentRunner
 import com.saveourtool.save.orchestrator.service.AgentService
 import com.saveourtool.save.orchestrator.service.DockerService
 import com.saveourtool.save.orchestrator.utils.LoggingContextImpl
@@ -32,6 +33,7 @@ import reactor.kotlin.core.publisher.doOnError
 class AgentsController(
     private val agentService: AgentService,
     private val dockerService: DockerService,
+    private val agentRunner: AgentRunner,
     private val configProperties: ConfigProperties,
 ) {
     /**
@@ -68,7 +70,8 @@ class AgentsController(
                 .flatMap { containerIds ->
                     agentService.saveAgentsWithInitialStatuses(
                         containerIds.map { containerId ->
-                            AgentDto(containerId, request.executionId)
+                            val containerName = agentRunner.getContainerIdentifier(containerId)
+                            AgentDto(containerId, containerName, request.executionId)
                         }
                     )
                         .doOnError(WebClientResponseException::class) { exception ->
diff --git a/save-orchestrator/src/main/kotlin/com/saveourtool/save/orchestrator/docker/DockerAgentRunner.kt b/save-orchestrator/src/main/kotlin/com/saveourtool/save/orchestrator/docker/DockerAgentRunner.kt
@@ -32,7 +32,6 @@ import java.util.concurrent.ConcurrentMap
 
 import kotlin.io.path.createTempDirectory
 import kotlin.io.path.writeText
-import kotlin.math.abs
 import kotlin.random.Random
 
 /**
@@ -153,6 +152,8 @@ class DockerAgentRunner(
         logger.info("Reclaimed $reclaimedBytes bytes after prune command")
     }
 
+    override fun getContainerIdentifier(containerId: String): String = dockerClient.inspectContainerCmd(containerId).exec().name
+
     /**
      * Creates a docker container
      *
@@ -168,6 +169,10 @@ class DockerAgentRunner(
         val baseImageTag = configuration.imageTag
         val runCmd = configuration.runCmd
         val envFileTargetPath = "$SAVE_AGENT_USER_HOME/.env"
+        val envVariables = configuration.env.map { (key, value) ->
+            "$key=$value"
+        } + "${AgentEnvName.AGENT_NAME.name}=$containerName"
+
         // createContainerCmd accepts image name, not id, so we retrieve it from tags
         val createContainerCmdResponse: CreateContainerResponse = dockerClient.createContainerCmd(baseImageTag)
             .withWorkingDir(EXECUTION_DIR)
@@ -183,9 +188,7 @@ class DockerAgentRunner(
             .withName(containerName)
             .withUser("save-agent")
             .withEnv(
-                configuration.env.map { (key, value) ->
-                    "$key=$value"
-                }
+                envVariables
             )
             .withHostConfig(
                 HostConfig.newHostConfig()
@@ -252,4 +255,4 @@ class DockerAgentRunner(
  * @param id
  */
 @Suppress("MAGIC_NUMBER", "MagicNumber")
-private fun containerName(id: String) = "save-execution-$id-${abs(Random.nextInt(100, 999))}"
+private fun containerName(id: String) = "save-execution-$id-${Random.nextInt(100, 999)}"
diff --git a/save-orchestrator/src/main/kotlin/com/saveourtool/save/orchestrator/kubernetes/KubernetesManager.kt b/save-orchestrator/src/main/kotlin/com/saveourtool/save/orchestrator/kubernetes/KubernetesManager.kt
@@ -159,6 +159,8 @@ class KubernetesManager(
         }
     }
 
+    override fun getContainerIdentifier(containerId: String): String = containerId
+
     private fun jobNameForExecution(executionId: Long) = "save-execution-$executionId"
 
     @Suppress("TOO_LONG_FUNCTION")
@@ -208,13 +210,17 @@ class KubernetesManager(
 
     companion object {
         private val logger = LoggerFactory.getLogger(KubernetesManager::class.java)
-        private val agentIdEnv = EnvVar().apply {
-            name = AgentEnvName.AGENT_ID.name
-            valueFrom = EnvVarSource().apply {
-                fieldRef = ObjectFieldSelector().apply {
-                    fieldPath = "metadata.name"
+        private val agentIdEnv = setOf(AgentEnvName.AGENT_ID, AgentEnvName.AGENT_NAME)
+            .map { it.name }
+            .map { envName ->
+                EnvVar().apply {
+                    name = envName
+                    valueFrom = EnvVarSource().apply {
+                        fieldRef = ObjectFieldSelector().apply {
+                            fieldPath = "metadata.name"
+                        }
+                    }
                 }
             }
-        }
     }
 }
diff --git a/save-orchestrator/src/main/kotlin/com/saveourtool/save/orchestrator/runner/AgentRunner.kt b/save-orchestrator/src/main/kotlin/com/saveourtool/save/orchestrator/runner/AgentRunner.kt
@@ -71,4 +71,12 @@ interface AgentRunner {
      * @return true if agent is not running
      */
     fun isAgentStopped(agentId: String): Boolean
+
+    /**
+     * Get container identifier: container name for docker agent runner and container id for kubernetes
+     *
+     * @param containerId
+     * @return container identifier
+     */
+    fun getContainerIdentifier(containerId: String): String
 }
diff --git a/save-orchestrator/src/test/kotlin/com/saveourtool/save/orchestrator/controller/agents/AgentsControllerTest.kt b/save-orchestrator/src/test/kotlin/com/saveourtool/save/orchestrator/controller/agents/AgentsControllerTest.kt
diff --git a/save-orchestrator/src/test/kotlin/com/saveourtool/save/orchestrator/controller/heartbeat/HeartbeatControllerTest.kt b/save-orchestrator/src/test/kotlin/com/saveourtool/save/orchestrator/controller/heartbeat/HeartbeatControllerTest.kt
diff --git a/save-sandbox/src/main/kotlin/com/saveourtool/save/orchestrator/controller/AgentsController.kt b/save-sandbox/src/main/kotlin/com/saveourtool/save/orchestrator/controller/AgentsController.kt
diff --git a/save-sandbox/src/main/kotlin/com/saveourtool/save/orchestrator/docker/DockerAgentRunner.kt b/save-sandbox/src/main/kotlin/com/saveourtool/save/orchestrator/docker/DockerAgentRunner.kt
diff --git a/save-sandbox/src/main/kotlin/com/saveourtool/save/orchestrator/kubernetes/KubernetesManager.kt b/save-sandbox/src/main/kotlin/com/saveourtool/save/orchestrator/kubernetes/KubernetesManager.kt
diff --git a/save-sandbox/src/main/kotlin/com/saveourtool/save/orchestrator/runner/AgentRunner.kt b/save-sandbox/src/main/kotlin/com/saveourtool/save/orchestrator/runner/AgentRunner.kt
diff --git a/save-sandbox/src/test/kotlin/com/saveourtool/save/orchestrator/controller/agents/AgentsControllerTest.kt b/save-sandbox/src/test/kotlin/com/saveourtool/save/orchestrator/controller/agents/AgentsControllerTest.kt
diff --git a/save-sandbox/src/test/kotlin/com/saveourtool/save/orchestrator/controller/heartbeat/HeartbeatControllerTest.kt b/save-sandbox/src/test/kotlin/com/saveourtool/save/orchestrator/controller/heartbeat/HeartbeatControllerTest.kt
