org.camunda.bpm.extension.junit5.test

Class ProcessEngineExtension

java.lang.Object

org.camunda.bpm.extension.junit5.test.ProcessEngineExtension

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterTestExecutionCallback, org.junit.jupiter.api.extension.BeforeTestExecutionCallback, org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.ParameterResolver, org.junit.jupiter.api.extension.TestInstancePostProcessor, org.junit.jupiter.api.extension.TestWatcher

public class ProcessEngineExtension
extends Object
implements org.junit.jupiter.api.extension.TestWatcher, org.junit.jupiter.api.extension.TestInstancePostProcessor, org.junit.jupiter.api.extension.BeforeTestExecutionCallback, org.junit.jupiter.api.extension.AfterTestExecutionCallback, org.junit.jupiter.api.extension.ParameterResolver

Junit 5 Extension to create and inject a process engine into the test class.

Used as @ExtendWith(ProcessEngineExtension.class) the process engine is build from the configuration file camunda.cfg.xml found on the classpath.

Used as

  @RegisterExtension
 ProcessEngineExtension extension = ProcessEngineExtension.builder()
    .configurationResource("myConfigurationFile.xml")
    .build();

you can provide a different configuration file.

This extension injects the process engine into a given field in the test class.

Author:

Ingo Richtsmeier

Field Summary

Fields

Modifier and Type	Field and Description
protected String	configurationResource
protected org.camunda.bpm.engine.ProcessEngine	processEngine
protected org.camunda.bpm.engine.impl.cfg.ProcessEngineConfigurationImpl	processEngineConfiguration
static List<String>	RESOURCE_SUFFIXES

Constructor Summary

Constructors

Constructor and Description
ProcessEngineExtension()

Method Summary

Modifier and Type	Method and Description
void	afterTestExecution(org.junit.jupiter.api.extension.ExtensionContext context)
void	beforeTestExecution(org.junit.jupiter.api.extension.ExtensionContext context)
ProcessEngineExtension	build()
static ProcessEngineExtension	builder()
ProcessEngineExtension	configurationResource(String configurationResource)
String	getConfigurationResource()
org.camunda.bpm.engine.ProcessEngine	getProcessEngine()
org.camunda.bpm.engine.impl.cfg.ProcessEngineConfigurationImpl	getProcessEngineConfiguration()
protected void	initializeProcessEngine()
void	postProcessTestInstance(Object testInstance, org.junit.jupiter.api.extension.ExtensionContext context)
Object	resolveParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	setConfigurationResource(String configurationResource)
void	setProcessEngine(org.camunda.bpm.engine.ProcessEngine processEngine)
void	setProcessEngineConfiguration(org.camunda.bpm.engine.impl.cfg.ProcessEngineConfigurationImpl processEngineConfiguration)
boolean	supportsParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.junit.jupiter.api.extension.TestWatcher

testAborted, testDisabled, testFailed, testSuccessful

Field Detail

processEngine

protected org.camunda.bpm.engine.ProcessEngine processEngine

processEngineConfiguration

protected org.camunda.bpm.engine.impl.cfg.ProcessEngineConfigurationImpl processEngineConfiguration

configurationResource

protected String configurationResource

RESOURCE_SUFFIXES

public static final List<String> RESOURCE_SUFFIXES

Constructor Detail

ProcessEngineExtension

public ProcessEngineExtension()

Method Detail

builder

public static ProcessEngineExtension builder()

configurationResource

public ProcessEngineExtension configurationResource(String configurationResource)

getProcessEngine

public org.camunda.bpm.engine.ProcessEngine getProcessEngine()

setProcessEngine

public void setProcessEngine(org.camunda.bpm.engine.ProcessEngine processEngine)

getConfigurationResource

public String getConfigurationResource()

setConfigurationResource

public void setConfigurationResource(String configurationResource)

getProcessEngineConfiguration

public org.camunda.bpm.engine.impl.cfg.ProcessEngineConfigurationImpl getProcessEngineConfiguration()

setProcessEngineConfiguration

public void setProcessEngineConfiguration(org.camunda.bpm.engine.impl.cfg.ProcessEngineConfigurationImpl processEngineConfiguration)

postProcessTestInstance

public void postProcessTestInstance(Object testInstance,
                                    org.junit.jupiter.api.extension.ExtensionContext context)
                             throws Exception

Specified by:

postProcessTestInstance in interface org.junit.jupiter.api.extension.TestInstancePostProcessor

Throws:

Exception

initializeProcessEngine

protected void initializeProcessEngine()

beforeTestExecution

public void beforeTestExecution(org.junit.jupiter.api.extension.ExtensionContext context)
                         throws Exception

Specified by:

beforeTestExecution in interface org.junit.jupiter.api.extension.BeforeTestExecutionCallback

Throws:

Exception

afterTestExecution

public void afterTestExecution(org.junit.jupiter.api.extension.ExtensionContext context)
                        throws Exception

Specified by:

afterTestExecution in interface org.junit.jupiter.api.extension.AfterTestExecutionCallback

Throws:

Exception

supportsParameter

public boolean supportsParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext,
                                 org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                          throws org.junit.jupiter.api.extension.ParameterResolutionException

Specified by:

supportsParameter in interface org.junit.jupiter.api.extension.ParameterResolver

Throws:

org.junit.jupiter.api.extension.ParameterResolutionException

resolveParameter

public Object resolveParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext,
                               org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                        throws org.junit.jupiter.api.extension.ParameterResolutionException

Specified by:

resolveParameter in interface org.junit.jupiter.api.extension.ParameterResolver

Throws:

org.junit.jupiter.api.extension.ParameterResolutionException

build

public ProcessEngineExtension build()