catch case where a key with a concept name has an equivalent non-variadic key in the template already

Author: lukaspie

src/pynxtools/dataconverter/helpers.py

@@ -73,6 +73,7 @@ class ValidationProblem(Enum):
     ReservedSuffixWithoutField = auto()
     ReservedPrefixInWrongContext = auto()
     InvalidNexusTypeForNamedConcept = auto()
+    KeysWithAndWithoutConcept = auto()
 
 
 class Collector:
@@ -185,6 +186,11 @@ def _log(self, path: str, log_type: ValidationProblem, value: Optional[Any], *ar
                 f"The type ('{args[0] if args else '<unknown>'}') of the given concept '{path}' "
                 f"conflicts with another existing concept of the same name, which is of type '{value.type}'."
             )
+        elif log_type == ValidationProblem.KeysWithAndWithoutConcept:
+            value = cast(Any, value)
+            logger.warning(
+                f"The key '{path}' uses the valid concept name '{args[0]}', but there is another valid key {value} that uses the non-variadic name of the node.'"
+            )
 
     def collect_and_log(
         self,

src/pynxtools/dataconverter/validation.py

@@ -898,6 +898,30 @@ def find_instance_name_conflicts(mapping: MutableMapping[str, str]) -> None:
 
                 # Determine the parent path up to just before this match
                 parent_path = key[: match.start()]
+                child_path = key[match.start() :].split("/", 1)[-1]
+
+                # Here we check if for this key with a concept name, another valid key
+                # with a non-concept name exists.
+                non_concept_key = f"{parent_path}{instance_name}/{child_path}"
+
+                if non_concept_key in mapping:
+                    try:
+                        node = add_best_matches_for(non_concept_key, tree)
+                        if node is not None:
+                            collector.collect_and_log(
+                                key,
+                                ValidationProblem.KeysWithAndWithoutConcept,
+                                non_concept_key,
+                                concept_name,
+                            )
+                            collector.collect_and_log(
+                                key, ValidationProblem.KeyToBeRemoved, "key"
+                            )
+                            keys_to_remove.append(key)
+                            continue
+                    except TypeError:
+                        pass
+
                 instance_usage[(instance_name, parent_path)].append((concept_name, key))
 
         for (instance_name, parent_path), entries in sorted(instance_usage.items()):

tests/dataconverter/test_validation.py

@@ -234,6 +234,20 @@ def listify_template(data_dict: Template):
 @pytest.mark.parametrize(
     "data_dict,error_messages",
     [
+        pytest.param(
+            alter_dict(
+                TEMPLATE,
+                "/ENTRY[my_entry]/NOTE[required_group2]/description",
+                "an additional description",
+            ),
+            [
+                "The key '/ENTRY[my_entry]/NOTE[required_group2]/description' uses the valid concept name 'NOTE', "
+                "but there is another valid key /ENTRY[my_entry]/required_group2/description that uses the non-variadic "
+                "name of the node.'",
+                "The key /ENTRY[my_entry]/NOTE[required_group2]/description will not be written.",
+            ],
+            id="same-concept-with-and-without-concept-name",
+        ),
         pytest.param(
             alter_dict(
                 alter_dict(