Add documentation to custom Mockk matchers

Author: sandjelkovic

kotlin/src/test/kotlin/org/axonframework/extensions/kotlin/QueryGatewayExtensionsTest.kt

@@ -41,9 +41,9 @@ class QueryGatewayExtensionsTest {
 
     @Before
     fun before() {
-        every { subjectGateway.query(queryName, exampleQuery, instanceResponseTypeMatcher<String>()) } returns instanceReturnValue
-        every { subjectGateway.query(queryName, exampleQuery, optionalResponseTypeMatcher<String>()) } returns optionalReturnValue
-        every { subjectGateway.query(queryName, exampleQuery, multipleInstancesResponseTypeMatcher<String>()) } returns listReturnValue
+        every { subjectGateway.query(queryName, exampleQuery, matchInstanceResponseType<String>()) } returns instanceReturnValue
+        every { subjectGateway.query(queryName, exampleQuery, matchOptionalResponseType<String>()) } returns optionalReturnValue
+        every { subjectGateway.query(queryName, exampleQuery, matchMultipleInstancesResponseType<String>()) } returns listReturnValue
     }
 
     @After
@@ -56,47 +56,47 @@ class QueryGatewayExtensionsTest {
         val queryResult = subjectGateway.queryForSingle<String, ExampleQuery>(queryName = queryName, query = exampleQuery)
 
         assertSame(queryResult, instanceReturnValue)
-        verify(exactly = 1) { subjectGateway.query(queryName, exampleQuery, responseTypeOfMatcher(String::class.java)) }
+        verify(exactly = 1) { subjectGateway.query(queryName, exampleQuery, matchExpectedResponseType(String::class.java)) }
     }
 
     @Test
     fun `Query for Single should invoke query method and not require explicit generic types`() {
         val queryResult: CompletableFuture<String> = subjectGateway.queryForSingle(queryName = queryName, query = exampleQuery)
 
         assertSame(queryResult, instanceReturnValue)
-        verify(exactly = 1) { subjectGateway.query(queryName, exampleQuery, responseTypeOfMatcher(String::class.java)) }
+        verify(exactly = 1) { subjectGateway.query(queryName, exampleQuery, matchExpectedResponseType(String::class.java)) }
     }
 
     @Test
     fun `Query for Optional should invoke query method with correct generic parameters`() {
         val queryResult = subjectGateway.queryForOptional<String, ExampleQuery>(queryName = queryName, query = exampleQuery)
 
         assertSame(queryResult, optionalReturnValue)
-        verify(exactly = 1) { subjectGateway.query(queryName, exampleQuery, responseTypeOfMatcher(String::class.java)) }
+        verify(exactly = 1) { subjectGateway.query(queryName, exampleQuery, matchExpectedResponseType(String::class.java)) }
     }
 
     @Test
     fun `Query for Optional should invoke query method and not require explicit generic types`() {
         val queryResult: CompletableFuture<Optional<String>> = subjectGateway.queryForOptional(queryName = queryName, query = exampleQuery)
 
         assertSame(queryResult, optionalReturnValue)
-        verify(exactly = 1) { subjectGateway.query(queryName, exampleQuery, responseTypeOfMatcher(String::class.java)) }
+        verify(exactly = 1) { subjectGateway.query(queryName, exampleQuery, matchExpectedResponseType(String::class.java)) }
     }
 
     @Test
     fun `Query for Multiple should invoke query method with correct generic parameters`() {
         val queryResult = subjectGateway.queryForMultiple<String, ExampleQuery>(queryName = queryName, query = exampleQuery)
 
         assertSame(queryResult, listReturnValue)
-        verify(exactly = 1) { subjectGateway.query(queryName, exampleQuery, responseTypeOfMatcher(String::class.java)) }
+        verify(exactly = 1) { subjectGateway.query(queryName, exampleQuery, matchExpectedResponseType(String::class.java)) }
     }
 
     @Test
     fun `Query for Multiple should invoke query method and not require explicit generic types`() {
         val queryResult: CompletableFuture<List<String>> = subjectGateway.queryForMultiple(queryName = queryName, query = exampleQuery)
 
         assertSame(queryResult, listReturnValue)
-        verify(exactly = 1) { subjectGateway.query(queryName, exampleQuery, responseTypeOfMatcher(String::class.java)) }
+        verify(exactly = 1) { subjectGateway.query(queryName, exampleQuery, matchExpectedResponseType(String::class.java)) }
     }
 
     @Test
@@ -110,7 +110,7 @@ class QueryGatewayExtensionsTest {
 
         assertSame(queryResult, nullInstanceReturnValue)
         assertTrue(nullInstanceReturnValue.get() == null)
-        verify(exactly = 1) { nullableQueryGateway.query(queryName, exampleQuery, responseTypeOfMatcher(String::class.java)) }
+        verify(exactly = 1) { nullableQueryGateway.query(queryName, exampleQuery, matchExpectedResponseType(String::class.java)) }
     }
 
 }

kotlin/src/test/kotlin/org/axonframework/extensions/kotlin/mockkExtensions.kt

@@ -24,7 +24,27 @@ import org.axonframework.messaging.responsetypes.OptionalResponseType
 import org.axonframework.messaging.responsetypes.ResponseType
 import java.util.*
 
-internal fun <T> MockKVerificationScope.responseTypeOfMatcher(clazz: Class<T>) = match { type: ResponseType<T> -> type.expectedResponseType == clazz }
-internal fun <T> MockKMatcherScope.instanceResponseTypeMatcher() = match { type: AbstractResponseType<T> -> type is InstanceResponseType }
-internal fun <T> MockKMatcherScope.optionalResponseTypeMatcher() = match { type: AbstractResponseType<Optional<T>> -> type is OptionalResponseType<*> }
-internal fun <T> MockKMatcherScope.multipleInstancesResponseTypeMatcher() = match { type: AbstractResponseType<List<T>> -> type is MultipleInstancesResponseType<*> }
+/**
+ * Matches wrapped type of given [ResponseType] instead of entire [ResponseType] object
+ * @param clazz Class object of the type to match
+ * @param T Type wrapped by [ResponseType]
+ */
+internal fun <T> MockKVerificationScope.matchExpectedResponseType(clazz: Class<T>) = match { type: ResponseType<T> -> type.expectedResponseType == clazz }
+
+/**
+ * Matches that given [ResponseType] is [InstanceResponseType]
+ * @param T Type wrapped by given [ResponseType] instance. Required for Mockk but will not be explicitly matched
+ */
+internal fun <T> MockKMatcherScope.matchInstanceResponseType() = match { type: AbstractResponseType<T> -> type is InstanceResponseType }
+
+/**
+ * Matches that given [ResponseType] is [OptionalResponseType]. Will not check type wrapped by the [Optional] instance
+ * @param T Type wrapped by given [ResponseType] instance. Required for Mockk but will not be explicitly matched
+ */
+internal fun <T> MockKMatcherScope.matchOptionalResponseType() = match { type: AbstractResponseType<Optional<T>> -> type is OptionalResponseType }
+
+/**
+ * Matches that given [ResponseType] is [MultipleInstancesResponseType]. Will not check type wrapped by the [List] instance
+ * @param T Type wrapped by given [ResponseType] instance. Required for Mockk but will not be explicitly matched
+ */
+internal fun <T> MockKMatcherScope.matchMultipleInstancesResponseType() = match { type: AbstractResponseType<List<T>> -> type is MultipleInstancesResponseType<*> }