feat: add integration test for transactional and non-transactional worker with idempotency

Author: i-am-not-giving-my-name-to-a-machine

spring-boot-starter/src/main/kotlin/dev/bpmcrafters/processengine/worker/configuration/ProcessEngineWorkerAutoConfiguration.kt

@@ -3,6 +3,7 @@ package dev.bpmcrafters.processengine.worker.configuration
 import com.fasterxml.jackson.databind.ObjectMapper
 import dev.bpmcrafters.processengine.worker.idempotency.IdempotencyRegistry
 import dev.bpmcrafters.processengine.worker.idempotency.InMemoryIdempotencyRegistry
+import dev.bpmcrafters.processengine.worker.idempotency.NoOpIdempotencyRegistry
 import dev.bpmcrafters.processengine.worker.registrar.*
 import dev.bpmcrafters.processengine.worker.registrar.metrics.ProcessEngineWorkerMetricsMicrometer
 import dev.bpmcrafters.processengine.worker.registrar.metrics.ProcessEngineWorkerMetricsNoOp
@@ -69,10 +70,10 @@ class ProcessEngineWorkerAutoConfiguration {
   }
 
   /**
-   * Fallback to in-memory idempotency repository.
+   * Fallback to no-op idempotency registry.
    */
   @Bean
   @ConditionalOnMissingBean(IdempotencyRegistry::class)
-  fun idempotencyRegistryFallback(): IdempotencyRegistry = InMemoryIdempotencyRegistry()
+  fun idempotencyRegistry(): IdempotencyRegistry = NoOpIdempotencyRegistry()
 
 }

spring-boot-starter/src/main/kotlin/dev/bpmcrafters/processengine/worker/idempotency/InMemoryIdempotencyRegistry.kt

@@ -8,6 +8,9 @@ import java.util.concurrent.ConcurrentHashMap
 
 /**
  * In-memory local implementation of the registry.
+ *
+ * Usage is discouraged because it can only take into account a single process instance.
+ * I.e., don't use it in a clustered environment.
  */
 class InMemoryIdempotencyRegistry : IdempotencyRegistry {
 

spring-boot-starter/src/main/kotlin/dev/bpmcrafters/processengine/worker/idempotency/NoOpIdempotencyRegistry.kt

@@ -0,0 +1,11 @@
+package dev.bpmcrafters.processengine.worker.idempotency
+
+import dev.bpmcrafters.processengineapi.task.TaskInformation
+
+class NoOpIdempotencyRegistry : IdempotencyRegistry {
+
+  override fun register(taskInformation: TaskInformation, result: Map<String, Any?>) {}
+
+  override fun getTaskResult(taskInformation: TaskInformation): Map<String, Any?>? = null
+
+}

…nal/AbstractTransactionalBehaviorTest.kt …amunda7/external/AbstractBehaviorTest.ktspring-boot-starter/src/test/kotlin/dev/bpmcrafters/processengine/worker/itest/camunda7/external/AbstractTransactionalBehaviorTest.kt renamed to spring-boot-starter/src/test/kotlin/dev/bpmcrafters/processengine/worker/itest/camunda7/external/AbstractBehaviorTest.kt spring-boot-starter/src/test/kotlin/dev/bpmcrafters/processengine/worker/itest/camunda7/external/AbstractTransactionalBehaviorTest.kt renamed to spring-boot-starter/src/test/kotlin/dev/bpmcrafters/processengine/worker/itest/camunda7/external/AbstractBehaviorTest.kt

@@ -13,11 +13,13 @@ import dev.bpmcrafters.processengineapi.process.StartProcessByDefinitionCmd
 import org.assertj.core.api.Assertions.assertThat
 import org.camunda.community.rest.client.api.ExternalTaskApiClient
 import org.camunda.community.rest.client.api.HistoryApiClient
+import org.camunda.community.rest.client.api.IncidentApiClient
 import org.camunda.community.rest.client.api.ProcessInstanceApiClient
 import org.camunda.community.rest.client.model.ExternalTaskDto
 import org.camunda.community.rest.client.model.ExternalTaskQueryDto
 import org.camunda.community.rest.client.model.HistoricActivityInstanceDto
 import org.camunda.community.rest.client.model.HistoricActivityInstanceQueryDto
+import org.camunda.community.rest.client.model.IncidentDto
 import org.junit.jupiter.api.AfterEach
 import org.junit.jupiter.api.BeforeEach
 import org.springframework.beans.factory.annotation.Autowired
@@ -31,7 +33,7 @@ import org.testcontainers.junit.jupiter.Testcontainers
 @SpringBootTest(classes = [TestApplication::class])
 @Testcontainers
 @ActiveProfiles("itest")
-abstract class AbstractTransactionalBehaviorTest {
+abstract class AbstractBehaviorTest {
   companion object {
 
     @Container
@@ -60,6 +62,8 @@ abstract class AbstractTransactionalBehaviorTest {
   @Autowired
   private lateinit var externalTaskApiClient: ExternalTaskApiClient
   @Autowired
+  private lateinit var incidentApiClient: IncidentApiClient
+  @Autowired
   private lateinit var historyApiClient: HistoryApiClient
   @Autowired
   private lateinit var processInstanceApiClient: ProcessInstanceApiClient
@@ -111,6 +115,34 @@ abstract class AbstractTransactionalBehaviorTest {
       .body as List<ExternalTaskDto>
   }
 
+  protected fun unlockExternalTask(taskId: String) {
+    externalTaskApiClient.unlock(taskId)
+  }
+
+  protected fun getIncidents(processInstanceId: String) = incidentApiClient.getIncidents(
+    null,
+    null,
+    null,
+    null,
+    null,
+    null,
+    processInstanceId,
+    null,
+    null,
+    null,
+    null,
+    null,
+    null,
+    null,
+    null,
+    null,
+    null,
+    null,
+    null,
+    null,
+    null
+  ).body as List<IncidentDto>
+
   protected fun getHistoricActivityInstances(processInstanceId: String, activityId: String): List<HistoricActivityInstanceDto> {
     return historyApiClient.queryHistoricActivityInstances(
       0,

spring-boot-starter/src/test/kotlin/dev/bpmcrafters/processengine/worker/itest/camunda7/external/AbstractIdempotencyTest.kt

@@ -0,0 +1,54 @@
+package dev.bpmcrafters.processengine.worker.itest.camunda7.external
+
+import dev.bpmcrafters.processengine.worker.idempotency.IdempotencyRegistry
+import dev.bpmcrafters.processengineapi.task.ServiceTaskCompletionApi
+import org.assertj.core.api.Assertions.assertThat
+import org.awaitility.Awaitility.await
+import org.junit.jupiter.api.Test
+import org.mockito.kotlin.*
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.context.annotation.Import
+import org.springframework.test.context.TestPropertySource
+import org.springframework.test.context.bean.override.mockito.MockitoSpyBean
+import java.util.*
+import java.util.concurrent.TimeUnit.SECONDS
+
+@Import(InMemoryIdempotencyRegistryConfiguration::class)
+@TestPropertySource(properties = [
+  "dev.bpm-crafters.process-api.worker.complete-tasks-before-commit=false"
+])
+@MockitoSpyBean(types = [IdempotencyRegistry::class])
+@MockitoSpyBean(name = "c7remote-service-task-completion-api", types = [ServiceTaskCompletionApi::class])
+abstract class AbstractIdempotencyTest : AbstractBehaviorTest() {
+
+  @Autowired
+  private lateinit var idempotencyRegistry: IdempotencyRegistry
+
+  @Autowired
+  private lateinit var serviceTaskCompletionApi: ServiceTaskCompletionApi
+
+  @Test
+  fun `fetching the same task does not execute business logic again`() {
+    val name = "Big or Lil' Someone ${UUID.randomUUID()}"
+    doThrow(IllegalStateException("Many things have gone wrong while completing a task"))
+      .`when`(serviceTaskCompletionApi)
+      .completeTask(any())
+    val processInstanceId = startProcess(name, verified = true)
+    assertThat(processInstanceIsRunning(processInstanceId)).isTrue()
+    await().atMost(30, SECONDS).untilAsserted {
+      val entity = findEntityByName(name)
+      assertThat(entity).isNotNull
+    }
+    doCallRealMethod().`when`(serviceTaskCompletionApi).completeTask(any())
+    unlockExternalTask(getExternalTasks(processInstanceId).first().id!!)
+    await().atMost(30, SECONDS).untilAsserted {
+      assertThat(processInstanceIsRunning(processInstanceId)).isFalse
+    }
+    val inOrder = inOrder(idempotencyRegistry)
+    inOrder.verify(idempotencyRegistry).getTaskResult(any())
+    inOrder.verify(idempotencyRegistry).register(any(), any())
+    inOrder.verify(idempotencyRegistry).getTaskResult(any())
+    inOrder.verify(idempotencyRegistry, never()).register(any(), any())
+  }
+
+}

spring-boot-starter/src/test/kotlin/dev/bpmcrafters/processengine/worker/itest/camunda7/external/ExternalTaskCompletionAfterCommitTest.kt

@@ -12,10 +12,10 @@ import java.util.concurrent.TimeUnit.SECONDS
 @TestPropertySource(properties = [
   "dev.bpm-crafters.process-api.worker.complete-tasks-before-commit=false"
 ])
-class ExternalTaskCompletionAfterCommitTest : AbstractTransactionalBehaviorTest() {
+class ExternalTaskCompletionAfterCommitTest : AbstractBehaviorTest() {
 
   @Test
-  fun `successful worker completes task after of transaction has been committed`() {
+  fun `successful worker completes task after transaction has been committed`() {
     val name = "Big or Lil' Someone ${UUID.randomUUID()}"
     val pi = startProcess(name = name, verified = true)
     assertThat(processInstanceIsRunning(pi)).isTrue()

spring-boot-starter/src/test/kotlin/dev/bpmcrafters/processengine/worker/itest/camunda7/external/ExternalTaskCompletionBeforeCommitTest.kt

@@ -12,7 +12,7 @@ import java.util.concurrent.TimeUnit.SECONDS
 @TestPropertySource(properties = [
   "dev.bpm-crafters.process-api.worker.complete-tasks-before-commit=true"
 ])
-class ExternalTaskCompletionBeforeCommitTest : AbstractTransactionalBehaviorTest() {
+class ExternalTaskCompletionBeforeCommitTest : AbstractBehaviorTest() {
 
   @Test
   fun `happy path create two verified valid entity`() {

spring-boot-starter/src/test/kotlin/dev/bpmcrafters/processengine/worker/itest/camunda7/external/ExternalTaskCompletionWithoutTransactionTest.kt

@@ -14,7 +14,7 @@ import java.util.*
 import java.util.concurrent.TimeUnit.SECONDS
 
 @Import(ExternalTaskCompletionWithoutTransactionTest.WorkerWithoutTransactionalAnnotation::class)
-class ExternalTaskCompletionWithoutTransactionTest : AbstractTransactionalBehaviorTest() {
+class ExternalTaskCompletionWithoutTransactionTest : AbstractBehaviorTest() {
 
   class WorkerWithoutTransactionalAnnotation(
     myEntityService: MyEntityService,

spring-boot-starter/src/test/kotlin/dev/bpmcrafters/processengine/worker/itest/camunda7/external/ExternalTaskFailJobExceptionTest.kt

@@ -20,7 +20,7 @@ import java.util.concurrent.TimeUnit.SECONDS
 @TestPropertySource(properties = [
   "dev.bpm-crafters.process-api.worker.complete-tasks-before-commit=true"
 ])
-class ExternalTaskFailJobExceptionTest : AbstractTransactionalBehaviorTest() {
+class ExternalTaskFailJobExceptionTest : AbstractBehaviorTest() {
 
   class WorkerWithFailJobException(
     myEntityService: MyEntityService,

spring-boot-starter/src/test/kotlin/dev/bpmcrafters/processengine/worker/itest/camunda7/external/IdempotencyWithTransactionTest.kt

@@ -0,0 +1,6 @@
+package dev.bpmcrafters.processengine.worker.itest.camunda7.external
+
+import org.springframework.context.annotation.Import
+
+@Import(WorkerWithTransactionalAnnotation::class)
+class IdempotencyWithTransactionTest : AbstractIdempotencyTest()