import TestContainer from 'mocha-test-container-support'; import Diagram from 'diagram-js/lib/Diagram'; import BpmnModdle from 'bpmn-moddle'; import { importBpmnDiagram } from 'lib/import/Importer'; import Viewer from 'lib/Viewer'; import { matches as domMatches } from 'min-dom'; import { getChildren as getChildrenGfx } from 'diagram-js/lib/util/GraphicsUtil'; import { find, isFunction } from 'min-dash'; import { is } from 'lib/util/ModelUtil'; describe('import - Importer', function() { function createDiagram(container, modules) { return new Diagram({ canvas: { container: container }, modules: modules }); } var diagram; beforeEach(function() { diagram = createDiagram(TestContainer.get(this), Viewer.prototype._modules); }); function runImport(diagram, xml, diagramId, done) { if (isFunction(diagramId)) { done = diagramId; diagramId = null; } var moddle = new BpmnModdle(); moddle.fromXML(xml, function(err, definitions) { var selectedDiagram = find(definitions.diagrams, function(element) { return element.id === diagramId; }); importBpmnDiagram(diagram, definitions, selectedDiagram, done); }); } describe('events', function() { it('should fire and ', function(done) { // given var xml = require('../../fixtures/bpmn/import/process.bpmn'); var eventCount = 0; var eventBus = diagram.get('eventBus'); // log events eventBus.on('import.render.start', function(event) { expect(event.definitions).to.exist; eventCount++; }); eventBus.on('import.render.complete', function(event) { expect(event).to.have.property('error'); expect(event).to.have.property('warnings'); eventCount++; }); // when runImport(diagram, xml, function(err, warnings) { // then expect(eventCount).to.equal(2); done(err); }); }); it('should fire during import', function(done) { // given var xml = require('../../fixtures/bpmn/import/process.bpmn'); var eventCount = 0; // log events diagram.get('eventBus').on('bpmnElement.added', function(e) { eventCount++; }); // when runImport(diagram, xml, function(err, warnings) { // then expect(eventCount).to.equal(9); done(err); }); }); }); describe('basics', function() { it('should import process', function(done) { // given var xml = require('../../fixtures/bpmn/import/process.bpmn'); var events = []; // log events diagram.get('eventBus').on('bpmnElement.added', function(e) { events.push({ type: 'add', semantic: e.element.businessObject.id, di: e.element.businessObject.di.id, diagramElement: e.element && e.element.id }); }); // when runImport(diagram, xml, function(err, warnings) { // then expect(events).to.eql([ { type: 'add', semantic: 'Process_1', di: 'BPMNPlane_1', diagramElement: 'Process_1' }, { type: 'add', semantic: 'SubProcess_1', di: '_BPMNShape_SubProcess_2', diagramElement: 'SubProcess_1' }, { type: 'add', semantic: 'StartEvent_1', di: '_BPMNShape_StartEvent_2', diagramElement: 'StartEvent_1' }, { type: 'add', semantic: 'Task_1', di: '_BPMNShape_Task_2', diagramElement: 'Task_1' }, { type: 'add', semantic: 'EndEvent_1', di: '_BPMNShape_EndEvent_2', diagramElement: 'EndEvent_1' }, { type: 'add', semantic: 'StartEvent_2', di: '_BPMNShape_StartEvent_11', diagramElement: 'StartEvent_2' }, { type: 'add', semantic: 'SequenceFlow_1', di: 'BPMNEdge_SequenceFlow_1', diagramElement: 'SequenceFlow_1' }, { type: 'add', semantic: 'SequenceFlow_2', di: 'BPMNEdge_SequenceFlow_2', diagramElement: 'SequenceFlow_2' }, { type: 'add', semantic: 'SequenceFlow_3', di: 'BPMNEdge_SequenceFlow_3', diagramElement: 'SequenceFlow_3' } ]); done(err); }); }); it('should import collaboration', function(done) { // given var xml = require('../../fixtures/bpmn/import/collaboration.bpmn'); var events = []; // log events diagram.get('eventBus').on('bpmnElement.added', function(e) { events.push({ type: 'add', semantic: e.element.businessObject.id, di: e.element.businessObject.di.id, diagramElement: e.element && e.element.id }); }); // when runImport(diagram, xml, function(err, warnings) { // then expect(events).to.eql([ { type: 'add', semantic: '_Collaboration_2', di: 'BPMNPlane_1', diagramElement: '_Collaboration_2' }, { type: 'add', semantic: 'Participant_2', di: '_BPMNShape_Participant_2', diagramElement: 'Participant_2' }, { type: 'add', semantic: 'Task_1', di: '_BPMNShape_Task_3', diagramElement: 'Task_1' }, { type: 'add', semantic: 'Participant_1', di: '_BPMNShape_Participant_3', diagramElement: 'Participant_1' }, { type: 'add', semantic: 'StartEvent_1', di: '_BPMNShape_StartEvent_3', diagramElement: 'StartEvent_1' }, { type: 'add', semantic: 'Lane_1', di: '_BPMNShape_Lane_2', diagramElement: 'Lane_1' }, { type: 'add', semantic: 'Lane_2', di: '_BPMNShape_Lane_3', diagramElement: 'Lane_2' }, { type: 'add', semantic: 'Lane_3', di: '_BPMNShape_Lane_4', diagramElement: 'Lane_3' } ]); done(err); }); }); }); describe('position', function() { var xml = require('../../fixtures/bpmn/import/position/position-testcase.bpmn'); it('should round shape coordinates', function(done) { // given var events = {}; // log events diagram.get('eventBus').on('bpmnElement.added', function(e) { events[e.element.id] = e.element; }); runImport(diagram, xml, function(err, warnings) { // round up expect(events.ID_End.x).to.equal(Math.round(340.6)); expect(events.ID_End.y).to.equal(Math.round(136.6)); // round down expect(events.ID_Start.x).to.equal(Math.round(120.4)); expect(events.ID_Start.y).to.equal(Math.round(135.4)); done(err); }); }); it('should round shape dimensions', function(done) { // given var events = {}; // log events diagram.get('eventBus').on('bpmnElement.added', function(e) { events[e.element.id] = e.element; }); runImport(diagram, xml, function(err, warnings) { // round down expect(events.ID_Start.height).to.equal(Math.round(30.4)); expect(events.ID_Start.width).to.equal(Math.round(30.4)); done(err); }); }); }); describe('order', function() { it('should import sequence flows and lanes behind other flow nodes', function(done) { var xml = require('./sequenceFlow-ordering.bpmn'); // given var elementRegistry = diagram.get('elementRegistry'); runImport(diagram, xml, function(err, warnings) { // when var processShape = elementRegistry.get('Participant_1jxpy8o'); var children = processShape.children; // lanes // connections // other elements var correctlyOrdered = [].concat( children.filter(function(c) { return is(c, 'bpmn:Lane'); }), children.filter(function(c) { return c.waypoints; }), children.filter(function(c) { return !is(c, 'bpmn:Lane') && !c.waypoints; }) ); // then expectChildren(diagram, processShape, correctlyOrdered); done(err); }); }); }); describe('elements', function() { it('should import boundary events', function(done) { // given var xml = require('../../fixtures/bpmn/import/boundaryEvent.bpmn'); var events = []; // log events diagram.get('eventBus').on('bpmnElement.added', function(e) { events.push({ type: 'add', semantic: e.element.businessObject.id, di: e.element.businessObject.di.id, diagramElement: e.element && e.element.id }); }); // when runImport(diagram, xml, function(err, warnings) { // then expect(events).to.eql([ { type: 'add', semantic: 'Process_1', di: 'BPMNPlane_1', diagramElement: 'Process_1' }, { type: 'add', semantic: 'Task_1', di: '_BPMNShape_Task_2', diagramElement: 'Task_1' }, { type: 'add', semantic: 'Task_2', di: '_BPMNShape_Task_3', diagramElement: 'Task_2' }, { type: 'add', semantic: 'BoundaryEvent_1', di: '_BPMNShape_BoundaryEvent_2', diagramElement: 'BoundaryEvent_1' }, { type: 'add', semantic: 'SequenceFlow_1', di: 'BPMNEdge_SequenceFlow_1', diagramElement: 'SequenceFlow_1' } ]); done(err); }); }); it('should import data store as child of participant', function(done) { // given var xml = require('../../fixtures/bpmn/import/data-store.inside-participant.bpmn'); var events = {}; // log events diagram.get('eventBus').on('bpmnElement.added', function(e) { events[e.element.id] = e.element; }); runImport(diagram, xml, function(err, warnings) { expect(events.DataStoreReference.parent).to.equal(events.Participant); done(err); }); }); it('should import data store in participant as child of collaboration', function(done) { // given var xml = require('../../fixtures/bpmn/import/data-store.outside-participant.participant.bpmn'); var events = {}; // log events diagram.get('eventBus').on('bpmnElement.added', function(e) { events[e.element.id] = e.element; }); runImport(diagram, xml, function(err, warnings) { expect(events.DataStoreReference.parent).to.equal(events.Collaboration); done(err); }); }); it('should import data store in subprocess as child of collaboration', function(done) { // given var xml = require('../../fixtures/bpmn/import/data-store.outside-participant.subprocess.bpmn'); var events = {}; // log events diagram.get('eventBus').on('bpmnElement.added', function(e) { events[e.element.id] = e.element; }); runImport(diagram, xml, function(err, warnings) { expect(events.DataStoreReference.parent).to.equal(events.Collaboration); done(err); }); }); it('should import data store outside of participant without warnings', function(done) { // given var xml = require('../../fixtures/bpmn/import/data-store.outside-participant.dangling.bpmn'); // when runImport(diagram, xml, function(err, warnings) { // then expect(warnings).to.be.empty; done(err); }); }); it('should import single diagram from multiple diagrams 2', function(done) { // given var xml = require('../../fixtures/bpmn/import/multiple-diagrams.bpmn'); var events = []; // log events diagram.get('eventBus').on('bpmnElement.added', function(e) { events.push({ type: 'add', semantic: e.element.businessObject.id, di: e.element.businessObject.di.id, diagramElement: e.element && e.element.id }); }); // when runImport(diagram, xml, 'BPMNDiagram_2', function(err, warnings) { // then expect(events).to.eql([ { type: 'add', semantic: 'Process_2', di: 'BPMNPlane_2', diagramElement: 'Process_2' }, { type: 'add', semantic: 'StartEvent_2', di: '_BPMNShape_StartEvent_2', diagramElement: 'StartEvent_2' }, { type: 'add', semantic: 'IntermediateThrowEvent_1', di: '_BPMNShape_IntermediateThrowEvent_1', diagramElement: 'IntermediateThrowEvent_1' }, { type: 'add', semantic: 'EndEvent_2', di: '_BPMNShape_EndEvent_2', diagramElement: 'EndEvent_2' }, { type: 'add', semantic: 'SequenceFlow_4', di: 'BPMNEdge_SequenceFlow_4', diagramElement: 'SequenceFlow_4' }, { type: 'add', semantic: 'SequenceFlow_5', di: 'BPMNEdge_SequenceFlow_5', diagramElement: 'SequenceFlow_5' } ]); done(err); }); }); it('should import single diagram from multiple diagrams 1', function(done) { // given var xml = require('../../fixtures/bpmn/import/multiple-diagrams.bpmn'); var events = []; // log events diagram.get('eventBus').on('bpmnElement.added', function(e) { events.push({ type: 'add', semantic: e.element.businessObject.id, di: e.element.businessObject.di.id, diagramElement: e.element && e.element.id }); }); // when runImport(diagram, xml, 'BPMNDiagram_1', function(err, warnings) { // then expect(events).to.eql([ { type: 'add', semantic: 'Process_1', di: 'BPMNPlane_1', diagramElement: 'Process_1' }, { type: 'add', semantic: 'StartEvent_1', di: '_BPMNShape_StartEvent_1', diagramElement: 'StartEvent_1' }, { type: 'add', semantic: 'Task_1', di: '_BPMNShape_Task_1', diagramElement: 'Task_1' }, { type: 'add', semantic: 'Task_2', di: '_BPMNShape_Task_2', diagramElement: 'Task_2' }, { type: 'add', semantic: 'EndEvent_1', di: '_BPMNShape_EndEvent_1', diagramElement: 'EndEvent_1' }, { type: 'add', semantic: 'SequenceFlow_1', di: 'BPMNEdge_SequenceFlow_1', diagramElement: 'SequenceFlow_1' }, { type: 'add', semantic: 'SequenceFlow_2', di: 'BPMNEdge_SequenceFlow_2', diagramElement: 'SequenceFlow_2' }, { type: 'add', semantic: 'SequenceFlow_3', di: 'BPMNEdge_SequenceFlow_3', diagramElement: 'SequenceFlow_3' } ]); done(err); }); }); }); describe('forgiveness', function() { it('should import invalid flowElement', function(done) { // given var xml = require('../../fixtures/bpmn/import/error/invalid-flow-element.bpmn'); // when runImport(diagram, xml, function(err, warnings) { expect(warnings).to.have.length(0); done(err); }); }); it('should import multiple DIs', function(done) { // given var xml = require('../../fixtures/bpmn/import/error/multiple-dis.bpmn'); // when runImport(diagram, xml, function(err, warnings) { var expectedMessage = 'multiple DI elements defined for '; expect(warnings).to.have.length(1); expect(warnings[0].message).to.equal(expectedMessage); done(err); }); }); it('should import sequence flow without waypoints', function(done) { // given var xml = require('./sequenceFlow-missingWaypoints.bpmn'); // when runImport(diagram, xml, function(err, warnings) { expect(warnings).to.be.empty; done(err); }); }); it('should extend attributes with default value', function(done) { // given var xml = require('../../fixtures/bpmn/import/default-attrs.bpmn'); // when runImport(diagram, xml, function(err, warnings) { var elementRegistry = diagram.get('elementRegistry'); var element = elementRegistry.get('GATEWAY_1'); expect(element.businessObject.eventGatewayType).to.equal('Exclusive'); done(); }); }); describe('boundary events', function() { it('should handle missing attachToRef', function(done) { // given var xml = require('../../fixtures/bpmn/import/error/boundaryEvent-missingAttachToRef.bpmn'); // when runImport(diagram, xml, function(err, warnings) { // then expect(warnings.length).to.eql(2); expect(warnings[0].message).to.eql('missing #attachedToRef'); expect(warnings[1].message).to.eql('element referenced by #sourceRef not yet drawn'); done(err); }); }); it('should handle invalid attachToRef', function(done) { // given var xml = require('../../fixtures/bpmn/import/error/boundaryEvent-invalidAttachToRef.bpmn'); // when runImport(diagram, xml, function(err, warnings) { // then expect(warnings.length).to.eql(2); expect(warnings[0].message).to.eql('missing #attachedToRef'); expect(warnings[1].message).to.eql('element referenced by #sourceRef not yet drawn'); done(err); }); }); }); }); describe('integration', function() { it('should import dangling process message flows', function(done) { // given var xml = require('../../fixtures/bpmn/import/error/dangling-process-message-flow.bpmn'); // when runImport(diagram, xml, function(err, warnings) { // then expect(warnings).to.have.length(0); expect(diagram.get('elementRegistry').get('_b467921a-ef7b-44c5-bf78-fd624c400d17')).to.exist; expect(diagram.get('elementRegistry').get('_c311cc87-677e-47a4-bdb1-8744c4ec3147')).to.exist; done(err); }); }); }); describe('hiding', function() { it('should hide shapes and connections inside of collapsed subprocess', function(done) { // given var xml = require('../../fixtures/bpmn/import/collapsed/processWithChildren.bpmn'); // when runImport(diagram, xml, function(err, warnings) { var elementRegistry = diagram.get('elementRegistry'); var children = elementRegistry.get('SubProcess_1').children; var visible = find(children, function(child) { return !child.hidden; }); // then expect(visible).to.be.undefined; done(err); }); }); }); }); // helpers ////////////////////// function expectChildren(diagram, parent, children) { return diagram.invoke(function(elementRegistry) { // verify model is consistent expect(parent.children).to.eql(children); // verify SVG is consistent var parentGfx = elementRegistry.getGraphics(parent); var expectedChildrenGfx = children.map(function(c) { return elementRegistry.getGraphics(c); }); var childrenContainerGfx = domMatches(parentGfx, '[data-element-id="Process_1"]') ? parentGfx : getChildrenGfx(parentGfx); var existingChildrenGfx = Array.prototype.map.call(childrenContainerGfx.childNodes, function(c) { return c.querySelector('.djs-element'); }); expect(existingChildrenGfx).to.eql(expectedChildrenGfx); }); }