Increase consistency and readability of feedback message in some check functions

Author: cwang39403

esdlvalidator/validation/functions/check_has_pair.py

@@ -38,17 +38,18 @@ def execute(self):
             raise TypeError(f"Expect '{property}' to a string, got {type(p)}.")
 
         msg = None
+        entity_type = type(self.value).__name__
         if keyword in p:
             p_paired = p.replace(keyword, "")
             if p_paired not in properties:
-                msg = f"{self.value.name} (id: {self.value.id}) does not have a paired entity with [{property}] = '{p_paired}'"
+                msg = f"[{entity_type}] with [name] = '{self.value.name}' does not have a paired entity with [{property}] = '{p_paired}'"
         else:
             has_paired = any(
                 keyword in item and item.replace(keyword, "") == p 
                 for item in properties
             )
             if not has_paired:
-                msg = f"{self.value.name} (id: {self.value.id}) does not have a paired entity with [{property}] containing: '{p}' and '{keyword}'"
+                msg = f"[{entity_type}] with [name] = '{self.value.name}' does not have a paired entity with [{property}] containing: '{p}' and '{keyword}'"
 
         if msg:
             if self.args.get("resultMsgJSON"):

esdlvalidator/validation/functions/check_is_supported_types.py

@@ -36,7 +36,7 @@ def execute(self):
 
         if not supported_type:
             entity_type = type(self.value).__name__
-            result = f"{self.value.id} is of type {entity_type}, which is not included in the supported types [{', '.join(types)}]."
+            result = f"{self.value.name} is of type [{entity_type}], which is not included in the supported types [{', '.join(types)}]."
 
         if self.args.get("resultMsgJSON"):
             msg = {"offending_asset": self.value.id, "message": result}

esdlvalidator/validation/functions/check_property_uniqueness.py

@@ -30,7 +30,7 @@ def execute(self):
         if p is not None:
             counts = properties.count(p)
             if counts > 1:
-                msg = f"{self.value.id} has a non-unique [{property}] ({p}), it occurs {counts} times in this ESDL"
+                msg = f"[{property}] should be unique, but found ({counts}) assets with [{property}] = '{p}' in this ESDL."
                 if self.args.get("resultMsgJSON"):
                     result = { "offending_asset": self.value.id, "message": msg }
                     return CheckResult(False, result)

esdlvalidator/validation/functions/check_reference_attributes_comparison.py

@@ -126,8 +126,8 @@ def execute(self):
         left_entity = self._resolve_reference(entity, left_args.get("ref"), results)
         right_entity = self._resolve_reference(entity, right_args.get("ref"), results)
 
-        left_val = self._get_attribute_value(left_entity, left_args, results)
-        right_val = self._get_attribute_value(right_entity, right_args, results)
+        left_val = self._get_attribute_value(left_entity, left_args, results) if left_entity else None
+        right_val = self._get_attribute_value(right_entity, right_args, results) if right_entity else None
 
         if left_val is not None and right_val is not None:
             results.extend(self._compare_values(left_val, right_val, operator, left_args, right_args))

esdlvalidator/validation/functions/check_reference_count_in_range.py

@@ -32,7 +32,7 @@ def execute(self):
 
         r = utils.get_attribute(self.value, referenceType)
         if r is None:
-            raise ValueError(f"{self.value.id} ({self.value.name}) has no reference '{referenceType}'")
+            raise ValueError(f"{self.value.name} (id: {self.value.id}) has no reference '{referenceType}'")
         if not isinstance(r, Iterable):
             raise TypeError(f"Reference '{referenceType}' is not iterable")