Merge branch 'dev' into ms/#1182-add-getPreviousValue-to-TimeSeriesSource

# Conflicts:
#	CHANGELOG.md

Author: staudtMarius

CHANGELOG.md

@@ -11,9 +11,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Enhance `WeatherSource` with method to retrieve all time keys after a given key [#572](https://github.com/ie3-institute/PowerSystemDataModel/issues/572)
 - Adding timeseries for voltage values [#1128](https://github.com/ie3-institute/PowerSystemDataModel/issues/1128)
 - Added Staudt to list of reviewers [#1190](https://github.com/ie3-institute/PowerSystemDataModel/issues/1190)
+- Extend ValidationUtils for validating ThermalGrids [#1216](https://github.com/ie3-institute/PowerSystemDataModel/issues/1216) 
 - Enhance `TimeSeriesSource` with method to retrieve the previous value before a given key [#1182](https://github.com/ie3-institute/PowerSystemDataModel/issues/1182)
 
 ### Fixed
+- Removing opened `SwitchInput` during connectivity check [#1221](https://github.com/ie3-institute/PowerSystemDataModel/issues/1221)
 
 ### Changed
 - Storage minimum level parameter removed from cylindrical thermal storage [#1123](https://github.com/ie3-institute/PowerSystemDataModel/issues/1123)
@@ -24,6 +26,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Converted `MappingEntry` into a normal class [#1087](https://github.com/ie3-institute/PowerSystemDataModel/issues/1087)
 - Renamed timeseries mapping `participant` column to `asset` [#1191](https://github.com/ie3-institute/PowerSystemDataModel/issues/1191)
 - Removed attribute `dsm` from `LoadInput` [#1195](https://github.com/ie3-institute/PowerSystemDataModel/issues/1195)
+- Fix spotless deprecations [#1123](https://github.com/ie3-institute/PowerSystemDataModel/issues/1223)
 
 ## [5.1.0] - 2024-06-24
 

build.gradle

@@ -5,7 +5,7 @@ plugins {
   id 'signing'
   id 'pmd' // code check, working on source code
   id 'com.diffplug.spotless' version '7.0.2' //code format
-  id 'com.github.spotbugs' version '6.1.0' // code check, working on byte code
+  id 'com.github.spotbugs' version '6.1.3' // code check, working on byte code
   id 'de.undercouch.download' version '5.6.0'
   id 'kr.motd.sphinx' version '2.10.1' // documentation generation
   id 'jacoco' // java code coverage plugin
@@ -17,7 +17,7 @@ ext {
   //version (changing these should be considered thoroughly!)
   javaVersion = JavaVersion.VERSION_17
   groovyVersion = "4.0"
-  groovyBinaryVersion = "4.0.24"
+  groovyBinaryVersion = "4.0.25"
   testcontainersVersion = '1.20.4'
 
   scriptsLocation = 'gradle' + File.separator + 'scripts' + File.separator //location of script plugins
@@ -73,7 +73,7 @@ dependencies {
   testImplementation 'org.junit.jupiter:junit-jupiter:5.11.4'
   testImplementation "org.spockframework:spock-core:2.3-groovy-$groovyVersion"
   testImplementation 'org.objenesis:objenesis:3.4' // Mock creation with constructor parameters
-  testImplementation 'net.bytebuddy:byte-buddy:1.15.11' // Mocks of classes
+  testImplementation 'net.bytebuddy:byte-buddy:1.17.0' // Mocks of classes
 
   // testcontainers (docker framework for testing)
   testImplementation "org.testcontainers:testcontainers:$testcontainersVersion"
@@ -94,7 +94,7 @@ dependencies {
   runtimeOnly 'org.postgresql:postgresql:42.7.5' // postgresql jdbc driver required during runtime
 
   implementation 'commons-io:commons-io:2.18.0' // I/O functionalities
-  implementation 'commons-codec:commons-codec:1.17.2' // needed by commons-compress
+  implementation 'commons-codec:commons-codec:1.18.0' // needed by commons-compress
   implementation 'org.apache.commons:commons-compress:1.27.1' // I/O functionalities
 }
 

docs/readthedocs/io/ValidationUtils.md

@@ -11,7 +11,7 @@ The methods in ValidationUtils and subclasses can be used to check that objects
 The general validation checks:
 - if assigned values are valid, e.g. lines are not allowed to have negative lengths or the rated power factor of any unit must be between 0 and 1
 - furthermore, several connections are checked, e.g. that lines only connect nodes of the same voltage level or that the voltage levels indicated for the transformer sides match the voltage levels of the nodes they are connected to.
-- the connectivity of the given grid for all defined operation intervals
+- the connectivity of the given grid for all defined operation intervals, if a switch is opened, it is filtered out for the connectivity check
 
 The uniqueness validation checks if a collection of given objects are unique in either:
 - a specific field

gradle/scripts/spotless.gradle

@@ -22,21 +22,21 @@ spotless {
     // the Groovy Eclipse formatter extends the Java Eclipse formatter,
     // so it formats Java files by default (unless `excludeJava` is used).
     greclipse().configFile('greclipse.properties')
-    indentWithSpaces 2
+    leadingTabsToSpaces 2
   }
 
   groovyGradle {
     // same as groovy, but for .gradle (defaults to '*.gradle')
     target '*.gradle', 'gradle/scripts/*.gradle'
     greclipse()
-    indentWithSpaces 2
+    leadingTabsToSpaces 2
   }
 
   // removes unnecessary whitespace, indents with tabs and ends on new line for gradle, md and gitignore files and config-XMLs
   format 'misc', {
     target '**/.gitignore', 'configs/**'
     trimTrailingWhitespace()
-    indentWithTabs()
+    leadingSpacesToTabs()
     endWithNewline()
   }
 }

src/main/java/edu/ie3/datamodel/utils/validation/GridContainerValidationUtils.java

@@ -16,9 +16,7 @@
 import edu.ie3.datamodel.models.input.AssetInput;
 import edu.ie3.datamodel.models.input.MeasurementUnitInput;
 import edu.ie3.datamodel.models.input.NodeInput;
-import edu.ie3.datamodel.models.input.connector.ConnectorInput;
-import edu.ie3.datamodel.models.input.connector.LineInput;
-import edu.ie3.datamodel.models.input.connector.Transformer3WInput;
+import edu.ie3.datamodel.models.input.connector.*;
 import edu.ie3.datamodel.models.input.container.*;
 import edu.ie3.datamodel.models.input.graphics.GraphicInput;
 import edu.ie3.datamodel.models.input.system.SystemParticipantInput;
@@ -241,6 +239,7 @@ protected static Try<Void, InvalidGridException> checkConnectivity(
                 graph.addEdge(connector.getNodeA().getUuid(), connector.getNodeB().getUuid()));
     rawGridElements.getSwitches().stream()
         .filter(isInOperation)
+        .filter(SwitchInput::isClosed)
         .forEach(
             connector ->
                 graph.addEdge(connector.getNodeA().getUuid(), connector.getNodeB().getUuid()));

src/main/java/edu/ie3/datamodel/utils/validation/ThermalUnitValidationUtils.java renamed to src/main/java/edu/ie3/datamodel/utils/validation/ThermalValidationUtils.java

@@ -7,17 +7,18 @@
 
 import edu.ie3.datamodel.exceptions.InvalidEntityException;
 import edu.ie3.datamodel.exceptions.ValidationException;
+import edu.ie3.datamodel.models.input.container.ThermalGrid;
 import edu.ie3.datamodel.models.input.thermal.*;
 import edu.ie3.datamodel.utils.Try;
 import edu.ie3.datamodel.utils.Try.Failure;
 import java.util.ArrayList;
 import java.util.List;
 import javax.measure.Quantity;
 
-public class ThermalUnitValidationUtils extends ValidationUtils {
+public class ThermalValidationUtils extends ValidationUtils {
 
   /** Private Constructor as this class is not meant to be instantiated */
-  private ThermalUnitValidationUtils() {
+  private ThermalValidationUtils() {
     throw new IllegalStateException("Don't try and instantiate a Utility class.");
   }
 
@@ -57,6 +58,42 @@ private ThermalUnitValidationUtils() {
     return exceptions;
   }
 
+  /**
+   * Validates a thermal grid if:
+   *
+   * <ul>
+   *   <li>it is not null
+   * </ul>
+   *
+   * A "distribution" method, that forwards the check request to specific implementations to fulfill
+   * the checking task, based on the class of the given object.
+   *
+   * @param thermalGrid ThermalGrid to validate
+   * @return a list of try objects either containing an {@link ValidationException} or an empty
+   *     Success
+   */
+  protected static List<Try<Void, ? extends ValidationException>> check(ThermalGrid thermalGrid) {
+    Try<Void, InvalidEntityException> isNull = checkNonNull(thermalGrid, "a thermal grid");
+
+    if (isNull.isFailure()) {
+      return List.of(isNull);
+    }
+
+    List<Try<Void, ? extends ValidationException>> exceptions = new ArrayList<>();
+
+    // Validate houses
+    for (ThermalHouseInput house : thermalGrid.houses()) {
+      exceptions.addAll(checkThermalHouse(house));
+    }
+
+    // Validate storages
+    for (ThermalStorageInput storage : thermalGrid.storages()) {
+      exceptions.addAll(check(storage));
+    }
+
+    return exceptions;
+  }
+
   /**
    * Validates a thermalSinkInput if:
    *

src/main/java/edu/ie3/datamodel/utils/validation/ValidationUtils.java

@@ -16,6 +16,7 @@
 import edu.ie3.datamodel.models.input.connector.type.Transformer2WTypeInput;
 import edu.ie3.datamodel.models.input.connector.type.Transformer3WTypeInput;
 import edu.ie3.datamodel.models.input.container.GridContainer;
+import edu.ie3.datamodel.models.input.container.ThermalGrid;
 import edu.ie3.datamodel.models.input.graphics.GraphicInput;
 import edu.ie3.datamodel.models.input.system.SystemParticipantInput;
 import edu.ie3.datamodel.models.input.system.type.SystemParticipantTypeInput;
@@ -68,6 +69,8 @@ public static void check(Object obj) throws ValidationException {
       exceptions.addAll(GraphicValidationUtils.check((GraphicInput) obj));
     } else if (AssetTypeInput.class.isAssignableFrom(obj.getClass())) {
       exceptions.addAll(checkAssetType((AssetTypeInput) obj));
+    } else if (ThermalGrid.class.isAssignableFrom(obj.getClass())) {
+      exceptions.addAll(ThermalValidationUtils.check((ThermalGrid) obj));
     } else {
       logNotImplemented(obj);
     }
@@ -151,7 +154,9 @@ else if (SystemParticipantInput.class.isAssignableFrom(assetInput.getClass()))
       exceptions.addAll(
           SystemParticipantValidationUtils.check((SystemParticipantInput) assetInput));
     else if (ThermalUnitInput.class.isAssignableFrom(assetInput.getClass()))
-      exceptions.addAll(ThermalUnitValidationUtils.check((ThermalUnitInput) assetInput));
+      exceptions.addAll(ThermalValidationUtils.check((ThermalUnitInput) assetInput));
+    else if (ThermalGrid.class.isAssignableFrom(assetInput.getClass()))
+      exceptions.addAll(ThermalValidationUtils.check((ThermalUnitInput) assetInput));
     else {
       logNotImplemented(assetInput);
     }

src/test/groovy/edu/ie3/datamodel/utils/validation/GridContainerValidationUtilsTest.groovy

@@ -103,4 +103,25 @@ class GridContainerValidationUtilsTest extends Specification {
       GTD.nodeG.uuid
     ])
   }
+
+  def "The GridContainerValidationUtils should return an exception if the grid is not properly connected, because a switch is open"() {
+    given:
+    def nodeA = GTD.nodeA.copy().operationTime(OperationTime.notLimited()).build()
+    def nodeB = GTD.nodeB.copy().operationTime(OperationTime.notLimited()).build()
+
+    def switchAtoB = GTD.switchAtoB.copy()
+        .nodeA(nodeA)
+        .nodeB(nodeB)
+        .operationTime(OperationTime.notLimited())
+        .closed(false)
+        .build()
+
+    def rawGrid = new RawGridElements([nodeA, nodeB] as Set, [] as Set, [] as Set, [] as Set, [switchAtoB] as Set, [] as Set)
+
+    when:
+    def actual = GridContainerValidationUtils.checkConnectivity(rawGrid, Optional.of(start) as Optional<ZonedDateTime>)
+
+    then:
+    actual.exception.get().message == "The grid contains unconnected elements for time "+start+": [47d29df0-ba2d-4d23-8e75-c82229c5c758]"
+  }
 }

src/test/groovy/edu/ie3/datamodel/utils/validation/ThermalUnitValidationUtilsTest.groovy renamed to src/test/groovy/edu/ie3/datamodel/utils/validation/ThermalValidationUtilsTest.groovy

@@ -10,6 +10,7 @@ import edu.ie3.datamodel.exceptions.ValidationException
 import edu.ie3.datamodel.models.OperationTime
 import edu.ie3.datamodel.models.StandardUnits
 import edu.ie3.datamodel.models.input.OperatorInput
+import edu.ie3.datamodel.models.input.container.ThermalGrid
 import edu.ie3.datamodel.models.input.thermal.CylindricalStorageInput
 import edu.ie3.datamodel.models.input.thermal.ThermalHouseInput
 import edu.ie3.datamodel.utils.Try
@@ -26,7 +27,7 @@ import tech.units.indriya.quantity.Quantities
 import javax.measure.quantity.Temperature
 import javax.measure.quantity.Volume
 
-class ThermalUnitValidationUtilsTest extends Specification {
+class ThermalValidationUtilsTest extends Specification {
 
   // General data
   private static final UUID thermalUnitUuid = UUID.fromString("717af017-cc69-406f-b452-e022d7fb516a")
@@ -44,7 +45,7 @@ class ThermalUnitValidationUtilsTest extends Specification {
   private static final ComparableQuantity<Temperature> UPPER_TEMPERATURE_LIMIT = Quantities.getQuantity(25, StandardUnits.TEMPERATURE)
   private static final ComparableQuantity<Temperature> LOWER_TEMPERATURE_LIMIT = Quantities.getQuantity(15, StandardUnits.TEMPERATURE)
 
-  // Specific data for thermal cylindric storage input
+  // Specific data for thermal cylindrical storage input
   private static final ComparableQuantity<Volume> storageVolumeLvl = Quantities.getQuantity(100, StandardUnits.VOLUME)
   private static final ComparableQuantity<Temperature> inletTemp = Quantities.getQuantity(100, StandardUnits.TEMPERATURE)
   private static final ComparableQuantity<Temperature> returnTemp = Quantities.getQuantity(80, StandardUnits.TEMPERATURE)
@@ -65,7 +66,7 @@ class ThermalUnitValidationUtilsTest extends Specification {
 
   def "ThermalUnitValidationUtils.checkThermalHouse() recognizes all potential errors for a thermal house"() {
     when:
-    List<Try<Void, ? extends ValidationException>> exceptions = ThermalUnitValidationUtils.check(invalidThermalHouse).stream().filter { it -> it.failure }.toList()
+    List<Try<Void, ? extends ValidationException>> exceptions = ThermalValidationUtils.check(invalidThermalHouse).stream().filter { it -> it.failure }.toList()
 
     then:
     exceptions.size() == expectedSize
@@ -98,7 +99,7 @@ class ThermalUnitValidationUtilsTest extends Specification {
 
   def "ThermalUnitValidationUtils.checkCylindricalStorage() recognizes all potential errors for a thermal cylindrical storage"() {
     when:
-    List<Try<Void, ? extends ValidationException>> exceptions = ThermalUnitValidationUtils.check(invalidCylindricalStorage).stream().filter { it -> it.failure }.toList()
+    List<Try<Void, ? extends ValidationException>> exceptions = ThermalValidationUtils.check(invalidCylindricalStorage).stream().filter { it -> it.failure }.toList()
 
     then:
     exceptions.size() == expectedSize
@@ -107,9 +108,34 @@ class ThermalUnitValidationUtilsTest extends Specification {
     ex.message == expectedException.message
 
     where:
-    invalidCylindricalStorage                                                                                                                                                                                                                                                                                           || expectedSize || expectedException
-    new CylindricalStorageInput(thermalUnitUuid, id, operator, operationTime, SystemParticipantTestData.thermalBus, storageVolumeLvl, Quantities.getQuantity(100, StandardUnits.TEMPERATURE), Quantities.getQuantity(200, StandardUnits.TEMPERATURE), c)                                           || 1            || new InvalidEntityException("Inlet temperature of the cylindrical storage cannot be lower or equal than outlet temperature", invalidCylindricalStorage)
-    new CylindricalStorageInput(thermalUnitUuid, id, operator, operationTime, SystemParticipantTestData.thermalBus, storageVolumeLvl, Quantities.getQuantity(100, StandardUnits.TEMPERATURE), Quantities.getQuantity(100, StandardUnits.TEMPERATURE), c)                                           || 1            || new InvalidEntityException("Inlet temperature of the cylindrical storage cannot be lower or equal than outlet temperature", invalidCylindricalStorage)
+    invalidCylindricalStorage                                                                                                                                                                                                                                       || expectedSize || expectedException
+    new CylindricalStorageInput(thermalUnitUuid, id, operator, operationTime, SystemParticipantTestData.thermalBus, storageVolumeLvl, Quantities.getQuantity(100, StandardUnits.TEMPERATURE), Quantities.getQuantity(200, StandardUnits.TEMPERATURE), c)            || 1            || new InvalidEntityException("Inlet temperature of the cylindrical storage cannot be lower or equal than outlet temperature", invalidCylindricalStorage)
+    new CylindricalStorageInput(thermalUnitUuid, id, operator, operationTime, SystemParticipantTestData.thermalBus, storageVolumeLvl, Quantities.getQuantity(100, StandardUnits.TEMPERATURE), Quantities.getQuantity(100, StandardUnits.TEMPERATURE), c)            || 1            || new InvalidEntityException("Inlet temperature of the cylindrical storage cannot be lower or equal than outlet temperature", invalidCylindricalStorage)
     new CylindricalStorageInput(thermalUnitUuid, id, operator, operationTime, SystemParticipantTestData.thermalBus, Quantities.getQuantity(-100, StandardUnits.VOLUME), inletTemp, returnTemp, Quantities.getQuantity(-1.05, StandardUnits.SPECIFIC_HEAT_CAPACITY)) || 1            || new InvalidEntityException("The following quantities have to be positive: -100 ㎥, -1.05 kWh/K*m³", invalidCylindricalStorage)
   }
+
+  def "ThermalUnitValidationUtils.check() works for complete ThermalGrid as well"() {
+    when:
+    def thermalBus = ThermalUnitInputTestData.thermalBus
+    def cylindricalStorageInput = [
+      ThermalUnitInputTestData.cylindricStorageInput
+    ]
+
+
+    ThermalGrid thermalGrid = new ThermalGrid(thermalBus, [thermalHouse], cylindricalStorageInput)
+
+
+    List<Try<Void, ? extends ValidationException>> exceptions = ThermalValidationUtils.check(thermalGrid).stream().filter { it -> it.failure }.toList()
+
+    then:
+    exceptions.size() == expectedSize
+    Exception ex = exceptions.get(0).exception.get()
+    ex.class == expectedException.class
+    ex.message == expectedException.message
+
+
+    where:
+    thermalHouse                                                                                                                                                                                                                                      || expectedSize || expectedException
+    new ThermalHouseInput(thermalUnitUuid, id, operator, operationTime, SystemParticipantTestData.thermalBus, thermalConductance, ethCapa, Quantities.getQuantity(0, StandardUnits.TEMPERATURE), UPPER_TEMPERATURE_LIMIT, LOWER_TEMPERATURE_LIMIT)    || 1            || new InvalidEntityException("Target temperature must be higher than lower temperature limit and lower than upper temperature limit", thermalHouse)
+  }
 }