Class ProcessEngineTestExtension

java.lang.Object
org.operaton.bpm.engine.test.junit5.ProcessEngineTestExtension
All Implemented Interfaces:
org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension
Direct Known Subclasses:
MigrationTestExtension

public class ProcessEngineTestExtension extends Object implements org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.AfterEachCallback
JUnit 5 Extension for managing a ProcessEngine during tests.

This extension provides many of the utility methods from your former JUnit 4 rule. It now has a default no-args constructor that creates a ProcessEngine using the default configuration. This allows you to register it via:

 @RegisterExtension
 protected ProcessEngineTestExtension testRule = new ProcessEngineTestExtension();
 

  • Field Details

  • Constructor Details

    • ProcessEngineTestExtension

      public ProcessEngineTestExtension()
    • ProcessEngineTestExtension

      public ProcessEngineTestExtension(ProcessEngineExtension processEngineExtension)
  • Method Details

    • getProcessEngine

      public ProcessEngine getProcessEngine()
    • beforeEach

      public void beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
      Specified by:
      beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback
    • afterEach

      public void afterEach(org.junit.jupiter.api.extension.ExtensionContext context)
      Specified by:
      afterEach in interface org.junit.jupiter.api.extension.AfterEachCallback
    • assertProcessEnded

      public void assertProcessEnded(String processInstanceId)
    • assertProcessNotEnded

      public void assertProcessNotEnded(String processInstanceId)
    • assertCaseEnded

      public void assertCaseEnded(String caseInstanceId)
    • deploy

      public DeploymentWithDefinitions deploy(BpmnModelInstance... bpmnModelInstances)
    • deploy

      public DeploymentWithDefinitions deploy(String... resources)
    • deploy

      public <T extends DeploymentWithDefinitions> T deploy(DeploymentBuilder deploymentBuilder)
    • deploy

      public Deployment deploy(BpmnModelInstance bpmnModelInstance, String resource)
    • deployForTenant

      public Deployment deployForTenant(String tenantId, BpmnModelInstance... bpmnModelInstances)
    • deployForTenant

      public Deployment deployForTenant(String tenantId, String... resources)
    • deployForTenant

      public Deployment deployForTenant(String tenant, BpmnModelInstance bpmnModelInstance, String resource)
    • deployAndGetDefinition

      public ProcessDefinition deployAndGetDefinition(BpmnModelInstance bpmnModel)
    • deployAndGetDefinition

      public ProcessDefinition deployAndGetDefinition(String classpathResource)
    • deployForTenantAndGetDefinition

      public ProcessDefinition deployForTenantAndGetDefinition(String tenant, String classpathResource)
    • deployForTenantAndGetDefinition

      public ProcessDefinition deployForTenantAndGetDefinition(String tenant, BpmnModelInstance bpmnModel)
    • deploy

      protected DeploymentWithDefinitions deploy(DeploymentBuilder deploymentBuilder, List<BpmnModelInstance> bpmnModelInstances, List<String> resources)
    • createDeploymentBuilder

      protected DeploymentBuilder createDeploymentBuilder()
    • waitForJobExecutorToProcessAllJobs

      public void waitForJobExecutorToProcessAllJobs()
    • waitForJobExecutorToProcessAllJobs

      public void waitForJobExecutorToProcessAllJobs(long maxMillisToWait)
    • availableJobs

      protected List<Job> availableJobs()
    • areJobsAvailable

      public boolean areJobsAvailable()
    • executeAvailableJobs

      public void executeAvailableJobs()
      Execute all available jobs recursively till no more jobs found.
    • executeAvailableJobs

      public void executeAvailableJobs(Boolean recursive)
    • executeAvailableJobs

      public void executeAvailableJobs(int expectedExecutions)
      Execute all available jobs recursively till no more jobs found or the number of executions is higher than expected.
      Parameters:
      expectedExecutions - number of expected job executions
      Throws:
      org.opentest4j.AssertionFailedError - when execute less or more jobs than expected
      See Also:
    • executeAvailableJobs

      public void executeAvailableJobs(int expectedExecutions, Boolean recursive)
    • completeTask

      public void completeTask(String taskKey)
    • completeAnyTask

      public void completeAnyTask(String taskKey)
    • setAnyVariable

      public void setAnyVariable(String executionId)
    • setVariable

      public void setVariable(String executionId, String varName, Object varValue)
    • correlateMessage

      public void correlateMessage(String messageName)
    • sendSignal

      public void sendSignal(String signalName)
    • isHistoryLevelNone

      public boolean isHistoryLevelNone()
    • isHistoryLevelActivity

      public boolean isHistoryLevelActivity()
    • isHistoryLevelAudit

      public boolean isHistoryLevelAudit()
    • isHistoryLevelFull

      public boolean isHistoryLevelFull()
    • assertTextPresent

      public void assertTextPresent(String expected, String actual)
      Asserts if the provided text is part of some text.
    • assertTextPresentIgnoreCase

      public void assertTextPresentIgnoreCase(String expected, String actual)
      Asserts if the provided text is part of some text, ignoring any uppercase characters
    • defaultManualActivation

      public Object defaultManualActivation()
    • deleteHistoryCleanupJobs

      public void deleteHistoryCleanupJobs()
    • createCaseInstanceByKey

      public CaseInstance createCaseInstanceByKey(String caseDefinitionKey)
    • createCaseInstanceByKey

      public CaseInstance createCaseInstanceByKey(String caseDefinitionKey, String businessKey)
    • createCaseInstanceByKey

      public CaseInstance createCaseInstanceByKey(String caseDefinitionKey, VariableMap variables)
    • createCaseInstanceByKey

      public CaseInstance createCaseInstanceByKey(String caseDefinitionKey, String businessKey, VariableMap variables)
    • getDatabaseType

      public String getDatabaseType()
    • deleteAllAuthorizations

      public void deleteAllAuthorizations()
    • deleteAllStandaloneTasks

      public void deleteAllStandaloneTasks()
    • createGrantAuthorization

      public void createGrantAuthorization(String userId, Resource resource, String resourceId, Permission... permissions)
    • getInstancesForActivityId

      public List<ActivityInstance> getInstancesForActivityId(ActivityInstance activityInstance, String activityId)