G002-bugfix

[ModelExecutionException] catch exception if ModelExecutionCmd.run() is used

[bugfix] [ModelicaSystem] fix exception; use ModelicaSystemError (instead of wrong ModelExecutionException)

[bugfix] [ModelicaSystemABC] fix _prepare_input_data() - ensure returned data is dict[str, str]

Author: syntron

OMPython/ModelicaSystem.py

@@ -140,7 +140,7 @@ def getContinuous(
                     retval3.append(str(val))
             return retval3
 
-        raise ModelExecutionException("Invalid data!")
+        raise ModelicaSystemError("Invalid data!")
 
     def getOutputs(
             self,
@@ -167,7 +167,7 @@ def getOutputs(
                     retval3.append(str(val))
             return retval3
 
-        raise ModelExecutionException("Invalid data!")
+        raise ModelicaSystemError("Invalid data!")
 
 
 class ModelicaSystemDoE(ModelicaDoEOMC):
@@ -209,7 +209,8 @@ def get_exe(self) -> pathlib.Path:
         return path_exe
 
     def get_cmd(self) -> list:
-        """Get a list with the path to the executable and all command line args.
+        """
+        Get a list with the path to the executable and all command line args.
 
         This can later be used as an argument for subprocess.run().
         """
@@ -218,6 +219,10 @@ def get_cmd(self) -> list:
 
         return cmdl
 
-    def run(self):
+    def run(self) -> int:
         cmd_definition = self.definition()
-        return cmd_definition.run()
+        try:
+            returncode = cmd_definition.run()
+        except ModelExecutionException as exc:
+            raise ModelicaSystemError(f"Cannot execute model: {exc}") from exc
+        return returncode

OMPython/modelica_doe_abc.py

@@ -14,6 +14,7 @@
 
 from OMPython.model_execution import (
     ModelExecutionData,
+    ModelExecutionException,
 )
 from OMPython.om_session_abc import (
     OMPathABC,
@@ -310,8 +311,8 @@ def worker(worker_id, task_queue):
                     returncode = cmd_definition.run()
                     logger.info(f"[Worker {worker_id}] Simulation {resultpath.name} "
                                 f"finished with return code: {returncode}")
-                except ModelicaSystemError as ex:
-                    logger.warning(f"Simulation error for {resultpath.name}: {ex}")
+                except ModelExecutionException as exc:
+                    logger.warning(f"Simulation error for {resultpath.name}: {exc}")
 
                 # Mark the task as done
                 task_queue.task_done()

OMPython/modelica_system_abc.py

@@ -18,6 +18,7 @@
 
 from OMPython.model_execution import (
     ModelExecutionCmd,
+    ModelExecutionException,
 )
 from OMPython.om_session_abc import (
     OMPathABC,
@@ -199,7 +200,10 @@ def check_model_executable(self):
         # ... by running it - output help for command help
         om_cmd.arg_set(key="help", val="help")
         cmd_definition = om_cmd.definition()
-        returncode = cmd_definition.run()
+        try:
+            returncode = cmd_definition.run()
+        except ModelExecutionException as exc:
+            raise ModelicaSystemError(f"Cannot execute model: {exc}") from exc
         if returncode != 0:
             raise ModelicaSystemError("Model executable not working!")
 
@@ -730,7 +734,10 @@ def simulate(
             self._result_file.unlink()
         # ... run simulation ...
         cmd_definition = om_cmd.definition()
-        returncode = cmd_definition.run()
+        try:
+            returncode = cmd_definition.run()
+        except ModelExecutionException as exc:
+            raise ModelicaSystemError(f"Cannot execute model: {exc}") from exc
         # and check returncode *AND* resultfile
         if returncode != 0 and self._result_file.is_file():
             # check for an empty (=> 0B) result file which indicates a crash of the model executable
@@ -758,8 +765,10 @@ def prepare_str(str_in: str) -> dict[str, str]:
             key_val_list: list[str] = str_in.split("=")
             if len(key_val_list) != 2:
                 raise ModelicaSystemError(f"Invalid 'key=value' pair: {str_in}")
+            if len(key_val_list[0]) == 0:
+                raise ModelicaSystemError(f"Empty key: {str_in}")
 
-            input_data_from_str: dict[str, str] = {key_val_list[0]: key_val_list[1]}
+            input_data_from_str: dict[str, str] = {str(key_val_list[0]): str(key_val_list[1])}
 
             return input_data_from_str
 
@@ -785,7 +794,12 @@ def prepare_str(str_in: str) -> dict[str, str]:
                         raise ModelicaSystemError(f"Invalid input data type for set*() function: {type(item)}!")
                     input_data = input_data | prepare_str(item)
             elif isinstance(input_arg, dict):
-                input_data = input_data | input_arg
+                input_arg_str: dict[str, str] = {}
+                for key, val in input_arg.items():
+                    if not isinstance(key, str) or len(key) == 0:
+                        raise ModelicaSystemError(f"Invalid key for set*() functions: {repr(key)}")
+                    input_arg_str[key] = str(val)
+                input_data = input_data | input_arg_str
             else:
                 raise ModelicaSystemError(f"Invalid input data type for set*() function: {type(input_arg)}!")
 
@@ -1173,7 +1187,10 @@ def linearize(
         linear_file.unlink(missing_ok=True)
 
         cmd_definition = om_cmd.definition()
-        returncode = cmd_definition.run()
+        try:
+            returncode = cmd_definition.run()
+        except ModelExecutionException as exc:
+            raise ModelicaSystemError(f"Cannot execute model: {exc}") from exc
         if returncode != 0:
             raise ModelicaSystemError(f"Linearize failed with return code: {returncode}")
         if not linear_file.is_file():