bpmnlint-plugin-camunda-compat 0.6.3 → 0.8.0

package/CHANGELOG.md

@@ -6,9 +6,26 @@ All notable changes to [bpmnlint-plugin-camunda-compat](https://github.com/camun
 
 ___Note:__ Yet to be released changes appear here._
 
-## 0.6.3
+## 0.8.0
 
-* `FIX`: backport of ([#34](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/34)) to v0.6
+* `FEAT`: add templates rule ([#31](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/31))
+
+## 0.7.1
+
+* `FIX`: lint subscription only if start event child of sub process ([#34](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/34))
+
+## 0.7.0
+
+* `FEAT`: refactor plugin structure ([#29](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/29))
+* `DEPS`: update to `bpmnlint@7.8.0` ([#29](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/29))
+
+### Breaking Changes
+
+* configuration not selected based on execution platform and version anymore, either configure manually or use [`@camunda/linting`](https://github.com/camunda/linting)
+* error message not adjusted to be shown in Camunda Modeler anymore
+* error type ELEMENT_TYPE changed to ELEMENT_TYPE_NOT_ALLOWED
+* error type PROPERTY_TYPE changed to PROPERTY_TYPE_NOT_ALLOWED
+* error data changed (cf. docs/ERRORS.md)
 
 ## 0.6.2
 

package/README.md

@@ -2,25 +2,24 @@
 
 [![CI](https://github.com/camunda/bpmnlint-plugin-camunda-compat/workflows/CI/badge.svg)](https://github.com/camunda/bpmnlint-plugin-camunda-compat/actions?query=workflow%3ACI)
 
-Camunda BPMN compatibility, packed as a [bpmnlint](https://github.com/bpmn-io/bpmnlint) plug-in.
+Camunda BPMN compatibility provided as a [bpmnlint](https://github.com/bpmn-io/bpmnlint) plug-in.
 
 
 ## Usage
 
-Add the plug-in via your `.bpmnlintrc` file:
+To configure the linter dynamically based on the [execution platform and version](https://github.com/camunda/modeler-moddle), use [`@camunda/linting`](https://github.com/camunda/linting).
+
+To configure the linter statically, add the configuration corresponding to your execution platform and version to your `.bpmnlintrc` file:
 
 ```
 {
   "extends": [
     "bpmnlint:recommended",
-    "plugin:camunda-compat/recommended"
+    "plugin:camunda-compat/camunda-cloud-8-0"
   ]
 }
 ```
 
-To validate a diagram it must be pinned to a particular execution platform via the [`modeler`](https://github.com/camunda/modeler-moddle) BPMN 2.0 extension.
-
-
 ## Resources
 
 * [Issues](https://github.com/camunda/bpmnlint-plugin-camunda-compat/issues)

package/index.js

@@ -1,43 +1,65 @@
+const calledDecisionOrTaskDefinitionConfig = require('./rules/called-decision-or-task-definition/config'),
+      elementTypeConfig = require('./rules/element-type/config');
+
 module.exports = {
   configs: {
-    all: {
+    'camunda-cloud-1-0': {
       rules: {
-        'camunda-cloud-1-0': 'error',
-        'camunda-cloud-1-1': 'error',
-        'camunda-cloud-1-2': 'error',
-        'camunda-cloud-1-3': 'error',
-        'camunda-cloud-8-0': 'error',
-        'camunda-platform-7-15': 'error',
-        'camunda-platform-7-16': 'error',
-        'camunda-platform-7-17': 'error'
+        'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud10 ],
+        'called-element': 'error',
+        'element-type': [ 'error', elementTypeConfig.camundaCloud10 ],
+        'error-reference': 'error',
+        'loop-characteristics': 'error',
+        'message-reference': 'error',
+        'no-template': 'error',
+        'subscription': 'error'
       }
     },
-    recommended: {
+    'camunda-cloud-1-1': {
       rules: {
-        'camunda-cloud-1-0': 'error',
-        'camunda-cloud-1-1': 'error',
-        'camunda-cloud-1-2': 'error',
-        'camunda-cloud-1-3': 'error',
-        'camunda-cloud-8-0': 'error',
-        'camunda-platform-7-15': 'error',
-        'camunda-platform-7-16': 'error',
-        'camunda-platform-7-17': 'error'
+        'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud11 ],
+        'called-element': 'error',
+        'element-type': [ 'error', elementTypeConfig.camundaCloud11 ],
+        'error-reference': 'error',
+        'loop-characteristics': 'error',
+        'message-reference': 'error',
+        'no-template': 'error',
+        'subscription': 'error'
       }
     },
-    cloud: {
+    'camunda-cloud-1-2': {
       rules: {
-        'camunda-cloud-1-0': 'error',
-        'camunda-cloud-1-1': 'error',
-        'camunda-cloud-1-2': 'error',
-        'camunda-cloud-1-3': 'error',
-        'camunda-cloud-8-0': 'error'
+        'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud12 ],
+        'called-element': 'error',
+        'element-type': [ 'error', elementTypeConfig.camundaCloud12 ],
+        'error-reference': 'error',
+        'loop-characteristics': 'error',
+        'message-reference': 'error',
+        'no-template': 'error',
+        'subscription': 'error'
       }
     },
-    platform: {
+    'camunda-cloud-1-3': {
       rules: {
-        'camunda-platform-7-15': 'error',
-        'camunda-platform-7-16': 'error',
-        'camunda-platform-7-17': 'error'
+        'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud13 ],
+        'called-element': 'error',
+        'element-type': [ 'error', elementTypeConfig.camundaCloud12 ],
+        'error-reference': 'error',
+        'loop-characteristics': 'error',
+        'message-reference': 'error',
+        'no-template': 'error',
+        'subscription': 'error'
+      }
+    },
+    'camunda-cloud-8-0': {
+      rules: {
+        'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud13 ],
+        'called-element': 'error',
+        'element-type': [ 'error', elementTypeConfig.camundaCloud12 ],
+        'error-reference': 'error',
+        'loop-characteristics': 'error',
+        'message-reference': 'error',
+        'subscription': 'error'
       }
     }
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bpmnlint-plugin-camunda-compat",
-  "version": "0.6.3",
-  "description": "A bpmnlint plug-in for Camunda Cloud and Platform compatibility",
+  "version": "0.8.0",
+  "description": "A bpmnlint plug-in for Camunda Platform compatibility",
   "main": "index.js",
   "scripts": {
     "all": "npm run lint && npm test",
@@ -24,8 +24,7 @@
   "license": "MIT",
   "devDependencies": {
     "bpmn-moddle": "^7.1.2",
-    "bpmnlint": "^7.6.0",
-    "camunda-bpmn-moddle": "^6.1.1",
+    "bpmnlint": "^7.8.0",
     "chai": "^4.3.5",
     "eslint": "^7.32.0",
     "eslint-plugin-bpmn-io": "^0.13.0",
@@ -33,7 +32,7 @@
     "modeler-moddle": "^0.1.0",
     "sinon": "^13.0.1",
     "sinon-chai": "^3.7.0",
-    "zeebe-bpmn-moddle": "^0.10.0"
+    "zeebe-bpmn-moddle": "^0.12.1"
   },
   "dependencies": {
     "@philippfromme/moddle-helpers": "^0.1.0",

package/rules/called-decision-or-task-definition/config.js

@@ -0,0 +1,36 @@
+module.exports = {
+  camundaCloud10: {
+    elementsTaskDefinition: [
+      'bpmn:ServiceTask'
+    ]
+  },
+  camundaCloud11: {
+    elementsTaskDefinition: [
+      'bpmn:BusinessRuleTask',
+      'bpmn:ServiceTask',
+      'bpmn:ScriptTask',
+      'bpmn:SendTask'
+    ]
+  },
+  camundaCloud12: {
+    elementsTaskDefinition: [
+      'bpmn:BusinessRuleTask',
+      'bpmn:IntermediateThrowEvent',
+      'bpmn:ServiceTask',
+      'bpmn:ScriptTask',
+      'bpmn:SendTask'
+    ]
+  },
+  camundaCloud13: {
+    elementsCalledDecision: [
+      'bpmn:BusinessRuleTask'
+    ],
+    elementsTaskDefinition: [
+      'bpmn:BusinessRuleTask',
+      'bpmn:IntermediateThrowEvent',
+      'bpmn:ServiceTask',
+      'bpmn:ScriptTask',
+      'bpmn:SendTask'
+    ]
+  }
+};

package/rules/called-decision-or-task-definition/index.js

@@ -0,0 +1,122 @@
+const {
+  is,
+  isAny
+} = require('bpmnlint-utils');
+
+const { getPath } = require('@philippfromme/moddle-helpers');
+
+const {
+  findExtensionElement,
+  getEventDefinition,
+  hasProperties,
+  hasExtensionElementOfType,
+  hasExtensionElementsOfTypes
+} = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { ERROR_TYPES } = require('../utils/error-types');
+
+module.exports = function(config) {
+  const {
+    elementsCalledDecision = [],
+    elementsTaskDefinition = []
+  } = config;
+
+  function check(node, reporter) {
+    if (!isAny(node, elementsCalledDecision) && !isAny(node, elementsTaskDefinition)) {
+      return;
+    }
+
+    if (is(node, 'bpmn:ThrowEvent') && !getEventDefinition(node)) {
+      return;
+    }
+
+    let errors;
+
+    const calledDecision = findExtensionElement(node, 'zeebe:CalledDecision'),
+          taskDefinition = findExtensionElement(node, 'zeebe:TaskDefinition');
+
+    if (calledDecision && !taskDefinition) {
+
+      if (!isAny(node, elementsCalledDecision)) {
+        reportErrors(node, reporter, {
+          message: 'Extension element of type <zeebe:CalledDecision> not allowed',
+          path: getPath(calledDecision, node),
+          error: {
+            type: ERROR_TYPES.EXTENSION_ELEMENT_NOT_ALLOWED,
+            node,
+            parentNode: null,
+            extensionElement: calledDecision
+          }
+        });
+
+        return;
+      }
+
+      errors = hasProperties(calledDecision, {
+        decisionId: {
+          required: true
+        },
+        resultVariable: {
+          required: true
+        }
+      }, node);
+
+      if (errors && errors.length) {
+        reportErrors(node, reporter, errors);
+
+        return;
+      }
+    }
+
+    if (!calledDecision && taskDefinition) {
+
+      if (!isAny(node, elementsTaskDefinition)) {
+        reportErrors(node, reporter, {
+          message: 'Extension element of type <zeebe:TaskDefinition> not allowed',
+          path: getPath(taskDefinition, node),
+          error: {
+            type: ERROR_TYPES.EXTENSION_ELEMENT_NOT_ALLOWED,
+            node,
+            parentNode: null,
+            extensionElement: taskDefinition
+          }
+        });
+
+        return;
+      }
+
+      errors = hasProperties(taskDefinition, {
+        type: {
+          required: true
+        }
+      }, node);
+
+      if (errors && errors.length) {
+        reportErrors(node, reporter, errors);
+      }
+    }
+
+    if (isAny(node, elementsCalledDecision) && isAny(node, elementsTaskDefinition)) {
+      errors = hasExtensionElementsOfTypes(node, [
+        'zeebe:CalledDecision',
+        'zeebe:TaskDefinition'
+      ], node, true);
+    } else if (isAny(node, elementsCalledDecision)) {
+      errors = hasExtensionElementOfType(node, 'zeebe:CalledDecision', node);
+    } else {
+      errors = hasExtensionElementOfType(node, 'zeebe:TaskDefinition', node);
+    }
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+
+      return;
+    }
+  }
+
+  return {
+    check
+  };
+};

package/rules/called-element.js

@@ -0,0 +1,41 @@
+const { is } = require('bpmnlint-utils');
+
+const {
+  findExtensionElement,
+  hasExtensionElementOfType,
+  hasProperties
+} = require('./utils/element');
+
+const { reportErrors } = require('./utils/reporter');
+
+module.exports = function() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:CallActivity')) {
+      return;
+    }
+
+    let errors = hasExtensionElementOfType(node, 'zeebe:CalledElement', node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+
+      return;
+    }
+
+    const calledElement = findExtensionElement(node, 'zeebe:CalledElement');
+
+    errors = hasProperties(calledElement, {
+      processId: {
+        required: true
+      }
+    }, node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+};

package/rules/element-type/config.js

@@ -0,0 +1,186 @@
+module.exports = {
+  camundaCloud10: {
+    elements: [
+      'bpmn:Association',
+      'bpmn:BoundaryEvent',
+      'bpmn:CallActivity',
+      'bpmn:Collaboration',
+      'bpmn:Definitions',
+      'bpmn:EndEvent',
+      'bpmn:EventBasedGateway',
+      'bpmn:ExclusiveGateway',
+      'bpmn:Group',
+      'bpmn:IntermediateCatchEvent',
+      'bpmn:MessageFlow',
+      'bpmn:ParallelGateway',
+      'bpmn:Participant',
+      'bpmn:Process',
+      'bpmn:ReceiveTask',
+      'bpmn:SequenceFlow',
+      'bpmn:ServiceTask',
+      'bpmn:StartEvent',
+      'bpmn:SubProcess',
+      'bpmn:TextAnnotation',
+      'bpmn:UserTask'
+    ],
+    elementsNoEventDefinitionRequired: [
+      'bpmn:EndEvent',
+      'bpmn:StartEvent'
+    ],
+    eventDefinitions: {
+      'bpmn:BoundaryEvent': [
+        'bpmn:ErrorEventDefinition',
+        'bpmn:MessageEventDefinition',
+        'bpmn:TimerEventDefinition'
+      ],
+      'bpmn:EndEvent': [
+        'bpmn:ErrorEventDefinition'
+      ],
+      'bpmn:IntermediateCatchEvent': [
+        'bpmn:MessageEventDefinition',
+        'bpmn:TimerEventDefinition'
+      ],
+      'bpmn:StartEvent': [
+        'bpmn:ErrorEventDefinition',
+        'bpmn:MessageEventDefinition',
+        'bpmn:TimerEventDefinition'
+      ]
+    }
+  },
+  camundaCloud11: {
+    elements: [
+
+      // 1.0
+      'bpmn:Association',
+      'bpmn:BoundaryEvent',
+      'bpmn:CallActivity',
+      'bpmn:Collaboration',
+      'bpmn:Definitions',
+      'bpmn:EndEvent',
+      'bpmn:EventBasedGateway',
+      'bpmn:ExclusiveGateway',
+      'bpmn:Group',
+      'bpmn:IntermediateCatchEvent',
+      'bpmn:MessageFlow',
+      'bpmn:ParallelGateway',
+      'bpmn:Participant',
+      'bpmn:Process',
+      'bpmn:ReceiveTask',
+      'bpmn:SequenceFlow',
+      'bpmn:ServiceTask',
+      'bpmn:StartEvent',
+      'bpmn:SubProcess',
+      'bpmn:TextAnnotation',
+      'bpmn:UserTask',
+
+      // 1.1
+      'bpmn:BusinessRuleTask',
+      'bpmn:IntermediateThrowEvent',
+      'bpmn:ManualTask',
+      'bpmn:ScriptTask',
+      'bpmn:SendTask'
+    ],
+    elementsNoEventDefinitionRequired: [
+
+      // 1.0
+      'bpmn:EndEvent',
+      'bpmn:StartEvent',
+
+      // 1.1
+      'bpmn:IntermediateThrowEvent'
+    ],
+    eventDefinitions: {
+      'bpmn:BoundaryEvent': [
+        'bpmn:ErrorEventDefinition',
+        'bpmn:MessageEventDefinition',
+        'bpmn:TimerEventDefinition'
+      ],
+      'bpmn:EndEvent': [
+        'bpmn:ErrorEventDefinition'
+      ],
+      'bpmn:IntermediateCatchEvent': [
+        'bpmn:MessageEventDefinition',
+        'bpmn:TimerEventDefinition'
+      ],
+      'bpmn:StartEvent': [
+        'bpmn:ErrorEventDefinition',
+        'bpmn:MessageEventDefinition',
+        'bpmn:TimerEventDefinition'
+      ]
+    }
+  },
+  camundaCloud12: {
+    elements: [
+
+      // 1.0
+      'bpmn:Association',
+      'bpmn:BoundaryEvent',
+      'bpmn:CallActivity',
+      'bpmn:Collaboration',
+      'bpmn:Definitions',
+      'bpmn:EndEvent',
+      'bpmn:EventBasedGateway',
+      'bpmn:ExclusiveGateway',
+      'bpmn:Group',
+      'bpmn:IntermediateCatchEvent',
+      'bpmn:MessageFlow',
+      'bpmn:ParallelGateway',
+      'bpmn:Participant',
+      'bpmn:Process',
+      'bpmn:ReceiveTask',
+      'bpmn:SequenceFlow',
+      'bpmn:ServiceTask',
+      'bpmn:StartEvent',
+      'bpmn:SubProcess',
+      'bpmn:TextAnnotation',
+      'bpmn:UserTask',
+
+      // 1.1
+      'bpmn:BusinessRuleTask',
+      'bpmn:IntermediateThrowEvent',
+      'bpmn:ManualTask',
+      'bpmn:ScriptTask',
+      'bpmn:SendTask'
+    ],
+    elementsNoEventDefinitionRequired: [
+
+      // 1.0
+      'bpmn:EndEvent',
+      'bpmn:StartEvent',
+
+      // 1.1
+      'bpmn:IntermediateThrowEvent'
+    ],
+    eventDefinitions: {
+
+      // 1.1
+      'bpmn:BoundaryEvent': [
+        'bpmn:ErrorEventDefinition',
+        'bpmn:MessageEventDefinition',
+        'bpmn:TimerEventDefinition'
+      ],
+      'bpmn:EndEvent': [
+
+        // 1.0
+        'bpmn:ErrorEventDefinition',
+
+        // 1.1
+        'bpmn:MessageEventDefinition'
+      ],
+      'bpmn:IntermediateCatchEvent': [
+        'bpmn:MessageEventDefinition',
+        'bpmn:TimerEventDefinition'
+      ],
+      'bpmn:StartEvent': [
+        'bpmn:ErrorEventDefinition',
+        'bpmn:MessageEventDefinition',
+        'bpmn:TimerEventDefinition'
+      ],
+
+      // 1.2
+      'bpmn:IntermediateThrowEvent': [
+        'bpmn:MessageEventDefinition'
+      ]
+    }
+  }
+};

package/rules/element-type/index.js

@@ -0,0 +1,86 @@
+const { isAny } = require('bpmnlint-utils');
+
+const {
+  isAnyExactly,
+  getEventDefinition
+} = require('../utils/element');
+
+const { ERROR_TYPES } = require('../utils/error-types');
+
+const { reportErrors } = require('../utils/reporter');
+
+module.exports = function(config) {
+  const {
+    elements,
+    elementsNoEventDefinitionRequired,
+    eventDefinitions
+  } = config;
+
+  function check(node, reporter) {
+    if (!isAny(node, [ 'bpmn:FlowElement', 'bpmn:FlowElementsContainer' ])) {
+      return;
+    }
+
+    if (!isAnyExactly(node, elements)) {
+      const error = {
+        message: `Element of type <${ node.$type }> not allowed`,
+        path: null,
+        error: {
+          type: ERROR_TYPES.ELEMENT_TYPE_NOT_ALLOWED,
+          node,
+          parentNode: null
+        }
+      };
+
+      reportErrors(node, reporter, error);
+
+      return;
+    }
+
+    const eventDefinition = getEventDefinition(node);
+
+    if (isAny(node, [ 'bpmn:CatchEvent', 'ThrowEvent' ]) && !eventDefinition && !elementsNoEventDefinitionRequired.includes(node.$type)) {
+      const error = {
+        message: `Element of type <${ node.$type }> must have property <eventDefinitions>`,
+        path: [ 'eventDefinitions' ],
+        error: {
+          type: ERROR_TYPES.PROPERTY_REQUIRED,
+          node,
+          parentNode: null,
+          requiredProperty: 'eventDefinitions'
+        }
+      };
+
+      reportErrors(node, reporter, error);
+
+      return;
+    }
+
+    if (!eventDefinition) {
+      return;
+    }
+
+    if (!eventDefinitions[ node.$type ] || !isAny(eventDefinition, eventDefinitions[ node.$type ])) {
+      const error = {
+        message: `Property of type <${ eventDefinition.$type }> not allowed`,
+        path: [
+          'eventDefinitions',
+          0
+        ],
+        error: {
+          type: ERROR_TYPES.PROPERTY_TYPE_NOT_ALLOWED,
+          node: node,
+          parentNode: null,
+          property: 'eventDefinitions',
+          requiredPropertyType: eventDefinitions[ node.$type ]
+        }
+      };
+
+      reportErrors(node, reporter, error);
+    }
+  }
+
+  return {
+    check
+  };
+};