Merge pull request #709 from ie3-institute/vb/#586-grid-io-it

Vb/#586 grid io it

Author: sebastian-peter

CHANGELOG.md

@@ -18,6 +18,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `EmResult` and `FlexOptionsResult` for Energy Management Systems [#651](https://github.com/ie3-institute/PowerSystemDataModel/issues/651)
 - `EvcsInput` now has a parameter for enabling and disabling vehicle to grid support [#681](https://github.com/ie3-institute/PowerSystemDataModel/issues/681)
 - Added Dependabot updates to sphinx/readthedocs dependencies [#735](https://github.com/ie3-institute/PowerSystemDataModel/issues/735)
+- Created convenience function for JointGridContainer from CSV [#502](https://github.com/ie3-institute/PowerSystemDataModel/issues/502)
+- Added CSV grid IO integration test [#586](https://github.com/ie3-institute/PowerSystemDataModel/issues/586)
 
 ### Fixed
 - Reduced code smells [#492](https://github.com/ie3-institute/PowerSystemDataModel/issues/492)

src/main/java/edu/ie3/datamodel/io/source/csv/CsvJointGridContainerSource.java

@@ -0,0 +1,56 @@
+/*
+ * © 2022. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.io.source.csv;
+
+import edu.ie3.datamodel.exceptions.SourceException;
+import edu.ie3.datamodel.io.naming.FileNamingStrategy;
+import edu.ie3.datamodel.io.source.*;
+import edu.ie3.datamodel.models.input.container.GraphicElements;
+import edu.ie3.datamodel.models.input.container.JointGridContainer;
+import edu.ie3.datamodel.models.input.container.RawGridElements;
+import edu.ie3.datamodel.models.input.container.SystemParticipants;
+
+/** Convenience class for cases where all used data comes from CSV sources */
+public class CsvJointGridContainerSource {
+  private CsvJointGridContainerSource() {}
+
+  public static JointGridContainer read(String gridName, String csvSep, String directoryPath)
+      throws SourceException {
+
+    /* Parameterization */
+
+    FileNamingStrategy namingStrategy = new FileNamingStrategy(); // Default naming strategy
+
+    /* Instantiating sources */
+    TypeSource typeSource = new CsvTypeSource(csvSep, directoryPath, namingStrategy);
+    RawGridSource rawGridSource =
+        new CsvRawGridSource(csvSep, directoryPath, namingStrategy, typeSource);
+    ThermalSource thermalSource =
+        new CsvThermalSource(csvSep, directoryPath, namingStrategy, typeSource);
+    SystemParticipantSource systemParticipantSource =
+        new CsvSystemParticipantSource(
+            csvSep, directoryPath, namingStrategy, typeSource, thermalSource, rawGridSource);
+    GraphicSource graphicsSource =
+        new CsvGraphicSource(csvSep, directoryPath, namingStrategy, typeSource, rawGridSource);
+
+    /* Loading models */
+    RawGridElements rawGridElements =
+        rawGridSource
+            .getGridData()
+            .orElseThrow(() -> new SourceException("Error during reading of raw grid data."));
+    SystemParticipants systemParticipants =
+        systemParticipantSource
+            .getSystemParticipants()
+            .orElseThrow(
+                () -> new SourceException("Error during reading of system participant data."));
+    GraphicElements graphicElements =
+        graphicsSource
+            .getGraphicElements()
+            .orElseThrow(() -> new SourceException("Error during reading of graphic elements."));
+
+    return new JointGridContainer(gridName, rawGridElements, systemParticipants, graphicElements);
+  }
+}

src/test/groovy/edu/ie3/datamodel/io/connectors/CsvFileConnectorTest.groovy

@@ -62,8 +62,8 @@ class CsvFileConnectorTest extends Specification {
   }
 
   def cleanupSpec() {
-    FileIOUtils.deleteRecursively(tmpDirectory)
     cfc.shutdown()
+    FileIOUtils.deleteRecursively(tmpDirectory)
   }
 
   def "The csv file connector is able to provide correct paths to time series files"() {

src/test/groovy/edu/ie3/datamodel/io/csv/GridIoIT.groovy

@@ -0,0 +1,60 @@
+/*
+ * © 2022. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+ */
+package edu.ie3.datamodel.io.csv
+
+import edu.ie3.datamodel.io.sink.CsvFileSink
+import edu.ie3.datamodel.io.source.csv.CsvJointGridContainerSource
+import edu.ie3.datamodel.io.source.csv.CsvTestDataMeta
+import edu.ie3.util.io.FileIOUtils
+import spock.lang.Shared
+import spock.lang.Specification
+
+import java.nio.file.Files
+import java.nio.file.Path
+
+/**
+ * Testing whether PSDM CSV grids are equal when serialized and deserialized sequentially.
+ * Grid data should <strong>not</strong> change when written out or parsed.
+ */
+class GridIoIT extends Specification implements CsvTestDataMeta {
+
+  @Shared
+  Path tempDirectory
+
+  @Shared
+  CsvFileSink sink
+
+  def setupSpec() {
+    tempDirectory = Files.createTempDirectory("GridIoIT")
+    sink = new CsvFileSink(tempDirectory.toAbsolutePath().toString())
+  }
+
+  def cleanupSpec() {
+    sink.shutdown()
+    FileIOUtils.deleteRecursively(tempDirectory)
+  }
+
+  def "Input JointGridContainer equals Output JointGridContainer."() {
+
+    given:
+    // create joint grid container
+    def gridName = "vn_simona"
+    def separator = ","
+    def firstGridContainer = CsvJointGridContainerSource.read(gridName, separator, jointGridFolderPath)
+
+    when:
+    // write files from joint grid container in output directory
+    sink.persistJointGrid(firstGridContainer)
+
+    // create second grid container from output folder
+    def secondGridContainer = CsvJointGridContainerSource.read(gridName, separator, tempDirectory.toAbsolutePath().toString())
+
+    then:
+    // compare input and output joint grid container
+    firstGridContainer == secondGridContainer
+
+  }
+}

src/test/groovy/edu/ie3/datamodel/io/source/csv/CsvTestDataMeta.groovy

@@ -24,6 +24,7 @@ trait CsvTestDataMeta {
   static String coordinatesCosmoFolderPath = getResourceAbs("_coordinates/cosmo")
   static String weatherCosmoFolderPath = getResourceAbs("_weather/cosmo")
   static String weatherIconFolderPath = getResourceAbs("_weather/icon")
+  static String jointGridFolderPath = getResourceAbs("_joint_grid")
 
   static String gridDefaultFolderPath = getResourceAbs("_grid/default")
   static String gridMalformedFolderPath = getResourceAbs("_grid/malformed")

src/test/resources/edu/ie3/datamodel/io/source/csv/_joint_grid/bm_input.csv

@@ -0,0 +1,2 @@
+"uuid","cost_controlled","feed_in_tariff","id","market_reaction","node","operates_from","operates_until","operator","q_characteristics","type"
+a3b7576b-cac7-4350-90ff-06316cdca192,true,51.0,BM_Test,true,f5839ade-5968-4879-a824-90b5fb3552cd,,,,cosPhiFixed:{(0.00,1.00)},2fdca5f1-c11b-4169-a695-4c98f0e0a84a

src/test/resources/edu/ie3/datamodel/io/source/csv/_joint_grid/bm_type_input.csv

@@ -0,0 +1,2 @@
+"uuid","active_power_gradient","capex","cos_phi_rated","eta_conv","id","opex","s_rated"
+2fdca5f1-c11b-4169-a695-4c98f0e0a84a,5.0,0.0,1.0,1.0,typ_01,0.05,190.0

src/test/resources/edu/ie3/datamodel/io/source/csv/_joint_grid/evcs_input.csv

@@ -0,0 +1,3 @@
+"uuid","cos_phi_rated","id","node","operates_from","operates_until","operator","q_characteristics","chargingpoints","type","location_type","v2gSupport"
+06a14909-366e-4e94-a593-1016e1455b30,0.9,test_evcs_1,5f1c776c-6935-40f7-ba9e-60646e08992b,,,,cosPhiFixed:{(0.00,1.0)},4,ChargingStationType1,HOME,false
+104acdaa-5dc5-4197-aed2-2fddb3c4f237,0.9,test_evcs_2,ed4697fd-016c-40c2-a66b-e793878dadea,,,,cosPhiFixed:{(0.00,1.0)},4,ChargingStationType1,HOME,false

src/test/resources/edu/ie3/datamodel/io/source/csv/_joint_grid/fixed_feed_in_input.csv

@@ -0,0 +1,2 @@
+"uuid","cos_phi_rated","id","node","operates_from","operates_until","operator","q_characteristics","s_rated"
+9abe950d-362e-4efe-b686-500f84d8f368,0.9,test_feed_in,5f1c776c-6935-40f7-ba9e-60646e08992b,,,,cosPhiFixed:{(0.00,0.95)},200.0

src/test/resources/edu/ie3/datamodel/io/source/csv/_joint_grid/its_pq_8c04e94e-76b0-4369-a55c-f5e1117fb83e.csv

@@ -0,0 +1,2 @@
+"uuid","p","q","time"
+4df88950-dc48-4905-b41f-63d0757eae03,3.999998968803,0.0,2011-01-01T00:00:00Z