Coverage

Author: tobi-laa

build.gradle.kts

@@ -1,6 +1,7 @@
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 val springBootVersion = "3.2.3"
+val junitPlatformVersion = "1.10.2"
 val jsonPathVersion = "2.9.0" // override transitive dep due to CVE violation
 val embeddedRedisVersion = "1.4.1"
 val mockkVersion = "1.13.9"
@@ -60,6 +61,7 @@ dependencies {
     compileOnly("org.junit.jupiter:junit-jupiter-api")
     testRuntimeOnly("org.junit.platform:junit-platform-launcher")
     testImplementation("org.junit.jupiter:junit-jupiter")
+    testImplementation("org.junit.platform:junit-platform-testkit")
     testImplementation("org.springframework.boot:spring-boot-starter-data-redis")
     testImplementation("org.springframework.boot:spring-boot-starter-test")
     testImplementation("com.jayway.jsonpath:json-path:$jsonPathVersion") // override transitive dep due to CVE violation
@@ -76,6 +78,7 @@ tasks.withType<KotlinCompile> {
 
 tasks.withType<Test> {
     useJUnitPlatform()
+    exclude("**/RedisValidationExtensionTest$*")
 }
 
 tasks.jacocoTestReport {

src/main/kotlin/io/github/tobi/laa/spring/boot/embedded/redis/FindTestClassAnnotation.kt

@@ -0,0 +1,24 @@
+package io.github.tobi.laa.spring.boot.embedded.redis
+
+import org.springframework.core.annotation.MergedAnnotations.SearchStrategy.TYPE_HIERARCHY
+import org.springframework.core.annotation.MergedAnnotations.search
+import org.springframework.test.context.TestContextAnnotationUtils.searchEnclosingClass
+
+
+internal inline fun <reified T : Annotation> findTestClassAnnotations(
+    testClass: Class<*>,
+    annotationType: Class<T>
+): List<T> {
+    var clazz = testClass
+    val mergedAnnotations = mutableListOf(search(TYPE_HIERARCHY).from(testClass))
+    while (searchEnclosingClass(clazz) && clazz.enclosingClass != null) {
+        clazz = clazz.enclosingClass
+        mergedAnnotations += search(TYPE_HIERARCHY).from(clazz)
+    }
+    return mergedAnnotations
+        .stream()
+        .flatMap { it.stream(annotationType) }
+        .filter { it != null }
+        .map { it.synthesize() }
+        .toList()
+}

src/main/kotlin/io/github/tobi/laa/spring/boot/embedded/redis/FindTestClassAnnotations.kt

@@ -1,40 +1,45 @@
 package io.github.tobi.laa.spring.boot.embedded.redis.junit.extension
 
 import io.github.tobi.laa.spring.boot.embedded.redis.cluster.EmbeddedRedisCluster
+import io.github.tobi.laa.spring.boot.embedded.redis.findTestClassAnnotations
 import io.github.tobi.laa.spring.boot.embedded.redis.server.EmbeddedRedisServer
 import io.github.tobi.laa.spring.boot.embedded.redis.shardedcluster.EmbeddedRedisShardedCluster
 import org.junit.jupiter.api.extension.BeforeAllCallback
 import org.junit.jupiter.api.extension.ExtensionContext
+import java.util.stream.Stream
 import kotlin.reflect.KClass
 
 /**
  * JUnit 5 extension to validate that the API is used correctly.
  */
 internal class RedisValidationExtension : BeforeAllCallback {
 
-    private val VALID_PORT_RANGE = 0..65535
+    private val validPortRange = 0..65535
 
     override fun beforeAll(context: ExtensionContext?) {
         val embeddedRedisServer = annotation(context, EmbeddedRedisServer::class.java)
         val embeddedRedisCluster = annotation(context, EmbeddedRedisCluster::class.java)
         val embeddedRedisShardedCluster = annotation(context, EmbeddedRedisShardedCluster::class.java)
-        validateMutuallyExclusive(embeddedRedisServer, embeddedRedisCluster, embeddedRedisShardedCluster)
+        validateMutuallyExclusive(context)
         embeddedRedisServer?.let { validateServer(it) }
         embeddedRedisCluster?.let { validateCluster(it) }
         embeddedRedisShardedCluster?.let { validateShardedCluster(it) }
     }
 
-    private fun validateMutuallyExclusive(
-        embeddedRedisServer: EmbeddedRedisServer?,
-        embeddedRedisCluster: EmbeddedRedisCluster?,
-        embeddedRedisShardedCluster: EmbeddedRedisShardedCluster?
-    ) {
-        val count = listOfNotNull(embeddedRedisServer, embeddedRedisCluster, embeddedRedisShardedCluster).count()
+    private fun validateMutuallyExclusive(context: ExtensionContext?) {
+        val count = Stream.of(
+            annotations(context, EmbeddedRedisServer::class.java),
+            annotations(context, EmbeddedRedisCluster::class.java),
+            annotations(context, EmbeddedRedisShardedCluster::class.java)
+        )
+            .flatMap { it.stream() }
+            .filter { it != null }
+            .count()
         require(count <= 1) { "Only one of @EmbeddedRedisServer, @EmbeddedRedisCluster, @EmbeddedRedisShardedCluster is allowed" }
     }
 
     private fun validateServer(config: EmbeddedRedisServer) {
-        require(config.port in VALID_PORT_RANGE) { "Port must be in range $VALID_PORT_RANGE" }
+        require(config.port in validPortRange) { "Port must be in range $validPortRange" }
         require(config.configFile.isEmpty() || config.settings.isEmpty()) { "Either 'configFile' or 'settings' can be set, but not both" }
         validateCustomizers(config.customizer)
     }
@@ -46,7 +51,7 @@ internal class RedisValidationExtension : BeforeAllCallback {
     private fun validateShardedCluster(config: EmbeddedRedisShardedCluster) {
         require(config.shards.all { it.replicas > 0 }) { "Replicas for all shards must be greater than 0" }
         require(config.ports.isEmpty() || config.ports.size == config.shards.sumOf { it.replicas + 1 }) { "If ports are specified, they must match the number of nodes" }
-        require(config.ports.all { it in VALID_PORT_RANGE }) { "All ports must be in range $VALID_PORT_RANGE" }
+        require(config.ports.all { it in validPortRange }) { "All ports must be in range $validPortRange" }
         require(config.initializationTimeout > 0) { "Initialization timeout must be greater than 0" }
         validateCustomizers(config.customizer)
     }
@@ -59,7 +64,11 @@ internal class RedisValidationExtension : BeforeAllCallback {
         return customizer.constructors.any { it.parameters.isEmpty() }
     }
 
-    private fun <A : Annotation> annotation(extensionContext: ExtensionContext?, type: Class<A>): A? {
-        return extensionContext!!.requiredTestClass.getAnnotation(type)
+    private inline fun <reified A : Annotation> annotation(context: ExtensionContext?, type: Class<A>): A? {
+        return annotations(context, type).firstOrNull()
+    }
+
+    private inline fun <reified A : Annotation> annotations(context: ExtensionContext?, type: Class<A>): List<A> {
+        return findTestClassAnnotations(context!!.requiredTestClass, type)
     }
 }

src/main/kotlin/io/github/tobi/laa/spring/boot/embedded/redis/junit/extension/RedisValidationExtension.kt

@@ -1,6 +1,6 @@
 package io.github.tobi.laa.spring.boot.embedded.redis.server
 
-import io.github.tobi.laa.spring.boot.embedded.redis.findTestClassAnnotation
+import io.github.tobi.laa.spring.boot.embedded.redis.findTestClassAnnotations
 import org.springframework.test.context.ContextConfigurationAttributes
 import org.springframework.test.context.ContextCustomizer
 import org.springframework.test.context.ContextCustomizerFactory
@@ -11,7 +11,7 @@ internal class RedisServerContextCustomizerFactory : ContextCustomizerFactory {
         testClass: Class<*>,
         configAttributes: MutableList<ContextConfigurationAttributes>
     ): ContextCustomizer {
-        val embeddedRedisServer = findTestClassAnnotation(testClass, EmbeddedRedisServer::class.java)
+        val embeddedRedisServer = findTestClassAnnotations(testClass, EmbeddedRedisServer::class.java).firstOrNull()
         return RedisServerContextCustomizer(embeddedRedisServer!!)
     }
 }

src/main/kotlin/io/github/tobi/laa/spring/boot/embedded/redis/server/RedisServerContextCustomizerFactory.kt

@@ -60,10 +60,10 @@ internal class RedisShardedClusterContextCustomizer(
 
     private fun ports(): List<Int> {
         return if (config.ports.isEmpty()) {
-            val nOfNodes = config.shards.map { it.replicas + 1 }.sum()
+            val nOfNodes = config.shards.sumOf { it.replicas + 1 }
             range(0, nOfNodes).map { _ -> portProvider.next() }.toList()
         } else {
-            config.ports.asList()
+            config.ports.map { if (it == 0) portProvider.next() else it }.toList()
         }
     }
 

src/main/kotlin/io/github/tobi/laa/spring/boot/embedded/redis/shardedcluster/RedisShardedClusterContextCustomizer.kt

@@ -1,6 +1,6 @@
 package io.github.tobi.laa.spring.boot.embedded.redis.shardedcluster
 
-import io.github.tobi.laa.spring.boot.embedded.redis.findTestClassAnnotation
+import io.github.tobi.laa.spring.boot.embedded.redis.findTestClassAnnotations
 import org.springframework.test.context.ContextConfigurationAttributes
 import org.springframework.test.context.ContextCustomizer
 import org.springframework.test.context.ContextCustomizerFactory
@@ -11,7 +11,8 @@ internal class RedisShardedClusterContextCustomizerFactory : ContextCustomizerFa
         testClass: Class<*>,
         configAttributes: MutableList<ContextConfigurationAttributes>
     ): ContextCustomizer {
-        val embeddedRedisShardedCluster = findTestClassAnnotation(testClass, EmbeddedRedisShardedCluster::class.java)
+        val embeddedRedisShardedCluster =
+            findTestClassAnnotations(testClass, EmbeddedRedisShardedCluster::class.java).firstOrNull()
         return RedisShardedClusterContextCustomizer(embeddedRedisShardedCluster!!)
     }
 }