signavio / bpmn2constraints Goto Github PK

At the moment, there are no tests for the compiler and the constraints it generates.

A test that verifies that...

• Choice constraints are not generated for elements in gateways constructs.
• Succession/Co-Existence/Choice constraints are generated for elements in a sequential flow.
• All gateway combinations are generated.
• Precedence constraints are generated.
• Response constraints are generated.
• End constraints are generated for all endings.
• Init constraints are generated for all starts.

At minimum, we should add diagrams for all the diagrams that we test. And also add tests for those diagrams.

At the moment, the description of an Alternate Succession is identical to a regular Succession (i.e., x leads to y). This issue should:

• Investigate what could be a better description of Alternate Successions.
• Change the descriptions in the compiler.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update actions/setup-python action to v5

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

At the moment, the code does not follow any specific code standard. The most common code style for Python is (?) Black, let's go with that.

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-vulnerability_alerts-1
Explanation: Are vulnerability alerts enabled? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-assigned_teams-4
Explanation: Does it have a team with push privileges on GitHub? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

At the moment, errors are handled and in an unsatisfactory manner. This issue should:

• Log more errors.
• Handle malformed input in a better way.

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-reuse_tool-4
Explanation: Is it compliant with REUSE rules? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-assigned_teams-2
Explanation: Does it have an admin team on GitHub? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

At the moment, testing is very (read: non-existent) limited. This issue should add:

• Testing for start attributes.
• Testing for end attributes.
• Testing for splitting and joining gateways.
• Testing for transitivity.
• Testing for verifying if elements are part of an gateway construct.

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-vulnerability_alerts-1
Explanation: Are vulnerability alerts enabled? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-reuse_tool-3
Explanation: Is it registered in REUSE? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

At the moment, the parser only supports parsing of JSON files. However, BPMN files can also be stored in a XML format. This issue should:

• Add detection whether input is in XML or JSON format, reject all other.
• Change parsing depending on format.

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-assigned_teams-1
Explanation: Does it have enough teams on GitHub? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-license_file-1
Explanation: Does it have a license file? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-vulnerability_alerts-1
Explanation: Are vulnerability alerts enabled? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

At the moment, the parser deems some start and end events "bad", and instead opts to use the first activity instead. For example, in this BPMN diagram, the parser will mark register invoice as start, and accept invoice as end.

We should add a flag so it can include these when compiling to mermaid.

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-assigned_teams-5
Explanation: Does teams have enough members on GitHub? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-reuse_tool-2
Explanation: Does it have LICENSES directory with licenses? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-assigned_teams-3
Explanation: Does it have enough admins on GitHub? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

At the moment, the init constraint generated from the following diagram is Init[XOR].

• Fix so invalid names are not allowed as constraints (i.e., XOR should not be a valid name for a constraint).
• Fix so that the init constraint are as follows: Init[activity1], Init[activity2] (though, this should only be the case for XOR gateways preferably).

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-reuse_tool-1
Explanation: Does README mention REUSE? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

The parser does not seem to recognise the last activities in the following diagrams as ending, subsequently, the compiler does not generate End constraints for them.

Expected end constraints:

1. End[activity4]
2. End[activity5]

At the moment, the code is not properly documented. This issue should:

• Investigate the possibilities of using Sphinx or Pydoc as means for documentation.
• Document the parser.
• Document the compiler.
• Document the utils.
• Document all modules.
• Document the scripts.
• (Optional) Create a GitHub Action for hosting the documentation on GitHub pages.

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-vulnerability_alerts-1
Explanation: Are vulnerability alerts enabled? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html