bpmn-js-properties-panel/test/spec/provider/bpmn/ErrorEventDefinitionSpec.js

A simple properties panel for bpmn-js

'use strict';

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

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

/* global bootstrapModeler, inject */

var propertiesPanelModule = require('../../../../lib'),
    domQuery = require('min-dom/lib/query'),
    domClasses = require('min-dom/lib/classes'),
    coreModule = require('bpmn-js/lib/core'),
    selectionModule = require('diagram-js/lib/features/selection'),
    modelingModule = require('bpmn-js/lib/features/modeling'),
    propertiesProviderModule = require('../../../../lib/provider/bpmn'),
    getBusinessObject = require('bpmn-js/lib/util/ModelUtil').getBusinessObject,
    find = require('lodash/collection/find'),
    eventDefinitionHelper = require('../../../../lib/helper/EventDefinitionHelper');

function getGeneralTab(container) {
  return domQuery('div[data-tab="general"]', container);
}

function getDetailsGroup(container) {
  var tab = getGeneralTab(container);
  return domQuery('div[data-group="details"]', tab);
}

function getEntry(container, entryId) {
  return domQuery('div[data-entry="' + entryId + '"]', getDetailsGroup(container));
}

function getInputField(container, entryId, inputName) {
  var selector = 'input' + (inputName ? '[name="' + inputName + '"]' : '');
  return domQuery(selector, getEntry(container, entryId));
}

function getSelectField(container, entryId, selectName) {
  var selector = 'select' + (selectName ? '[name="' + selectName + '"]' : '');
  return domQuery(selector, getEntry(container, entryId));
}

function getErrorDefinitionsField(container) {
  return getSelectField(container, 'event-definitions-error', 'selectedElement');
}

function selectErrorDefinition(id, container) {
  var selectBox = getErrorDefinitionsField(container);
  var option = find(selectBox.options, function(o) {
    return o.value === id;
  });
  option.selected  = 'selected';
  TestHelper.triggerEvent(selectBox, 'change');
}

function getErrorNameField(container) {
  return getInputField(container, 'error-element-name', 'name');
}

function getErrorCodeField(container) {
  return getInputField(container, 'error-element-code', 'errorCode');
}

function getErrorCodeVariableField(container) {
  return getInputField(container, 'errorCodeVariable', 'errorCodeVariable');
}

function getErrorMessageVariableField(container) {
  return getInputField(container, 'errorMessageVariable', 'errorMessageVariable');
}

function getClearButton(container, selector) {
  return domQuery('div[data-entry=' + selector + '] button[data-action=clear]', container);
}

function getCreateButton(container, selector) {
  return domQuery('div[data-entry=' + selector + '] button[data-action=addElement]', container);
}

function isHidden(node) {
  return domClasses(node).has('bpp-hidden');
}

function isInputHidden(node) {
  return isHidden(node.parentNode);
}

describe('error-event-properties', function() {

  var diagramXML = require('./ErrorEventDefinition.bpmn');

  var testModules = [
    coreModule, selectionModule, modelingModule,
    propertiesPanelModule,
    propertiesProviderModule
  ];

  var container;

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

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


  beforeEach(inject(function(commandStack, propertiesPanel) {

    var undoButton = document.createElement('button');
    undoButton.textContent = 'UNDO';

    undoButton.addEventListener('click', function() {
      commandStack.undo();
    });

    container.appendChild(undoButton);

    propertiesPanel.attachTo(container);
  }));


  describe('get', function() {

    var container, errorEventDefinition;

    beforeEach(inject(function(elementRegistry, propertiesPanel, selection) {

      // given
      container = propertiesPanel._container;

      var shape = elementRegistry.get('ErrorBoundaryEvent_All');
      selection.select(shape);

      var bo = getBusinessObject(shape);
      errorEventDefinition = eventDefinitionHelper.getErrorEventDefinition(bo);

    }));


    it('should fetch the errorRef of an error event', function() {

      var field = getErrorDefinitionsField(container);

      expect(field.value).to.equal(errorEventDefinition.errorRef.id);

    });


    it('should fetch the errorName of an error event', function() {

      var field = getErrorNameField(container);

      expect(field.value).to.equal(errorEventDefinition.errorRef.name);

    });


    it('should fetch the errorCode of an error event', function() {

      var field = getErrorCodeField(container);

      expect(field.value).to.equal(errorEventDefinition.errorRef.errorCode);

    });


    it('should fetch the errorCodeVariable of an error event', function() {

      var field = getErrorCodeVariableField(container);

      expect(field.value).to.equal(errorEventDefinition.get('camunda:errorCodeVariable'));

    });


    it('should fetch the errorMessageVariable of an error event', function() {

      var field = getErrorMessageVariableField(container);

      expect(field.value).to.equal(errorEventDefinition.get('camunda:errorMessageVariable'));

    });

  });


  describe('set', function() {

    describe('should set the errorName for an error event', function() {

      var errorEventDefinition, field;

      beforeEach(inject(function(elementRegistry, selection, propertiesPanel) {

        // given
        var item = elementRegistry.get('ErrorEndEvent_ErrorCode');
        selection.select(item);

        var bo = item.businessObject;
        errorEventDefinition = eventDefinitionHelper.getErrorEventDefinition(bo);

        field = getErrorNameField(container);

        // when
        TestHelper.triggerValue(field, 'FOO', 'change');

      }));

      describe('in the DOM', function() {

        it('should execute', function() {
          expect(field.value).to.equal('FOO');
        });

        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(field.value).to.equal('b');
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(field.value).to.equal('FOO');
        }));

      });

      describe('on the business object', function() {

        it('should execute', function() {
          expect(errorEventDefinition.errorRef.name).to.equal('FOO');
        });

        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(errorEventDefinition.errorRef.name).to.equal('b');
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(errorEventDefinition.errorRef.name).to.equal('FOO');
        }));

      });

    });


    describe('should set the errorCode for an error event', function() {

      var errorEventDefinition, field;

      beforeEach(inject(function(elementRegistry, selection, propertiesPanel) {

        // given
        var item = elementRegistry.get('ErrorEndEvent_ErrorCode');
        selection.select(item);

        var bo = item.businessObject;
        errorEventDefinition = eventDefinitionHelper.getErrorEventDefinition(bo);

        field = getErrorCodeField(container);

        // when
        TestHelper.triggerValue(field, '', 'change');

      }));

      describe('in the DOM', function() {

        it('should execute', function() {
          expect(field.value).to.equal('');
        });

        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(field.value).to.equal('foo');
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(field.value).to.equal('');
        }));

      });

      describe('on the business object', function() {

        it('should execute', function() {
          expect(errorEventDefinition.errorRef.errorCode).to.be.undefined;
        });

        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(errorEventDefinition.errorRef.errorCode).to.equal('foo');
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(errorEventDefinition.errorRef.errorCode).to.be.undefined;
        }));

      });

    });


    describe('should set the errorCodeVariable for an error event', function() {

      var errorEventDefinition, field;

      beforeEach(inject(function(elementRegistry, selection, propertiesPanel) {

        // given
        var item = elementRegistry.get('ErrorStartEvent_Empty');
        selection.select(item);

        var bo = item.businessObject;
        errorEventDefinition = eventDefinitionHelper.getErrorEventDefinition(bo);

        field = getErrorCodeVariableField(container);

        // when
        TestHelper.triggerValue(field, 'FOO', 'change');

      }));

      describe('in the DOM', function() {

        it('should execute', function() {
          expect(field.value).to.equal('FOO');
        });

        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(field.value).to.equal('');
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(field.value).to.equal('FOO');
        }));

      });

      describe('on the business object', function() {

        it('should execute', function() {
          expect(errorEventDefinition.get('camunda:errorCodeVariable')).to.equal('FOO');
        });

        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(errorEventDefinition.get('camunda:errorCodeVariable')).to.be.undefined;
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(errorEventDefinition.get('camunda:errorCodeVariable')).to.equal('FOO');
        }));

      });

    });


    describe('should set the errorMessageVariable for an error event', function() {

      var errorEventDefinition, field;

      beforeEach(inject(function(elementRegistry, selection, propertiesPanel) {

        // given
        var item = elementRegistry.get('ErrorStartEvent_Empty');
        selection.select(item);

        var bo = item.businessObject;
        errorEventDefinition = eventDefinitionHelper.getErrorEventDefinition(bo);

        field = getErrorMessageVariableField(container);

        // when
        TestHelper.triggerValue(field, 'FOO', 'change');

      }));

      describe('in the DOM', function() {

        it('should execute', function() {
          expect(field.value).to.equal('FOO');
        });

        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(field.value).to.equal('');
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(field.value).to.equal('FOO');
        }));

      });

      describe('on the business object', function() {

        it('should execute', function() {
          expect(errorEventDefinition.get('camunda:errorMessageVariable')).to.equal('FOO');
        });

        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(errorEventDefinition.get('camunda:errorMessageVariable')).to.be.undefined;
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(errorEventDefinition.get('camunda:errorMessageVariable')).to.equal('FOO');
        }));

      });

    });


  });


  describe('change error reference', function() {

    var container, errorEventDefinition;

    beforeEach(inject(function(elementRegistry, propertiesPanel, selection) {

      // given
      container = propertiesPanel._container;

      var shape = elementRegistry.get('WITH_ERROR_REF');
      selection.select(shape);

      var bo = getBusinessObject(shape);
      errorEventDefinition = eventDefinitionHelper.getErrorEventDefinition(bo);
    }));


    describe('to another error element', function() {

      var select;

      beforeEach(function() {
        select = getErrorDefinitionsField(container);

        // when
        selectErrorDefinition('Error_2', container);
      });


      describe('in the DOM', function() {

        it('should execute', function() {
          // then
          expect(select.value).to.equal('Error_2');

          expect(isInputHidden(getErrorNameField(container))).to.be.false;
          expect(isInputHidden(getErrorCodeField(container))).to.be.false;
        });


        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(select.value).to.equal('Error_4');

          expect(isInputHidden(getErrorNameField(container))).to.be.false;
          expect(isInputHidden(getErrorCodeField(container))).to.be.false;
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(select.value).to.equal('Error_2');

          expect(isInputHidden(getErrorNameField(container))).to.be.false;
          expect(isInputHidden(getErrorCodeField(container))).to.be.false;
        }));

      });


      describe('on the business object', function() {

        it('should execute', function() {
          // then
          expect(errorEventDefinition.errorRef).to.be.ok;
          expect(errorEventDefinition.errorRef.id).to.equal('Error_2');
        });


        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(errorEventDefinition.errorRef).to.be.ok;
          expect(errorEventDefinition.errorRef.id).to.equal('Error_4');
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(errorEventDefinition.errorRef).to.be.ok;
          expect(errorEventDefinition.errorRef.id).to.equal('Error_2');
        }));

      });

    });


    describe('to undefined', function() {

      var select;

      beforeEach(function() {
        select = getErrorDefinitionsField(container);

        // when
        selectErrorDefinition('', container);
      });

      describe('in the DOM', function() {

        it('should execute', function() {
          // then
          expect(select.value).to.equal('');

          expect(isInputHidden(getErrorNameField(container))).to.be.true;
          expect(isInputHidden(getErrorCodeField(container))).to.be.true;
        });


        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(select.value).to.equal('Error_4');

          expect(isInputHidden(getErrorNameField(container))).to.be.false;
          expect(isInputHidden(getErrorCodeField(container))).to.be.false;
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(select.value).to.equal('');

          expect(isInputHidden(getErrorNameField(container))).to.be.true;
          expect(isInputHidden(getErrorCodeField(container))).to.be.true;
        }));

      });


      describe('on the business object', function() {

        it('should execute', function() {
          // then
          expect(errorEventDefinition.errorRef).not.to.be.ok;
        });


        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(errorEventDefinition.errorRef).to.be.ok;
          expect(errorEventDefinition.errorRef.id).to.equal('Error_4');
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(errorEventDefinition.errorRef).not.to.be.ok;
        }));

      });

    });

  });


  describe('validation', function() {

    var container;

    beforeEach(inject(function(elementRegistry, propertiesPanel, selection) {

      // given
      container = propertiesPanel._container;

      var shape = elementRegistry.get('ErrorEndEvent_Invalid');
      selection.select(shape);

    }));

    it('should be shown if error name is empty', function() {

      var field = getErrorNameField(container);

      expect(domClasses(field).has('invalid')).to.be.true;

    });
  });


  describe('remove', function() {

    var container, errorEventDefinition;

    beforeEach(inject(function(elementRegistry, propertiesPanel, selection) {

      // given
      container = propertiesPanel._container;

      var shape = elementRegistry.get('ErrorBoundaryEvent_All');
      selection.select(shape);

      var bo = getBusinessObject(shape);
      errorEventDefinition = eventDefinitionHelper.getErrorEventDefinition(bo);

    }));

    describe('#errorCode', function() {

      var field, button;

      beforeEach(function() {

        field = getErrorCodeField(container);
        button = getClearButton(container, 'error-element-code');

        TestHelper.triggerEvent(button, 'click');

      });

      describe('in the DOM', function() {

        it('should execute', function() {
          expect(field.value).is.empty;
        });

        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(field.value).to.equal('foo');
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(field.value).is.empty;
        }));

      });

      describe('on the business object', function() {

        it('should execute', function() {
          expect(errorEventDefinition.errorRef.errorCode).to.be.undefined;
        });

        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(errorEventDefinition.errorRef.errorCode).to.equal('foo');
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(errorEventDefinition.errorRef.errorCode).to.be.undefined;
        }));

      });

    });

    describe('#errorCodeVariable', function() {

      var field, button;

      beforeEach(function() {

        field = getErrorCodeVariableField(container);
        button = getClearButton(container, 'errorCodeVariable');

        TestHelper.triggerEvent(button, 'click');

      });

      describe('in the DOM', function() {

        it('should execute', function() {
          expect(field.value).is.empty;
        });

        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(field.value).to.equal('myErrorCodeVariable');
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(field.value).is.empty;
        }));

      });

      describe('on the business object', function() {

        it('should execute', function() {
          expect(errorEventDefinition.get('camunda:errorCodeVariable')).to.be.undefined;
        });

        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(errorEventDefinition.get('camunda:errorCodeVariable')).to.equal('myErrorCodeVariable');
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(errorEventDefinition.get('camunda:errorCodeVariable')).to.be.undefined;
        }));

      });

    });


    describe('#errorMessageVariable', function() {

      var field, button;

      beforeEach(function() {

        field = getErrorMessageVariableField(container);
        button = getClearButton(container, 'errorMessageVariable');

        TestHelper.triggerEvent(button, 'click');

      });

      describe('in the DOM', function() {

        it('should execute', function() {
          expect(field.value).is.empty;
        });

        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(field.value).to.equal('myErrorMessageVariable');
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(field.value).is.empty;
        }));

      });

      describe('on the business object', function() {

        it('should execute', function() {
          expect(errorEventDefinition.get('camunda:errorMessageVariable')).to.be.undefined;
        });

        it('should undo', inject(function(commandStack) {
          // when
          commandStack.undo();

          // then
          expect(errorEventDefinition.get('camunda:errorMessageVariable')).to.equal('myErrorMessageVariable');
        }));


        it('should redo', inject(function(commandStack) {
          // when
          commandStack.undo();
          commandStack.redo();

          // then
          expect(errorEventDefinition.get('camunda:errorMessageVariable')).to.be.undefined;
        }));

      });

    });

  });


  describe('control visibility', function() {

    function expectVisible(elementId, visible, getter) {

      return inject(function(propertiesPanel, selection, elementRegistry) {

        // given
        var element = elementRegistry.get(elementId);

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

        // when
        selection.select(element);
        var field = getter(propertiesPanel._container);

        // then
        if (visible) {
          expect(field).to.exist;
        } else {
          expect(field).not.to.exist;
        }
      });
    }


    describe('should show', function() {

      it('StartEvent_ErrorCodeVariable', expectVisible('ErrorStartEvent_Empty', true, getErrorCodeVariableField));
      it('StartEvent_ErrorMessageVariable', expectVisible('ErrorStartEvent_Empty', true, getErrorMessageVariableField));

      it('BoundaryEvent_ErrorCodeVariable', expectVisible('ErrorBoundaryEvent_All', true, getErrorCodeVariableField));
      it('BoundaryEvent_ErrorMessageVariable', expectVisible('ErrorBoundaryEvent_All', true, getErrorMessageVariableField));

    });


    describe('should hide', function() {

      it('EndEvent_ErrorCodeVariable', expectVisible('ErrorEndEvent_ErrorCode', false, getErrorCodeVariableField));
      it('EndEvent_ErrorMessageVariable', expectVisible('ErrorEndEvent_ErrorCode', false, getErrorMessageVariableField));

    });

  });


  describe('create new error', function() {

    var errorEventDefinition, field;

    beforeEach(inject(function(elementRegistry, selection, propertiesPanel) {

      // given
      var item = elementRegistry.get('ErrorStartEvent_Empty');
      selection.select(item);

      var bo = item.businessObject;
      errorEventDefinition = eventDefinitionHelper.getErrorEventDefinition(bo);

      var button = getCreateButton(container, 'event-definitions-error');
      field = getErrorDefinitionsField(container);

      // when
      TestHelper.triggerEvent(button, 'click');

    }));

    describe('in the DOM', function() {

      it('should execute', function() {
        expect(field).to.have.length.of(6);
        expect(field.value).not.to.equal('');
      });

      it('should undo', inject(function(commandStack) {
        // when
        commandStack.undo();

        // then
        expect(field).to.have.length.of(5);
        expect(field.value).to.equal('');
      }));


      it('should redo', inject(function(commandStack) {
        // when
        commandStack.undo();
        commandStack.redo();

        // then
        expect(field).to.have.length.of(6);
        expect(field.value).not.to.equal('');
      }));

    });

    describe('on the business object', function() {

      it('should execute', function() {
        expect(errorEventDefinition.errorRef.name).to.be.defined;
      });

      it('should undo', inject(function(commandStack) {
        // when
        commandStack.undo();

        // then
        expect(errorEventDefinition.errorRef).to.be.undefined;
      }));


      it('should redo', inject(function(commandStack) {
        // when
        commandStack.undo();
        commandStack.redo();

        // then
        expect(errorEventDefinition.errorRef.name).to.be.defined;
      }));

    });

  });


});