chore: Fix sporadically failing Tests

... due to simultaneous access to shared resources.
Due to a Gradle or Library update it seems that the
debug and release tests are executed using multiple
threads, which might lead to one thread starting the
corresponding Databroker Container, while the other
 closes it. This might lead to timeouts and therefore
failing tests. Fixed it, by creating a container for
each test class. Previously only one container was
created for each testset (testRelease / testDebug)

Author: wba2hi

kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/connectivity/authentication/DataBrokerConnectorAuthenticationTest.kt

@@ -72,6 +72,7 @@ class DataBrokerConnectorAuthenticationTest : BehaviorSpec({
             val jwtFile = JwtType.READ_WRITE_ALL
 
             val dataBrokerConnector = dataBrokerConnectorProvider.createSecure(
+                port = databrokerContainer!!.port,
                 jwtFileStream = jwtFile.asInputStream(),
             )
 
@@ -104,6 +105,7 @@ class DataBrokerConnectorAuthenticationTest : BehaviorSpec({
         and("a secure DataBrokerConnector with a READ_ALL JWT") {
             val jwtFile = JwtType.READ_ALL
             val dataBrokerConnector = dataBrokerConnectorProvider.createSecure(
+                port = databrokerContainer!!.port,
                 jwtFileStream = jwtFile.asInputStream(),
             )
 
@@ -135,6 +137,7 @@ class DataBrokerConnectorAuthenticationTest : BehaviorSpec({
         and("a secure DataBrokerConnector with a READ_WRITE_ALL_VALUES_ONLY JWT") {
             val jwtFile = JwtType.READ_WRITE_ALL_VALUES_ONLY
             val dataBrokerConnector = dataBrokerConnectorProvider.createSecure(
+                port = databrokerContainer!!.port,
                 jwtFileStream = jwtFile.asInputStream(),
             )
 
@@ -189,6 +192,7 @@ class DataBrokerConnectorAuthenticationTest : BehaviorSpec({
 
         and("a secure DataBrokerConnector with no JWT") {
             val dataBrokerConnector = dataBrokerConnectorProvider.createSecure(
+                port = databrokerContainer!!.port,
                 jwtFileStream = null,
             )
 

kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/connectivity/databroker/DataBrokerConfig.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 - 2024 Contributors to the Eclipse Foundation
+ * Copyright (c) 2023 - 2025 Contributors to the Eclipse Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,5 +23,5 @@ import java.util.concurrent.TimeUnit
 
 const val DATABROKER_HOST = "127.0.0.1"
 
-const val DATABROKER_TIMEOUT_SECONDS = 5L
+const val DATABROKER_TIMEOUT_SECONDS = 10L
 val DATABROKER_TIMEOUT_UNIT = TimeUnit.SECONDS

kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/connectivity/databroker/DataBrokerConnectionTest.kt

@@ -63,7 +63,9 @@ class DataBrokerConnectionTest : BehaviorSpec({
 
     given("A successfully established connection to the DataBroker") {
         val dataBrokerConnectorProvider = DataBrokerConnectorProvider()
-        val connector = dataBrokerConnectorProvider.createInsecure()
+        val connector = dataBrokerConnectorProvider.createInsecure(
+            port = databrokerContainer!!.port,
+        )
         val dataBrokerConnection = connector.connect()
 
         and("A request with a valid VSS Path") {

kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/connectivity/databroker/DataBrokerConnectorProvider.kt

@@ -36,7 +36,7 @@ class DataBrokerConnectorProvider {
     lateinit var managedChannel: ManagedChannel
     fun createInsecure(
         host: String = DATABROKER_HOST,
-        port: Int = DATABROKER_PORT,
+        port: Int,
         jwtFileStream: InputStream? = null,
     ): DataBrokerConnector {
         managedChannel = ManagedChannelBuilder.forAddress(host, port).usePlaintext().build()
@@ -56,7 +56,7 @@ class DataBrokerConnectorProvider {
 
     fun createSecure(
         host: String = DATABROKER_HOST,
-        port: Int = DATABROKER_PORT,
+        port: Int,
         overrideAuthority: String = "",
         rootCertFileStream: InputStream = TestResourceFile("tls/CA.pem").inputStream(),
         jwtFileStream: InputStream? = JwtType.READ_WRITE_ALL.asInputStream(),

kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/connectivity/databroker/DataBrokerConnectorSecureTest.kt

@@ -52,6 +52,7 @@ class DataBrokerConnectorSecureTest : BehaviorSpec({
             val tlsCertificate = TestResourceFile("tls/CA.pem")
 
             val dataBrokerConnector = dataBrokerConnectorProvider.createSecure(
+                port = databrokerContainer!!.port,
                 rootCertFileStream = tlsCertificate.inputStream(),
             )
 

kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/connectivity/databroker/DataBrokerConnectorTest.kt

@@ -47,7 +47,9 @@ class DataBrokerConnectorTest : BehaviorSpec({
         val dataBrokerConnectorProvider = DataBrokerConnectorProvider()
 
         and("an insecure DataBrokerConnector with valid Host and Port") {
-            val dataBrokerConnector = dataBrokerConnectorProvider.createInsecure()
+            val dataBrokerConnector = dataBrokerConnectorProvider.createInsecure(
+                port = databrokerContainer!!.port,
+            )
 
             `when`("Trying to establish an insecure connection") {
                 val connection = dataBrokerConnector.connect()

kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/connectivity/databroker/docker/DataBrokerDockerContainer.kt

@@ -35,6 +35,7 @@ import com.github.dockerjava.httpclient5.ApacheDockerHttpClient
 import org.eclipse.kuksa.connectivity.databroker.DATABROKER_TIMEOUT_SECONDS
 import java.time.Duration
 import java.util.concurrent.TimeUnit
+import java.util.concurrent.atomic.AtomicInteger
 
 private const val KEY_PROPERTY_DATABROKER_TAG = "databroker.tag"
 private const val KEY_ENV_DATABROKER_TAG = "DATABROKER_TAG"
@@ -62,8 +63,9 @@ private const val DEFAULT_DATABROKER_TAG = "main"
  */
 abstract class DataBrokerDockerContainer(
     protected val containerName: String,
-    protected val port: Int,
 ) {
+    val port: Int = atomicPortNumber.getAndIncrement()
+
     protected open val hostConfig: HostConfig = HostConfig.newHostConfig()
         .withNetworkMode("host")
         .withAutoRemove(true)
@@ -134,9 +136,13 @@ abstract class DataBrokerDockerContainer(
 
             dockerClient.waitContainerCmd(containerId)
                 .exec(WaitContainerResultCallback())
-                .awaitCompletion(5, TimeUnit.SECONDS)
+                .awaitCompletion(10, TimeUnit.SECONDS)
         } catch (_: NotModifiedException) {
             // thrown when a container is already started
         }
     }
+
+    companion object {
+        private val atomicPortNumber = AtomicInteger(55560)
+    }
 }

kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/connectivity/databroker/docker/InsecureDataBrokerDockerContainer.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 - 2024 Contributors to the Eclipse Foundation
+ * Copyright (c) 2023 - 2025 Contributors to the Eclipse Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,18 +21,16 @@ package org.eclipse.kuksa.connectivity.databroker.docker
 
 import com.github.dockerjava.api.command.CreateContainerResponse
 import org.eclipse.kuksa.connectivity.databroker.DATABROKER_CONTAINER_NAME
-import org.eclipse.kuksa.connectivity.databroker.DATABROKER_PORT
 
 // no tls, no authentication
 class InsecureDataBrokerDockerContainer(
     containerName: String = DATABROKER_CONTAINER_NAME,
-    port: Int = DATABROKER_PORT,
-) : DataBrokerDockerContainer(containerName, port) {
+) : DataBrokerDockerContainer(containerName) {
 
     @Suppress("ArgumentListWrapping", "ktlint:standard:argument-list-wrapping") // better key-value pair readability
     override fun createContainer(tag: String): CreateContainerResponse {
         return dockerClient.createContainerCmd("$repository:$tag")
-            .withName(containerName)
+            .withName("${containerName}_${System.nanoTime()}")
             .withHostConfig(hostConfig)
             .withCmd(
                 "--port", "$port",

kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/connectivity/databroker/docker/SecureDataBrokerDockerContainer.kt

@@ -25,14 +25,12 @@ import com.github.dockerjava.api.model.Bind
 import com.github.dockerjava.api.model.HostConfig
 import com.github.dockerjava.api.model.Volume
 import org.eclipse.kuksa.connectivity.databroker.DATABROKER_CONTAINER_NAME
-import org.eclipse.kuksa.connectivity.databroker.DATABROKER_PORT
 import org.eclipse.kuksa.test.TestResourceFile
 
 // tls enabled, authentication enabled
 class SecureDataBrokerDockerContainer(
     containerName: String = DATABROKER_CONTAINER_NAME,
-    port: Int = DATABROKER_PORT,
-) : DataBrokerDockerContainer(containerName, port) {
+) : DataBrokerDockerContainer(containerName) {
 
     private val authenticationFolder = TestResourceFile("authentication").toString()
     private val authenticationMount = "/resources/authentication"
@@ -49,7 +47,7 @@ class SecureDataBrokerDockerContainer(
     @Suppress("ArgumentListWrapping", "ktlint:standard:argument-list-wrapping") // better key-value pair readability
     override fun createContainer(tag: String): CreateContainerResponse {
         return dockerClient.createContainerCmd("$repository:$tag")
-            .withName(containerName)
+            .withName("${containerName}_${System.nanoTime()}")
             .withHostConfig(hostConfig)
             .withCmd(
                 "--port", "$port",

kuksa-sdk/src/testDebug/kotlin/org/eclipse/kuksa/connectivity/databroker/DebugDataBrokerConfig.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 - 2024 Contributors to the Eclipse Foundation
+ * Copyright (c) 2023 - 2025 Contributors to the Eclipse Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,5 +19,4 @@
 
 package org.eclipse.kuksa.connectivity.databroker
 
-const val DATABROKER_PORT = 55557
-const val DATABROKER_CONTAINER_NAME = "databroker_testDebug"
+const val DATABROKER_CONTAINER_NAME = "databroker_test_debug"

kuksa-sdk/src/testRelease/kotlin/org/eclipse/kuksa/connectivity/databroker/ReleaseDataBrokerConfig.kt

@@ -18,5 +18,4 @@
 
 package org.eclipse.kuksa.connectivity.databroker
 
-const val DATABROKER_PORT = 55558
-const val DATABROKER_CONTAINER_NAME = "databroker_testRelease"
+const val DATABROKER_CONTAINER_NAME = "databroker_test_release"