Add BPMN DI layout generation at the end of the Simod run. Closes #154

The current problem was that (a) SplitMiner CLI tool didn't generate BPMN DI part of the BPMN; (b) during the extraneous timers discovery new elements are added to the control flow, so a new layout generation has been required.

This commit adds a Java dependency to run on a BPMN file with the control flow to add the generated diagram in the XML format.

Author: iharsuvorau

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "simod"
-version = "4.0.3"
+version = "4.1.0"
 authors = [
     "Ihar Suvorau <ihar.suvorau@gmail.com>",
     "David Chapela <david.chapela@ut.ee>",

src/simod/control_flow/discovery.py

@@ -9,7 +9,8 @@
 )
 from simod.utilities import execute_external_command, is_windows
 
-split_miner_jar_path: Path = Path(__file__).parent / "lib/splitminer-1.6-all.jar"
+split_miner_jar_path: Path = Path(__file__).parent / "lib/split-miner-1.7.1-all.jar"
+bpmn_layout_jar_path: Path = Path(__file__).parent / "lib/bpmn-layout-1.0.6-jar-with-dependencies.jar"
 
 
 def discover_process_model(log_path: Path, output_model_path: Path, params: HyperoptIterationParams):
@@ -40,6 +41,21 @@ def discover_process_model(log_path: Path, output_model_path: Path, params: Hype
     assert output_model_path.exists(), f"Error trying to discover the process model in '{output_model_path}'."
 
 
+def add_bpmn_diagram_to_model(bpmn_model_path: Path):
+    """
+    Add BPMN diagram to the control flow of the existing BPMN model using the hierarchical layout algorithm.
+    This function overwrites the existing BPMN model file.
+
+    :param bpmn_model_path:
+    :return: None
+    """
+    global bpmn_layout_jar_path
+
+    args = ["java", "-jar", str(bpmn_layout_jar_path), str(bpmn_model_path)]
+    print_step(f"Adding BPMN diagram to the model: {args}")
+    execute_external_command(args)
+
+
 @dataclass
 class SplitMinerV1Settings:
     log_path: Path

src/simod/control_flow/lib/bpmn-layout-1.0.6-jar-with-dependencies.jar

@@ -17,7 +17,7 @@
 from simod.batching.discovery import discover_batching_rules
 from simod.case_attributes.discovery import discover_case_attributes
 from simod.cli_formatter import print_section, print_subsection
-from simod.control_flow.discovery import discover_process_model
+from simod.control_flow.discovery import discover_process_model, add_bpmn_diagram_to_model
 from simod.control_flow.optimizer import ControlFlowOptimizer
 from simod.control_flow.settings import HyperoptIterationParams as ControlFlowHyperoptIterationParams
 from simod.event_log.event_log import EventLog
@@ -238,6 +238,9 @@ def run(self):
             self._clean_up()
         self._settings.to_yaml(self._best_result_dir)
 
+        # --- Add BPMN diagram to the model --- #
+        add_bpmn_diagram_to_model(self.final_bps_model.process_model)
+
     def _optimize_control_flow(self) -> ControlFlowHyperoptIterationParams:
         """
         Control-flow and Gateway Probabilities discovery.