Switch to keyword arguments on OSITrace, add tests

Add tests to ensure topic is correctly ignored for single trace files,
also fix formatting error in related_to code.

Signed-off-by: Pierre R. Mai <pmai@pmsf.de>

Author: pmai

qc_ositrace/checks/deserialization/deserialization_checker.py

@@ -68,10 +68,9 @@ def run_checks(config: Configuration, result: Result) -> None:
     try:
         try:
             trace = OSITrace(
-                config.get_config_param("InputFile"),
-                config.get_config_param("osiType"),
-                False,
-                config.get_config_param("osiTopic"),
+                path=config.get_config_param("InputFile"),
+                type_name=config.get_config_param("osiType"),
+                topic=config.get_config_param("osiTopic"),
             )
         except Exception as e:
             logging.error(f"Error reading input file: {e}")

qc_ositrace/checks/osirules/osirules_checker.py

@@ -406,7 +406,11 @@ def check_message_against_rules(
                         )
                     else:
                         # Check if referred message matches one of the expected types
-                        expected_types = ["osi3." + t for t in rule['refers_to']] if isinstance(rule['refers_to'], list) else ["osi3." + rule['refers_to']]
+                        expected_types = (
+                            ["osi3." + t for t in rule["refers_to"]]
+                            if isinstance(rule["refers_to"], list)
+                            else ["osi3." + rule["refers_to"]]
+                        )
                         if referred_message.DESCRIPTOR.full_name not in expected_types:
                             register_issue(
                                 result,
@@ -470,10 +474,9 @@ def run_checks(config: Configuration, result: Result) -> None:
     try:
         try:
             trace = OSITrace(
-                config.get_config_param("InputFile"),
-                expected_type_name,
-                False,
-                config.get_config_param("osiTopic"),
+                path=config.get_config_param("InputFile"),
+                type_name=expected_type_name,
+                topic=config.get_config_param("osiTopic"),
             )
         except Exception as e:
             logging.error(f"Error reading input file: {e}")

tests/test_deserialization_checks.py

@@ -94,3 +94,37 @@ def test_deserialization_mcap_topic(
     else:
         check_issues(rule_uid, issue_count, issue_severity)
     cleanup_files()
+
+
+@pytest.mark.parametrize(
+    "target_file,target_topic,target_type,target_version,issue_count",
+    [
+        ("360", "MySensorView", "SensorView", "3.5.0", 547),
+        ("360", "MySensorView", "SensorView", "3.6.0", 0),
+        ("360", "Foo", "SensorView", "3.5.0", 547),
+        ("360", "Foo", "SensorView", "3.6.0", 0),
+    ],
+)
+def test_deserialization_single_topic(
+    target_file: str,
+    target_topic: str,
+    target_type: str,
+    target_version: str,
+    issue_count: int,
+    monkeypatch,
+) -> None:
+    base_path = "tests/data/deserialization_expected_version/"
+    target_file_name = f"deserialization_expected_version_{target_file}.osi"
+    rule_uid = "asam.net:osi:3.0.0:deserialization.expected_version"
+    issue_severity = IssueSeverity.ERROR
+
+    target_file_path = os.path.join(base_path, target_file_name)
+    create_test_config(
+        target_file_path, target_type, target_version, None, target_topic
+    )
+    launch_main(monkeypatch)
+    if issue_count < 0:
+        check_failure(deserialization_checker_id)
+    else:
+        check_issues(rule_uid, issue_count, issue_severity)
+    cleanup_files()