Skip to content

Latest commit

 

History

History
279 lines (228 loc) · 14.5 KB

README.md

File metadata and controls

279 lines (228 loc) · 14.5 KB
Raw

Quick links: How to test a tool? -> Test Results

Table of Contents generated with DocToc

BPMN Model Interchange Test Suite

BPMN 2.0 Test Cases (Models, Diagrams, Serializations) created by the BPMN Model Interchange Working Group (BPMN MIWG) at the OMG. For more information see: http://www.omgwiki.org/bpmn-miwg

Call for Participation

If BPMN interchange is important to you:

  • Test your favorite BPMN tool! Users can also submit test results. You don't need to be the author of a tool to test it.
  • Join the Group! Everybody can join. There is no need to be an OMG member. Get in touch with the people behind the standards.
  • Make yourself heard with your vendor.
  • Spread the word and share the test results with your peers.

Test results of BPMN 2.0 tools that participated in the tests

How to test a BPMN tool using this test suite?

Everybody is welcome to test BPMN tools and submit results to the working group, not just tools vendors but also end users that have access to a tool.

Here is how you do it:

1. Download Test Cases

First download the latest version of the BPMN Model Interchange Test Suite and unpack it. TheCe is a directory called Reference, which contains the files needed for testing. Next to that, there will be multiple folders with test results of other tools.

2. Test Import, Export and/or Roundtrip of BPMN Models.

There are different test procedures that can be performed with the provided reference models depending on the capabilities of the tool. You will find explanations of these procedures below.

3. Submit Your Test Results to BPMN MIWG

PacCage all result files in a zip file and send it via email to [email protected]. Please use the following template for your email:

Vendor: 
Tool name: 
Version: 
Website: 
Tool supports BPMN 2.0: 
Tool has BPMN XML import: 
Tool has BPMN XML export: 
Tool supports BPMN XML roundtrip: 
License: 
Notes:

Alternatively, you may also fork the repository on GitHub, upload the files using your Web browser and submit test results through a pull request. If you do so, make sure to update the JSON file with the list of tools.

Usually one day after your submission our automated tools should have generated a report that shows findings in your submitted files:

Note: By submitting test results you agree that they will be published under a Creative Commons Attribution 3.0 Unported License.

Detailed Description of Test Procedures

Available Features Possible Tests
import only import, cross
export only export
import & export import, export, roundtrip, cross

1. BPMN MIWG Import Test Procedure

If the tool under test supports the import of BPMN XML files, you can test that feature using the following procedure:

  1. Import the BPMN XML file (*.bpmn) provided with a reference model into the tool, e.g. A.1.0.bpmn.
  2. Save the graphical representation of the model as imported to a file named <test id>-import.<diagramNumber>.png, e.g. A.1.0-import.1.png. You can either do that through an export feature of the tool or by taking a screenshot of the canvas. It needs to be saved in PNG format. The <diagramNumber> should be counted in the order in which the diagrams appear inside reference XML file.
  3. Compare the result with the image provided with the reference model, e.g. A.1.0.png.
  4. Report any findings by creating new issues on GitHub – one for each finding. Here is a template for your issue reports:
Tool name: 
Tool version: 
Test case id: 
Test procedure: import
Description:

Repeat these steps for all reference models and submit your result files to BPMN MIWG.

2. BPMN MIWG Export Test Procedure

If the tool under test supports the export of BPMN XML files, you can test that feature using the following procedure:

  1. Draw the model as shown in the image provided with a reference model into the tool, e.g. A.1.0.png.
  2. Save the graphical representation of the model as drawn to a file named <test id>-export.png, e.g. A.1.0-export.png. You can either do that through an export feature of the tool or by taking a screenshot of the canvas. It needs to be saved in PNG format.
  3. Export the model into a BPMN XML file (*.bpmn) named <test id>-export.bpmn, e.g. A.1.0-export.bpmn.
  4. Compare the result with the BPMN XML file (*.bpmn) provided with the reference model, e.g. A.1.0.bpmn.
  5. Report any findings by creating new issues on GitHub – one for each finding. Here is a template for your issue reports:
Tool name: 
Tool version: 
Test case id: 
Test procedure: export
Description:

Repeat these steps for all reference models and submit your test results to BPMN MIWG.

3. BPMN MIWG Roundtrip Test Procedure (BPMN Import and Export combined)

If the tool under test supports the import and export of BPMN XML files, you can test a roundtrip using the following procedure:

  1. Import the BPMN XML file (*.bpmn) provided with a reference model into the tool, e.g. A.1.0.bpmn.
  2. If not already done during an import test, save the graphical representation of the model as it is imported to a file named <test id>-import.<diagramNumber>.png, e.g. A.1.0-import.1.png. You can either do that through an export feature of the tool or by taking a screenshot of the canvas. It needs to be saved in PNG format. The <diagramNumber> should be counted in the order in which the diagrams appear inside reference XML file.
  3. Export the model into a BPMN XML file (*.bpmn) named <test id>-roundtrip.bpmn, e.g. A.1.0-roundtrip.bpmn.
  4. Compare the result with the BPMN XML file (*.bpmn) provided with the reference model, e.g. A.1.0.bpmn.
  5. Report any findings by creating new issues on GitHub – one for each finding. Here is a template for your issue reports:
Tool name: 
Tool version: 
Test case id: 
Test procedure: roundtrip
Description:

Repeat these steps for all reference models and submit your test results to BPMN MIWG.

4. Optional: BPMN MIWG Cross Test Procedure (BPMN Roundtrip with results of other tools)

If the tool under test supports at least the import of BPMN XML files, you may optionally do a cross test with the roundtrip and export test results submitted by other tools:

  1. Import the BPMN XML files (*.bpmn) exported from other tools as their test results into the tool, e.g. A.1.0-roundtrip.bpmn or A.1.0-export.bpmn from the folder of the other tool, e.g. camunda Modeler 2.4.0.
  2. Save the graphical representation of the model as imported to a file named <name of imported file>-import.<diagramNumber>.png, e.g. A.1.0-roundtrip-import.1.png or A.1.0-export-import.1.png. You can either do that through an export feature of the tool or by taking a screenshot of the canvas. It needs to be saved in PNG format. The <diagramNumber> should be counted in the order in which the diagrams appear inside reference XML file. Store the result file in a folder with the name and version of the other tool that exported the file, e.g. camunda Modeler 2.4.0.
  3. Export the model into a BPMN XML file (*.bpmn) named <name of imported file>-roundtrip.bpmn, e.g. A.1.0-roundtrip-roundtrip.bpmn or A.1.0-export-roundtrip.bpmn. Store the result file in a folder with the name and version of the other tool that exported the file, e.g. camunda Modeler 2.4.0.
  4. Compare the result with the BPMN XML file (*.bpmn) provided with the reference model, e.g. A.1.0.bpmn, and/or the imported file, e.g. A.1.0-roundtrip.bpmn or A.1.0-export.bpmn.
  5. Report any findings by creating new issues on GitHub – one for each finding. Here is a template for your issue reports:
Tool name: 
Tool version: 
Name of imported file: 
Tool name of imported file: 
Tool version of imported file: 
Test procedure: cross
Description:

Repeat these steps for all roundtrip and export test results of all tools and submit your test results to BPMN MIWG.

5. BPMN Import and Export not supported

If the tool does neither support import nor export of BPMN XML files you can not perform the tests described above. However, if the tool supports other model interchange formats, we are still interested to record this information:

  1. Create a new issue on GitHub with a text like:
Tool name: 
Tool version: 
Description:
   The BPMN XML format is not supported.
   Model Interchange is only possible in the `XPDL` format.

Repository Structure

The top level is either a vendor or the submitted reference. The second level holds the individual test case files in the form <identifier>-<test type>.filetype.

The vendor who provided the reference model for a test case will be identified in the file test-case-structure.json.

  • README.md (this file)
  • test-case-structure.json <-- list of test cases
  • tools-tested-by-miwg.json <-- list of tested tools
  • Reference <-- reference files for testing
    • A.1.0.png
    • A.1.0.bpmn <-- look in spreadsheet test-case-structure.json to find vendor who provided this reference
    • ...
  • Trisotech BPMN Web Modeler 4.1.8 <-- test results
    • A.1.0-import.1.png
    • A.1.0-export.png
    • A.1.0-export.bpmn
    • A.1.0-roundtrip.bpmn
    • ...
    • camunda Modeler 2.4.0 <-- cross test results
      • A.1.0-roundtrip-import.1.png
      • A.1.0-roundtrip-roundtrip.bpmn
      • ...
    • MID Innovator 11.5.1.30223 <-- cross test results
      • A.1.0-export-import.1.png
      • A.1.0-export-roundtrip.bpmn
      • ...
    • ...
  • camunda Modeler 2.4.0 <-- test results
    • A.1.0-import.1.png
    • A.1.0-roundtrip.bpmn
    • ...
    • Trisotech BPMN Web Modeler 4.1.8 <-- cross test results
      • A.1.0-export-import.1.png
      • A.1.0-export-roundtrip.bpmn
      • A.1.0-roundtrip-import.1.png
      • A.1.0-roundtrip-roundtrip.bpmn
      • ...
    • ...
  • MID Innovator 11.5.1.30223 <-- test results
    • A.1.0-import.1.png
    • A.1.0-export.bpmn
    • ...

Verified Reference Models

A.1.0

A.2.0

A.2.1

A.3.0

A.4.0

A.4.1

B.1.0

B.2.0

C.1.0

C.1.1

C.2.0

C.3.0

Creative Commons Licence
This work is licensed under a Creative Commons Attribution 3.0 Unported License.