Add minimum_/maximum_length rules and checks (#16)

Allows checking of repeated fields for a minimum or maximum number of
entries.

Signed-off-by: Pierre R. Mai <pmai@pmsf.de>
Co-authored-by: Carlo van Driesten <carlo.van-driesten@bmw.de>

Author: pmai

qc_ositrace/checks/osirules/osirules_checker.py

@@ -142,6 +142,10 @@ def evaluate_rule_condition(
         return False
     if "is_set" in rule:
         return True
+    if "minimum_length" in rule and len(values) >= rule["minimum_length"]:
+        return True
+    if "maximum_length" in rule and len(values) <= rule["maximum_length"]:
+        return True
     if "is_greater_than" in rule and all(
         [value > rule["is_greater_than"] for value in values]
     ):
@@ -196,8 +200,10 @@ def check_message_against_rules(
             continue
         if field_descriptor.label == field_descriptor.LABEL_REPEATED:
             has_field = True
+            values = getattr(message, field_name)
         else:
             has_field = message.HasField(field_name)
+            values = [getattr(message, field_name)] if has_field else []
         for rule_uid, rule in rules:
             if "is_set" in rule and not has_field:
                 register_issue(
@@ -209,6 +215,26 @@ def check_message_against_rules(
                     IssueSeverity.ERROR,
                     description=f"Field '{field_name}' is not set in message '{message.DESCRIPTOR.full_name}' but should be set.",
                 )
+            if "minimum_length" in rule and len(values) < rule["minimum_length"]:
+                register_issue(
+                    result,
+                    message,
+                    index,
+                    time,
+                    rule_uid,
+                    IssueSeverity.ERROR,
+                    description=f"Field '{field_name}' in message '{message.DESCRIPTOR.full_name}' has less than {rule['minimum_length']} entries.",
+                )
+            if "maximum_length" in rule and len(values) > rule["maximum_length"]:
+                register_issue(
+                    result,
+                    message,
+                    index,
+                    time,
+                    rule_uid,
+                    IssueSeverity.ERROR,
+                    description=f"Field '{field_name}' in message '{message.DESCRIPTOR.full_name}' has more than {rule['maximum_length']} entries.",
+                )
             if (
                 "check_if" in rule
                 and "do_check" in rule

tests/data/customrules/customrules.yml

@@ -12,6 +12,11 @@ GroundTruth:
     - is_set:
   map_reference:
     - is_set:
+  stationary_object:
+    - minimum_length: 1
+  moving_object:
+    - minimum_length: 1
+    - maximum_length: 1
 MovingObject:
   id:
   base:
@@ -51,4 +56,4 @@ BaseMoving:
   velocity:
     - is_set:
   acceleration:
-    - is_set:
+    - is_set:

tests/test_osirules_checks.py

@@ -143,6 +143,20 @@ def test_osirules_automatic_rules(
             "groundtruth.map_reference.is_set",
             547,
         ),
+        (
+            "deserialization_expected_version/deserialization_expected_version_360.osi",
+            "SensorView",
+            "3.6.0",
+            "groundtruth.stationary_object.minimum_length_1",
+            547,
+        ),
+        (
+            "deserialization_expected_version/deserialization_expected_version_360.osi",
+            "SensorView",
+            "3.6.0",
+            "groundtruth.moving_object.maximum_length_1",
+            547,
+        ),
     ],
 )
 def test_osirules_custom_rules(