Merge branch 'dev' into pp/#873-thermal-house-documentation-in-docs-not-up-to-date

Author: sebastian-peter

AUTHORS

@@ -1,10 +1,14 @@
-Copyright (c) 2023, Institute of Energy Systems, Energy Efficiency and Energy Economics (ie3)
+Copyright (c) 2024, Institute of Energy Systems, Energy Efficiency and Energy Economics (ie3)
 All rights reserved.
 
 Lead Developers:
     - Johannes Hiry
     - Chris Kittl
     - Debopama Sen-Sarma
+    - Thomas Oberließen
+    - Daniel Feismann
+    - Johannes Bao
+    - Sebastian Peter
 
 Main Contributers:
     - Johannes Hiry - https://github.com/johanneshiry
@@ -20,3 +24,8 @@ Main Contributers:
     - Marius Staudt - https://github.com/staudtMarius
     - Lara Roumeliotis - https://github.com/lararou
     - Vicky Bung - https://github.com/vickybung1
+    - Daniel Feismann - https://github.com/danielfeismann
+    - Johannes Bao - https://github.com/jo-bao
+    - Julian Hohmann - https://github.com/julianhohmann
+    - Simon Huette - https://github.com/SimonHuette
+    - Pierre Petersmeier - http://github.com/pierrepetersmeier

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Formatting Spotless Groovy import order [#960](https://github.com/ie3-institute/PowerSystemDataModel/issues/960)
 - Implementing missing typical methods in `Try` [#970](https://github.com/ie3-institute/PowerSystemDataModel/issues/970)
+- Added log warning when using `SwitchInputs` with `parallelDevices` parameter [#840](https://github.com/ie3-institute/PowerSystemDataModel/issues/840)
 
 ### Fixed
 - Fixed Couchbase integration tests that randomly failed [#755](https://github.com/ie3-institute/PowerSystemDataModel/issues/755)
@@ -25,6 +26,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Allowing for additional unused columns in sources [#839](https://github.com/ie3-institute/PowerSystemDataModel/issues/839)
 - Improving column name validation to only run once per source [#849](https://github.com/ie3-institute/PowerSystemDataModel/issues/849)
 - Refactored and abstracted `EntitySource`s and `EntityData` creation [#969](https://github.com/ie3-institute/PowerSystemDataModel/issues/969)
+- Updated contributing.md [#737](https://github.com/ie3-institute/PowerSystemDataModel/issues/737)
 
 ## [4.1.0] - 2023-11-02
 
@@ -48,6 +50,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 - Fixed wrong rated power unit hint [#804](https://github.com/ie3-institute/PowerSystemDataModel/issues/804)
 - Fixed wrong hash code generation of ConnectorResult [#817](https://github.com/ie3-institute/PowerSystemDataModel/issues/817) 
+- Fixed wrong path for timeSeriesMapping [#886](https://github.com/ie3-institute/PowerSystemDataModel/issues/886)
 
 ### Changed
 - Removing deprecated classes and methods [#540](https://github.com/ie3-institute/PowerSystemDataModel/issues/540)

CONTRIBUTING.md

@@ -16,7 +16,7 @@ With this document we would like to give you some orientation on how you can con
 ## Testing and reporting bugs
 We really appreciate your usage of this project.
 Whenever you find a bug, it would be nice to check, if this isn't a feature to us. :wink:
-You may find extensive information about the intended behaviour when you [Read the Docs](https://powersystemdatamodel.readthedocs.io/en/latest/) or within the [javadoc](https://ie3-institute.github.io/PowerSystemDataModel/javadoc/).
+You may find extensive information about the intended behaviour when you [Read the Docs](https://powersystemdatamodel.readthedocs.io/en/latest/).
 If you still think it's a bug, please raise an [issue](https://guides.github.com/features/issues/) for us.
 Considering the following aspects in your inquiry, assists us in helping you:
 
@@ -67,9 +67,6 @@ Before marking the pull request as 'ready to review', take these precautionary a
 `gradle finalizePR` summarizes all of these steps .
 
 ## For any doubts
-... please contact
-* Johannes (@johanneshiry),
-* Debopama (@sensarmad) or
-* Chris (@ckittl)
+... please contact [us](AUTHORS)
 
 We are happy to help! :smiley:

build.gradle

@@ -5,7 +5,7 @@ plugins {
   id 'signing'
   id 'pmd' // code check, working on source code
   id 'com.diffplug.spotless' version '6.25.0' //code format
-  id 'com.github.spotbugs' version '5.2.5' // code check, working on byte code
+  id 'com.github.spotbugs' version '6.0.7' // code check, working on byte code
   id 'de.undercouch.download' version '5.5.0'
   id 'kr.motd.sphinx' version '2.10.1' // documentation generation
   id 'jacoco' // java code coverage plugin
@@ -18,7 +18,7 @@ ext {
   javaVersion = JavaVersion.VERSION_17
   groovyVersion = "4.0"
   groovyBinaryVersion = "4.0.18"
-  testcontainersVersion = '1.19.3'
+  testcontainersVersion = '1.19.4'
 
   scriptsLocation = 'gradle' + File.separator + 'scripts' + File.separator //location of script plugins
 }

gradle/scripts/spotbugs.gradle

@@ -1,21 +1,26 @@
 // spotBugs is a code check tool, working on byte code
 
+// workaround because imports do not work in files that are only included by build.gradle
+def classLoader = plugins['com.github.spotbugs'].class.classLoader
+def SpotBugsEffort = classLoader.findLoadedClass( 'com.github.spotbugs.snom.Effort' )
+def SpotBugsConfidence = classLoader.findLoadedClass( 'com.github.spotbugs.snom.Confidence' )
+
 spotbugs{
   ignoreFailures = true // dont let the build fail on rule violations
-  effort = 'max'
-  reportLevel = 'high'
+  effort = SpotBugsEffort.valueOf("MAX")
+  reportLevel = SpotBugsConfidence.valueOf("HIGH")
 }
 
 spotbugsMain{
   reports{
-    html.enabled = false
-    xml.enabled = true
+    html.required.set(false)
+    xml.required.set(true)
   }
 }
 
 spotbugsTest{
   reports{
-    html.enabled = false
-    xml.enabled = true
+    html.required.set(false)
+    xml.required.set(true)
   }
 }

src/main/java/edu/ie3/datamodel/io/connectors/CsvFileConnector.java

@@ -42,12 +42,12 @@ public class CsvFileConnector implements DataConnector {
   private final Map<UUID, BufferedCsvWriter> timeSeriesWriters = new HashMap<>();
 
   private final FileNamingStrategy fileNamingStrategy;
-  private final Path baseDirectoryName;
+  private final Path baseDirectory;
 
   private static final String FILE_ENDING = ".csv";
 
-  public CsvFileConnector(Path baseDirectoryName, FileNamingStrategy fileNamingStrategy) {
-    this.baseDirectoryName = baseDirectoryName;
+  public CsvFileConnector(Path baseDirectory, FileNamingStrategy fileNamingStrategy) {
+    this.baseDirectory = baseDirectory;
     this.fileNamingStrategy = fileNamingStrategy;
   }
 
@@ -61,7 +61,7 @@ public synchronized BufferedCsvWriter getOrInitWriter(
     /* If it is not available, build and register one */
     try {
       CsvFileDefinition fileDefinition = buildFileDefinition(clz, headerElements, csvSep);
-      BufferedCsvWriter newWriter = initWriter(baseDirectoryName, fileDefinition);
+      BufferedCsvWriter newWriter = initWriter(baseDirectory, fileDefinition);
 
       entityWriters.put(clz, newWriter);
       return newWriter;
@@ -81,7 +81,7 @@ BufferedCsvWriter getOrInitWriter(T timeSeries, String[] headerElements, String
     /* If it is not available, build and register one */
     try {
       CsvFileDefinition fileDefinition = buildFileDefinition(timeSeries, headerElements, csvSep);
-      BufferedCsvWriter newWriter = initWriter(baseDirectoryName, fileDefinition);
+      BufferedCsvWriter newWriter = initWriter(baseDirectory, fileDefinition);
 
       timeSeriesWriters.put(timeSeries.getUuid(), newWriter);
       return newWriter;
@@ -188,7 +188,7 @@ public BufferedReader initReader(Class<? extends UniqueEntity> clz)
    * @throws FileNotFoundException if no file with the provided file name can be found
    */
   public BufferedReader initReader(Path filePath) throws FileNotFoundException {
-    File fullPath = baseDirectoryName.resolve(filePath.toString() + FILE_ENDING).toFile();
+    File fullPath = baseDirectory.resolve(filePath.toString() + FILE_ENDING).toFile();
     return new BufferedReader(
         new InputStreamReader(new FileInputStream(fullPath), StandardCharsets.UTF_8), 16384);
   }
@@ -228,10 +228,9 @@ public BufferedReader initReader(Path filePath) throws FileNotFoundException {
    * @return A set of relative paths to time series files, with respect to the base folder path
    */
   private Set<Path> getIndividualTimeSeriesFilePaths() {
-    Path baseDirectoryPath = baseDirectoryName.resolve(baseDirectoryName);
-    try (Stream<Path> pathStream = Files.walk(baseDirectoryPath)) {
+    try (Stream<Path> pathStream = Files.walk(baseDirectory)) {
       return pathStream
-          .map(baseDirectoryPath::relativize)
+          .map(baseDirectory::relativize)
           .filter(
               path -> {
                 Path withoutEnding =

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

@@ -34,6 +34,18 @@ protected SwitchInput buildModel(
       OperatorInput operator,
       OperationTime operationTime) {
     final boolean closed = data.getBoolean(CLOSED);
+
+    if (data.containsKey(PARALLEL_DEVICES)) {
+      String parallelDevices = data.getField(PARALLEL_DEVICES);
+
+      log.warn(
+          "The SwitchInput with id `{}` specifies the unused parameter `parallelDevices` with a value of `{}`."
+              + " SwitchInputs do not need to specify `parallelDevices`, as its physical value depends on"
+              + " the electrotechnical context of where the switch is embedded.",
+          id,
+          parallelDevices);
+    }
+
     return new SwitchInput(uuid, id, operator, operationTime, nodeA, nodeB, closed);
   }
 }

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

@@ -23,9 +23,12 @@ class BufferedCsvWriterTest extends Specification {
   }
 
   def cleanupSpec() {
-    FileIOUtils.deleteRecursively(tmpDirectory)
+    try {
+      FileIOUtils.deleteRecursively(tmpDirectory)
+    } catch (IOException e) {
+      throw new FileException("Unable to delete recursively.", e)
+    }
   }
-
   def "The convenience constructor of the BufferedCsvWriter class works as expected."() {
     given:
     def baseDirectory = tmpDirectory

src/test/groovy/edu/ie3/datamodel/io/factory/input/SwitchInputFactoryTest.groovy

@@ -58,4 +58,38 @@ class SwitchInputFactoryTest extends Specification implements FactoryTestHelper
       assert closed
     }
   }
+
+  def "A SwitchInputFactory should parse a valid SwitchInput with parallelDevices parameter correctly"() {
+    given: "a system participant input type factory and model data"
+    def inputFactory = new SwitchInputFactory()
+    Map<String, String> parameter = [
+      "uuid"         : "91ec3bcf-1777-4d38-af67-0bf7c9fa73c7",
+      "operatesfrom" : "2019-01-01T00:00:00+01:00[Europe/Berlin]",
+      "operatesuntil": "",
+      "id"           : "TestID",
+      "closed"       : "true",
+      "paralleldevices": "2"
+    ]
+    def inputClass = SwitchInput
+    def operatorInput = Mock(OperatorInput)
+    def nodeInputA = Mock(NodeInput)
+    def nodeInputB = Mock(NodeInput)
+
+    expect:
+    Try<SwitchInput, FactoryException> input = inputFactory.get(new ConnectorInputEntityData(parameter, inputClass, operatorInput, nodeInputA, nodeInputB))
+    input.success
+    input.data.get().getClass() == inputClass
+    input.data.get().with {
+      assert uuid == UUID.fromString(parameter["uuid"])
+      assert operationTime.startDate.present
+      assert operationTime.startDate.get() == ZonedDateTime.parse(parameter["operatesfrom"])
+      assert !operationTime.endDate.present
+      assert operator == operatorInput
+      assert id == parameter["id"]
+      assert nodeA == nodeInputA
+      assert nodeB == nodeInputB
+      assert closed
+      assert parallelDevices == 1
+    }
+  }
 }

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

@@ -68,7 +68,7 @@ class CsvDataSourceTest extends Specification implements CsvTestDataMeta {
   def "A DataSource should contain a valid connector after initialization"() {
     expect:
     dummyCsvSource.connector != null
-    dummyCsvSource.connector.baseDirectoryName == testBaseFolderPath
+    dummyCsvSource.connector.baseDirectory == testBaseFolderPath
     dummyCsvSource.connector.fileNamingStrategy == fileNamingStrategy
     dummyCsvSource.connector.entityWriters.isEmpty()
   }