Merge pull request #12 from AxonFramework/feature/10-gateway-extension-test

Feature/10 gateway extension test

Author: sandjelkovic

kotlin/pom.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-  ~ Copyright (c) 2010-2018. Axon Framework
+  ~ Copyright (c) 2010-2020. Axon Framework
   ~
   ~ Licensed under the Apache License, Version 2.0 (the "License");
   ~ you may not use this file except in compliance with the License.

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/CommandGatewayExtensions.kt

@@ -1,61 +1,35 @@
-/*-
- * #%L
- * Axon Framework Kotlin Extension
- * %%
- * Copyright (C) 2019 AxonIQ
- * %%
+/*
+ * Copyright (c) 2010-2020. Axon Framework
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
- *  you may not use this file except in compliance with the License.
- *  You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the License is distributed on an "AS IS" BASIS,
- *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *  See the License for the specific language governing permissions and
- *  limitations under the License.
- * #L%
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 package org.axonframework.extensions.kotlin
 
-import org.axonframework.commandhandling.CommandCallback
 import org.axonframework.commandhandling.CommandMessage
 import org.axonframework.commandhandling.gateway.CommandGateway
 import org.axonframework.messaging.MetaData
-import java.util.concurrent.TimeUnit
 
 /**
- * Extension for command gateway.
+ * Callback-style [CommandGateway.send] with dedicated on-success and on-error functions
+ * @param command The command to send
+ * @param onError Callback to handle failed execution
+ * @param onSuccess Callback to handle successful execution
+ * @param [R] the type of result of the command handling
+ * @param [C] the type of payload of the command
+ * @see CommandGateway.send
  */
-object CommandGatewayExtensions {
-    /**
-     * Callback-style send with dedicated on-success and on-error functions (defaults do nothing)
-     */
-    inline fun <reified C : Any, reified R : Any?> CommandGateway.send(
-            command: C,
-            crossinline onSuccess: (commandMessage: CommandMessage<out C>, result: R, metaData: MetaData) -> Unit = { _, _, _ -> },
-            crossinline onError: (commandMessage: CommandMessage<out C>, exception: Throwable, metaData: MetaData) -> Unit = { _, _, _ -> }
-    ) {
-        this.send(command, CommandCallback<C, R> { commandMessage, callBack ->
-            val metaData = callBack.metaData ?: MetaData.emptyInstance()
-            if (callBack.isExceptional) {
-                onError(commandMessage, callBack.exceptionResult(), metaData)
-            } else {
-                onSuccess(commandMessage, callBack.payload, metaData)
-            }
-        })
-    }
-
-    /**
-     * Reified version of send and wait.
-     */
-    inline fun <reified R : Any?> CommandGateway.sendAndWaitWithResponse(command: Any) =
-            this.sendAndWait<R>(command)
-
-    /**
-     * Reified version of send and wait with a timeout (defaulting to {@link TimeUnit.MILLISECONDS} unit)
-     */
-    inline fun <reified R : Any?> CommandGateway.sendAndWaitWithResponse(command: Any, timeout: Long, unit: TimeUnit = TimeUnit.MILLISECONDS) =
-            this.sendAndWait<R>(command, timeout, unit)
-}
+fun <C : Any, R : Any?> CommandGateway.send(
+    command: C,
+    onSuccess: (commandMessage: CommandMessage<out C>, result: R, metaData: MetaData) -> Unit = { _, _, _ -> },
+    onError: (commandMessage: CommandMessage<out C>, exception: Throwable, metaData: MetaData) -> Unit = { _, _, _ -> }
+): Unit = this.send(command, ResultDiscriminatorCommandCallback<C, R>(onSuccess, onError))

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/EventUpcaster.kt

@@ -1,21 +1,17 @@
-/*-
- * #%L
- * Axon Framework Kotlin Extension
- * %%
- * Copyright (C) 2019 AxonIQ
- * %%
+/*
+ * Copyright (c) 2010-2020. Axon Framework
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
- *  you may not use this file except in compliance with the License.
- *  You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the License is distributed on an "AS IS" BASIS,
- *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *  See the License for the specific language governing permissions and
- *  limitations under the License.
- * #L%
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 package org.axonframework.extensions.kotlin
 
@@ -29,7 +25,7 @@ import kotlin.reflect.KClass
  */
 object EventUpcaster {
     /**
-     * Creates a singleEventUpcaster for given type and revisions and calls [IntermediateEventRepresentation#upcastPayload] using the [converter].
+     * Creates a singleEventUpcaster for given type and revisions and calls [IntermediateEventRepresentation.upcastPayload] using the [converter].
      */
     fun <T : Any> singleEventUpcaster(eventType: KClass<*>,
                                       storageType: KClass<T>,

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/GenericEventMessageExtensions.kt

@@ -1,21 +1,17 @@
-/*-
- * #%L
- * Axon Framework Kotlin Extension
- * %%
- * Copyright (C) 2019 AxonIQ
- * %%
+/*
+ * Copyright (c) 2010-2020. Axon Framework
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
- *  you may not use this file except in compliance with the License.
- *  You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the License is distributed on an "AS IS" BASIS,
- *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *  See the License for the specific language governing permissions and
- *  limitations under the License.
- * #L%
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 package org.axonframework.extensions.kotlin
 

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/QueryGatewayExtensions.kt

@@ -1,21 +1,17 @@
-/*-
- * #%L
- * Axon Framework Kotlin Extension
- * %%
- * Copyright (C) 2019 AxonIQ
- * %%
+/*
+ * Copyright (c) 2010-2020. Axon Framework
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
- *  you may not use this file except in compliance with the License.
- *  You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the License is distributed on an "AS IS" BASIS,
- *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *  See the License for the specific language governing permissions and
- *  limitations under the License.
- * #L%
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 package org.axonframework.extensions.kotlin
 
@@ -25,29 +21,46 @@ import java.util.*
 import java.util.concurrent.CompletableFuture
 
 /**
- * Extensions to access query gateway.
+ * Reified version of [QueryGateway.query] with explicit query name
+ * which expects a collection as a response using [org.axonframework.messaging.responsetypes.MultipleInstancesResponseType]
+ * @param queryName Name of the query
+ * @param query Query to send
+ * @param [Q] the type of payload of the query
+ * @param [R] the type of result of the query
+ * @return [CompletableFuture] wrapping the result of the query
+ * @see QueryGateway.query
+ * @see ResponseTypes
  */
-object QueryGatewayExtensions {
-
-    /**
-     * Reified version of queryForMultiple.
-     */
-    inline fun <reified R, reified Q> QueryGateway.queryForMultiple(queryName: String, query: Q): CompletableFuture<List<R>> {
-        return this.query(queryName, query, ResponseTypes.multipleInstancesOf(R::class.java))
-    }
-
-    /**
-     * Reified version of queryForSingle.
-     */
-    inline fun <reified R, reified Q> QueryGateway.queryForSingle(queryName: String, query: Q): CompletableFuture<R> {
-        return this.query(queryName, query, ResponseTypes.instanceOf(R::class.java))
-    }
+inline fun <reified R, reified Q> QueryGateway.queryForMultiple(queryName: String, query: Q): CompletableFuture<List<R>> {
+    return this.query(queryName, query, ResponseTypes.multipleInstancesOf(R::class.java))
+}
 
-    /**
-     * Reified version of queryForOptional.
-     */
-    inline fun <reified R, reified Q> QueryGateway.queryForOptional(queryName: String, query: Q): CompletableFuture<Optional<R>> {
-        return this.query(queryName, query, ResponseTypes.optionalInstanceOf(R::class.java))
-    }
+/**
+ * Reified version of [QueryGateway.query] with explicit query name
+ * which expects a single object as a response using [org.axonframework.messaging.responsetypes.InstanceResponseType]
+ * @param queryName Name of the query
+ * @param query Query to send
+ * @param [Q] the type of payload of the query
+ * @param [R] the type of result of the query
+ * @return [CompletableFuture] wrapping the result of the query
+ * @see QueryGateway.query
+ * @see ResponseTypes
+ */
+inline fun <reified R, reified Q> QueryGateway.queryForSingle(queryName: String, query: Q): CompletableFuture<R> {
+    return this.query(queryName, query, ResponseTypes.instanceOf(R::class.java))
+}
 
+/**
+ * Reified version of [QueryGateway.query] with explicit query name
+ * which expects an Optional object as a response using [org.axonframework.messaging.responsetypes.OptionalResponseType]
+ * @param queryName Name of the query
+ * @param query Query to send
+ * @param [Q] the type of payload of the query
+ * @param [R] the type of result of the query
+ * @return [CompletableFuture] wrapping the result of the query
+ * @see QueryGateway.query
+ * @see ResponseTypes
+ */
+inline fun <reified R, reified Q> QueryGateway.queryForOptional(queryName: String, query: Q): CompletableFuture<Optional<R>> {
+    return this.query(queryName, query, ResponseTypes.optionalInstanceOf(R::class.java))
 }

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/ResultDiscriminatorCommandCallback.kt

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2010-2020. Axon Framework
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.axonframework.extensions.kotlin
+
+import org.axonframework.commandhandling.CommandCallback
+import org.axonframework.commandhandling.CommandMessage
+import org.axonframework.commandhandling.CommandResultMessage
+import org.axonframework.messaging.MetaData
+
+/**
+ * Implementation of the [CommandCallback] that is appropriate for dedicated [onError] and [onSuccess] callbacks
+ * @param onError Callback to handle failed execution. Defaults to an empty function
+ * @param onSuccess Callback to handle successful execution. Defaults to an empty function
+ * @param [R] the type of result of the command handling
+ * @param [C] the type of payload of the command
+ * @see CommandCallback
+ * @author Stefan Andjelkovic
+ */
+internal class ResultDiscriminatorCommandCallback<C, R>(
+    val onSuccess: (commandMessage: CommandMessage<out C>, result: R, metaData: MetaData) -> Unit,
+    val onError: (commandMessage: CommandMessage<out C>, exception: Throwable, metaData: MetaData) -> Unit
+) : CommandCallback<C, R> {
+    override fun onResult(commandMessage: CommandMessage<out C>, commandResultMessage: CommandResultMessage<out R>) {
+        val metaData = commandResultMessage.metaData ?: MetaData.emptyInstance()
+        if (commandResultMessage.isExceptional) {
+            onError(commandMessage, commandResultMessage.exceptionResult(), metaData)
+        } else {
+            onSuccess(commandMessage, commandResultMessage.payload, metaData)
+        }
+    }
+}
+

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

@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2010-2020. Axon Framework
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.axonframework.extensions.kotlin
+
+import io.mockk.Runs
+import io.mockk.every
+import io.mockk.just
+import io.mockk.mockk
+import io.mockk.verify
+import org.axonframework.commandhandling.CommandCallback
+import org.axonframework.commandhandling.CommandMessage
+import org.axonframework.commandhandling.gateway.CommandGateway
+import org.axonframework.messaging.MetaData
+import java.util.concurrent.TimeUnit
+import kotlin.test.Test
+
+/**
+ * Tests Command Gateway extensions.
+ *
+ * @author Stefan Andjelkovic
+ */
+class CommandGatewayExtensionsTest {
+    private val subjectGateway = mockk<CommandGateway>()
+
+    private val exampleCommand = ExampleCommand("1")
+    private val timeoutInterval: Long = 30
+    private val defaultTimeUnit = TimeUnit.MILLISECONDS
+
+    @Test
+    fun `Send extension should invoke correct method on the gateway`() {
+        every { subjectGateway.send(exampleCommand, any<CommandCallback<ExampleCommand, Any>>()) } just Runs
+
+        subjectGateway.send<ExampleCommand, Any>(command = exampleCommand, onError = { _, _, _ -> }, onSuccess = { _, _, _ -> })
+
+        verify { subjectGateway.send(exampleCommand, any<CommandCallback<ExampleCommand, Any>>()) }
+    }
+
+    @Test
+    fun `Send extension should invoke correct method on the gateway without explicit generic parameters`() {
+        every { subjectGateway.send(exampleCommand, any<CommandCallback<ExampleCommand, Any>>()) } just Runs
+
+        subjectGateway.send(
+            command = exampleCommand,
+            onError = { _: Any, _: Throwable, _: MetaData -> },
+            onSuccess = { _: CommandMessage<out ExampleCommand>, _: Any, _: MetaData -> }
+        )
+
+        verify { subjectGateway.send(exampleCommand, any<CommandCallback<ExampleCommand, Any>>()) }
+    }
+}