search

bpmn-io / bpmnlint

Validate BPMN diagrams based on configurable lint rules.
MIT License
121 stars 36 forks source link

Be Able to Specify Test Name When Using RuleTester.verify #67

Closed philippfromme closed 2 years ago

philippfromme commented 2 years ago

Console output when using RuleTester.verify looks like this:

rules/camunda-cloud-1-0-integration
    should lint valid
      √ test case #1
      √ test case #2
      √ test case #3
      √ test case #4
      √ test case #5
      √ test case #6
      √ test case #7
      √ test case #8
      √ test case #9
      √ test case #10
      √ test case #11
      √ test case #12
      √ test case #13
      √ test case #14
      √ test case #15
      √ test case #16
      √ test case #17
    should lint invalid
      √ test case #0
      √ test case #1
      √ test case #2
      √ test case #3
      √ test case #4
      √ test case #5

Finding failing test cases is quite hard with this kind of output.

Changing https://github.com/bpmn-io/bpmnlint/blob/master/lib/testers/rule-tester.js#L36 to include a name would result in:

rules/camunda-cloud-1-0-integration
    should lint valid
      √ test case #1 (BpmnDiTest.xml)
      √ test case #2 (CollaborationParserTest.bpmn)
      √ test case #3 (ConditionalSequenceFlowTest.xml)
      √ test case #4 (DataStoreTest.bpmn)
      √ test case #5 (DefinitionsTest.shouldImportEmptyDefinitions.bpmn)
      √ test case #6 (DefinitionsTest.shouldNotAffectComments.bpmn)
      √ test case #7 (DefinitionsTest.shouldNotImportWrongOrderedSequence.bpmn)
      √ test case #8 (GenerateIdTest.bpmn)
      √ test case #9 (ProcessTest.shouldImportProcess.bpmn)
      √ test case #10 (ReferenceTest.shouldFindReferenceWithNamespace.bpmn)
      √ test case #11 (ResourceRolesTest.bpmn)
      √ test case #12 (TransactionTest.xml)
      √ test case #13 (instance/TextAnnotationTest.bpmn)
      √ test case #14 (validation/default-flow.bpmn)
      √ test case #15 (validation/multiple-timer-start-event-sub-process.bpmn)
      √ test case #16 (validation/no-start-event-sub-process.bpmn)
      √ test case #17 (validation/non-executable-elements.bpmn)
    should lint invalid
      √ test case #0 (CamundaExtensionsCompatabilityTest.xml)
      √ test case #1 (CamundaExtensionsTest.xml)
      √ test case #2 (DataObjectTest.bpmn)
      √ test case #3 (EventDefinitionsTest.xml)
      √ test case #4 (GatewaysTest.xml)
      √ test case #5 (validation/collaboration-with-lanes.bpmn)
nikku commented 2 years ago

Happy to take a PR to sketch a solution.

philippfromme commented 2 years ago

Will do if I find the time. 👍🏻