/* Copyright (c) 2014, Effektif GmbH.
*
* 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 com.effektif.workflow.test.serialization;
import com.effektif.workflow.api.activities.*;
import com.effektif.workflow.api.bpmn.BpmnElement;
import com.effektif.workflow.api.bpmn.BpmnReader;
import com.effektif.workflow.api.bpmn.BpmnTypeAttribute;
import com.effektif.workflow.api.bpmn.BpmnWriter;
import com.effektif.workflow.api.json.TypeName;
import com.effektif.workflow.api.model.*;
import com.effektif.workflow.api.types.*;
import com.effektif.workflow.api.workflow.*;
import com.effektif.workflow.api.workflow.diagram.Bounds;
import com.effektif.workflow.api.workflow.diagram.Diagram;
import com.effektif.workflow.api.workflow.diagram.Node;
import com.effektif.workflow.impl.activity.AbstractActivityType;
import com.effektif.workflow.impl.json.DefaultJsonStreamMapper;
import com.effektif.workflow.impl.json.JsonStreamMapper;
import com.effektif.workflow.impl.util.Lists;
import com.effektif.workflow.impl.workflowinstance.ActivityInstanceImpl;
import org.joda.time.DateTime;
import org.joda.time.DateTimeZone;
import org.joda.time.LocalDateTime;
import org.junit.BeforeClass;
import org.junit.Test;
import java.util.HashMap;
import java.util.Map;
import static org.junit.Assert.*;
/**
* Tests workflow serialisation to JSON, by serialising and deserialising workflow objects.
*
* @author Tom Baeyens
*/
public class WorkflowStreamTest {
protected static JsonStreamMapper jsonStreamMapper = null;
@TypeName("relativity")
@BpmnElement("serviceTask")
@BpmnTypeAttribute(attribute="type", value="relativity")
public static class RelativityActivity extends Activity {
RelativeTime delay;
public RelativityActivity() {
}
public RelativityActivity(RelativeTime relativeTime) {
this.delay = relativeTime;
}
@Override
public void readBpmn(BpmnReader r) {
super.readBpmn(r);
r.startExtensionElements();
delay = r.readRelativeTimeEffektif("delay");
r.endExtensionElements();
}
@Override
public void writeBpmn(BpmnWriter w) {
super.writeBpmn(w);
w.startExtensionElements();
w.writeRelativeTimeEffektif("delay", delay);
w.endExtensionElements();
}
}
public static class RelativityActivityImpl extends AbstractActivityType {
public RelativityActivityImpl() {
super(RelativityActivity.class);
}
@Override
public void execute(ActivityInstanceImpl activityInstance) {
}
}
@BeforeClass
public static void initialize() {
if (jsonStreamMapper==null) {
jsonStreamMapper = new DefaultJsonStreamMapper();
jsonStreamMapper.pretty();
}
}
public static JsonStreamMapper getJsonStreamMapper() {
initialize();
return jsonStreamMapper;
}
public <T extends AbstractWorkflow> T serializeWorkflow(T o) {
String jsonString = jsonStreamMapper.write(o);
System.out.println(jsonString);
return (T) jsonStreamMapper.readString(jsonString, o.getClass());
}
public <T extends Activity> T serializeActivity(T a) {
AbstractWorkflow w = new ExecutableWorkflow()
.activity((Activity)a);
w = serializeWorkflow(w);
return (T) w.getActivities().get(0);
}
public <T extends RelativeTime> T serializeRelativeTime(T relativeTime) {
AbstractWorkflow w = new ExecutableWorkflow()
.activity(new RelativityActivity(relativeTime));
w = serializeWorkflow(w);
return (T) ((RelativityActivity) w.getActivities().get(0)).delay;
}
protected String getWorkflowIdInternal() {
return "wid";
}
@Test
public void testActivity() {
Activity activity = new NoneTask()
.id("verifyRequirements")
.defaultTransitionId("continue")
.multiInstance(new MultiInstance()
.valuesExpression("reviewers")
.variable("reviewer", TextType.INSTANCE));
activity = serializeActivity(activity);
assertEquals("verifyRequirements", activity.getId());
assertEquals("continue", activity.getDefaultTransitionId());
assertNotNull(activity.getMultiInstance());
assertEquals("reviewer", activity.getMultiInstance().getVariable().getId());
assertEquals("reviewers", activity.getMultiInstance().getValues().get(0).getExpression());
}
@Test
public void testSubProcess() {
LocalDateTime now = new LocalDateTime();
ExecutableWorkflow workflow = new ExecutableWorkflow()
.activity(new SubProcess()
.id("runTests")
.inputValue("d", now)
.inputValue("s", "string")
.inputExpression("v", "version")
.subWorkflowSourceId("Run tests")
.subWorkflowId(new WorkflowId(getWorkflowIdInternal())));
workflow = serializeWorkflow(workflow);
assertNotNull(workflow);
SubProcess subProcess = (SubProcess) workflow.getActivities().get(0);
assertEquals(new WorkflowId(getWorkflowIdInternal()), subProcess.getSubWorkflowId());
assertEquals("Run tests", subProcess.getSubWorkflowSourceId());
assertEquals(now, subProcess.getSubWorkflowInputs().get("d").getValue());
assertEquals("string", subProcess.getSubWorkflowInputs().get("s").getValue());
assertEquals("version", subProcess.getSubWorkflowInputs().get("v").getExpression());
}
@Test
public void testEndEvent() {
EndEvent activity = new EndEvent();
activity.setId("releaseComplete");
activity.setName("software released");
activity.setDescription("Ends the process when the release is complete.");
activity = serializeActivity(activity);
assertEquals(EndEvent.class, activity.getClass());
assertEquals("releaseComplete", activity.getId());
assertEquals("software released", activity.getName());
assertEquals("Ends the process when the release is complete.", activity.getDescription());
assertNull(activity.getOutgoingTransitions());
}
@Test
public void testExclusiveGateway() {
ExclusiveGateway activity = (ExclusiveGateway) new ExclusiveGateway()
.id("test-ok")
.defaultTransitionId("proceed");
activity = serializeActivity(activity);
assertEquals(ExclusiveGateway.class, activity.getClass());
assertEquals("test-ok", activity.getId());
assertEquals("proceed", activity.getDefaultTransitionId());
}
@Test
public void testExecutableWorkflow() {
LocalDateTime now = new LocalDateTime();
Map<String,Object> p = new HashMap<>();
p.put("str", "s");
p.put("lis", Lists.of("a", 1, true));
p.put("num", Long.MAX_VALUE);
p.put("dou", Double.MAX_VALUE);
p.put("boo", true);
String workflowIdInternal = getWorkflowIdInternal();
ExecutableWorkflow workflow = new ExecutableWorkflow()
.id(new WorkflowId(workflowIdInternal))
.name("Software release")
.description("Regular software production release process.")
.createTime(now)
.creatorId("iamdevloper")
.sourceWorkflowId("source")
.variable("v", TextType.INSTANCE)
.activity("start", new StartEvent())
.activity("end", new EndEvent())
.transition(new Transition().fromId("start").toId("end"))
.property("str", "s")
.property("lis", Lists.of("a", 1, true))
.property("num", Long.MAX_VALUE)
.property("dou", Double.MAX_VALUE)
.property("boo", true);
workflow.setEnableCases(true);
workflow = serializeWorkflow(workflow);
assertNotNull(workflow);
assertEquals(workflowIdInternal, workflow.getId().getInternal());
assertEquals("Software release", workflow.getName());
assertEquals("Regular software production release process.", workflow.getDescription());
assertEquals(now, workflow.getCreateTime());
assertEquals("iamdevloper", workflow.getCreatorId());
assertEquals("source", workflow.getSourceWorkflowId());
assertEquals("start", ((StartEvent)workflow.getActivities().get(0)).getId());
assertEquals("end", ((EndEvent)workflow.getActivities().get(1)).getId());
assertEquals("start", workflow.getTransitions().get(0).getFromId());
assertEquals("end", workflow.getTransitions().get(0).getToId());
// Not tested, pending implementation.
// assertEquals(p.get("str"), workflow.getProperty("str"));
// assertEquals(p.get("lis"), workflow.getProperty("lis"));
// assertEquals(p.get("num"), workflow.getProperty("num"));
// assertEquals(p.get("dou"), workflow.getProperty("dou"));
// assertEquals(p.get("boo"), workflow.getProperty("boo"));
assertTrue(workflow.isEnableCases());
}
@Test
public void testEmbeddedSubprocess() {
ExecutableWorkflow workflow = new ExecutableWorkflow()
.activity("phase1",
new EmbeddedSubprocess().name("phase one").activity("start", new StartEvent()).activity("end", new EndEvent())
.transition(new Transition().fromId("start").toId("end")));
workflow = serializeWorkflow(workflow);
EmbeddedSubprocess embeddedSubprocess = (EmbeddedSubprocess) workflow.getActivities().get(0);
assertEquals("phase1", embeddedSubprocess.getId());
assertEquals("phase one", embeddedSubprocess.getName());
StartEvent startEvent = (StartEvent) embeddedSubprocess.getActivities().get(0);
assertEquals("start", startEvent.getId());
EndEvent endEvent = (EndEvent) embeddedSubprocess.getActivities().get(1);
assertEquals("end", endEvent.getId());
Transition transition = embeddedSubprocess.getTransitions().get(0);
assertEquals("start", transition.getFromId());
assertEquals("end", transition.getToId());
}
@Test
public void testHttpServiceTask() {
HttpServiceTask activity = new HttpServiceTask();
activity.setId("publishReleaseNotes");
activity = serializeActivity(activity);
assertEquals(HttpServiceTask.class, activity.getClass());
assertEquals("publishReleaseNotes", activity.getId());
}
@Test
public void testJavaServiceTask() {
JavaServiceTask activity = new JavaServiceTask();
activity.setId("profilePerformance");
activity = serializeActivity(activity);
assertEquals(JavaServiceTask.class, activity.getClass());
assertEquals("profilePerformance", activity.getId());
}
@Test
public void testNoneTask() {
NoneTask activity = new NoneTask();
activity.setId("verifyRequirements");
activity = serializeActivity(activity);
assertEquals(NoneTask.class, activity.getClass());
assertEquals("verifyRequirements", activity.getId());
}
@Test
public void testParallelGateway() {
ParallelGateway activity = new ParallelGateway();
activity.setId("fork");
activity = serializeActivity(activity);
assertEquals(ParallelGateway.class, activity.getClass());
assertEquals("fork", activity.getId());
}
@Test
public void testReceiveTask() {
ReceiveTask activity = new ReceiveTask();
activity.setId("buildComplete");
activity = serializeActivity(activity);
assertEquals(ReceiveTask.class, activity.getClass());
assertEquals("buildComplete", activity.getId());
}
@Test
public void testStartEvent() {
StartEvent activity = new StartEvent();
activity.setId("codeComplete");
activity.setName("code complete");
activity.setDescription("Starts the process when the code is ready to release.");
activity = serializeActivity(activity);
assertEquals(StartEvent.class, activity.getClass());
assertEquals("codeComplete", activity.getId());
assertEquals("code complete", activity.getName());
assertEquals("Starts the process when the code is ready to release.", activity.getDescription());
}
@Test
public void testInOutParameters() {
ExecutableWorkflow workflow = new ExecutableWorkflow()
.activity("a", new NoneTask()
.inputValue("in1", "value1")
.inputExpression("in2", "expression2")
.inputListBinding("in3", new Binding<Object>().value("listValue1"))
.inputListBinding("in3", new Binding<Object>().expression("listExpression2"))
.output("out1", "var1"));
workflow = serializeWorkflow(workflow);
Activity activity = workflow.getActivities().get(0);
assertEquals("value1", activity.getInputs().get("in1").getBinding().getValue());
assertEquals("expression2", activity.getInputs().get("in2").getBinding().getExpression());
assertEquals("listValue1", activity.getInputs().get("in3").getBindings().get(0).getValue());
assertEquals("listExpression2", activity.getInputs().get("in3").getBindings().get(1).getExpression());
assertEquals("var1", activity.getOutputs().get("out1"));
}
@Test
public void testVariables() {
LocalDateTime now = DateTime.now().withZone(DateTimeZone.UTC).withMillisOfSecond(0).toLocalDateTime();
ExecutableWorkflow workflow = new ExecutableWorkflow();
workflow.variable(new Variable().id("variable01").type(BooleanType.INSTANCE).defaultValue(Boolean.TRUE));
ChoiceType choiceType = new ChoiceType().option("Red pill").option("Blue pill");
workflow.variable(new Variable().id("variable02").type(choiceType).defaultValue("Blue pill"));
workflow.variable(new Variable().id("variable03").type(new DateType()).defaultValue(now));
workflow.variable(new Variable().id("variable04").type(EmailAddressType.INSTANCE).defaultValue("alice@example.org"));
workflow.variable(new Variable().id("variable05").type(new JavaBeanType(Integer.class)));
workflow.variable(new Variable().id("variable06").type(LinkType.INSTANCE).defaultValue("http://example.org/"));
workflow.variable(new Variable().id("variable07").type(new ListType(NumberType.INSTANCE)).defaultValue(Lists.of(40, 41, 42)));
Money defaultMoneyValue = new Money().currency("EUR").amount(41.99);
workflow.variable(new Variable().id("variable08").type(MoneyType.INSTANCE).defaultValue(defaultMoneyValue));
workflow.variable(new Variable().id("variable09").type(NumberType.INSTANCE).defaultValue(42.5));
workflow.variable(new Variable().id("variable10").type(new TextType().multiLine()).defaultValue("hello"));
workflow.variable(new Variable().id("variable11").type(new DateType().date()).defaultValue(now));
workflow.variable(new Variable().id("variable12").type(new DateType().time()).defaultValue(now));
workflow = serializeWorkflow(workflow);
assertNotNull(workflow.getVariables());
assertEquals(12, workflow.getVariables().size());
assertEquals(BooleanType.class, workflow.getVariables().get(0).getType().getClass());
assertEquals(Boolean.TRUE, workflow.getVariables().get(0).getDefaultValue());
assertEquals(ChoiceType.class, workflow.getVariables().get(1).getType().getClass());
assertEquals("Red pill", ((ChoiceType) workflow.getVariables().get(1).getType()).getOptions().get(0).getId());
assertEquals("Blue pill", workflow.getVariables().get(1).getDefaultValue());
assertEquals(DateType.class, workflow.getVariables().get(2).getType().getClass());
assertEquals("datetime", ((DateType) workflow.getVariables().get(2).getType()).getKind());
assertEquals(now, workflow.getVariables().get(2).getDefaultValue());
assertEquals(EmailAddressType.class, workflow.getVariables().get(3).getType().getClass());
assertEquals("alice@example.org", workflow.getVariables().get(3).getDefaultValue());
assertEquals(JavaBeanType.class, workflow.getVariables().get(4).getType().getClass());
assertEquals(Integer.class, ((JavaBeanType) workflow.getVariables().get(4).getType()).getJavaClass());
assertEquals(LinkType.class, workflow.getVariables().get(5).getType().getClass());
assertEquals(ListType.class, workflow.getVariables().get(6).getType().getClass());
assertEquals(Lists.of(40, 41, 42), workflow.getVariables().get(6).getDefaultValue());
assertEquals(NumberType.class, ((ListType) workflow.getVariables().get(6).getType()).getElementType().getClass());
assertEquals(MoneyType.class, workflow.getVariables().get(7).getType().getClass());
assertEquals(defaultMoneyValue, workflow.getVariables().get(7).getDefaultValue());
assertEquals(NumberType.class, workflow.getVariables().get(8).getType().getClass());
assertEquals(Double.class, workflow.getVariables().get(8).getDefaultValue().getClass());
assertEquals(42.5, workflow.getVariables().get(8).getDefaultValue());
assertEquals(TextType.class, workflow.getVariables().get(9).getType().getClass());
assertTrue(((TextType) workflow.getVariables().get(9).getType()).isMultiLine());
assertEquals("hello", workflow.getVariables().get(9).getDefaultValue());
assertEquals(DateType.class, workflow.getVariables().get(10).getType().getClass());
assertEquals("date", ((DateType) workflow.getVariables().get(10).getType()).getKind());
LocalDateTime defaultValue11 = (LocalDateTime) workflow.getVariables().get(10).getDefaultValue();
assertEquals(now.withTime(0, 0, 0, 0), defaultValue11.withTime(0, 0, 0, 0));
assertEquals(DateType.class, workflow.getVariables().get(11).getType().getClass());
assertEquals("time", ((DateType) workflow.getVariables().get(11).getType()).getKind());
LocalDateTime defaultValue12 = (LocalDateTime) workflow.getVariables().get(11).getDefaultValue();
assertEquals(now.withDate(1, 1, 1), defaultValue12.withDate(1, 1, 1));
}
@Test
public void testAfterRelativeTime() {
assertNull(serializeRelativeTime(AfterRelativeTime.minutes(5)).getAtHour());
assertEquals(5, (int) serializeRelativeTime(AfterRelativeTime.minutes(5)).getDuration());
assertEquals(AfterRelativeTime.MINUTES, serializeRelativeTime(AfterRelativeTime.minutes(5)).getDurationUnit());
assertEquals(AfterRelativeTime.HOURS, serializeRelativeTime(AfterRelativeTime.hours(5)).getDurationUnit());
assertEquals(AfterRelativeTime.DAYS, serializeRelativeTime(AfterRelativeTime.days(5)).getDurationUnit());
assertEquals(AfterRelativeTime.WEEKS, serializeRelativeTime(AfterRelativeTime.weeks(5)).getDurationUnit());
assertEquals(AfterRelativeTime.MONTHS, serializeRelativeTime(AfterRelativeTime.months(5)).getDurationUnit());
assertEquals(AfterRelativeTime.YEARS, serializeRelativeTime(AfterRelativeTime.years(5)).getDurationUnit());
RelativeTime relativeTime = serializeRelativeTime(AfterRelativeTime
.minutes(5)
.at(11,45));
assertEquals(11, (int) relativeTime.getAtHour());
assertEquals(45, (int) relativeTime.getAtMinute());
}
@Test
public void testNextRelativeTime() {
assertNull(serializeRelativeTime(NextRelativeTime.hourOfDay(5)).getAtHour());
assertEquals(5, (int) serializeRelativeTime(NextRelativeTime.hourOfDay(5)).getIndex());
assertEquals(NextRelativeTime.HOUR_OF_DAY, serializeRelativeTime(NextRelativeTime.hourOfDay(5)).getIndexUnit());
assertEquals(NextRelativeTime.DAY_OF_WEEK, serializeRelativeTime(NextRelativeTime.dayOfWeek(5)).getIndexUnit());
assertEquals(NextRelativeTime.DAY_OF_MONTH, serializeRelativeTime(NextRelativeTime.dayOfMonth(5)).getIndexUnit());
RelativeTime relativeTime = serializeRelativeTime(NextRelativeTime.dayOfMonth(5)
.at(11,45));
assertEquals(11, (int) relativeTime.getAtHour());
assertEquals(45, (int) relativeTime.getAtMinute());
}
@Test
public void testEmptyDiagram() throws Exception {
ExecutableWorkflow workflow = new ExecutableWorkflow().id(new WorkflowId(getWorkflowIdInternal()));
workflow.setDiagram(new Diagram().canvas(new Node().addNode(new Node().bounds(new Bounds(0, 0, 10, 10)))));
workflow = serializeWorkflow(workflow);
// No execptions due to empty workflow and diagram.
}
}