Improving validation utils

.github/dependabot.yml

@@ -13,10 +13,6 @@ updates:
   - sebastian-peter
   - danielfeismann
   - jo-bao
-  ignore:
-  - dependency-name: org.spockframework:spock-core
-    versions:
-        - 2.3-groovy-4.0
 
 - package-ecosystem: pip
   directory: "/docs/readthedocs"

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 - Data source will throw an exceptions instead of returning an empty optionals [#707](https://github.com/ie3-institute/PowerSystemDataModel/issues/707)
+- Improving `ValidationUtils` [#758](https://github.com/ie3-institute/PowerSystemDataModel/issues/758)
 
 
 ## [3.0.0] - 2023-02-16
@@ -87,6 +88,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - BREAKING: Updating PowerSystemUtils dependency to 2.0-SNAPSHOT [#595](https://github.com/ie3-institute/PowerSystemDataModel/issues/595)
 - BREAKING: Generified the `LoadInput` attribute `standardLoadProfile` to `loadProfile` as it should also address the newly added `TemperatureDependantLoadProfile`s [#601](https://github.com/ie3-institute/PowerSystemDataModel/issues/601)
 - Adapted to new double converters in PSU [#705](https://github.com/ie3-institute/PowerSystemDataModel/issues/705)
+- Setting fixed groovy version and updating groovy [#788](https://github.com/ie3-institute/PowerSystemDataModel/issues/788)
 
 ## [2.1.0] - 2022-01-05
 

build.gradle

@@ -4,9 +4,9 @@ plugins {
   id 'maven-publish'
   id 'signing'
   id 'pmd' // code check, working on source code
-  id 'com.diffplug.spotless' version '6.16.0'//code format
-  id 'com.github.spotbugs' version '5.0.13' // code check, working on byte code
-  id 'de.undercouch.download' version '5.3.1'
+  id 'com.diffplug.spotless' version '6.18.0'//code format
+  id 'com.github.spotbugs' version '5.0.14' // code check, working on byte code
+  id 'de.undercouch.download' version '5.4.0'
   id 'kr.motd.sphinx' version '2.10.1' // documentation generation
   id 'jacoco' // java code coverage plugin
   id "org.sonarqube" version "4.0.0.2929" // sonarqube
@@ -16,7 +16,9 @@ plugins {
 ext {
   //version (changing these should be considered thoroughly!)
   javaVersion = JavaVersion.VERSION_17
-  testcontainersVersion = '1.17.6'
+  groovyVersion = "4.0"
+  groovyBinaryVersion = "4.0.11"
+  testcontainersVersion = '1.18.0'
 
   scriptsLocation = 'gradle' + File.separator + 'scripts' + File.separator //location of script plugins
 }
@@ -43,7 +45,6 @@ repositories {
 
   // sonatype snapshot repo
   maven { url 'https://s01.oss.sonatype.org/content/repositories/snapshots' }
-
 }
 
 dependencies {
@@ -64,10 +65,12 @@ dependencies {
   implementation 'org.jgrapht:jgrapht-core:1.5.1'
 
   // testing
+  testImplementation "org.apache.groovy:groovy:$groovyBinaryVersion"
+
   testImplementation 'org.junit.jupiter:junit-jupiter:5.9.2'
-  testImplementation 'org.spockframework:spock-core:2.3-groovy-3.0'
+  testImplementation "org.spockframework:spock-core:2.3-groovy-$groovyVersion"
   testImplementation 'org.objenesis:objenesis:3.3' // Mock creation with constructor parameters
-  testImplementation 'net.bytebuddy:byte-buddy:1.14.1' // Mocks of classes
+  testImplementation 'net.bytebuddy:byte-buddy:1.14.4' // Mocks of classes
 
   // testcontainers (docker framework for testing)
   testImplementation "org.testcontainers:testcontainers:$testcontainersVersion"
@@ -84,13 +87,12 @@ dependencies {
 
   // Databases
   implementation 'org.influxdb:influxdb-java:2.23'
-  implementation 'com.couchbase.client:java-client:3.4.3'
-  runtimeOnly 'org.postgresql:postgresql:42.5.4' // postgresql jdbc driver required during runtime
+  implementation 'com.couchbase.client:java-client:3.4.4'
+  runtimeOnly 'org.postgresql:postgresql:42.6.0' // postgresql jdbc driver required during runtime
 
   implementation 'commons-io:commons-io:2.11.0' // I/O functionalities
-  implementation 'org.apache.commons:commons-compress:1.22' // I/O functionalities
+  implementation 'org.apache.commons:commons-compress:1.23.0' // I/O functionalities
   implementation 'org.apache.commons:commons-lang3:3.12.0'
-
 }
 
 tasks.withType(JavaCompile) {

gradle/scripts/mavenCentralPublish.gradle

@@ -73,7 +73,6 @@ if (project.hasProperty('user') && project.hasProperty('password') && project.ha
         from components.java
         artifact sourcesJar
         artifact javadocJar
-
       }
     }
     repositories {

gradle/scripts/sonarqube.gradle

@@ -34,8 +34,6 @@ sonarqube {
 
     // exclusions
     property 'sonar.exclusions', ['docs/**']
-
-
   }
 }
 

src/main/java/edu/ie3/datamodel/exceptions/FailedValidationException.java

@@ -0,0 +1,23 @@
+/*
+ * © 2023. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.exceptions;
+
+import edu.ie3.datamodel.utils.ExceptionUtils;
+import java.util.List;
+
+public class FailedValidationException extends ValidationException {
+  public FailedValidationException(String message, Throwable throwable) {
+    super(message, throwable);
+  }
+
+  public FailedValidationException(String message) {
+    super(message);
+  }
+
+  public FailedValidationException(List<? extends Exception> exceptions) {
+    super("Validation failed due to: " + ExceptionUtils.getMessages(exceptions));
+  }
+}

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

@@ -87,7 +87,7 @@ protected CsvDataSource(String csvSep, String folderPath, FileNamingStrategy fil
    * @return a map containing the mapping of (fieldName to fieldValue) or an empty map if an error
    *     occurred
    */
-  private Map<String, String> buildFieldsToAttributes(
+  protected Map<String, String> buildFieldsToAttributes(
       final String csvRow, final String[] headline) {
 
     TreeMap<String, String> insensitiveFieldsToAttributes =
@@ -175,7 +175,7 @@ protected String[] parseCsvRow(String csvRow, String csvSep) {
    * @deprecated only left for downward compatibility. Will be removed in a major release
    */
   @Deprecated(since = "1.1.0", forRemoval = true)
-  private String[] oldFieldVals(String csvSep, String csvRow) {
+  protected String[] oldFieldVals(String csvSep, String csvRow) {
 
     /*geo json support*/
     final String geoJsonRegex = "\\{.+?}}}";
@@ -241,7 +241,7 @@ private List<String> extractMatchingStrings(String regexString, String csvRow) {
    * @return either the first found instancen of {@link OperatorInput} or {@link
    *     OperatorInput#NO_OPERATOR_ASSIGNED}
    */
-  private OperatorInput getFirstOrDefaultOperator(
+  protected OperatorInput getFirstOrDefaultOperator(
       Collection<OperatorInput> operators,
       String operatorUuid,
       String entityClassName,

src/main/java/edu/ie3/datamodel/utils/ExceptionUtils.java

@@ -5,19 +5,21 @@
 */
 package edu.ie3.datamodel.utils;
 
+import java.util.ArrayList;
 import java.util.List;
 
 public class ExceptionUtils {
   /**
-   * Creates a string containing multiple exception messsages.
+   * Creates a string containing multiple exception messages.
    *
    * @param exceptions list of exceptions
    * @return str containing the messages
    */
   public static String getMessages(List<? extends Exception> exceptions) {
-    Exception firstInList = exceptions.remove(0);
-    return exceptions.stream()
+    ArrayList<? extends Exception> list = new ArrayList<>(exceptions);
+    Exception firstInList = list.remove(0);
+    return list.stream()
         .map(Throwable::getMessage)
-        .reduce(firstInList.getMessage(), (a, b) -> a + ", " + b);
+        .reduce(firstInList.getMessage(), (a, b) -> a + ",\n" + b);
   }
 }