Package org.camunda.bpm.engine.impl.test
Class TestHelper
- java.lang.Object
-
- org.camunda.bpm.engine.impl.test.TestHelper
-
public abstract class TestHelper extends Object
- Author:
- Tom Baeyens
-
-
Field Summary
Fields Modifier and Type Field Description static String
EMPTY_LINE
static List<String>
RESOURCE_SUFFIXES
static List<String>
TABLENAMES_EXCLUDED_FROM_DB_CLEAN_CHECK
-
Constructor Summary
Constructors Constructor Description TestHelper()
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static String
annotationDeploymentSetUp(ProcessEngine processEngine, Class<?> testClass, String methodName, Class<?>... parameterTypes)
static String
annotationDeploymentSetUp(ProcessEngine processEngine, Class<?> testClass, String methodName, Deployment deploymentAnnotation, Class<?>... parameterTypes)
static String
annotationDeploymentSetUp(ProcessEngine processEngine, String[] resources, Class<?> testClass, boolean onMethod, String methodName)
static String
annotationDeploymentSetUp(ProcessEngine processEngine, String[] resources, Class<?> testClass, String methodName)
static void
annotationDeploymentTearDown(ProcessEngine processEngine, String deploymentId, Class<?> testClass, String methodName)
static boolean
annotationRequiredDatabaseCheck(ProcessEngine processEngine, Class<?> testClass, String methodName, Class<?>... parameterTypes)
static boolean
annotationRequiredDatabaseCheck(ProcessEngine processEngine, RequiredDatabase annotation, Class<?> testClass, String methodName, Class<?>... parameterTypes)
static boolean
annotationRequiredHistoryLevelCheck(ProcessEngine processEngine, Class<?> testClass, String methodName, Class<?>... parameterTypes)
static boolean
annotationRequiredHistoryLevelCheck(ProcessEngine processEngine, RequiredHistoryLevel annotation, Class<?> testClass, String methodName)
static boolean
areJobsAvailable(ProcessEngineConfigurationImpl processEngineConfiguration)
static void
assertAndEnsureCleanDbAndCache(ProcessEngine processEngine)
Ensures that the deployment cache and database is clean after a test.static String
assertAndEnsureCleanDbAndCache(ProcessEngine processEngine, boolean fail)
Ensures that the deployment cache and database is clean after a test.static void
assertAndEnsureCleanDeploymentCache(ProcessEngine processEngine)
Ensures that the deployment cache is empty after a test.static String
assertAndEnsureCleanDeploymentCache(ProcessEngine processEngine, boolean fail)
Ensures that the deployment cache is empty after a test.static String
assertAndEnsureNoProcessApplicationsRegistered(ProcessEngine processEngine)
static void
assertProcessEnded(ProcessEngine processEngine, String processInstanceId)
Deprecated.static void
clearUserOperationLog(ProcessEngineConfigurationImpl processEngineConfiguration)
static void
closeProcessEngines()
static void
createOrUpdateHistoryLevel(ProcessEngineConfigurationImpl processEngineConfiguration)
static void
createSchema(ProcessEngineConfigurationImpl processEngineConfiguration)
static Object
defaultManualActivation()
static void
deleteDeployment(ProcessEngine processEngine, String deploymentId)
static void
deleteHistoryLevel(ProcessEngineConfigurationImpl processEngineConfiguration)
static void
deleteInstallationId(ProcessEngineConfigurationImpl processEngineConfiguration)
static void
deleteTelemetryProperty(ProcessEngineConfigurationImpl processEngineConfiguration)
static void
dropSchema(ProcessEngineConfigurationImpl processEngineConfiguration)
protected static void
fail(String message)
static String
getBpmnProcessDefinitionResource(Class<?> type, String name)
get a resource location by convention based on a class (type) and a relative resource name.protected static Method
getMethod(Class<?> clazz, String methodName, Class<?>... parameterTypes)
static ProcessEngine
getProcessEngine(String configurationResource)
static void
resetIdGenerator(ProcessEngineConfigurationImpl processEngineConfiguration)
static void
waitForJobExecutorToProcessAllJobs(ProcessEngineConfigurationImpl processEngineConfiguration, long maxMillisToWait, long intervalMillis)
-
-
-
Method Detail
-
assertProcessEnded
@Deprecated public static void assertProcessEnded(ProcessEngine processEngine, String processInstanceId)
Deprecated.useProcessEngineAssert
instead.
-
annotationDeploymentSetUp
public static String annotationDeploymentSetUp(ProcessEngine processEngine, Class<?> testClass, String methodName, Deployment deploymentAnnotation, Class<?>... parameterTypes)
-
annotationDeploymentSetUp
public static String annotationDeploymentSetUp(ProcessEngine processEngine, String[] resources, Class<?> testClass, String methodName)
-
annotationDeploymentSetUp
public static String annotationDeploymentSetUp(ProcessEngine processEngine, String[] resources, Class<?> testClass, boolean onMethod, String methodName)
-
annotationDeploymentSetUp
public static String annotationDeploymentSetUp(ProcessEngine processEngine, Class<?> testClass, String methodName, Class<?>... parameterTypes)
-
annotationDeploymentTearDown
public static void annotationDeploymentTearDown(ProcessEngine processEngine, String deploymentId, Class<?> testClass, String methodName)
-
deleteDeployment
public static void deleteDeployment(ProcessEngine processEngine, String deploymentId)
-
getBpmnProcessDefinitionResource
public static String getBpmnProcessDefinitionResource(Class<?> type, String name)
get a resource location by convention based on a class (type) and a relative resource name. The return value will be the full classpath location of the type, plus a suffix built from the name parameter:BpmnDeployer.BPMN_RESOURCE_SUFFIXES
. The first resource matching a suffix will be returned.
-
annotationRequiredHistoryLevelCheck
public static boolean annotationRequiredHistoryLevelCheck(ProcessEngine processEngine, RequiredHistoryLevel annotation, Class<?> testClass, String methodName)
-
annotationRequiredHistoryLevelCheck
public static boolean annotationRequiredHistoryLevelCheck(ProcessEngine processEngine, Class<?> testClass, String methodName, Class<?>... parameterTypes)
-
annotationRequiredDatabaseCheck
public static boolean annotationRequiredDatabaseCheck(ProcessEngine processEngine, RequiredDatabase annotation, Class<?> testClass, String methodName, Class<?>... parameterTypes)
-
annotationRequiredDatabaseCheck
public static boolean annotationRequiredDatabaseCheck(ProcessEngine processEngine, Class<?> testClass, String methodName, Class<?>... parameterTypes)
-
getMethod
protected static Method getMethod(Class<?> clazz, String methodName, Class<?>... parameterTypes) throws SecurityException, NoSuchMethodException
-
assertAndEnsureCleanDbAndCache
public static void assertAndEnsureCleanDbAndCache(ProcessEngine processEngine)
Ensures that the deployment cache and database is clean after a test. If not the cache and database will be cleared.- Parameters:
processEngine
- theProcessEngine
to test- Throws:
AssertionError
- if the deployment cache or database was not clean
-
assertAndEnsureCleanDbAndCache
public static String assertAndEnsureCleanDbAndCache(ProcessEngine processEngine, boolean fail)
Ensures that the deployment cache and database is clean after a test. If not the cache and database will be cleared.- Parameters:
processEngine
- theProcessEngine
to testfail
- if true the method will throw anAssertionError
if the deployment cache or database is not clean- Throws:
AssertionError
- if the deployment cache or database was not clean
-
fail
protected static void fail(String message)
-
assertAndEnsureCleanDeploymentCache
public static void assertAndEnsureCleanDeploymentCache(ProcessEngine processEngine)
Ensures that the deployment cache is empty after a test. If not the cache will be cleared.- Parameters:
processEngine
- theProcessEngine
to test- Throws:
AssertionError
- if the deployment cache was not clean
-
assertAndEnsureCleanDeploymentCache
public static String assertAndEnsureCleanDeploymentCache(ProcessEngine processEngine, boolean fail)
Ensures that the deployment cache is empty after a test. If not the cache will be cleared.- Parameters:
processEngine
- theProcessEngine
to testfail
- if true the method will throw anAssertionError
if the deployment cache is not clean- Returns:
- the deployment cache summary if fail is set to false or null if deployment cache was clean
- Throws:
AssertionError
- if the deployment cache was not clean and fail is set to true
-
assertAndEnsureNoProcessApplicationsRegistered
public static String assertAndEnsureNoProcessApplicationsRegistered(ProcessEngine processEngine)
-
waitForJobExecutorToProcessAllJobs
public static void waitForJobExecutorToProcessAllJobs(ProcessEngineConfigurationImpl processEngineConfiguration, long maxMillisToWait, long intervalMillis)
-
areJobsAvailable
public static boolean areJobsAvailable(ProcessEngineConfigurationImpl processEngineConfiguration)
-
resetIdGenerator
public static void resetIdGenerator(ProcessEngineConfigurationImpl processEngineConfiguration)
-
getProcessEngine
public static ProcessEngine getProcessEngine(String configurationResource)
-
closeProcessEngines
public static void closeProcessEngines()
-
createSchema
public static void createSchema(ProcessEngineConfigurationImpl processEngineConfiguration)
-
dropSchema
public static void dropSchema(ProcessEngineConfigurationImpl processEngineConfiguration)
-
createOrUpdateHistoryLevel
public static void createOrUpdateHistoryLevel(ProcessEngineConfigurationImpl processEngineConfiguration)
-
deleteHistoryLevel
public static void deleteHistoryLevel(ProcessEngineConfigurationImpl processEngineConfiguration)
-
clearUserOperationLog
public static void clearUserOperationLog(ProcessEngineConfigurationImpl processEngineConfiguration)
-
deleteTelemetryProperty
public static void deleteTelemetryProperty(ProcessEngineConfigurationImpl processEngineConfiguration)
-
deleteInstallationId
public static void deleteInstallationId(ProcessEngineConfigurationImpl processEngineConfiguration)
-
defaultManualActivation
public static Object defaultManualActivation()
-
-