Added check for replaced field names in source

Author: staudtMarius

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Extend Validation to EnergyManagement Systems. [#1356](https://github.com/ie3-institute/PowerSystemDataModel/issues/1356)
 - Added `CITATION.cff` [#1380](https://github.com/ie3-institute/PowerSystemDataModel/issues/1380)
+- Added check for replaced field names in sources [#1383](https://github.com/ie3-institute/PowerSystemDataModel/issues/1383)
 
 ### Fixed
 - Fixed handling of `CongestionResult.InputModelType` in `EntityProcessor` [#1325](https://github.com/ie3-institute/PowerSystemDataModel/issues/1325)

src/main/java/edu/ie3/datamodel/io/factory/Factory.java

@@ -111,24 +111,36 @@ private void isSupportedClass(Class<?> desiredClass) {
    */
   protected abstract List<Set<String>> getFields(Class<?> entityClass);
 
+  /**
+   * Returns a map: old field name to new field name.
+   *
+   * @param entityClass class that can be used to specify the fields that are returned
+   * @return map of replaced field names
+   */
+  protected Map<String, String> getReplacedFields(Class<?> entityClass) {
+    return Collections.emptyMap();
+  }
+
   /**
    * Method to find and return additional fields that were found in a source and are not used by the
    * data model. This method will return the minimal unused fields among all field sets, meaning
    * that the set of actual fields is compared to the field set with the least unused fields.
    *
    * @param actualFields found in the source
    * @param validFieldSets that contains at least all fields found in the source
+   * @param replacedFields fields, that are replaced and therefore, reported as unused
    * @return a set of unused fields
    */
   protected Set<String> getUnusedFields(
-      Set<String> actualFields, List<Set<String>> validFieldSets) {
+      Set<String> actualFields, List<Set<String>> validFieldSets, Set<String> replacedFields) {
     // checking for additional fields
     // and returning the set with the least additional fields
     return validFieldSets.stream()
         .map(
             s -> {
               Set<String> set = new HashSet<>(actualFields);
               set.removeAll(s);
+              set.removeAll(replacedFields);
               return set;
             })
         .min(Comparator.comparing(Collection::size))
@@ -174,10 +186,30 @@ public Try<Void, ValidationException> validate(
                   + "' are possible (NOT case-sensitive!):\n"
                   + possibleOptions));
     } else {
-      Set<String> unused = getUnusedFields(harmonizedActualFields, validFieldSets);
+      // find all replaced fields
+      Map<String, String> replacedFields = getReplacedFields(entityClass);
+
+      Set<String> unsupportedFields =
+          actualFields.stream().filter(replacedFields::containsKey).collect(Collectors.toSet());
+
+      if (!unsupportedFields.isEmpty()) {
+        List<String> strings =
+            unsupportedFields.stream()
+                .map(field -> field + " -> " + replacedFields.get(field))
+                .toList();
+
+        log.warn(
+            "The following field were renamed '{}'. Please rename field like: [{}]",
+            unsupportedFields,
+            String.join(", ", strings));
+      }
+
+      // find all unused fields
+      Set<String> unused =
+          getUnusedFields(harmonizedActualFields, validFieldSets, replacedFields.keySet());
 
       if (!unused.isEmpty()) {
-        log.debug(
+        log.info(
             "The following additional fields were found for entity class of '{}': {}",
             entityClass.getSimpleName(),
             unused);
@@ -216,6 +248,17 @@ protected static TreeSet<String> newSet(String... attributes) {
     return set;
   }
 
+  protected static Map.Entry<String, String> entry(String key, String value) {
+    return new AbstractMap.SimpleEntry<>(key, value);
+  }
+
+  @SafeVarargs
+  protected static Map<String, String> newMap(Map.Entry<String, String>... attributes) {
+    Map<String, String> map = new HashMap<>();
+    Arrays.stream(attributes).forEach(e -> map.put(e.getKey(), e.getValue()));
+    return map;
+  }
+
   /**
    * Expands a set of attributes with further attributes. This method should always be used when
    * returning attribute sets, i.e. through getting the needed fields. The set maintains a

src/main/java/edu/ie3/datamodel/io/factory/input/EmInputFactory.java

@@ -38,4 +38,9 @@ protected EmInput buildModel(
 
     return new EmInput(uuid, id, operator, operationTime, controlStrategy, parentEm);
   }
+
+  @Override
+  protected Map<String, String> getReplacedFields(Class<?> entityClass) {
+    return newMap(entry("parentEm", CONTROLLING_EM));
+  }
 }

src/main/java/edu/ie3/datamodel/io/factory/input/participant/SystemParticipantInputEntityFactory.java

@@ -30,18 +30,24 @@ public abstract class SystemParticipantInputEntityFactory<
         T extends SystemParticipantInput, D extends SystemParticipantEntityData>
     extends AssetInputEntityFactory<T, D> {
 
+  private static final String NODE = "node";
+
   private static final String Q_CHARACTERISTICS = "qCharacteristics";
 
   public static final String CONTROLLING_EM = "controllingEm";
 
+  @SafeVarargs
   protected SystemParticipantInputEntityFactory(Class<? extends T>... allowedClasses) {
     super(allowedClasses);
   }
 
   @Override
   protected List<Set<String>> getFields(Class<?> entityClass) {
     List<Set<String>> fields = new ArrayList<>(super.getFields(entityClass));
-    for (Set<String> set : fields) set.add(Q_CHARACTERISTICS);
+    for (Set<String> set : fields) {
+      set.add(Q_CHARACTERISTICS);
+      set.add(NODE);
+    }
 
     List<Set<String>> withEm =
         fields.stream().map(f -> (Set<String>) expandSet(f, CONTROLLING_EM)).toList();
@@ -51,6 +57,11 @@ protected List<Set<String>> getFields(Class<?> entityClass) {
     return fields;
   }
 
+  @Override
+  protected Map<String, String> getReplacedFields(Class<?> entityClass) {
+    return newMap(entry("em", CONTROLLING_EM));
+  }
+
   @Override
   protected T buildModel(
       D data, UUID uuid, String id, OperatorInput operator, OperationTime operationTime) {

src/test/groovy/edu/ie3/datamodel/io/factory/FactoryTest.groovy

@@ -6,6 +6,7 @@
 package edu.ie3.datamodel.io.factory
 
 import edu.ie3.datamodel.exceptions.FactoryException
+import edu.ie3.datamodel.models.input.EmInput
 import edu.ie3.datamodel.utils.Try
 import spock.lang.Shared
 import spock.lang.Specification
@@ -17,7 +18,7 @@ class FactoryTest extends Specification {
 
   def "A Factory can return unused fields correctly"() {
     when:
-    def unused = factory.getUnusedFields(actualFields as Set<String>, validFieldSets)
+    def unused = factory.getUnusedFields(actualFields as Set<String>, validFieldSets, [] as Set<String>)
 
     then:
     unused == expected as Set<String>
@@ -97,5 +98,14 @@ class FactoryTest extends Specification {
         ["id", "time", "value1"] as Set<String>
       ]
     }
+
+    @Override
+    protected Map<String, String> getReplacedFields(Class<?> entityClass) {
+      if (entityClass.isAssignableFrom(EmInput)) {
+        return ["parentEm": "controllingEM"]
+      } else {
+        return [:]
+      }
+    }
   }
 }

src/test/groovy/edu/ie3/datamodel/io/factory/input/participant/FixedFeedInInputFactoryTest.groovy

@@ -88,21 +88,21 @@ class FixedFeedInInputFactoryTest extends Specification implements FactoryTestHe
     input.failure
     input.exception.get().message == "The provided fields [cosphi_rated, id, s_rated, uuid] are invalid for instance of 'FixedFeedInInput'. \n" +
         "The following fields (without complex objects e.g. nodes, operators, ...) to be passed to a constructor of 'FixedFeedInInput' are possible (NOT case-sensitive!):\n" +
-        "0: [cosPhiRated, id, qCharacteristics, sRated, uuid] or [cos_phi_rated, id, q_characteristics, s_rated, uuid]\n" +
-        "1: [cosPhiRated, id, operatesFrom, qCharacteristics, sRated, uuid] or [cos_phi_rated, id, operates_from, q_characteristics, s_rated, uuid]\n" +
-        "2: [cosPhiRated, id, operatesUntil, qCharacteristics, sRated, uuid] or [cos_phi_rated, id, operates_until, q_characteristics, s_rated, uuid]\n" +
-        "3: [cosPhiRated, id, operatesFrom, operatesUntil, qCharacteristics, sRated, uuid] or [cos_phi_rated, id, operates_from, operates_until, q_characteristics, s_rated, uuid]\n" +
-        "4: [cosPhiRated, id, operator, qCharacteristics, sRated, uuid] or [cos_phi_rated, id, operator, q_characteristics, s_rated, uuid]\n" +
-        "5: [cosPhiRated, id, operatesFrom, operator, qCharacteristics, sRated, uuid] or [cos_phi_rated, id, operates_from, operator, q_characteristics, s_rated, uuid]\n" +
-        "6: [cosPhiRated, id, operatesUntil, operator, qCharacteristics, sRated, uuid] or [cos_phi_rated, id, operates_until, operator, q_characteristics, s_rated, uuid]\n" +
-        "7: [cosPhiRated, id, operatesFrom, operatesUntil, operator, qCharacteristics, sRated, uuid] or [cos_phi_rated, id, operates_from, operates_until, operator, q_characteristics, s_rated, uuid]\n" +
-        "8: [controllingEm, cosPhiRated, id, qCharacteristics, sRated, uuid] or [controlling_em, cos_phi_rated, id, q_characteristics, s_rated, uuid]\n" +
-        "9: [controllingEm, cosPhiRated, id, operatesFrom, qCharacteristics, sRated, uuid] or [controlling_em, cos_phi_rated, id, operates_from, q_characteristics, s_rated, uuid]\n" +
-        "10: [controllingEm, cosPhiRated, id, operatesUntil, qCharacteristics, sRated, uuid] or [controlling_em, cos_phi_rated, id, operates_until, q_characteristics, s_rated, uuid]\n" +
-        "11: [controllingEm, cosPhiRated, id, operatesFrom, operatesUntil, qCharacteristics, sRated, uuid] or [controlling_em, cos_phi_rated, id, operates_from, operates_until, q_characteristics, s_rated, uuid]\n" +
-        "12: [controllingEm, cosPhiRated, id, operator, qCharacteristics, sRated, uuid] or [controlling_em, cos_phi_rated, id, operator, q_characteristics, s_rated, uuid]\n" +
-        "13: [controllingEm, cosPhiRated, id, operatesFrom, operator, qCharacteristics, sRated, uuid] or [controlling_em, cos_phi_rated, id, operates_from, operator, q_characteristics, s_rated, uuid]\n" +
-        "14: [controllingEm, cosPhiRated, id, operatesUntil, operator, qCharacteristics, sRated, uuid] or [controlling_em, cos_phi_rated, id, operates_until, operator, q_characteristics, s_rated, uuid]\n" +
-        "15: [controllingEm, cosPhiRated, id, operatesFrom, operatesUntil, operator, qCharacteristics, sRated, uuid] or [controlling_em, cos_phi_rated, id, operates_from, operates_until, operator, q_characteristics, s_rated, uuid]\n"
+        "0: [cosPhiRated, id, node, qCharacteristics, sRated, uuid] or [cos_phi_rated, id, node, q_characteristics, s_rated, uuid]\n" +
+        "1: [cosPhiRated, id, node, operatesFrom, qCharacteristics, sRated, uuid] or [cos_phi_rated, id, node, operates_from, q_characteristics, s_rated, uuid]\n" +
+        "2: [cosPhiRated, id, node, operatesUntil, qCharacteristics, sRated, uuid] or [cos_phi_rated, id, node, operates_until, q_characteristics, s_rated, uuid]\n" +
+        "3: [cosPhiRated, id, node, operatesFrom, operatesUntil, qCharacteristics, sRated, uuid] or [cos_phi_rated, id, node, operates_from, operates_until, q_characteristics, s_rated, uuid]\n" +
+        "4: [cosPhiRated, id, node, operator, qCharacteristics, sRated, uuid] or [cos_phi_rated, id, node, operator, q_characteristics, s_rated, uuid]\n" +
+        "5: [cosPhiRated, id, node, operatesFrom, operator, qCharacteristics, sRated, uuid] or [cos_phi_rated, id, node, operates_from, operator, q_characteristics, s_rated, uuid]\n" +
+        "6: [cosPhiRated, id, node, operatesUntil, operator, qCharacteristics, sRated, uuid] or [cos_phi_rated, id, node, operates_until, operator, q_characteristics, s_rated, uuid]\n" +
+        "7: [cosPhiRated, id, node, operatesFrom, operatesUntil, operator, qCharacteristics, sRated, uuid] or [cos_phi_rated, id, node, operates_from, operates_until, operator, q_characteristics, s_rated, uuid]\n" +
+        "8: [controllingEm, cosPhiRated, id, node, qCharacteristics, sRated, uuid] or [controlling_em, cos_phi_rated, id, node, q_characteristics, s_rated, uuid]\n" +
+        "9: [controllingEm, cosPhiRated, id, node, operatesFrom, qCharacteristics, sRated, uuid] or [controlling_em, cos_phi_rated, id, node, operates_from, q_characteristics, s_rated, uuid]\n" +
+        "10: [controllingEm, cosPhiRated, id, node, operatesUntil, qCharacteristics, sRated, uuid] or [controlling_em, cos_phi_rated, id, node, operates_until, q_characteristics, s_rated, uuid]\n" +
+        "11: [controllingEm, cosPhiRated, id, node, operatesFrom, operatesUntil, qCharacteristics, sRated, uuid] or [controlling_em, cos_phi_rated, id, node, operates_from, operates_until, q_characteristics, s_rated, uuid]\n" +
+        "12: [controllingEm, cosPhiRated, id, node, operator, qCharacteristics, sRated, uuid] or [controlling_em, cos_phi_rated, id, node, operator, q_characteristics, s_rated, uuid]\n" +
+        "13: [controllingEm, cosPhiRated, id, node, operatesFrom, operator, qCharacteristics, sRated, uuid] or [controlling_em, cos_phi_rated, id, node, operates_from, operator, q_characteristics, s_rated, uuid]\n" +
+        "14: [controllingEm, cosPhiRated, id, node, operatesUntil, operator, qCharacteristics, sRated, uuid] or [controlling_em, cos_phi_rated, id, node, operates_until, operator, q_characteristics, s_rated, uuid]\n" +
+        "15: [controllingEm, cosPhiRated, id, node, operatesFrom, operatesUntil, operator, qCharacteristics, sRated, uuid] or [controlling_em, cos_phi_rated, id, node, operates_from, operates_until, operator, q_characteristics, s_rated, uuid]\n"
   }
 }