Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Inclusive Gateway Rule #44

Merged
merged 2 commits into from
Sep 12, 2022
Merged

Add Inclusive Gateway Rule #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d800f67
chore: clean up config
philippfromme Sep 8, 2022
4b7bbf6
feat: add inclusive gateway rule
philippfromme Sep 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,11 @@ const camundaCloud13Rules = {

const camundaCloud80Rules = omit(camundaCloud13Rules, 'no-template');

const camundaCloud81Rules = omit(camundaCloud13Rules, 'no-zeebe-properties');
const camundaCloud81Rules = {
...omit(camundaCloud80Rules, 'no-zeebe-properties'),
'element-type': [ 'error', elementTypeConfig.camundaCloud81 ],
'inclusive-gateway': 'error'
};

module.exports = {
configs: {
Expand Down
279 changes: 107 additions & 172 deletions rules/element-type/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,186 +1,121 @@
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: [
const camundaCloud10Elements = [
'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.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',
const camundaCloud11Elements = [
...camundaCloud10Elements,
'bpmn:BusinessRuleTask',
'bpmn:IntermediateThrowEvent',
'bpmn:ManualTask',
'bpmn:ScriptTask',
'bpmn:SendTask'
];

// 1.1
'bpmn:BusinessRuleTask',
'bpmn:IntermediateThrowEvent',
'bpmn:ManualTask',
'bpmn:ScriptTask',
'bpmn:SendTask'
],
elementsNoEventDefinitionRequired: [
const camundaCloud12Elements = [
...camundaCloud11Elements
];

// 1.0
'bpmn:EndEvent',
'bpmn:StartEvent',
const camundaCloud81Elements = [
...camundaCloud12Elements,
'bpmn:InclusiveGateway'
];

// 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: [
const camundaCloud10ElementsNoEventDefinitionRequired = [
'bpmn:EndEvent',
'bpmn:StartEvent'
];

// 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',
const camundaCloud11ElementsNoEventDefinitionRequired = [
...camundaCloud10ElementsNoEventDefinitionRequired,
'bpmn:IntermediateThrowEvent'
];

// 1.1
'bpmn:BusinessRuleTask',
'bpmn:IntermediateThrowEvent',
'bpmn:ManualTask',
'bpmn:ScriptTask',
'bpmn:SendTask'
],
elementsNoEventDefinitionRequired: [
const camundaCloud12ElementsNoEventDefinitionRequired = [
...camundaCloud11ElementsNoEventDefinitionRequired
];

// 1.0
'bpmn:EndEvent',
'bpmn:StartEvent',
const camundaCloud81ElementsNoEventDefinitionRequired = [
...camundaCloud12ElementsNoEventDefinitionRequired
];

// 1.1
'bpmn:IntermediateThrowEvent'
],
eventDefinitions: {
const camundaCloud10EventDefinitions = {
'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'
]
};

// 1.1
'bpmn:BoundaryEvent': [
'bpmn:ErrorEventDefinition',
'bpmn:MessageEventDefinition',
'bpmn:TimerEventDefinition'
],
'bpmn:EndEvent': [
const camundaCloud11EventDefinitions = {
...camundaCloud10EventDefinitions
};

// 1.0
'bpmn:ErrorEventDefinition',
const camundaCloud12EventDefinitions = {
...camundaCloud11EventDefinitions,
'bpmn:EndEvent': [
...camundaCloud11EventDefinitions['bpmn:EndEvent'],
'bpmn:MessageEventDefinition'
],
'bpmn:IntermediateThrowEvent': [
'bpmn:MessageEventDefinition'
]
};

// 1.1
'bpmn:MessageEventDefinition'
],
'bpmn:IntermediateCatchEvent': [
'bpmn:MessageEventDefinition',
'bpmn:TimerEventDefinition'
],
'bpmn:StartEvent': [
'bpmn:ErrorEventDefinition',
'bpmn:MessageEventDefinition',
'bpmn:TimerEventDefinition'
],
const camundaCloud81EventDefinitions = {
...camundaCloud12EventDefinitions
};

// 1.2
'bpmn:IntermediateThrowEvent': [
'bpmn:MessageEventDefinition'
]
}
module.exports = {
camundaCloud10: {
elements: camundaCloud10Elements,
elementsNoEventDefinitionRequired: camundaCloud10ElementsNoEventDefinitionRequired,
eventDefinitions: camundaCloud10EventDefinitions
},
camundaCloud11: {
elements: camundaCloud11Elements,
elementsNoEventDefinitionRequired: camundaCloud11ElementsNoEventDefinitionRequired,
eventDefinitions: camundaCloud11EventDefinitions
},
camundaCloud12: {
elements: camundaCloud12Elements,
elementsNoEventDefinitionRequired: camundaCloud12ElementsNoEventDefinitionRequired,
eventDefinitions: camundaCloud12EventDefinitions
},
camundaCloud81: {
elements: camundaCloud81Elements,
elementsNoEventDefinitionRequired: camundaCloud81ElementsNoEventDefinitionRequired,
eventDefinitions: camundaCloud81EventDefinitions
}
};
52 changes: 52 additions & 0 deletions rules/inclusive-gateway.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
const { is } = require('bpmnlint-utils');

const { hasProperties, ERROR_TYPES } = require('./utils/element');

const { reportErrors } = require('./utils/reporter');

module.exports = function() {
function check(node, reporter) {
if (!is(node, 'bpmn:InclusiveGateway')) {
return;
}

const incoming = node.get('incoming');

if (incoming && incoming.length > 1) {
const error = {
message: `Element of type <${ node.$type }> must have one property <incoming> of type <bpmn:SequenceFlow>`,
path: [ 'incoming' ],
error: {
type: ERROR_TYPES.PROPERTY_NOT_ALLOWED,
node,
parentNode: null,
property: 'incoming'
}
};

reportErrors(node, reporter, error);
}

const outgoing = node.get('outgoing');

if (outgoing && outgoing.length > 1) {
for (let sequenceFlow of outgoing) {
if (node.get('default') !== sequenceFlow) {
const errors = hasProperties(sequenceFlow, {
conditionExpression: {
required: true
}
}, sequenceFlow);

if (errors.length) {
reportErrors(sequenceFlow, reporter, errors);
}
}
}
}
}

return {
check
};
};
14 changes: 14 additions & 0 deletions test/camunda-cloud/camunda-cloud-1-0-element-type.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,20 @@ const invalid = [
parentNode: null
}
}
},
{
name: 'inlusive gateway',
moddleElement: createModdle(createProcess('<bpmn:inclusiveGateway id="InclusiveGateway_1" />')),
report: {
id: 'InclusiveGateway_1',
message: 'Element of type <bpmn:InclusiveGateway> not allowed',
path: null,
error: {
type: ERROR_TYPES.ELEMENT_TYPE_NOT_ALLOWED,
node: 'InclusiveGateway_1',
parentNode: null
}
}
}
];

Expand Down
Loading