bpmnlint-plugin-camunda-compat 0.2.0 → 0.5.0

package/CHANGELOG.md

@@ -6,6 +6,26 @@ All notable changes to [bpmnlint-plugin-camunda-compat](https://github.com/camun
 
 ___Note:__ Yet to be released changes appear here._
 
+## 0.5.0
+
+* `FEAT`: update Camunda Cloud rules to lint extension elements and their properties ([#18](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/18))
+
+## 0.4.0
+
+* `CHORE`: rename `Cloud` `1.4` to `8.0` ([#14](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/14))
+* `CHORE`: rename `Cloud` to `Platform`/`Zeebe` ([#15](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/15))
+
+## 0.3.0
+
+* `FEAT`: support multiInstance for subprocesses with cloud 1.0 ([#6](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/6))
+* `FEAT`: add Camunda Platform rules ([#5](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/5))
+* `FEAT`: add Camunda Cloud 1.4 rule ([#5](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/5))
+* `TEST`: add Cloud 1.1, 1.2, 1.3 integration tests ([#4](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/4))
+* `TEST`: verify exported configs ([#5](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/5))
+* `DEPS`: fix security audit warnings ([#6](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/6))
+* `DOCS`: update link to documentation
+* `DOCS`: link Camunda Cloud and Platform BPMN coverage
+
 ## 0.2.0
 
 * `FEAT`: early return if execution platform does not match

package/README.md

@@ -23,8 +23,8 @@ To validate a diagram it must be pinned to a particular execution platform via t
 
 ## Resources
 
-* [Documentation](https://github.com/camunda/bpmnlint-plugin-camunda-compat/tree/master/docs/rules)
 * [Issues](https://github.com/camunda/bpmnlint-plugin-camunda-compat/issues)
+* BPMN coverage for [Camunda Cloud](https://docs.camunda.io/docs/reference/bpmn-processes/bpmn-coverage/) and [Camunda Platform](https://docs.camunda.org/manual/latest/reference/bpmn20/)
 
 
 ## License

package/index.js

@@ -1,20 +1,44 @@
 module.exports = {
   configs: {
+    all: {
+      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'
+      }
+    },
     recommended: {
       rules: {
         'camunda-cloud-1-0': 'error',
         'camunda-cloud-1-1': 'error',
         'camunda-cloud-1-2': 'error',
-        'camunda-cloud-1-3': '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'
       }
     },
-    all: {
+    cloud: {
+      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'
+      }
+    },
+    platform: {
       rules: {
-        'camunda-cloud-1-0': 'warn',
-        'camunda-cloud-1-1': 'warn',
-        'camunda-cloud-1-2': 'warn',
-        'camunda-cloud-1-3': 'warn'
+        'camunda-platform-7-15': 'error',
+        'camunda-platform-7-16': 'error',
+        'camunda-platform-7-17': 'error'
       }
     }
   }
-}
+};

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "bpmnlint-plugin-camunda-compat",
-  "version": "0.2.0",
+  "version": "0.5.0",
   "description": "A bpmnlint plug-in for Camunda Cloud and Platform compatibility",
   "main": "index.js",
   "scripts": {
-    "all": "npm test",
-    "test": "mocha test/**/*.spec.js"
+    "all": "npm run lint && npm test",
+    "lint": "eslint .",
+    "test": "mocha test/**/*.spec.js",
+    "test:watch": "npm run test -- --watch"
   },
   "repository": {
     "type": "git",
@@ -22,13 +24,19 @@
   "license": "MIT",
   "devDependencies": {
     "bpmn-moddle": "^7.1.2",
-    "bpmnlint": "^6.1.0",
-    "chai": "^4.2.0",
+    "bpmnlint": "^7.6.0",
+    "camunda-bpmn-moddle": "^6.1.1",
+    "chai": "^4.3.5",
+    "eslint": "^7.32.0",
+    "eslint-plugin-bpmn-io": "^0.13.0",
     "mocha": "^5.2.0",
     "modeler-moddle": "^0.1.0",
+    "sinon": "^13.0.1",
+    "sinon-chai": "^3.7.0",
     "zeebe-bpmn-moddle": "^0.10.0"
   },
   "dependencies": {
+    "@philippfromme/moddle-helpers": "^0.1.0",
     "bpmnlint-utils": "^1.0.2",
     "min-dash": "^3.8.0"
   },

package/rules/camunda-cloud-1-0-checks.js

@@ -1,19 +1,29 @@
 const {
-  checkSome,
+  checkEventDefinition,
+  checkFlowNode,
+  checkIf,
+  hasErrorReference,
   hasEventDefinitionOfType,
-  hasLoopCharacteristicsOfType,
-  hasNoEventDefinition,
+  hasEventDefinitionOfTypeOrNone,
   hasNoLanes,
-  hasNoLoopCharacteristics,
-  isNotBpmn
-} = require('./utils/rule');
+  isNotBpmn,
+  withTranslations
+} = require('./utils/element');
+
+const {
+  hasZeebeCalledElement,
+  hasZeebeLoopCharacteristics,
+  hasZeebeSubscription,
+  hasZeebeTaskDefinition
+} = require('./utils/cloud/element');
+
+const { checkEvery } = require('./utils/rule');
 
 module.exports = [
   {
     check: isNotBpmn
   },
   'bpmn:Association',
-  'bpmn:CallActivity',
   'bpmn:Collaboration',
   'bpmn:DataObject',
   'bpmn:DataObjectReference',
@@ -29,27 +39,51 @@ module.exports = [
   'bpmn:TextAnnotation',
   {
     type: 'bpmn:BoundaryEvent',
-    check: hasEventDefinitionOfType([
-      'bpmn:ErrorEventDefinition',
-      'bpmn:MessageEventDefinition',
-      'bpmn:TimerEventDefinition'
-    ])
+    check: checkEvery(
+      hasEventDefinitionOfType([
+        'bpmn:ErrorEventDefinition',
+        'bpmn:MessageEventDefinition',
+        'bpmn:TimerEventDefinition'
+      ]),
+      checkIf(
+        checkEventDefinition(hasErrorReference),
+        hasEventDefinitionOfType('bpmn:ErrorEventDefinition')
+      ),
+      checkIf(
+        checkEventDefinition(hasZeebeSubscription),
+        hasEventDefinitionOfType('bpmn:MessageEventDefinition')
+      )
+    )
+  },
+  {
+    type: 'bpmn:CallActivity',
+    check: checkEvery(
+      hasZeebeCalledElement,
+      hasZeebeLoopCharacteristics
+    )
   },
   {
     type: 'bpmn:EndEvent',
-    check: checkSome(
-      hasNoEventDefinition,
-      hasEventDefinitionOfType([
-        'bpmn:ErrorEventDefinition'
-      ])
+    check: checkEvery(
+      hasEventDefinitionOfTypeOrNone('bpmn:ErrorEventDefinition'),
+      checkIf(
+        checkEventDefinition(hasErrorReference),
+        hasEventDefinitionOfType('bpmn:ErrorEventDefinition')
+      )
     )
   },
   {
     type: 'bpmn:IntermediateCatchEvent',
-    check: hasEventDefinitionOfType([
-      'bpmn:MessageEventDefinition',
-      'bpmn:TimerEventDefinition'
-    ])
+    check: checkEvery(
+      hasEventDefinitionOfType([
+        'bpmn:TimerEventDefinition',
+        'bpmn:MessageEventDefinition'
+      ]),
+      checkIf(
+        checkEventDefinition(hasZeebeSubscription),
+        hasEventDefinitionOfType('bpmn:MessageEventDefinition')
+      )
+    )
   },
   {
     type: 'bpmn:Process',
@@ -57,38 +91,47 @@ module.exports = [
   },
   {
     type: 'bpmn:ReceiveTask',
-    check: checkSome(
-      hasNoLoopCharacteristics,
-      hasLoopCharacteristicsOfType('bpmn:MultiInstanceLoopCharacteristics')
+    check: checkEvery(
+      checkFlowNode(hasZeebeSubscription),
+      hasZeebeLoopCharacteristics
     )
   },
   {
     type: 'bpmn:ServiceTask',
-    check: checkSome(
-      hasNoLoopCharacteristics,
-      hasLoopCharacteristicsOfType('bpmn:MultiInstanceLoopCharacteristics')
+    check: withTranslations(
+      checkEvery(
+        hasZeebeLoopCharacteristics,
+        hasZeebeTaskDefinition
+      ),
+      {
+        'foo': 'bar'
+      }
     )
   },
   {
     type: 'bpmn:StartEvent',
-    check: checkSome(
-      hasNoEventDefinition,
-      hasEventDefinitionOfType([
+    check: checkEvery(
+      hasEventDefinitionOfTypeOrNone([
         'bpmn:ErrorEventDefinition',
         'bpmn:MessageEventDefinition',
         'bpmn:TimerEventDefinition'
-      ])
+      ]),
+      checkIf(
+        checkEventDefinition(hasErrorReference),
+        hasEventDefinitionOfType('bpmn:ErrorEventDefinition')
+      ),
+      checkIf(
+        checkEventDefinition(hasZeebeSubscription),
+        hasEventDefinitionOfType('bpmn:MessageEventDefinition')
+      )
     )
   },
   {
     type: 'bpmn:SubProcess',
-    check: hasNoLoopCharacteristics
+    check: hasZeebeLoopCharacteristics
   },
   {
     type: 'bpmn:UserTask',
-    check: checkSome(
-      hasNoLoopCharacteristics,
-      hasLoopCharacteristicsOfType('bpmn:MultiInstanceLoopCharacteristics')
-    )
+    check: hasZeebeLoopCharacteristics
   }
-];
+];

package/rules/camunda-cloud-1-0.js

@@ -2,4 +2,4 @@ const { createRule } = require('./utils/rule');
 
 const checks = require('./camunda-cloud-1-0-checks');
 
-module.exports = createRule('Camunda Cloud', '1.0', checks);
+module.exports = createRule('Camunda Cloud', '1.0', checks, 'Zeebe');

package/rules/camunda-cloud-1-1-checks.js

@@ -1,19 +1,21 @@
 const camundaCloud10Checks = require('./camunda-cloud-1-0-checks');
 
+const { checkEvery } = require('./utils/rule');
+
+const { hasNoEventDefinition } = require('./utils/element');
+
 const {
-  checkSome,
-  hasLoopCharacteristicsOfType,
-  hasNoEventDefinition,
-  hasNoLoopCharacteristics
-} = require('./utils/rule');
+  hasZeebeTaskDefinition,
+  hasZeebeLoopCharacteristics
+} = require('./utils/cloud/element');
 
 module.exports = [
   ...camundaCloud10Checks,
   {
     type: 'bpmn:BusinessRuleTask',
-    check: checkSome(
-      hasNoLoopCharacteristics,
-      hasLoopCharacteristicsOfType('bpmn:MultiInstanceLoopCharacteristics')
+    check: checkEvery(
+      hasZeebeLoopCharacteristics,
+      hasZeebeTaskDefinition
     )
   },
   {
@@ -22,23 +24,20 @@ module.exports = [
   },
   {
     type: 'bpmn:ManualTask',
-    check: checkSome(
-      hasNoLoopCharacteristics,
-      hasLoopCharacteristicsOfType('bpmn:MultiInstanceLoopCharacteristics')
-    )
+    check: hasZeebeLoopCharacteristics
   },
   {
     type: 'bpmn:ScriptTask',
-    check: checkSome(
-      hasNoLoopCharacteristics,
-      hasLoopCharacteristicsOfType('bpmn:MultiInstanceLoopCharacteristics')
+    check: checkEvery(
+      hasZeebeLoopCharacteristics,
+      hasZeebeTaskDefinition
     )
   },
   {
     type: 'bpmn:SendTask',
-    check: checkSome(
-      hasNoLoopCharacteristics,
-      hasLoopCharacteristicsOfType('bpmn:MultiInstanceLoopCharacteristics')
+    check: checkEvery(
+      hasZeebeLoopCharacteristics,
+      hasZeebeTaskDefinition
     )
   }
 ];

package/rules/camunda-cloud-1-1.js

@@ -2,4 +2,4 @@ const { createRule } = require('./utils/rule');
 
 const checks = require('./camunda-cloud-1-1-checks');
 
-module.exports = createRule('Camunda Cloud', '1.1', checks);
+module.exports = createRule('Camunda Cloud', '1.1', checks, 'Zeebe');

package/rules/camunda-cloud-1-2-checks.js

@@ -1,19 +1,47 @@
 const camundaCloud11Checks = require('./camunda-cloud-1-1-checks');
 
-const { hasEventDefinitionOfType } = require('./utils/rule');
- 
+const {
+  checkEvery,
+  replaceChecks
+} = require('./utils/rule');
+
+const {
+  checkEventDefinition,
+  checkIf,
+  hasErrorReference,
+  hasEventDefinitionOfType,
+  hasEventDefinitionOfTypeOrNone,
+} = require('./utils/element');
+
+const { hasZeebeTaskDefinition } = require('./utils/cloud/element');
+
 module.exports = [
-  ...camundaCloud11Checks,
-  {
-    type: 'bpmn:EndEvent',
-    check: hasEventDefinitionOfType([
-      'bpmn:MessageEventDefinition'
-    ])
-  },
-  {
-    type: 'bpmn:IntermediateThrowEvent',
-    check: hasEventDefinitionOfType([
-      'bpmn:MessageEventDefinition'
-    ])
-  }
+  ...replaceChecks(
+    camundaCloud11Checks,
+    [
+      {
+        type: 'bpmn:IntermediateThrowEvent',
+        check: checkEvery(
+          hasEventDefinitionOfTypeOrNone('bpmn:MessageEventDefinition'),
+          checkIf(
+            hasZeebeTaskDefinition,
+            hasEventDefinitionOfType('bpmn:MessageEventDefinition')
+          )
+        )
+      },
+      {
+        type: 'bpmn:EndEvent',
+        check: checkEvery(
+          hasEventDefinitionOfTypeOrNone([
+            'bpmn:ErrorEventDefinition',
+            'bpmn:MessageEventDefinition'
+          ]),
+          checkIf(
+            checkEventDefinition(hasErrorReference),
+            hasEventDefinitionOfType('bpmn:ErrorEventDefinition')
+          )
+        )
+      }
+    ]
+  )
 ];

package/rules/camunda-cloud-1-2.js

@@ -2,4 +2,4 @@ const { createRule } = require('./utils/rule');
 
 const checks = require('./camunda-cloud-1-2-checks');
 
-module.exports = createRule('Camunda Cloud', '1.2', checks);
+module.exports = createRule('Camunda Cloud', '1.2', checks, 'Zeebe');

package/rules/camunda-cloud-1-3-checks.js

@@ -1,5 +1,22 @@
 const camundaCloud12Checks = require('./camunda-cloud-1-2-checks');
 
+const {
+  checkEvery,
+  replaceCheck
+} = require('./utils/rule');
+
+const {
+  hasZeebeCalledDecisionOrTaskDefinition,
+  hasZeebeLoopCharacteristics
+} = require('./utils/cloud/element');
+
 module.exports = [
-  ...camundaCloud12Checks
+  ...replaceCheck(
+    camundaCloud12Checks,
+    'bpmn:BusinessRuleTask',
+    checkEvery(
+      hasZeebeCalledDecisionOrTaskDefinition,
+      hasZeebeLoopCharacteristics
+    )
+  )
 ];

package/rules/camunda-cloud-1-3.js

@@ -2,4 +2,4 @@ const { createRule } = require('./utils/rule');
 
 const checks = require('./camunda-cloud-1-3-checks');
 
-module.exports = createRule('Camunda Cloud', '1.3', checks);
+module.exports = createRule('Camunda Cloud', '1.3', checks, 'Zeebe');

package/rules/camunda-cloud-8-0-checks.js

@@ -0,0 +1,5 @@
+const camundaCloud13Checks = require('./camunda-cloud-1-3-checks');
+
+module.exports = [
+  ...camundaCloud13Checks
+];

package/rules/camunda-cloud-8-0.js

@@ -0,0 +1,5 @@
+const { createRule } = require('./utils/rule');
+
+const checks = require('./camunda-cloud-8-0-checks');
+
+module.exports = createRule('Camunda Cloud', '8.0', checks, 'Camunda Platform');

package/rules/camunda-platform-7-15.js

@@ -0,0 +1,3 @@
+const { createNoopRule } = require('./utils/rule');
+
+module.exports = createNoopRule();

package/rules/camunda-platform-7-16.js

@@ -0,0 +1,3 @@
+const { createNoopRule } = require('./utils/rule');
+
+module.exports = createNoopRule();

package/rules/camunda-platform-7-17.js

@@ -0,0 +1,3 @@
+const { createNoopRule } = require('./utils/rule');
+
+module.exports = createNoopRule();

package/rules/utils/cloud/element.js

@@ -0,0 +1,111 @@
+const { checkEvery } = require('../rule');
+
+const {
+  checkFlowNode,
+  checkLoopCharacteristics,
+  checkMessage,
+  hasExtensionElementOfType,
+  hasExtensionElementsOfTypes,
+  checkIf,
+  hasMultiInstanceLoopCharacteristics,
+  hasLoopCharacteristics
+} = require('../element');
+
+module.exports.hasZeebeCalledDecisionOrTaskDefinition = checkFlowNode(
+  hasExtensionElementsOfTypes([
+    {
+      type: 'zeebe:CalledDecision',
+      properties: {
+        decisionId: {
+          required: true
+        },
+        resultVariable: {
+          required: true
+        }
+      }
+    },
+    {
+      type: 'zeebe:TaskDefinition',
+      properties: {
+        type: {
+          required: true
+        },
+        retries: {
+          required: true
+        }
+      }
+    }
+  ], true)
+);
+
+module.exports.hasZeebeCalledElement = checkFlowNode(
+  hasExtensionElementOfType({
+    type: 'zeebe:CalledElement',
+    properties: {
+      processId: {
+        required: true
+      }
+    }
+  })
+);
+
+/**
+ * Check if one of the following is true:
+ *
+ * 1. no loop characteristics
+ * 2. bpmn:MultiInstanceLoopCharacteristics with zeebe:LoopCharacteristics
+ * extension element with zeebe:inputCollection
+ */
+module.exports.hasZeebeLoopCharacteristics = checkEvery(
+  checkIf(
+    hasMultiInstanceLoopCharacteristics,
+    hasLoopCharacteristics
+  ),
+  checkIf(
+    checkLoopCharacteristics(
+      hasExtensionElementOfType({
+        type: 'zeebe:LoopCharacteristics',
+        properties: {
+          inputCollection: {
+            required: true
+          },
+          outputCollection: {
+            dependendRequired: 'outputElement'
+          },
+          outputElement: {
+            dependendRequired: 'outputCollection'
+          }
+        }
+      })
+    ),
+    checkEvery(
+      hasLoopCharacteristics,
+      hasMultiInstanceLoopCharacteristics
+    )
+  )
+);
+
+module.exports.hasZeebeSubscription = checkMessage(
+  hasExtensionElementOfType({
+    type: 'zeebe:Subscription',
+    properties: {
+      correlationKey: {
+        required: true
+      }
+    }
+  })
+);
+
+module.exports.hasZeebeTaskDefinition = checkFlowNode(
+  hasExtensionElementOfType({
+    type: 'zeebe:TaskDefinition',
+    properties: {
+      type: {
+        required: true
+      },
+      retries: {
+        required: true
+      }
+    }
+  })
+);