bpmn-js/test/spec/ModelerSpec.js

'use strict';

var Modeler = require('../../lib/Modeler');

var TestContainer = require('mocha-test-container-support');

describe('Modeler', function() {

  var container;

  beforeEach(function() {
    container = TestContainer.get(this);
  });


  function createModeler(xml, done) {
    var modeler = new Modeler({ container: container });

    modeler.importXML(xml, function(err, warnings) {
      done(err, warnings, modeler);
    });
  }


  it('should import simple process', function(done) {
    var xml = require('../fixtures/bpmn/simple.bpmn');
    createModeler(xml, done);
  });


  it('should import collaboration', function(done) {
    var xml = require('../fixtures/bpmn/collaboration-message-flows.bpmn');
    createModeler(xml, done);
  });


  it('should import nested lanes', function(done) {
    var xml = require('./features/modeling/lanes/lanes.bpmn');
    createModeler(xml, done);
  });


  it('should not import empty definitions', function(done) {
    var xml = require('../fixtures/bpmn/empty-definitions.bpmn');

    // given
    createModeler(xml, function(err, warnings, modeler) {

      // when
      modeler.importXML(xml, function(err, warnings) {

        // then
        expect(err.message).to.equal('no diagram to display');

        done();
      });

    });
  });


  it('should re-import simple process', function(done) {

    var xml = require('../fixtures/bpmn/simple.bpmn');

    // given
    createModeler(xml, function(err, warnings, modeler) {

      if (err) {
        return done(err);
      }

      // when
      // mimic re-import of same diagram
      modeler.importXML(xml, function(err, warnings) {

        if (err) {
          return done(err);
        }

        // then
        expect(warnings.length).to.equal(0);

        done();
      });

    });
  });


  describe('defaults', function() {

    it('should use <body> as default parent', function(done) {

      var xml = require('../fixtures/bpmn/simple.bpmn');

      var modeler = new Modeler();

      modeler.importXML(xml, function(err, warnings) {

        expect(modeler.container.parentNode).to.equal(document.body);

        done(err, warnings);
      });
    });

  });


  describe('overlay support', function() {

    it('should allow to add overlays', function(done) {

      var xml = require('../fixtures/bpmn/simple.bpmn');

      createModeler(xml, function(err, warnings, viewer) {

        // given
        var overlays = viewer.get('overlays'),
            elementRegistry = viewer.get('elementRegistry');

        // assume
        expect(overlays).to.exist;
        expect(elementRegistry).to.exist;


        // when
        overlays.add('SubProcess_1', 'badge', {
          position: {
            bottom: 0,
            right: 0
          },
          html: '<div style="max-width: 50px">YUP GREAT STUFF!</div>'
        });

        overlays.add('StartEvent_1', 'badge', {
          position: {
            top: 0,
            left: 0
          },
          html: '<div style="max-width: 50px">YUP GREAT STUFF!</div>'
        });

        // then
        expect(overlays.get({ element: 'SubProcess_1', type: 'badge' }).length).to.equal(1);
        expect(overlays.get({ element: 'StartEvent_1', type: 'badge' }).length).to.equal(1);

        done(err);
      });

    });

  });


  describe('bendpoint editing support', function() {

    var createEvent = require('../util/MockEvents').createEvent;


    it('should allow to edit bendpoints', function(done) {

      var xml = require('../fixtures/bpmn/simple.bpmn');

      createModeler(xml, function(err, warnings, viewer) {

        // given
        var bendpointMove = viewer.get('bendpointMove'),
            dragging = viewer.get('dragging'),
            elementRegistry = viewer.get('elementRegistry'),
            canvas = viewer.get('canvas');

        // assume
        expect(bendpointMove).to.exist;

        // when
        bendpointMove.start(createEvent(canvas, { x: 0, y: 0 }), elementRegistry.get('SequenceFlow_1'), 1);
        dragging.move(createEvent(canvas, { x: 200, y: 200 }));

        done(err);
      });

    });

  });


  it('should handle errors', function(done) {

    var xml = 'invalid stuff';

    var modeler = new Modeler({ container: container });

    modeler.importXML(xml, function(err) {

      expect(err).to.exist;

      done();
    });
  });


  it('should create new diagram', function(done) {
    var modeler = new Modeler({ container: container });
    modeler.createDiagram(done);
  });


  describe('dependency injection', function() {

    it('should be available via di as <bpmnjs>', function(done) {

      var xml = require('../fixtures/bpmn/simple.bpmn');

      createModeler(xml, function(err, warnings, modeler) {

        expect(modeler.get('bpmnjs')).to.equal(modeler);

        done(err);
      });
    });

  });

});
chore(tests): use jasmine-test-container-support for test execution This allows us to have tests nice and easily rendered within test-local containers, including captions, status highlighting and links. 2014-06-18 09:45:30 +00:00			`'use strict';`

chore(tests): remove unused node test folders This commit cleans up reminders of the node-js test suite removal by removing the test/node folder. The test structure has been aligned by moving all tests from * test/spec/browser to test/spec * test/spec/integration to test/integration 2014-08-01 05:16:59 +00:00			`var Modeler = require('../../lib/Modeler');`
feat(import): import bpmn shapes We are able to import shapes based on BPMNDI. Related to #1 2014-03-13 15:06:30 +00:00
test(project): replace jasmine with mocha Closes #204 2015-07-15 15:22:19 +00:00			`var TestContainer = require('mocha-test-container-support');`
feat(import): import bpmn shapes We are able to import shapes based on BPMNDI. Related to #1 2014-03-13 15:06:30 +00:00
feat(bpmn-js): add #destroy method and allow custom position Closes #100 2014-12-18 08:45:45 +00:00			`describe('Modeler', function() {`
feat(import): import bpmn shapes We are able to import shapes based on BPMNDI. Related to #1 2014-03-13 15:06:30 +00:00
			`var container;`

			`beforeEach(function() {`
test(project): replace jasmine with mocha Closes #204 2015-07-15 15:22:19 +00:00			`container = TestContainer.get(this);`
feat(import): import bpmn shapes We are able to import shapes based on BPMNDI. Related to #1 2014-03-13 15:06:30 +00:00			`});`

fix(Viewer): handle and display errors Closes #8 2014-03-21 20:10:01 +00:00
chore(modeler/viewer): clean up module loading + api 2014-06-17 09:19:31 +00:00			`function createModeler(xml, done) {`
			`var modeler = new Modeler({ container: container });`

fix(Viewer): do not cache moddle This may have unwanted side-effects, i.e. when using id validation and caching. We must ensure the meta-model element is actually instance stateless in order to safely cache it. 2015-02-17 11:03:27 +00:00			`modeler.importXML(xml, function(err, warnings) {`
			`done(err, warnings, modeler);`
chore(modeler/viewer): clean up module loading + api 2014-06-17 09:19:31 +00:00			`});`
			`}`
feat(import): import bpmn shapes We are able to import shapes based on BPMNDI. Related to #1 2014-03-13 15:06:30 +00:00
chore(tests): use jasmine-test-container-support for test execution This allows us to have tests nice and easily rendered within test-local containers, including captions, status highlighting and links. 2014-06-18 09:45:30 +00:00
chore(modeler/viewer): clean up module loading + api 2014-06-17 09:19:31 +00:00			`it('should import simple process', function(done) {`
test(project): replace brfs with stringify This _could_ fix the various bundle building issues we are seeing on travis-ci and locally. Closes #234 2015-03-31 12:17:15 +00:00			`var xml = require('../fixtures/bpmn/simple.bpmn');`
chore(modeler/viewer): clean up module loading + api 2014-06-17 09:19:31 +00:00			`createModeler(xml, done);`
			`});`
feat(import): import bpmn shapes We are able to import shapes based on BPMNDI. Related to #1 2014-03-13 15:06:30 +00:00

feat(modeling): add message flow modeling Related to #199 Closes #201 2015-04-16 07:11:04 +00:00			`it('should import collaboration', function(done) {`
			`var xml = require('../fixtures/bpmn/collaboration-message-flows.bpmn');`
			`createModeler(xml, done);`
			`});`


feat(modeling): add lane modeling operations This commit adds the functionality to * add a lane (above/below an existing one) * split a lane into sub lanes * remove a lane * resize a lane Closes #379 Closes #338 2015-10-09 23:40:52 +00:00			`it('should import nested lanes', function(done) {`
			`var xml = require('./features/modeling/lanes/lanes.bpmn');`
			`createModeler(xml, done);`
			`});`


feat(Viewer): indicate empty model through an error Fail import with an error message if the XML does not contain a valid diagram. Closes #417 2015-11-24 11:53:18 +00:00			`it('should not import empty definitions', function(done) {`
test(project): replace brfs with stringify This _could_ fix the various bundle building issues we are seeing on travis-ci and locally. Closes #234 2015-03-31 12:17:15 +00:00			`var xml = require('../fixtures/bpmn/empty-definitions.bpmn');`
feat(Viewer): indicate empty model through an error Fail import with an error message if the XML does not contain a valid diagram. Closes #417 2015-11-24 11:53:18 +00:00
			`// given`
			`createModeler(xml, function(err, warnings, modeler) {`

			`// when`
			`modeler.importXML(xml, function(err, warnings) {`

			`// then`
			`expect(err.message).to.equal('no diagram to display');`

			`done();`
			`});`

			`});`
feat(import): import bpmn shapes We are able to import shapes based on BPMNDI. Related to #1 2014-03-13 15:06:30 +00:00			`});`
test(browser): clean up unused code + keep rendered resources 2014-04-25 11:30:10 +00:00

fix(tests): re-enable all 2015-02-18 12:25:20 +00:00			`it('should re-import simple process', function(done) {`
fix(Viewer): do not cache moddle This may have unwanted side-effects, i.e. when using id validation and caching. We must ensure the meta-model element is actually instance stateless in order to safely cache it. 2015-02-17 11:03:27 +00:00
test(project): replace brfs with stringify This _could_ fix the various bundle building issues we are seeing on travis-ci and locally. Closes #234 2015-03-31 12:17:15 +00:00			`var xml = require('../fixtures/bpmn/simple.bpmn');`
fix(Viewer): do not cache moddle This may have unwanted side-effects, i.e. when using id validation and caching. We must ensure the meta-model element is actually instance stateless in order to safely cache it. 2015-02-17 11:03:27 +00:00
			`// given`
			`createModeler(xml, function(err, warnings, modeler) {`

			`if (err) {`
			`return done(err);`
			`}`

			`// when`
			`// mimic re-import of same diagram`
			`modeler.importXML(xml, function(err, warnings) {`

			`if (err) {`
			`return done(err);`
			`}`

			`// then`
test(project): replace jasmine with mocha Closes #204 2015-07-15 15:22:19 +00:00			`expect(warnings.length).to.equal(0);`
fix(Viewer): do not cache moddle This may have unwanted side-effects, i.e. when using id validation and caching. We must ensure the meta-model element is actually instance stateless in order to safely cache it. 2015-02-17 11:03:27 +00:00
			`done();`
			`});`

			`});`
			`});`


test(Modeler): make sure we can bootstrap without options 2015-05-04 12:57:32 +00:00			`describe('defaults', function() {`

			`it('should use <body> as default parent', function(done) {`

			`var xml = require('../fixtures/bpmn/simple.bpmn');`

			`var modeler = new Modeler();`

			`modeler.importXML(xml, function(err, warnings) {`

test(project): replace jasmine with mocha Closes #204 2015-07-15 15:22:19 +00:00			`expect(modeler.container.parentNode).to.equal(document.body);`
test(Modeler): make sure we can bootstrap without options 2015-05-04 12:57:32 +00:00
			`done(err, warnings);`
			`});`
			`});`

			`});`


test(overlays): add overlay support tests Related to #54 2014-08-05 15:02:03 +00:00			`describe('overlay support', function() {`

			`it('should allow to add overlays', function(done) {`

test(project): replace brfs with stringify This _could_ fix the various bundle building issues we are seeing on travis-ci and locally. Closes #234 2015-03-31 12:17:15 +00:00			`var xml = require('../fixtures/bpmn/simple.bpmn');`
test(overlays): add overlay support tests Related to #54 2014-08-05 15:02:03 +00:00
fix(Viewer): do not cache moddle This may have unwanted side-effects, i.e. when using id validation and caching. We must ensure the meta-model element is actually instance stateless in order to safely cache it. 2015-02-17 11:03:27 +00:00			`createModeler(xml, function(err, warnings, viewer) {`
test(overlays): add overlay support tests Related to #54 2014-08-05 15:02:03 +00:00
test(Modeler): add additional overlay 2014-08-07 20:09:12 +00:00			`// given`
test(overlays): add overlay support tests Related to #54 2014-08-05 15:02:03 +00:00			`var overlays = viewer.get('overlays'),`
			`elementRegistry = viewer.get('elementRegistry');`

test(Modeler): add additional overlay 2014-08-07 20:09:12 +00:00			`// assume`
chore(tests): migrate to (.not).exist matcher Migrate parts of our test suite that rely on legacy `.to.be.(un)defined` matchers to Chai's `.to(.not).exist`. Closes #423 Closes #422 2015-12-01 07:27:45 +00:00			`expect(overlays).to.exist;`
			`expect(elementRegistry).to.exist;`
test(overlays): add overlay support tests Related to #54 2014-08-05 15:02:03 +00:00

			`// when`
test(Modeler): fix overlay expectations 2014-08-12 09:53:38 +00:00			`overlays.add('SubProcess_1', 'badge', {`
test(overlays): add overlay support tests Related to #54 2014-08-05 15:02:03 +00:00			`position: {`
			`bottom: 0,`
			`right: 0`
			`},`
			`html: '<div style="max-width: 50px">YUP GREAT STUFF!</div>'`
			`});`

test(Modeler): fix overlay expectations 2014-08-12 09:53:38 +00:00			`overlays.add('StartEvent_1', 'badge', {`
test(Modeler): add additional overlay 2014-08-07 20:09:12 +00:00			`position: {`
			`top: 0,`
			`left: 0`
			`},`
			`html: '<div style="max-width: 50px">YUP GREAT STUFF!</div>'`
			`});`

test(overlays): add overlay support tests Related to #54 2014-08-05 15:02:03 +00:00			`// then`
test(project): replace jasmine with mocha Closes #204 2015-07-15 15:22:19 +00:00			`expect(overlays.get({ element: 'SubProcess_1', type: 'badge' }).length).to.equal(1);`
			`expect(overlays.get({ element: 'StartEvent_1', type: 'badge' }).length).to.equal(1);`
test(overlays): add overlay support tests Related to #54 2014-08-05 15:02:03 +00:00
			`done(err);`
			`});`

			`});`

			`});`


feat(modeler): add bendpoints It is now possible to add bendpoints to flows or drag bendpoints to update their position / trigger reconnects. Upon bendpoint move a rule is checked to figure out whether or not a bendpoint operation is allowed or not. Closes #123 Closes #138 Closes #139 Closes #165 2015-01-14 17:48:06 +00:00			`describe('bendpoint editing support', function() {`

test(util): add MockEvents util + use in tests * MockEvents provides a simple to use interface for creating events globally or locally to the currently active DiagramJS instance. 2015-08-24 13:31:47 +00:00			`var createEvent = require('../util/MockEvents').createEvent;`

feat(modeler): add bendpoints It is now possible to add bendpoints to flows or drag bendpoints to update their position / trigger reconnects. Upon bendpoint move a rule is checked to figure out whether or not a bendpoint operation is allowed or not. Closes #123 Closes #138 Closes #139 Closes #165 2015-01-14 17:48:06 +00:00
			`it('should allow to edit bendpoints', function(done) {`

test(project): replace brfs with stringify This _could_ fix the various bundle building issues we are seeing on travis-ci and locally. Closes #234 2015-03-31 12:17:15 +00:00			`var xml = require('../fixtures/bpmn/simple.bpmn');`
feat(modeler): add bendpoints It is now possible to add bendpoints to flows or drag bendpoints to update their position / trigger reconnects. Upon bendpoint move a rule is checked to figure out whether or not a bendpoint operation is allowed or not. Closes #123 Closes #138 Closes #139 Closes #165 2015-01-14 17:48:06 +00:00
fix(Viewer): do not cache moddle This may have unwanted side-effects, i.e. when using id validation and caching. We must ensure the meta-model element is actually instance stateless in order to safely cache it. 2015-02-17 11:03:27 +00:00			`createModeler(xml, function(err, warnings, viewer) {`
feat(modeler): add bendpoints It is now possible to add bendpoints to flows or drag bendpoints to update their position / trigger reconnects. Upon bendpoint move a rule is checked to figure out whether or not a bendpoint operation is allowed or not. Closes #123 Closes #138 Closes #139 Closes #165 2015-01-14 17:48:06 +00:00
			`// given`
			`var bendpointMove = viewer.get('bendpointMove'),`
			`dragging = viewer.get('dragging'),`
			`elementRegistry = viewer.get('elementRegistry'),`
test(util): add MockEvents util + use in tests * MockEvents provides a simple to use interface for creating events globally or locally to the currently active DiagramJS instance. 2015-08-24 13:31:47 +00:00			`canvas = viewer.get('canvas');`
feat(modeler): add bendpoints It is now possible to add bendpoints to flows or drag bendpoints to update their position / trigger reconnects. Upon bendpoint move a rule is checked to figure out whether or not a bendpoint operation is allowed or not. Closes #123 Closes #138 Closes #139 Closes #165 2015-01-14 17:48:06 +00:00
			`// assume`
chore(tests): migrate to (.not).exist matcher Migrate parts of our test suite that rely on legacy `.to.be.(un)defined` matchers to Chai's `.to(.not).exist`. Closes #423 Closes #422 2015-12-01 07:27:45 +00:00			`expect(bendpointMove).to.exist;`
feat(modeler): add bendpoints It is now possible to add bendpoints to flows or drag bendpoints to update their position / trigger reconnects. Upon bendpoint move a rule is checked to figure out whether or not a bendpoint operation is allowed or not. Closes #123 Closes #138 Closes #139 Closes #165 2015-01-14 17:48:06 +00:00
			`// when`
test(util): add MockEvents util + use in tests * MockEvents provides a simple to use interface for creating events globally or locally to the currently active DiagramJS instance. 2015-08-24 13:31:47 +00:00			`bendpointMove.start(createEvent(canvas, { x: 0, y: 0 }), elementRegistry.get('SequenceFlow_1'), 1);`
			`dragging.move(createEvent(canvas, { x: 200, y: 200 }));`
feat(modeler): add bendpoints It is now possible to add bendpoints to flows or drag bendpoints to update their position / trigger reconnects. Upon bendpoint move a rule is checked to figure out whether or not a bendpoint operation is allowed or not. Closes #123 Closes #138 Closes #139 Closes #165 2015-01-14 17:48:06 +00:00
			`done(err);`
			`});`

			`});`

			`});`


chore(modeler/viewer): clean up module loading + api 2014-06-17 09:19:31 +00:00			`it('should handle errors', function(done) {`
fix(BpmnTreeWalker): do not fail if no di 2014-03-17 10:11:25 +00:00
chore(modeler/viewer): clean up module loading + api 2014-06-17 09:19:31 +00:00			`var xml = 'invalid stuff';`
fix(BpmnTreeWalker): do not fail if no di 2014-03-17 10:11:25 +00:00
feat(modeler): add createDiagram API Related to #4 2014-06-24 13:50:51 +00:00			`var modeler = new Modeler({ container: container });`
fix(Viewer): handle and display errors Closes #8 2014-03-21 20:10:01 +00:00
feat(modeler): add createDiagram API Related to #4 2014-06-24 13:50:51 +00:00			`modeler.importXML(xml, function(err) {`
feat(bpmn): make available BpmnRegistry in renderer This commit upgrades the code base to the latest diagram-js changes and adds a component called BpmnRegistry that can be used to retrieve a certain BPMN/DI element from a shape/connection id. Related to #19 2014-04-03 09:47:26 +00:00
chore(tests): migrate to (.not).exist matcher Migrate parts of our test suite that rely on legacy `.to.be.(un)defined` matchers to Chai's `.to(.not).exist`. Closes #423 Closes #422 2015-12-01 07:27:45 +00:00			`expect(err).to.exist;`
chore(modeler/viewer): clean up module loading + api 2014-06-17 09:19:31 +00:00
			`done();`
fix(Viewer): handle and display errors Closes #8 2014-03-21 20:10:01 +00:00			`});`
			`});`


feat(modeler): add createDiagram API Related to #4 2014-06-24 13:50:51 +00:00			`it('should create new diagram', function(done) {`
			`var modeler = new Modeler({ container: container });`
revert(Modeling): change back 'createTemplate' to 'createDiagram' 2015-11-11 10:31:58 +00:00			`modeler.createDiagram(done);`
feat(modeler): add createDiagram API Related to #4 2014-06-24 13:50:51 +00:00			`});`


chore(modeler/viewer): clean up module loading + api 2014-06-17 09:19:31 +00:00			`describe('dependency injection', function() {`
fix(Viewer): handle and display errors Closes #8 2014-03-21 20:10:01 +00:00
chore(modeler/viewer): clean up module loading + api 2014-06-17 09:19:31 +00:00			`it('should be available via di as <bpmnjs>', function(done) {`
fix(BpmnTreeWalker): do not fail if no di 2014-03-17 10:11:25 +00:00
test(project): replace brfs with stringify This _could_ fix the various bundle building issues we are seeing on travis-ci and locally. Closes #234 2015-03-31 12:17:15 +00:00			`var xml = require('../fixtures/bpmn/simple.bpmn');`
fix(Viewer): handle and display errors Closes #8 2014-03-21 20:10:01 +00:00
fix(Viewer): do not cache moddle This may have unwanted side-effects, i.e. when using id validation and caching. We must ensure the meta-model element is actually instance stateless in order to safely cache it. 2015-02-17 11:03:27 +00:00			`createModeler(xml, function(err, warnings, modeler) {`
fix(Viewer): handle and display errors Closes #8 2014-03-21 20:10:01 +00:00
test(project): replace jasmine with mocha Closes #204 2015-07-15 15:22:19 +00:00			`expect(modeler.get('bpmnjs')).to.equal(modeler);`
feat(drop): basic implementation This commit adds a basic implementation for model drop * using rules to check whether the drop is allowed * updating the model after drop See #127 2014-10-27 11:07:57 +00:00
chore(modeler/viewer): clean up module loading + api 2014-06-17 09:19:31 +00:00			`done(err);`
			`});`
fix(BpmnTreeWalker): do not fail if no di 2014-03-17 10:11:25 +00:00			`});`
chore(modeler/viewer): clean up module loading + api 2014-06-17 09:19:31 +00:00
fix(BpmnTreeWalker): do not fail if no di 2014-03-17 10:11:25 +00:00			`});`
fix(Viewer): handle and display errors Closes #8 2014-03-21 20:10:01 +00:00
feat(drop): basic implementation This commit adds a basic implementation for model drop * using rules to check whether the drop is allowed * updating the model after drop See #127 2014-10-27 11:07:57 +00:00			`});`