Improve test suite by including CLI tests

Author: nl78

.gitignore

@@ -72,3 +72,10 @@ tests/fmi3/passthrough/results-container-passthrough.csv
 tests/remoting/bouncing_ball-win64.fmu
 tests/remoting/results-bouncing_ball-win32.csv
 tests/remoting/results-bouncing_ball-win64.csv
+/tests/containers/bouncing_ball/cli-bouncing/
+/tests/containers/ssp/bouncing.dir/
+tests/cli-bouncing_ball.csv
+tests/containers/bouncing_ball/cli-bouncing.fmu
+tests/containers/arch/cli-flat-dump.json
+tests/containers/arch/cli-flat.fmu
+

fmu_manipulation_toolbox/cli/fmucontainer.py

@@ -1,6 +1,8 @@
 import argparse
 import logging
+import sys
 
+from typing import *
 from pathlib import Path
 
 from .utils import setup_logger, make_wide
@@ -9,7 +11,7 @@
 from ..version import __version__ as version
 
 
-def fmucontainer():
+def fmucontainer(command_options: Sequence[str]):
     logger = setup_logger()
 
     logger.info(f"FMUContainer version {version}")
@@ -63,7 +65,7 @@ def fmucontainer():
     parser.add_argument("-dump-json",  action="store_true", dest="dump", default=False,
                         help="Dump a JSON file for each container.")
 
-    config = parser.parse_args()
+    config = parser.parse_args(command_options)
 
     if config.debug:
         logger.setLevel(logging.DEBUG)
@@ -88,16 +90,16 @@ def fmucontainer():
                                 auto_parameter=config.auto_parameter)
         except FileNotFoundError as e:
             logger.fatal(f"Cannot read file: {e}")
-            continue
+            sys.exit(-1)
         except (FMUContainerError, AssemblyError) as e:
             logger.fatal(f"{filename}: {e}")
-            continue
+            sys.exit(-2)
 
         try:
             assembly.make_fmu(dump_json=config.dump, fmi_version=int(config.fmi_version))
         except FMUContainerError as e:
             logger.fatal(f"{filename}: {e}")
-            continue
+            sys.exit(-3)
 
 if __name__ == "__main__":
-    fmucontainer()
+    fmucontainer(sys.argv[1:])

fmu_manipulation_toolbox/cli/fmusplit.py

@@ -1,12 +1,15 @@
 import argparse
 import logging
+import sys
+
+from typing import *
 
 from .utils import setup_logger, make_wide
 from ..split import FMUSplitter, FMUSplitterError
 from ..version import __version__ as version
 
 
-def fmusplit():
+def fmusplit(command_options: Sequence[str]):
     logger = setup_logger()
 
     logger.info(f"FMUSplit version {version}")
@@ -24,7 +27,7 @@ def fmusplit():
                         metavar="filename.fmu", required=True,
                         help="Description of the FMU container to split.")
 
-    config = parser.parse_args()
+    config = parser.parse_args(command_options)
 
     if config.debug:
         logger.setLevel(logging.DEBUG)
@@ -35,11 +38,11 @@ def fmusplit():
             splitter.split_fmu()
         except FMUSplitterError as e:
             logger.fatal(f"{fmu_filename}: {e}")
-            continue
+            sys.exit(-1)
         except FileNotFoundError as e:
             logger.fatal(f"Cannot read file: {e}")
-            continue
+            sys.exit(-2)
 
 
 if __name__ == "__main__":
-    fmusplit()
+    fmusplit(sys.argv[1:])

fmu_manipulation_toolbox/cli/fmutool.py

@@ -1,6 +1,8 @@
 import argparse
 import sys
 
+from typing import *
+
 from .utils import setup_logger, make_wide
 from ..operations import (OperationSummary, OperationError, OperationRemoveRegexp,
                           OperationRemoveSources, OperationTrimUntil, OperationKeepOnlyRegexp, OperationMergeTopLevel,
@@ -12,7 +14,7 @@
 from ..help import Help
 
 
-def fmutool():
+def fmutool(command_options: Sequence[str]):
     logger = setup_logger()
 
     logger.info(f"FMU Manipulation Toolbox version {version}")
@@ -68,7 +70,7 @@ def add_option(option, *args, **kwargs):
     add_option('-summary', action='append_const', dest='operations_list', const=OperationSummary())
     add_option('-check', action='append_const', dest='operations_list', const=[checker() for checker in checker_list])
 
-    cli_options = parser.parse_args()
+    cli_options = parser.parse_args(command_options)
     # handle the "no operation" use case
     if not cli_options.operations_list:
         cli_options.operations_list = []
@@ -121,4 +123,4 @@ def operation_iterator():
         logger.info(f"INFO    Modified FMU is not saved. If necessary use '-output' option.")
 
 if __name__ == "__main__":
-    fmutool()
+    fmutool(sys.argv[1:])

fmu_manipulation_toolbox/split.py

@@ -6,6 +6,8 @@
 from typing import *
 from pathlib import Path
 
+from .container import EmbeddedFMUPort
+
 logger = logging.getLogger("fmu_manipulation_toolbox")
 
 
@@ -66,7 +68,7 @@ def __del__(self):
     def split_fmu(self):
         logger.info(f"Splitting...")
         config = self._split_fmu(fmu_filename=str(self.fmu_filename), relative_path="")
-        config_filename = self.directory / self.fmu_filename.with_suffix(".json")
+        config_filename = self.directory / self.fmu_filename.with_suffix(".json").name
         with open(config_filename, "w") as file:
             json.dump(config, file, indent=2)
         logger.info(f"Container definition saved to '{config_filename}'")
@@ -77,7 +79,7 @@ def _split_fmu(self, fmu_filename: str, relative_path: str) -> Dict[str, Any]:
         if txt_filename in self.filenames_list:
             description = FMUSplitterDescription(self.zip)
             config = description.parse_txt_file(txt_filename)
-            config["name"] = fmu_filename
+            config["name"] = Path(fmu_filename).name
             for i, fmu_filename in enumerate(config["candidate_fmu"]):
                 directory = f"{relative_path}resources/{i:02x}/"
                 if directory not in self.dir_set:
@@ -134,6 +136,7 @@ def __init__(self, zip):
         self.current_vr = None
         self.current_name = None
         self.current_causality = None
+        self.supported_fmi_types: Tuple[str] = ()
 
     @staticmethod
     def get_line(file):
@@ -182,10 +185,12 @@ def parse_model_description(self, directory: str, fmu_filename: str):
     def parse_txt_file_header(self, file, txt_filename):
         flags = self.get_line(file).split(" ")
         if len(flags) == 1:
+            self.supported_fmi_types = ("Real", "Integer", "Boolean", "String")
             self.config["mt"] = flags[0] == "1"
             self.config["profiling"] = self.get_line(file) == "1"
             self.config["sequential"] = False
         elif len(flags) == 3:
+            self.supported_fmi_types = EmbeddedFMUPort.ALL_TYPES
             self.config["mt"] = flags[0] == "1"
             self.config["profiling"] = flags[1] == "1"
             self.config["sequential"] = flags[2] == "1"
@@ -242,7 +247,7 @@ def add_port(self, fmi_type: str, fmu_id: int, fmu_vr: int, container_vr: int):
             logger.debug(f"Adding container port {causality}: {definition}")
 
     def parse_txt_file_ports(self, file):
-        for fmi_type in ("Real", "Integer", "Boolean", "String"):
+        for fmi_type in self.supported_fmi_types:
             nb_port_variables = self.get_line(file).split(" ")[0]
             for i in range(int(nb_port_variables)):
                 tokens = self.get_line(file).split(" ")

tests/containers/arch/REF-cli-flat-dump.json

@@ -0,0 +1,38 @@
+{
+  "name": "cli-flat.fmu",
+  "mt": false,
+  "profiling": false,
+  "sequential": false,
+  "auto_link": true,
+  "auto_input": true,
+  "auto_output": true,
+  "auto_parameter": false,
+  "auto_local": false,
+  "step_size": 0.5,
+  "fmu": [
+    "gain.fmu",
+    "integrate.fmu",
+    "sine.fmu"
+  ],
+  "output": [
+    [
+      "gain.fmu",
+      "final",
+      "final"
+    ]
+  ],
+  "link": [
+    [
+      "sine.fmu",
+      "sine",
+      "integrate.fmu",
+      "sine"
+    ],
+    [
+      "integrate.fmu",
+      "integrate",
+      "gain.fmu",
+      "integrate"
+    ]
+  ]
+}

tests/containers/arch/cli-flat.json

@@ -0,0 +1,8 @@
+{
+  "fmu": [
+    "sine.fmu",
+    "integrate.fmu",
+    "gain.fmu"
+  ],
+  "step_size": 0.5
+}

tests/containers/bouncing_ball/cli-bouncing.csv

@@ -0,0 +1,7 @@
+rule;from_fmu;from_port;to_fmu;to_port
+FMU;bb_position.fmu;;;
+FMU;bb_velocity.fmu;;;
+OUTPUT;bb_position.fmu;position1;;position
+LINK;bb_position.fmu;is_ground;bb_velocity.fmu;reset
+LINK;bb_velocity.fmu;velocity;bb_position.fmu;velocity
+OUTPUT;bb_velocity.fmu;velocity;;

tests/containers/ssp/REF-split-bouncing.json

@@ -0,0 +1,16 @@
+{
+  "auto_input": false,
+  "auto_output": false,
+  "auto_parameter": false,
+  "auto_local": false,
+  "auto_link": false,
+  "mt": false,
+  "profiling": false,
+  "sequential": false,
+  "step_size": 0.001,
+  "name": "bouncing.fmu",
+  "fmu": [
+    "bb_velocity.fmu",
+    "bb_position.fmu"
+  ]
+}

tests/operations/cli-bouncing_ball.csv

@@ -0,0 +1,7 @@
+name;newName;valueReference;causality;variability;scalarType;startValue
+h;h;0;local;continuous;Real;1
+der(h);der(h);1;local;continuous;Real;
+v;v;2;local;continuous;Real;0
+der(v);der(v);3;local;continuous;Real;
+g;g;4;parameter;fixed;Real;9.81
+e;e;5;parameter;tunable;Real;0.7