bpmn-js/test/spec/features/rules/ModelingRulesSpec.js

'use strict';

var Matchers = require('../../../Matchers');

/* global bootstrapModeler, inject */

var fs = require('fs');

var modelingModule = require('../../../../lib/features/modeling'),
    rulesModule = require('../../../../lib/features/modeling/rules'),
    coreModule = require('../../../../lib/core');


describe('features/ModelingRules', function() {

  beforeEach(Matchers.addDeepEquals);


  var sequenceXML = fs.readFileSync('test/fixtures/bpmn/sequence-flows.bpmn', 'utf8');
  var eventGatewaysEdgeXML =
      fs.readFileSync('test/fixtures/bpmn/features/rules/event-based-gateway-outgoing-edge.bpmn', 'utf8');
  var linkEventXML = fs.readFileSync('test/fixtures/bpmn/features/rules/link-event.bpmn', 'utf8');
  var textAnnotationXML = fs.readFileSync('test/fixtures/bpmn/features/rules/text-annotation-association.bpmn', 'utf8');

  var testModules = [ coreModule, modelingModule, rulesModule ];


  // See workaround https://github.com/bpmn-io/bpmn-js/issues/176
  // The wanted behavior until https://github.com/bpmn-io/bpmn-js/issues/176 is fixed
  describe('connect with source == target', function() {

    beforeEach(bootstrapModeler(sequenceXML, { modules: testModules }));

    it('should not allow connection', inject(function(elementRegistry, modeling, rules) {

      // given
      var taskShape = elementRegistry.get('Task_1');

      // when
      var allowed = rules.allowed('connection.create', {
        connection: null,
        source: taskShape,
        target: taskShape
      });

      // then
      // connection should not be allowed
      expect(allowed).toBe(false);
    }));
  });

  describe('eventbased gateway', function() {

    beforeEach(bootstrapModeler(eventGatewaysEdgeXML, { modules: testModules }));

    it('should allow catching message intermediate event on outgoing edges', inject(function(elementRegistry, modeling, rules) {

      // given
      var eventGateway = elementRegistry.get('EventBasedGateway_1'),
          messageEvent = elementRegistry.get('IntermediateCatchEvent_0');


      // when
      var allowed = rules.allowed('connection.create', {
        connection: null,
        source: eventGateway,
        target: messageEvent
      });

      // then
      // connection should not be allowed
      expect(allowed).toBe(true);
    }));

    it('should allow catching timer intermediate event on outgoing edges', inject(function(elementRegistry, modeling, rules) {

      // given
      var eventGateway = elementRegistry.get('EventBasedGateway_1'),
          timerEvent = elementRegistry.get('IntermediateCatchEvent_1');


      // when
      var allowed = rules.allowed('connection.create', {
        connection: null,
        source: eventGateway,
        target: timerEvent
      });

      // then
      // connection should not be allowed
      expect(allowed).toBe(true);
    }));

    it('should allow catching condition intermediate event on outgoing edges', inject(function(elementRegistry, modeling, rules) {

      // given
      var eventGateway = elementRegistry.get('EventBasedGateway_1'),
          conditionEvent = elementRegistry.get('IntermediateCatchEvent_2');


      // when
      var allowed = rules.allowed('connection.create', {
        connection: null,
        source: eventGateway,
        target: conditionEvent
      });

      // then
      // connection should not be allowed
      expect(allowed).toBe(true);
    }));

    it('should allow catching signal intermediate event on outgoing edges', inject(function(elementRegistry, modeling, rules) {

      // given
      var eventGateway = elementRegistry.get('EventBasedGateway_1'),
          signalEvent = elementRegistry.get('IntermediateCatchEvent_3');


      // when
      var allowed = rules.allowed('connection.create', {
        connection: null,
        source: eventGateway,
        target: signalEvent
      });

      // then
      // connection should not be allowed
      expect(allowed).toBe(true);
    }));

    it('should allow receive task on outgoing edges', inject(function(elementRegistry, modeling, rules) {

      // given
      var eventGateway = elementRegistry.get('EventBasedGateway_1'),
          receiveTask = elementRegistry.get('ReceiveTask_1');


      // when
      var allowed = rules.allowed('connection.create', {
        connection: null,
        source: eventGateway,
        target: receiveTask
      });

      // then
      // connection should not be allowed
      expect(allowed).toBe(true);
    }));

    it('should not allow throw event on outgoing edges', inject(function(elementRegistry, modeling, rules) {

      // given
      var eventGateway = elementRegistry.get('EventBasedGateway_1'),
          throwEvent = elementRegistry.get('IntermediateThrowEvent_0');


      // when
      var allowed = rules.allowed('connection.create', {
        connection: null,
        source: eventGateway,
        target: throwEvent
      });

      // then
      // connection should not be allowed
      expect(allowed).toBe(false);
    }));

    it('should not allow task on outgoing edges', inject(function(elementRegistry, modeling, rules) {

      // given
      var eventGateway = elementRegistry.get('EventBasedGateway_1'),
          task = elementRegistry.get('Task_1');


      // when
      var allowed = rules.allowed('connection.create', {
        connection: null,
        source: eventGateway,
        target: task
      });

      // then
      // connection should not be allowed
      expect(allowed).toBe(false);
    }));

  });



  describe('catch link events', function() {

    beforeEach(bootstrapModeler(linkEventXML, { modules: testModules }));

    it('should not have incoming sequence flows ', inject(function(elementRegistry, modeling, rules) {

      // given
      var catchEvent   = elementRegistry.get('IntermediateCatchEvent'),
          incomingTask = elementRegistry.get('Task_incoming');


      // when
      var allowed = rules.allowed('connection.create', {
        connection: null,
        source: incomingTask,
        target: catchEvent
      });

      // then
      // connection should not be allowed
      expect(allowed).toBe(false);
    }));

    it('should be allowed to have outgoing sequence flows ', inject(function(elementRegistry, modeling, rules) {

      // given
      var catchEvent   = elementRegistry.get('IntermediateCatchEvent'),
          outgoingTask = elementRegistry.get('Task_outgoing');

      // when
      var allowed = rules.allowed('connection.create', {
        connection: null,
        source: catchEvent,
        target: outgoingTask
      });

      // then
      // connection should not be allowed
      expect(allowed).toBe(true);
    }));
  });



  describe('throwing link events', function() {

    beforeEach(bootstrapModeler(linkEventXML, { modules: testModules }));

    it('should not have outgoing sequence flows ', inject(function(elementRegistry, modeling, rules) {

      // given
      var catchEvent   = elementRegistry.get('IntermediateThrowEvent'),
          outgoingTask = elementRegistry.get('Task_outgoing');


      // when
      var allowed = rules.allowed('connection.create', {
        connection: null,
        source: catchEvent,
        target: outgoingTask
      });

      // then
      // connection should not be allowed
      expect(allowed).toBe(false);
    }));

    it('should be allowed to have incoming sequence flows ', inject(function(elementRegistry, modeling, rules) {

      // given
      var catchEvent   = elementRegistry.get('IntermediateThrowEvent'),
          incomingTask = elementRegistry.get('Task_incoming');


      // when
      var allowed = rules.allowed('connection.create', {
        connection: null,
        source: incomingTask,
        target: catchEvent
      });

      // then
      // connection should not be allowed
      expect(allowed).toBe(true);
    }));
  });

  describe('Association', function() {

    beforeEach(bootstrapModeler(textAnnotationXML, { modules: testModules }));

    it('should allow drop on process', inject(function(elementRegistry, rules) {

      // given
      var association = elementRegistry.get('Association_1'),
          parent = elementRegistry.get('Process_1');

      // when
      var allowed = rules.allowed('shapes.move', {
        connection: null,
        shapes: [ association ],
        newParent: parent
      });

      // then
      expect(allowed).toBe(true);
    }));
  });
});