/* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.activiti.engine.impl.test;
import java.io.InputStream;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Timer;
import java.util.TimerTask;
import junit.framework.AssertionFailedError;
import org.activiti.engine.ActivitiException;
import org.activiti.engine.ActivitiObjectNotFoundException;
import org.activiti.engine.ProcessEngine;
import org.activiti.engine.ProcessEngineConfiguration;
import org.activiti.engine.impl.ProcessEngineImpl;
import org.activiti.engine.impl.bpmn.deployer.BpmnDeployer;
import org.activiti.engine.impl.bpmn.parser.factory.ActivityBehaviorFactory;
import org.activiti.engine.impl.cfg.ProcessEngineConfigurationImpl;
import org.activiti.engine.impl.db.DbSqlSession;
import org.activiti.engine.impl.interceptor.Command;
import org.activiti.engine.impl.interceptor.CommandContext;
import org.activiti.engine.impl.jobexecutor.JobExecutor;
import org.activiti.engine.impl.util.ReflectUtil;
import org.activiti.engine.repository.DeploymentBuilder;
import org.activiti.engine.runtime.ProcessInstance;
import org.activiti.engine.test.Deployment;
import org.activiti.engine.test.TestActivityBehaviorFactory;
import org.activiti.engine.test.mock.ActivitiMockSupport;
import org.activiti.engine.test.mock.MockServiceTask;
import org.activiti.engine.test.mock.MockServiceTasks;
import org.activiti.engine.test.mock.NoOpServiceTasks;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Tom Baeyens
* @author Joram Barrez
*/
public abstract class TestHelper {
private static Logger log = LoggerFactory.getLogger(TestHelper.class);
public static final String EMPTY_LINE = "\n";
public static final List<String> TABLENAMES_EXCLUDED_FROM_DB_CLEAN_CHECK = Arrays.asList(
"ACT_GE_PROPERTY"
);
static Map<String, ProcessEngine> processEngines = new HashMap<String, ProcessEngine>();
// Assertion methods ///////////////////////////////////////////////////
public static void assertProcessEnded(ProcessEngine processEngine, String processInstanceId) {
ProcessInstance processInstance = processEngine
.getRuntimeService()
.createProcessInstanceQuery()
.processInstanceId(processInstanceId)
.singleResult();
if (processInstance!=null) {
throw new AssertionFailedError("expected finished process instance '"+processInstanceId+"' but it was still in the db");
}
}
// Test annotation support /////////////////////////////////////////////
public static String annotationDeploymentSetUp(ProcessEngine processEngine, Class<?> testClass, String methodName) {
String deploymentId = null;
Method method = null;
try {
method = testClass.getMethod(methodName, (Class<?>[]) null);
} catch (Exception e) {
log.warn("Could not get method by reflection. This could happen if you are using @Parameters in combination with annotations.", e);
return null;
}
Deployment deploymentAnnotation = method.getAnnotation(Deployment.class);
if (deploymentAnnotation != null) {
log.debug("annotation @Deployment creates deployment for {}.{}", testClass.getSimpleName(), methodName);
String[] resources = deploymentAnnotation.resources();
if (resources.length == 0) {
String name = method.getName();
String resource = getBpmnProcessDefinitionResource(testClass, name);
resources = new String[]{resource};
}
DeploymentBuilder deploymentBuilder = processEngine.getRepositoryService()
.createDeployment()
.name(testClass.getSimpleName()+"."+methodName);
for (String resource: resources) {
deploymentBuilder.addClasspathResource(resource);
}
deploymentId = deploymentBuilder.deploy().getId();
}
return deploymentId;
}
public static void annotationDeploymentTearDown(ProcessEngine processEngine, String deploymentId, Class<?> testClass, String methodName) {
log.debug("annotation @Deployment deletes deployment for {}.{}", testClass.getSimpleName(), methodName);
if(deploymentId != null) {
try {
processEngine.getRepositoryService().deleteDeployment(deploymentId, true);
} catch (ActivitiObjectNotFoundException e) {
// Deployment was already deleted by the test case. Ignore.
}
}
}
public static void annotationMockSupportSetup(Class<?> testClass, String methodName, ActivitiMockSupport mockSupport) {
// Get method
Method method = null;
try {
method = testClass.getMethod(methodName, (Class<?>[]) null);
} catch (Exception e) {
log.warn("Could not get method by reflection. This could happen if you are using @Parameters in combination with annotations.", e);
return;
}
handleMockServiceTaskAnnotation(mockSupport, method);
handleMockServiceTasksAnnotation(mockSupport, method);
handleNoOpServiceTasksAnnotation(mockSupport, method);
}
protected static void handleMockServiceTaskAnnotation(ActivitiMockSupport mockSupport, Method method) {
MockServiceTask mockedServiceTask = method.getAnnotation(MockServiceTask.class);
if (mockedServiceTask != null) {
handleMockServiceTaskAnnotation(mockSupport, mockedServiceTask);
}
}
protected static void handleMockServiceTaskAnnotation(ActivitiMockSupport mockSupport, MockServiceTask mockedServiceTask) {
mockSupport.mockServiceTaskWithClassDelegate(mockedServiceTask.originalClassName(), mockedServiceTask.mockedClassName());
}
protected static void handleMockServiceTasksAnnotation(ActivitiMockSupport mockSupport, Method method) {
MockServiceTasks mockedServiceTasks = method.getAnnotation(MockServiceTasks.class);
if (mockedServiceTasks != null) {
for (MockServiceTask mockedServiceTask : mockedServiceTasks.value()) {
handleMockServiceTaskAnnotation(mockSupport, mockedServiceTask);
}
}
}
protected static void handleNoOpServiceTasksAnnotation(ActivitiMockSupport mockSupport,Method method) {
NoOpServiceTasks noOpServiceTasks = method.getAnnotation(NoOpServiceTasks.class);
if (noOpServiceTasks != null) {
String[] ids = noOpServiceTasks.ids();
Class<?>[] classes = noOpServiceTasks.classes();
String[] classNames = noOpServiceTasks.classNames();
if ( (ids == null || ids.length == 0)
&& (classes == null || classes.length == 0)
&& (classNames == null || classNames.length == 0)) {
mockSupport.setAllServiceTasksNoOp();
} else {
if (ids != null && ids.length > 0) {
for (String id : ids) {
mockSupport.addNoOpServiceTaskById(id);
}
}
if (classes != null && classes.length > 0) {
for (Class<?> clazz : classes) {
mockSupport.addNoOpServiceTaskByClassName(clazz.getName());
}
}
if (classNames != null && classNames.length > 0) {
for (String className : classNames) {
mockSupport.addNoOpServiceTaskByClassName(className);
}
}
}
}
}
public static void annotationMockSupportTeardown(ActivitiMockSupport mockSupport) {
mockSupport.reset();
}
/**
* 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:
* <code>BpmnDeployer.BPMN_RESOURCE_SUFFIXES</code>.
* The first resource matching a suffix will be returned.
*/
public static String getBpmnProcessDefinitionResource(Class< ? > type, String name) {
for (String suffix : BpmnDeployer.BPMN_RESOURCE_SUFFIXES) {
String resource = type.getName().replace('.', '/') + "." + name + "." + suffix;
InputStream inputStream = ReflectUtil.getResourceAsStream(resource);
if (inputStream == null) {
continue;
} else {
return resource;
}
}
return type.getName().replace('.', '/') + "." + name + "." + BpmnDeployer.BPMN_RESOURCE_SUFFIXES[0];
}
// Engine startup and shutdown helpers ///////////////////////////////////////////////////
public static ProcessEngine getProcessEngine(String configurationResource) {
ProcessEngine processEngine = processEngines.get(configurationResource);
if (processEngine == null) {
log.debug("==== BUILDING PROCESS ENGINE ========================================================================");
processEngine = ProcessEngineConfiguration
.createProcessEngineConfigurationFromResource(
configurationResource).buildProcessEngine();
log.debug("==== PROCESS ENGINE CREATED =========================================================================");
processEngines.put(configurationResource, processEngine);
}
return processEngine;
}
public static void closeProcessEngines() {
for (ProcessEngine processEngine : processEngines.values()) {
processEngine.close();
}
processEngines.clear();
}
/**
* Each test is assumed to clean up all DB content it entered.
* After a test method executed, this method scans all tables to see if the DB is completely clean.
* It throws AssertionFailed in case the DB is not clean.
* If the DB is not clean, it is cleaned by performing a create a drop.
*/
public static void assertAndEnsureCleanDb(ProcessEngine processEngine) {
log.debug("verifying that db is clean after test");
Map<String, Long> tableCounts = processEngine.getManagementService().getTableCount();
StringBuilder outputMessage = new StringBuilder();
for (String tableName : tableCounts.keySet()) {
if (!TABLENAMES_EXCLUDED_FROM_DB_CLEAN_CHECK.contains(tableName)) {
Long count = tableCounts.get(tableName);
if (count!=0L) {
outputMessage.append(" ").append(tableName).append(": ").append(count).append(" record(s) ");
}
}
}
if (outputMessage.length() > 0) {
outputMessage.insert(0, "DB NOT CLEAN: \n");
log.error(EMPTY_LINE);
log.error(outputMessage.toString());
((ProcessEngineImpl)processEngine)
.getProcessEngineConfiguration().getCommandExecutor()
.execute(new Command<Object>() {
public Object execute(CommandContext commandContext) {
DbSqlSession dbSqlSession = commandContext.getSession(DbSqlSession.class);
dbSqlSession.dbSchemaDrop();
dbSqlSession.dbSchemaCreate();
return null;
}
});
throw new AssertionError(outputMessage.toString());
}
}
// Mockup support ////////////////////////////////////////////////////////
public static TestActivityBehaviorFactory initializeTestActivityBehaviorFactory(ActivityBehaviorFactory existingActivityBehaviorFactory) {
return new TestActivityBehaviorFactory(existingActivityBehaviorFactory);
}
// Helper method for working with timers ///////////////////////////////////////////////////
public static void waitForJobExecutorToProcessAllJobs(ProcessEngineConfigurationImpl processEngineConfiguration, long maxMillisToWait, long intervalMillis) {
JobExecutor jobExecutor = processEngineConfiguration.getJobExecutor();
jobExecutor.start();
try {
Timer timer = new Timer();
InteruptTask task = new InteruptTask(Thread.currentThread());
timer.schedule(task, maxMillisToWait);
boolean areJobsAvailable = true;
try {
while (areJobsAvailable && !task.isTimeLimitExceeded()) {
Thread.sleep(intervalMillis);
areJobsAvailable = areJobsAvailable(processEngineConfiguration);
}
} catch (InterruptedException e) {
} finally {
timer.cancel();
}
if (areJobsAvailable) {
throw new ActivitiException("time limit of " + maxMillisToWait + " was exceeded");
}
} finally {
jobExecutor.shutdown();
}
}
public static boolean areJobsAvailable(ProcessEngineConfigurationImpl processEngineConfiguration) {
return !processEngineConfiguration
.getManagementService()
.createJobQuery()
.executable()
.list()
.isEmpty();
}
private static class InteruptTask extends TimerTask {
protected boolean timeLimitExceeded = false;
protected Thread thread;
public InteruptTask(Thread thread) {
this.thread = thread;
}
public boolean isTimeLimitExceeded() {
return timeLimitExceeded;
}
public void run() {
timeLimitExceeded = true;
thread.interrupt();
}
}
}