Skip to content

Commit

Permalink
test: Make Tests more robust
Browse files Browse the repository at this point in the history
  • Loading branch information
@wba2hi
wba2hi committed Mar 15, 2024
1 parent 0083330 commit 1c5b0ee
Show file tree
Hide file tree
Showing 7 changed files with 248 additions and 159 deletions.
86 changes: 78 additions & 8 deletions ...in/org/eclipse/kuksa/connectivity/authentication/DataBrokerConnectorAuthenticationTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,27 @@

package org.eclipse.kuksa.connectivity.authentication

import io.grpc.StatusRuntimeException
import io.kotest.assertions.nondeterministic.eventually
import io.kotest.core.spec.style.BehaviorSpec
import io.kotest.matchers.shouldBe
import io.kotest.matchers.shouldNotBe
import io.kotest.matchers.string.shouldContain
import io.kotest.matchers.types.instanceOf
import org.eclipse.kuksa.connectivity.databroker.DataBrokerConnectorProvider
import org.eclipse.kuksa.connectivity.databroker.DataBrokerException
import org.eclipse.kuksa.connectivity.databroker.docker.DockerDatabrokerContainer
import org.eclipse.kuksa.connectivity.databroker.docker.DockerSecureDatabrokerContainer
import org.eclipse.kuksa.connectivity.databroker.request.FetchRequest
import org.eclipse.kuksa.connectivity.databroker.request.SubscribeRequest
import org.eclipse.kuksa.connectivity.databroker.request.UpdateRequest
import org.eclipse.kuksa.mocking.FriendlyVssPathListener
import org.eclipse.kuksa.proto.v1.Types
import org.eclipse.kuksa.test.TestResourceFile
import org.eclipse.kuksa.test.kotest.Authentication
import org.eclipse.kuksa.test.kotest.Integration
import org.eclipse.kuksa.test.kotest.Secure
import org.eclipse.kuksa.test.kotest.SecureDatabroker
import org.eclipse.kuksa.test.kotest.eventuallyConfiguration
import kotlin.random.Random
import kotlin.random.nextInt

Expand All @@ -55,17 +63,15 @@ class DataBrokerConnectorAuthenticationTest : BehaviorSpec({
}

val random = Random(System.nanoTime())
val tlsCertificate = TestResourceFile("tls/CA.pem")

given("A DataBrokerConnectorProvider") {
val dataBrokerConnectorProvider = DataBrokerConnectorProvider()
val speedVssPath = "Vehicle.Speed"

and("an insecure DataBrokerConnector with a READ_WRITE_ALL JWT") {
and("a secure DataBrokerConnector with a READ_WRITE_ALL JWT") {
val jwtFile = JwtType.READ_WRITE_ALL

val dataBrokerConnector = dataBrokerConnectorProvider.createSecure(
rootCertFileStream = tlsCertificate.inputStream(),
jwtFileStream = jwtFile.asInputStream(),
)

Expand Down Expand Up @@ -95,10 +101,9 @@ class DataBrokerConnectorAuthenticationTest : BehaviorSpec({
}
}

and("an insecure DataBrokerConnector with a READ_ALL JWT") {
and("a secure DataBrokerConnector with a READ_ALL JWT") {
val jwtFile = JwtType.READ_ALL
val dataBrokerConnector = dataBrokerConnectorProvider.createSecure(
rootCertFileStream = tlsCertificate.inputStream(),
jwtFileStream = jwtFile.asInputStream(),
)

Expand Down Expand Up @@ -127,10 +132,9 @@ class DataBrokerConnectorAuthenticationTest : BehaviorSpec({
}
}

and("an insecure DataBrokerConnector with a READ_WRITE_ALL_VALUES_ONLY JWT") {
and("a secure DataBrokerConnector with a READ_WRITE_ALL_VALUES_ONLY JWT") {
val jwtFile = JwtType.READ_WRITE_ALL_VALUES_ONLY
val dataBrokerConnector = dataBrokerConnectorProvider.createSecure(
rootCertFileStream = tlsCertificate.inputStream(),
jwtFileStream = jwtFile.asInputStream(),
)

Expand Down Expand Up @@ -182,5 +186,71 @@ class DataBrokerConnectorAuthenticationTest : BehaviorSpec({
}
}
}

and("a secure DataBrokerConnector with no JWT") {
val dataBrokerConnector = dataBrokerConnectorProvider.createSecure(
jwtFileStream = null,
)

`when`("Trying to connect") {
val result = runCatching {
dataBrokerConnector.connect()
}

then("The connection should be successful") {
result.getOrNull() shouldNotBe null
}

val connection = result.getOrNull()!!

`when`("Reading the VALUE of Vehicle.Speed") {
val fetchRequest = FetchRequest(speedVssPath)
val fetchResult = runCatching {
connection.fetch(fetchRequest)
}

then("An error should occur") {
val exception = fetchResult.exceptionOrNull()
exception shouldNotBe null
exception shouldBe instanceOf(DataBrokerException::class)
exception!!.message shouldContain "UNAUTHENTICATED"
}
}

`when`("Writing the VALUE of Vehicle.Speed") {
val nextFloat = random.nextFloat() * 100F
val datapoint = Types.Datapoint.newBuilder().setFloat(nextFloat).build()
val updateRequest = UpdateRequest(speedVssPath, datapoint)

val updateResult = runCatching {
connection.update(updateRequest)
}

then("An error should occur") {
val exception = updateResult.exceptionOrNull()
exception shouldNotBe null
exception shouldBe instanceOf(DataBrokerException::class)
exception!!.message shouldContain "UNAUTHENTICATED"
}
}

`when`("Subscribing to the VALUE of Vehicle.Speed") {
val subscribeRequest = SubscribeRequest(speedVssPath)
val vssPathListener = FriendlyVssPathListener()

connection.subscribe(subscribeRequest, vssPathListener)

then("An error should occur") {
eventually(eventuallyConfiguration) {
vssPathListener.errors.size shouldBe 1

val exception = vssPathListener.errors.first()
exception shouldBe instanceOf(StatusRuntimeException::class)
exception.message shouldContain "UNAUTHENTICATED"
}
}
}
}
}
}
})
112 changes: 45 additions & 67 deletions ...sdk/src/test/kotlin/org/eclipse/kuksa/connectivity/databroker/DataBrokerConnectionTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,32 +23,29 @@ import io.grpc.ManagedChannel
import io.kotest.assertions.nondeterministic.eventually
import io.kotest.core.spec.style.BehaviorSpec
import io.kotest.matchers.shouldBe
import io.kotest.matchers.string.shouldContain
import io.mockk.clearMocks
import io.mockk.every
import io.mockk.mockk
import io.mockk.slot
import io.mockk.verify
import kotlinx.coroutines.runBlocking
import org.eclipse.kuksa.connectivity.databroker.docker.DockerDatabrokerContainer
import org.eclipse.kuksa.connectivity.databroker.docker.DockerInsecureDatabrokerContainer
import org.eclipse.kuksa.connectivity.databroker.listener.DisconnectListener
import org.eclipse.kuksa.connectivity.databroker.listener.VssPathListener
import org.eclipse.kuksa.connectivity.databroker.request.FetchRequest
import org.eclipse.kuksa.connectivity.databroker.request.SubscribeRequest
import org.eclipse.kuksa.connectivity.databroker.request.UpdateRequest
import org.eclipse.kuksa.connectivity.databroker.request.VssNodeFetchRequest
import org.eclipse.kuksa.connectivity.databroker.request.VssNodeSubscribeRequest
import org.eclipse.kuksa.extensions.updateRandomFloatValue
import org.eclipse.kuksa.mocking.FriendlyVssNodeListener
import org.eclipse.kuksa.proto.v1.KuksaValV1
import org.eclipse.kuksa.mocking.FriendlyVssPathListener
import org.eclipse.kuksa.proto.v1.Types
import org.eclipse.kuksa.test.extension.equals
import org.eclipse.kuksa.test.kotest.Insecure
import org.eclipse.kuksa.test.kotest.InsecureDatabroker
import org.eclipse.kuksa.test.kotest.Integration
import org.eclipse.kuksa.test.kotest.eventuallyConfiguration
import org.eclipse.kuksa.vssNode.VssDriver
import org.junit.jupiter.api.Assertions
import kotlin.random.Random
import kotlin.time.Duration.Companion.seconds

class DataBrokerConnectionTest : BehaviorSpec({
tags(Integration, Insecure, InsecureDatabroker)
Expand All @@ -66,49 +63,50 @@ class DataBrokerConnectionTest : BehaviorSpec({
}

given("A successfully established connection to the DataBroker") {
val dataBrokerConnection = connectToDataBrokerBlocking()
val dataBrokerConnectorProvider = DataBrokerConnectorProvider()
val connector = dataBrokerConnectorProvider.createInsecure()
val dataBrokerConnection = connector.connect()

val dataBrokerTransporter = DataBrokerTransporter(dataBrokerConnectorProvider.managedChannel)

and("A request with a valid VSS Path") {
val vssPath = "Vehicle.Acceleration.Lateral"
val field = Types.Field.FIELD_VALUE
val subscribeRequest = SubscribeRequest(vssPath, field)

val initialValue = dataBrokerTransporter.updateRandomFloatValue(vssPath)

val subscribeRequest = SubscribeRequest(vssPath, field)
`when`("Subscribing to the VSS path") {
val vssPathListener = mockk<VssPathListener>(relaxed = true)
val vssPathListener = FriendlyVssPathListener()
dataBrokerConnection.subscribe(subscribeRequest, vssPathListener)

then("The #onEntryChanged method is triggered") {
val capturingSlot = slot<List<KuksaValV1.EntryUpdate>>()
verify(timeout = 100L) {
vssPathListener.onEntryChanged(capture(capturingSlot))
eventually(eventuallyConfiguration) {
vssPathListener.updates.flatten().count {
val entry = it.entry
val value = entry.value
entry.path == vssPath && value.float.equals(initialValue, 0.0001f)
} shouldBe 1
}

val entryUpdates = capturingSlot.captured
entryUpdates.size shouldBe 1
entryUpdates[0].entry.path shouldBe vssPath
}

`when`("The observed VSS path changes") {
clearMocks(vssPathListener)
vssPathListener.reset()

val random = Random(System.currentTimeMillis())
val newValue = random.nextFloat()
val datapoint = Types.Datapoint.newBuilder().setFloat(newValue).build()
val updatedValue = random.nextFloat()
val datapoint = Types.Datapoint.newBuilder().setFloat(updatedValue).build()
val updateRequest = UpdateRequest(vssPath, datapoint, field)
dataBrokerConnection.update(updateRequest)

then("The #onEntryChanged callback is triggered with the new value") {
val capturingSlot = slot<List<KuksaValV1.EntryUpdate>>()

verify(timeout = 100) {
vssPathListener.onEntryChanged(capture(capturingSlot))
eventually(eventuallyConfiguration) {
vssPathListener.updates.flatten().count {
val entry = it.entry
val value = entry.value
entry.path == vssPath && value.float.equals(updatedValue, 0.0001f)
} shouldBe 1
}

val entryUpdates = capturingSlot.captured
val capturedDatapoint = entryUpdates[0].entry.value
val float = capturedDatapoint.float

Assertions.assertEquals(newValue, float, 0.0001f)
}
}
}
Expand Down Expand Up @@ -193,7 +191,7 @@ class DataBrokerConnectionTest : BehaviorSpec({
dataBrokerConnection.subscribe(subscribeRequest, listener = vssNodeListener)

then("The #onNodeChanged method is triggered") {
eventually(1.seconds) {
eventually(eventuallyConfiguration) {
vssNodeListener.updatedVssNodes.size shouldBe 1
}
}
Expand All @@ -206,14 +204,12 @@ class DataBrokerConnectionTest : BehaviorSpec({
dataBrokerConnection.update(updateRequest)

then("Every child node has been updated with the correct value") {
eventually(1.seconds) {
vssNodeListener.updatedVssNodes.size shouldBe 2
eventually(eventuallyConfiguration) {
vssNodeListener.updatedVssNodes.count {
val heartRate = it.heartRate
heartRate.value == newHeartRateValue
} shouldBe 1
}

val updatedDriver = vssNodeListener.updatedVssNodes.last()
val heartRate = updatedDriver.heartRate

heartRate.value shouldBe newHeartRateValue
}
}

Expand All @@ -225,14 +221,12 @@ class DataBrokerConnectionTest : BehaviorSpec({
dataBrokerConnection.update(updateRequest)

then("The subscribed vssNode should be updated") {
eventually(1.seconds) {
vssNodeListener.updatedVssNodes.size shouldBe 3
eventually(eventuallyConfiguration) {
vssNodeListener.updatedVssNodes.count {
val heartRate = it.heartRate
heartRate.value == newHeartRateValue
} shouldBe 1
}

val updatedDriver = vssNodeListener.updatedVssNodes.last()
val heartRate = updatedDriver.heartRate

heartRate.value shouldBe newHeartRateValue
}
}
}
Expand All @@ -242,15 +236,16 @@ class DataBrokerConnectionTest : BehaviorSpec({
val invalidVssPath = "Vehicle.Some.Unknown.Path"

`when`("Trying to subscribe to the INVALID VSS path") {
val vssPathListener = mockk<VssPathListener>(relaxed = true)
val vssPathListener = FriendlyVssPathListener()
val subscribeRequest = SubscribeRequest(invalidVssPath)
dataBrokerConnection.subscribe(subscribeRequest, vssPathListener)

then("The VssPathListener#onError method should be triggered with 'NOT_FOUND' (Path not found)") {
val capturingSlot = slot<Throwable>()
verify(timeout = 100L) { vssPathListener.onError(capture(capturingSlot)) }
val capturedThrowable = capturingSlot.captured
capturedThrowable.message shouldContain "NOT_FOUND"
eventually(eventuallyConfiguration) {
vssPathListener.errors.count {
it.message?.contains("NOT_FOUND") == true
} shouldBe 1
}
}
}

Expand Down Expand Up @@ -331,20 +326,3 @@ private fun createRandomIntDatapoint(): Types.Datapoint {
val newValue = random.nextInt()
return Types.Datapoint.newBuilder().setInt32(newValue).build()
}

private fun connectToDataBrokerBlocking(): DataBrokerConnection {
var connection: DataBrokerConnection

runBlocking {
val connector = DataBrokerConnectorProvider().createInsecure()
try {
connection = connector.connect()
} catch (ignored: DataBrokerException) {
val errorMessage = "Could not establish a connection to the DataBroker. " +
"Check if the DataBroker is running and correctly configured in DataBrokerConfig."
throw IllegalStateException(errorMessage)
}
}

return connection
}
2 changes: 1 addition & 1 deletion ...-sdk/src/test/kotlin/org/eclipse/kuksa/connectivity/databroker/DataBrokerConnectorTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ class DataBrokerConnectorTest : BehaviorSpec({
dataBrokerConnector.connect()
}

then("It should throw an exception") {
then("It should throw a DataBrokerException") {
exception shouldNotBe null
}
}
Expand Down
11 changes: 8 additions & 3 deletions ...dk/src/test/kotlin/org/eclipse/kuksa/connectivity/databroker/DataBrokerTransporterTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
package org.eclipse.kuksa.connectivity.databroker

import io.grpc.ManagedChannelBuilder
import io.kotest.assertions.nondeterministic.eventually
import io.kotest.core.spec.style.BehaviorSpec
import io.kotest.matchers.shouldBe
import io.kotest.matchers.shouldNotBe
Expand All @@ -29,11 +30,13 @@ import org.eclipse.kuksa.connectivity.databroker.docker.DockerDatabrokerContaine
import org.eclipse.kuksa.connectivity.databroker.docker.DockerInsecureDatabrokerContainer
import org.eclipse.kuksa.connectivity.databroker.listener.VssPathListener
import org.eclipse.kuksa.extensions.updateRandomFloatValue
import org.eclipse.kuksa.mocking.FriendlyVssPathListener
import org.eclipse.kuksa.proto.v1.KuksaValV1
import org.eclipse.kuksa.proto.v1.Types
import org.eclipse.kuksa.test.kotest.Insecure
import org.eclipse.kuksa.test.kotest.InsecureDatabroker
import org.eclipse.kuksa.test.kotest.Integration
import org.eclipse.kuksa.test.kotest.eventuallyConfiguration
import kotlin.random.Random

class DataBrokerTransporterTest : BehaviorSpec({
Expand Down Expand Up @@ -135,12 +138,14 @@ class DataBrokerTransporterTest : BehaviorSpec({
Types.Field.FIELD_VALUE,
)

val vssPathListener = mockk<VssPathListener>(relaxed = true)
val vssPathListener = FriendlyVssPathListener()
subscription.listeners.register(vssPathListener)

then("An Error should be triggered") {
verify(timeout = 100L) {
vssPathListener.onError(any())
eventually(eventuallyConfiguration) {
vssPathListener.errors.count {
it.message?.contains("NOT_FOUND") == true
} shouldBe 1
}
}
}
Expand Down
Loading

0 comments on commit 1c5b0ee

Please sign in to comment.