io.camunda.zeebe.spring.test.ZeebeTestThreadSupport Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-boot-starter-camunda-test-common Show documentation
The newest version!
package io.camunda.zeebe.spring.test;

import static io.camunda.zeebe.process.test.assertions.BpmnAssert.assertThat;

import io.camunda.zeebe.client.api.response.ProcessInstanceEvent;
import io.camunda.zeebe.process.test.api.ZeebeTestEngine;
import io.camunda.zeebe.process.test.assertions.BpmnAssert;
import io.camunda.zeebe.process.test.filters.RecordStream;
import io.camunda.zeebe.process.test.inspections.model.InspectedProcessInstance;
import java.time.Duration;
import java.util.Objects;
import org.awaitility.Awaitility;

/** Helper to wait in the multithreaded environment for the worker to execute. */
public class ZeebeTestThreadSupport {

  private static final ThreadLocal ENGINES = new ThreadLocal<>();
  private static final Duration DEFAULT_DURATION = Duration.ofMillis(5000);
  private static final Integer DEFAULT_TIMES_PASSED = 1;
  private static final Long DEFAULT_INTERVAL_MILLIS = 100L;

  public static void setEngineForCurrentThread(ZeebeTestEngine engine) {
    ENGINES.set(engine);
  }

  public static void cleanupEngineForCurrentThread() {
    ENGINES.remove();
  }

  public static void waitForProcessInstanceCompleted(ProcessInstanceEvent processInstance) {
    waitForProcessInstanceCompleted(processInstance.getProcessInstanceKey(), DEFAULT_DURATION);
  }

  public static void waitForProcessInstanceCompleted(
      ProcessInstanceEvent processInstance, Duration duration) {
    waitForProcessInstanceCompleted(processInstance.getProcessInstanceKey(), duration);
  }

  public static void waitForProcessInstanceCompleted(long processInstanceKey) {
    waitForProcessInstanceCompleted(
        new InspectedProcessInstance(processInstanceKey), DEFAULT_DURATION);
  }

  public static void waitForProcessInstanceCompleted(long processInstanceKey, Duration duration) {
    waitForProcessInstanceCompleted(new InspectedProcessInstance(processInstanceKey), duration);
  }

  public static void waitForProcessInstanceCompleted(
      InspectedProcessInstance inspectedProcessInstance) {
    waitForProcessInstanceCompleted(inspectedProcessInstance, DEFAULT_DURATION);
  }

  public static void waitForProcessInstanceCompleted(
      InspectedProcessInstance inspectedProcessInstance, Duration duration) {
    // get it in the thread of the test
    final ZeebeTestEngine engine = ENGINES.get();
    if (engine == null) {
      throw new IllegalStateException(
          "No Zeebe engine is initialized for the current thread, annotate the test with @ZeebeSpringTest");
    }
    if (duration == null) {
      duration = DEFAULT_DURATION;
    }
    Awaitility.await()
        .atMost(duration)
        .untilAsserted(
            () -> {
              // allow the worker to work
              Thread.sleep(DEFAULT_INTERVAL_MILLIS);
              BpmnAssert.initRecordStream(
                  RecordStream.of(Objects.requireNonNull(engine).getRecordStreamSource()));
              // use inside the awaitility thread
              assertThat(inspectedProcessInstance).isCompleted();
            });
  }

  public static void waitForProcessInstanceHasPassedElement(
      ProcessInstanceEvent processInstance, String elementId) {
    waitForProcessInstanceHasPassedElement(
        processInstance.getProcessInstanceKey(), elementId, DEFAULT_DURATION);
  }

  public static void waitForProcessInstanceHasPassedElement(
      ProcessInstanceEvent processInstance, String elementId, Duration duration) {
    waitForProcessInstanceHasPassedElement(
        processInstance.getProcessInstanceKey(), elementId, duration);
  }

  public static void waitForProcessInstanceHasPassedElement(
      long processInstanceKey, String elementId) {
    waitForProcessInstanceHasPassedElement(
        new InspectedProcessInstance(processInstanceKey), elementId, DEFAULT_DURATION);
  }

  public static void waitForProcessInstanceHasPassedElement(
      long processInstanceKey, String elementId, Duration duration) {
    waitForProcessInstanceHasPassedElement(
        new InspectedProcessInstance(processInstanceKey), elementId, duration);
  }

  public static void waitForProcessInstanceHasPassedElement(
      InspectedProcessInstance inspectedProcessInstance, String elementId) {
    waitForProcessInstanceHasPassedElement(inspectedProcessInstance, elementId, DEFAULT_DURATION);
  }

  public static void waitForProcessInstanceHasPassedElement(
      InspectedProcessInstance inspectedProcessInstance, String elementId, Duration duration) {
    waitForProcessInstanceHasPassedElement(
        inspectedProcessInstance, elementId, duration, DEFAULT_TIMES_PASSED);
  }

  public static void waitForProcessInstanceHasPassedElement(
      InspectedProcessInstance inspectedProcessInstance,
      String elementId,
      Duration duration,
      final int times) {
    final ZeebeTestEngine engine = ENGINES.get();
    if (engine == null) {
      throw new IllegalStateException(
          "No Zeebe engine is initialized for the current thread, annotate the test with @ZeebeSpringTest");
    }
    if (duration == null) {
      duration = DEFAULT_DURATION;
    }
    Awaitility.await()
        .atMost(duration)
        .untilAsserted(
            () -> {
              Thread.sleep(DEFAULT_INTERVAL_MILLIS);
              BpmnAssert.initRecordStream(
                  RecordStream.of(Objects.requireNonNull(engine).getRecordStreamSource()));
              assertThat(inspectedProcessInstance).hasPassedElement(elementId, times);
            });
  }
}