/*
* JBoss, Home of Professional Open Source
* Copyright 2005, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jbpm.scheduler.exe;
import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.List;
import org.hibernate.criterion.Restrictions;
import org.jbpm.context.exe.ContextInstance;
import org.jbpm.db.AbstractDbTestCase;
import org.jbpm.graph.def.ActionHandler;
import org.jbpm.graph.def.Event;
import org.jbpm.graph.def.Node;
import org.jbpm.graph.def.ProcessDefinition;
import org.jbpm.graph.exe.ExecutionContext;
import org.jbpm.graph.exe.ProcessInstance;
import org.jbpm.job.Timer;
import org.jbpm.taskmgmt.exe.TaskInstance;
public class TimerDbTest extends AbstractDbTestCase {
public void testSaveTimer() {
// discard milliseconds as some databases have second precision only
Calendar ncal = Calendar.getInstance();
ncal.set(Calendar.MILLISECOND, 0);
Date now = ncal.getTime();
Timer timer = new Timer();
timer.setName("timer-name");
timer.setDueDate(now);
timer.setTransitionName("transition-name");
timer.setRepeat("repeat-duration");
session.save(timer);
newTransaction();
try {
timer = (Timer) session.load(Timer.class, new Long(timer.getId()));
assertEquals("timer-name", timer.getName());
// test each calendar field to ensure second precision across all databases
Calendar tcal = new GregorianCalendar();
tcal.setTime(timer.getDueDate());
assertEquals(ncal.get(Calendar.YEAR), tcal.get(Calendar.YEAR));
assertEquals(ncal.get(Calendar.MONTH), tcal.get(Calendar.MONTH));
assertEquals(ncal.get(Calendar.DAY_OF_MONTH), tcal.get(Calendar.DAY_OF_MONTH));
assertEquals(ncal.get(Calendar.HOUR_OF_DAY), tcal.get(Calendar.HOUR_OF_DAY));
assertEquals(ncal.get(Calendar.MINUTE), tcal.get(Calendar.MINUTE));
assertEquals(ncal.get(Calendar.SECOND), tcal.get(Calendar.SECOND));
assertEquals("transition-name", timer.getTransitionName());
assertEquals("repeat-duration", timer.getRepeat());
}
finally {
session.delete(timer);
}
}
public void testTimerCreation() throws Exception {
ProcessDefinition processDefinition = ProcessDefinition.parseXmlString("<process-definition name='"
+ getName()
+ "'>"
+ " <start-state>"
+ " <transition to='catch crooks' />"
+ " </start-state>"
+ " <state name='catch crooks'>"
+ " <timer name='reminder' duedate='5 seconds' />"
+ " <transition to='end'/>"
+ " </state>"
+ " <end-state name='end'/>"
+ "</process-definition>");
deployProcessDefinition(processDefinition);
ProcessInstance processInstance = new ProcessInstance(processDefinition);
// long before = System.currentTimeMillis();
processInstance.signal();
// long after = System.currentTimeMillis();
jbpmContext.save(processInstance);
newTransaction();
Timer timer = (Timer) session.createCriteria(Timer.class).uniqueResult();
assertNotNull("Timer is null", timer);
assertEquals("reminder", timer.getName());
// Commented out because of timer latency is changing between time
// required to connect to the database
// assertTrue((before + 5000) <= timer.getDueDate().getTime());
// assertTrue(timer.getDueDate().getTime() <= (after + 5000));
assertEquals("catch crooks", timer.getGraphElement().getName());
}
public void testTimerCancellation() {
ProcessDefinition processDefinition = ProcessDefinition.parseXmlString("<process-definition name='"
+ getName()
+ "'>"
+ " <start-state>"
+ " <transition to='catch crooks' />"
+ " </start-state>"
+ " <state name='catch crooks'>"
+ " <timer name='reminder' duedate='5 seconds' />"
+ " <transition to='end'/>"
+ " </state>"
+ " <end-state name='end'/>"
+ "</process-definition>");
deployProcessDefinition(processDefinition);
ProcessInstance processInstance = new ProcessInstance(processDefinition);
processInstance.signal();
processInstance = saveAndReload(processInstance);
processInstance.signal();
newTransaction();
assertEquals(0, getTimerCount());
}
public void testTimerAction() {
ProcessDefinition processDefinition = ProcessDefinition.parseXmlString("<process-definition name='"
+ getName()
+ "'>"
+ " <start-state>"
+ " <transition to='sometask' />"
+ " </start-state>"
+ " <task-node name='sometask'>"
+ " <timer name='reminder'"
+ " duedate='1 business minutes'"
+ " repeat='1 business minutes'"
+ " transition='time-out-transition' >"
+ " <action class='my-action-handler-class-name' />"
+ " </timer>"
+ " <task name='do something'/>"
+ " <transition name='time-out-transition' to='sometask' />"
+ " </task-node>"
+ "</process-definition>");
deployProcessDefinition(processDefinition);
Node node = processDefinition.getNode("sometask");
List actions = node.getEvent(Event.EVENTTYPE_NODE_ENTER).getActions();
assertEquals(1, actions.size());
actions = node.getEvent(Event.EVENTTYPE_NODE_LEAVE).getActions();
assertEquals(1, actions.size());
ProcessInstance processInstance = new ProcessInstance(processDefinition);
processInstance.signal();
jbpmContext.save(processInstance);
newTransaction();
assertEquals(1, getTimerCount());
}
public void testTaskTimerExecution() {
ProcessDefinition processDefinition = ProcessDefinition.parseXmlString("<process-definition name='"
+ getName()
+ "'>"
+ " <start-state>"
+ " <transition to='timed task' />"
+ " </start-state>"
+ " <task-node name='timed task'>"
+ " <task>"
+ " <timer duedate='23 business seconds'>"
+ " <action class='geftem-eu-shuppe-oender-ze-konte'/>"
+ " </timer>"
+ " </task>"
+ " </task-node>"
+ "</process-definition>");
deployProcessDefinition(processDefinition);
ProcessInstance processInstance = new ProcessInstance(processDefinition);
processInstance.signal();
newTransaction();
assertEquals(1, getTimerCount());
}
public void testTimerCancellationAtProcessEnd() {
ProcessDefinition processDefinition = ProcessDefinition.parseXmlString("<process-definition name='"
+ getName()
+ "'>"
+ " <start-state>"
+ " <transition to='s' />"
+ " </start-state>"
+ " <state name='s'>"
+ " <event type='node-enter'>"
+ " <create-timer duedate='52 seconds'>"
+ " <action class='claim.you.are.Innocent' />"
+ " </create-timer>"
+ " </event>"
+ " <transition to='end' />"
+ " </state>"
+ " <end-state name='end' />"
+ "</process-definition>");
deployProcessDefinition(processDefinition);
ProcessInstance processInstance = new ProcessInstance(processDefinition);
processInstance.signal();
processInstance = saveAndReload(processInstance);
assertEquals(1, getTimerCount());
processInstance.signal();
newTransaction();
assertEquals(1, getTimerCount());
processJobs();
assertEquals(0, getTimerCount());
}
public void testFindTimersByName() {
ProcessDefinition processDefinition = ProcessDefinition.parseXmlString("<process-definition name='"
+ getName()
+ "'>"
+ " <start-state>"
+ " <transition to='timed task' />"
+ " </start-state>"
+ " <task-node name='timed task'>"
+ " <task name='find the hole in the market'>"
+ " <timer name='reminder' duedate='23 business seconds'>"
+ " <action class='geftem-eu-shuppe-oender-ze-konte'/>"
+ " </timer>"
+ " </task>"
+ " </task-node>"
+ "</process-definition>");
deployProcessDefinition(processDefinition);
ProcessInstance processInstance = new ProcessInstance(processDefinition);
processInstance.signal();
processInstance = saveAndReload(processInstance);
List timersByName = session.createCriteria(Timer.class)
.add(Restrictions.eq("name", "reminder"))
.list();
assertEquals(1, timersByName.size());
Timer timer = (Timer) timersByName.get(0);
assertEquals("geftem-eu-shuppe-oender-ze-konte", timer.getAction()
.getActionDelegation()
.getClassName());
}
public void testTimerRepeat() throws Exception {
ProcessDefinition processDefinition = ProcessDefinition.parseXmlString("<process-definition name='"
+ getName()
+ "'>"
+ " <start-state>"
+ " <transition to='a' />"
+ " </start-state>"
+ " <state name='a'>"
+ " <timer name='reminder' "
+ " duedate='0 seconds'"
+ " repeat='1 minute' >"
+ " <action class='"
+ NoOp.class.getName()
+ "'/>"
+ " </timer>"
+ " <transition to='b'/>"
+ " <transition name='back' to='a'/>"
+ " </state>"
+ " <state name='b'/>"
+ "</process-definition>");
deployProcessDefinition(processDefinition);
ProcessInstance processInstance = new ProcessInstance(processDefinition);
processInstance.signal();
jbpmContext.save(processInstance);
newTransaction();
Timer timer = (Timer) jobSession.getFirstAcquirableJob(null);
assertNotNull(timer);
Date dueDate = timer.getDueDate();
assertNotNull(dueDate);
timer.execute(jbpmContext);
newTransaction();
timer = jobSession.loadTimer(timer.getId());
assertEquals(dueDate.getTime() + 60 * 1000, timer.getDueDate().getTime());
processInstance = jbpmContext.loadProcessInstance(processInstance.getId());
processInstance.signal("back");
jbpmContext.save(processInstance);
newTransaction();
timer = (Timer) jobSession.getFirstAcquirableJob(null);
assertNotNull(timer);
dueDate = timer.getDueDate();
assertNotNull(dueDate);
newTransaction();
processInstance = jbpmContext.loadProcessInstance(processInstance.getId());
processInstance.signal();
jbpmContext.save(processInstance);
newTransaction();
assertEquals(0, getTimerCount());
}
public void testTimerUpdatingProcessVariables() throws Exception {
// variable a will be a task instance local variable
// variable b will be a process instance variable
ProcessDefinition processDefinition = ProcessDefinition.parseXmlString("<process-definition name='"
+ getName()
+ "'>"
+ " <start-state>"
+ " <transition to='a' />"
+ " </start-state>"
+ " <task-node name='a'>"
+ " <task name='wait for var updates'>"
+ " <controller>"
+ " <variable name ='a' />"
+ " </controller>"
+ " <timer name='update variables' "
+ " duedate='0 seconds'"
+ " repeat='5 seconds' >"
+ " <action class='"
+ UpdateVariables.class.getName()
+ "'/>"
+ " </timer>"
+ " </task>"
+ " </task-node>"
+ "</process-definition>");
deployProcessDefinition(processDefinition);
ProcessInstance processInstance = new ProcessInstance(processDefinition);
ContextInstance contextInstance = processInstance.getContextInstance();
contextInstance.setVariable("a", "value a");
contextInstance.setVariable("b", "value b");
processInstance.signal();
jbpmContext.save(processInstance);
newTransaction();
Timer timer = (Timer) jobSession.getFirstAcquirableJob(null);
timer.execute(jbpmContext);
newTransaction();
processInstance = jbpmContext.loadProcessInstance(processInstance.getId());
contextInstance = processInstance.getContextInstance();
assertEquals("value a", contextInstance.getVariable("a"));
assertEquals("value b updated", contextInstance.getVariable("b"));
TaskInstance taskInstance = (TaskInstance) processInstance.getTaskMgmtInstance()
.getTaskInstances()
.iterator()
.next();
assertEquals("value a updated", taskInstance.getVariable("a"));
assertEquals("value b updated", taskInstance.getVariable("b"));
}
public static class ConcurrentUpdateAction implements ActionHandler {
private static final long serialVersionUID = 1L;
public void execute(ExecutionContext executionContext) throws Exception {
executionContext.setVariable("a", "value a timer actioned updated");
}
}
public static class NoOp implements ActionHandler {
private static final long serialVersionUID = 1L;
public void execute(ExecutionContext executionContext) throws Exception {
}
}
public static class UpdateVariables implements ActionHandler {
private static final long serialVersionUID = 1L;
public void execute(ExecutionContext executionContext) throws Exception {
executionContext.setVariable("a", "value a updated");
executionContext.setVariable("b", "value b updated");
}
}
}