feat: add ad-hoc-sub-process-activity rule

This rules ensures that an Ad-Hoc Sub-Process contains at least one activity.

Related to camunda/camunda-modeler#4811

index.js

@@ -96,7 +96,8 @@ const camundaCloud86Rules = withConfig({
 }, { version: '8.6' });
 
 const camundaCloud87Rules = withConfig({
-  ...camundaCloud86Rules
+  ...camundaCloud86Rules,
+  'ad-hoc-sub-process-activity': 'error',
 }, { version: '8.7' });
 
 const camundaCloud88Rules = withConfig({
@@ -132,6 +133,7 @@ const camundaPlatform723Rules = withConfig(camundaPlatform721Rules, {
 });
 
 const rules = {
+  'ad-hoc-sub-process-activity': './rules/camunda-cloud/ad-hoc-sub-process-activity',
   'element-type': './rules/camunda-cloud/element-type',
   'called-element': './rules/camunda-cloud/called-element',
   'collapsed-subprocess': './rules/camunda-cloud/collapsed-subprocess',

rules/camunda-cloud/ad-hoc-sub-process-activity.js

@@ -0,0 +1,34 @@
+const { is, isAny } = require('bpmnlint-utils');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:AdHocSubProcess')) {
+      return;
+    }
+
+    // Ad-Hoc Sub-Process must contain at least one activity
+    if (node.get('flowElements').some(isActivity)) {
+      return;
+    }
+
+    reportErrors(node, reporter, {
+      message: 'Element of type <bpmn:AdHocSubProcess> must contain at least one activity',
+      data: {
+        node,
+        parentNode: null
+      }
+    });
+  }
+
+  return {
+    check
+  };
+});
+
+function isActivity(element) {
+  return isAny(element, [ 'bpmn:Task', 'bpmn:SubProcess' ]);
+}

test/camunda-cloud/ad-hoc-sub-process-activity.spec.js

@@ -0,0 +1,59 @@
+const RuleTester = require('bpmnlint/lib/testers/rule-tester');
+
+const rule = require('../../rules/camunda-cloud/ad-hoc-sub-process-activity');
+
+const {
+  createModdle,
+  createProcess
+} = require('../helper');
+
+const valid = [
+  {
+    name: 'ad hoc sub process (with task)',
+    moddleElement: createModdle(createProcess(`
+      <bpmn:adHocSubProcess id="Subprocess_1">
+        <bpmn:task id="Task_1" />
+      </bpmn:adHocSubProcess>
+    `))
+  }
+];
+
+const invalid = [
+  {
+    name: 'ad hoc sub process (empty)',
+    moddleElement: createModdle(createProcess(`
+      <bpmn:adHocSubProcess id="Subprocess_1">
+      </bpmn:adHocSubProcess>
+    `)),
+    report: {
+      id: 'Subprocess_1',
+      message: 'Element of type <bpmn:AdHocSubProcess> must contain at least one activity',
+      data: {
+        node: 'Subprocess_1',
+        parentNode: null
+      }
+    }
+  },
+  {
+    name: 'ad hoc sub process (no activity)',
+    moddleElement: createModdle(createProcess(`
+      <bpmn:adHocSubProcess id="Subprocess_1">
+        <bpmn:exclusiveGateway id="Gateway_1" />
+        <bpmn:intermediateThrowEvent id="Event_1" />
+      </bpmn:adHocSubProcess>
+    `)),
+    report: {
+      id: 'Subprocess_1',
+      message: 'Element of type <bpmn:AdHocSubProcess> must contain at least one activity',
+      data: {
+        node: 'Subprocess_1',
+        parentNode: null
+      }
+    }
+  }
+];
+
+RuleTester.verify('called-element', rule, {
+  valid,
+  invalid
+});

test/camunda-cloud/integration/ad-hoc-sub-process-activity-errors.bpmn

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:modeler="http://camunda.org/schema/modeler/1.0" id="Definitions_00ka3lv" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="5.29.0" modeler:executionPlatform="Camunda Cloud" modeler:executionPlatformVersion="8.1.0">
+  <bpmn:process id="Process_0agkt49" isExecutable="true">
+    <bpmn:adHocSubProcess id="Subprocess_1" />
+  </bpmn:process>
+  <bpmndi:BPMNDiagram id="BPMNDiagram_1">
+    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_0agkt49">
+      <bpmndi:BPMNShape id="Activity_0djbhry_di" bpmnElement="Subprocess_1" isExpanded="true">
+        <dc:Bounds x="190" y="80" width="350" height="200" />
+      </bpmndi:BPMNShape>
+    </bpmndi:BPMNPlane>
+  </bpmndi:BPMNDiagram>
+</bpmn:definitions>

test/camunda-cloud/integration/ad-hoc-sub-process-activity.bpmn

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:modeler="http://camunda.org/schema/modeler/1.0" id="Definitions_00ka3lv" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="5.29.0" modeler:executionPlatform="Camunda Cloud" modeler:executionPlatformVersion="8.1.0">
+  <bpmn:process id="Process_0agkt49" isExecutable="true">
+    <bpmn:adHocSubProcess id="Subprocess_1">
+      <bpmn:task id="Task_1" />
+    </bpmn:adHocSubProcess>
+  </bpmn:process>
+  <bpmndi:BPMNDiagram id="BPMNDiagram_1">
+    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_0agkt49">
+      <bpmndi:BPMNShape id="Activity_0djbhry_di" bpmnElement="Subprocess_1" isExpanded="true">
+        <dc:Bounds x="190" y="80" width="350" height="200" />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="Activity_0b17sv2_di" bpmnElement="Task_1">
+        <dc:Bounds x="310" y="130" width="100" height="80" />
+      </bpmndi:BPMNShape>
+    </bpmndi:BPMNPlane>
+  </bpmndi:BPMNDiagram>
+</bpmn:definitions>

test/camunda-cloud/integration/ad-hoc-sub-process-activity.spec.js

@@ -0,0 +1,68 @@
+const { expect } = require('chai');
+
+const Linter = require('bpmnlint/lib/linter');
+
+const NodeResolver = require('bpmnlint/lib/resolver/node-resolver');
+
+const { readModdle } = require('../../helper');
+
+const versions = [
+  '8.7',
+  '8.8',
+];
+
+describe('integration - ad-hoc-sub-process-activity', function() {
+
+  let linter;
+
+  versions.forEach(function(version) {
+
+    beforeEach(function() {
+      linter = new Linter({
+        config: {
+          extends: `plugin:camunda-compat/camunda-cloud-${ version.replace('.', '-') }`
+        },
+        resolver: new NodeResolver()
+      });
+    });
+
+    describe(`Camunda Cloud ${ version }`, function() {
+
+      describe('no errors', function() {
+
+        it('should not have errors', async function() {
+
+          // given
+          const { root } = await readModdle('test/camunda-cloud/integration/ad-hoc-sub-process-activity.bpmn');
+
+          // when
+          const reports = await linter.lint(root);
+
+          // then
+          expect(reports[ 'camunda-compat/ad-hoc-sub-process-activity' ]).not.to.exist;
+        });
+
+      });
+
+
+      describe('errors', function() {
+
+        it('should have errors', async function() {
+
+          // given
+          const { root } = await readModdle('test/camunda-cloud/integration/ad-hoc-sub-process-activity-errors.bpmn');
+
+          // when
+          const reports = await linter.lint(root);
+
+          // then
+          expect(reports[ 'camunda-compat/ad-hoc-sub-process-activity' ]).to.exist;
+        });
+
+      });
+
+    });
+
+  });
+
+});

test/config/configs.spec.js

@@ -401,6 +401,7 @@ describe('configs', function() {
 
 
   it('camunda-cloud-8-7', expectRules(configs, 'camunda-cloud-8-7', {
+    'ad-hoc-sub-process-activity': [ 'error', { version: '8.7' } ],
     'called-element': [ 'error', { version: '8.7' } ],
     'connector-properties': [ 'warn', { version: '8.7' } ],
     'duplicate-execution-listeners': [ 'error', { version: '8.7' } ],
@@ -438,6 +439,7 @@ describe('configs', function() {
 
 
   it('camunda-cloud-8-8', expectRules(configs, 'camunda-cloud-8-8', {
+    'ad-hoc-sub-process-activity': [ 'error', { version: '8.8' } ],
     'called-element': [ 'error', { version: '8.8' } ],
     'connector-properties': [ 'warn', { version: '8.8' } ],
     'duplicate-execution-listeners': [ 'error', { version: '8.8' } ],
@@ -499,6 +501,7 @@ describe('configs', function() {
 
 
   it('all', expectRules(configs, 'all', {
+    'ad-hoc-sub-process-activity': 'error',
     'element-type': 'error',
     'called-element': 'error',
     'collapsed-subprocess': 'error',