Merge branch 'dev' into ms/#1294-enhancing-load-profile-source

Author: staudtMarius

.github/workflows/ci.yml

@@ -0,0 +1,102 @@
+# © 2025. TU Dortmund University,
+# Institute of Energy Systems, Energy Efficiency and Energy Economics,
+# Research group Distribution grid planning and operation
+#
+
+name: CI
+
+on:
+  push:
+    paths-ignore:
+      - 'docs/**'
+    branches:
+      - main
+      - dev
+      - 'hotfix/*'
+      - 'rel/*'
+      - 'dependabot/*'
+  pull_request:
+    branches:
+      - main
+      - dev
+
+jobs:
+  buildAndTest:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Source
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Check Branch
+        run: |
+          if [ "${{ github.event_name }}" == "pull_request" ]; then
+            BRANCH_NAME="${{ github.head_ref }}"
+          else
+            BRANCH_NAME="${{ github.ref_name }}"
+          fi
+
+          if [[ "$BRANCH_NAME" == refs/heads/* ]]; then
+            BRANCH_NAME="${BRANCH_NAME#refs/heads/}"
+          fi
+          
+          export BRANCH_NAME
+          
+          echo "BRANCH_NAME=$BRANCH_NAME" >> $GITHUB_ENV
+          
+          ./gradlew checkBranchName -PbranchName="$BRANCH_NAME" --warning-mode=none
+          
+          bash scripts/branch_type.sh
+
+      - name: Version Check
+        if: ${{ github.event_name == 'pull_request' }}
+        env:
+          BASE_BRANCH: ${{ github.event.pull_request.base.ref }}
+        run: bash scripts/run-version-check.sh
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: 17
+
+      - name: Build Project
+        run: ./gradlew --refresh-dependencies clean assemble spotlessCheck
+
+      - name: Run Tests
+        run: ./gradlew pmdMain pmdTest spotbugsMain spotbugsTest test jacocoTestReport jacocoTestCoverageVerification
+
+      - name: Build Java-Docs
+        run: ./gradlew javadoc
+
+      - name: SonarQube
+        run: |
+          ./gradlew sonar \
+          -Dsonar.projectKey=${{ vars.SONAR_PROJECT_KEY }} \
+          -Dsonar.host.url=${{ vars.SONAR_HOST_URL }} \
+          -Dsonar.login=${{ secrets.SONAR_TOKEN }} \
+          -Dsonar.qualitygate.wait=true
+
+      #Deployment
+      - name: Deploy
+        if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev'
+        env:
+          ORG_GRADLE_PROJECT_signingKey: ${{ secrets.MAVENCENTRAL_SIGNINGKEY }}
+          ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.MAVENCENTRAL_SIGNINGPASS }}
+          ORG_GRADLE_PROJECT_user: ${{ secrets.MAVENCENTRAL_USER }}
+          ORG_GRADLE_PROJECT_password: ${{ secrets.MAVENCENTRAL_PASS }}
+        run: |
+          if [ "${GITHUB_REF}" == "refs/heads/main" ]; then
+            currentVersion=$(./gradlew -q currentVersion)
+          else
+            currentVersion=$(./gradlew -q devVersion)
+          fi
+          
+          echo "currentVersion=$currentVersion"
+
+          ./gradlew publish -PdeployVersion=$currentVersion

CHANGELOG.md

@@ -7,9 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased/Snapshot]
 
 ### Added
+- Implemented GitHub Actions for automatic code integration. [#1237](https://github.com/ie3-institute/PowerSystemDataModel/issues/1237)
+- Added `CopyBuilders` to `Line-/Transformer2W-/Tranformer3WTypeInput` [#1275](https://github.com/ie3-institute/PowerSystemDataModel/issues/1275)
 
 ### Fixed
-
+- Fixed SonarQube junit path issue in GitHub Actions [#1284](https://github.com/ie3-institute/PowerSystemDataModel/issues/1284)
 ### Changed
 - Replaced `return this` with `return thisInstance` in CopyBuilders [#1250](https://github.com/ie3-institute/PowerSystemDataModel/issues/1250)
 - Enhancing load profile source [#1294](https://github.com/ie3-institute/PowerSystemDataModel/issues/1294)
@@ -30,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added domestic hot water storage model [#1257](https://github.com/ie3-institute/PowerSystemDataModel/issues/1257)
 - Validation for BDEW load profile values [#1243](https://github.com/ie3-institute/PowerSystemDataModel/issues/1243)
 - Added load profiles sources [#1106](https://github.com/ie3-institute/PowerSystemDataModel/issues/1106)
+- Add `v2gSupport` parameter to documentation of `EvcsModel` [#1278](https://github.com/ie3-institute/PowerSystemDataModel/issues/1278)
 
 ### Fixed
 - Removing opened `SwitchInput` during connectivity check [#1221](https://github.com/ie3-institute/PowerSystemDataModel/issues/1221)

build.gradle

@@ -9,7 +9,7 @@ plugins {
   id 'de.undercouch.download' version '5.6.0'
   id 'kr.motd.sphinx' version '2.10.1' // documentation generation
   id 'jacoco' // java code coverage plugin
-  id "org.sonarqube" version "6.0.1.5171" // sonarqube
+  id "org.sonarqube" version "6.1.0.5360" // sonarqube
   id 'net.thauvin.erik.gradle.semver' version '1.0.4' // semantic versioning
   id "com.github.johnrengelman.shadow" version "8.1.1" // fat jar
 }
@@ -45,6 +45,7 @@ apply from: scriptsLocation + 'mavenCentralPublish.gradle'
 apply from: scriptsLocation + 'sonarqube.gradle'
 apply from: scriptsLocation + 'vcs.gradle'
 apply from: scriptsLocation + 'semVer.gradle'
+apply from: scriptsLocation + 'branchName.gradle' // checks naming scheme of branches
 
 repositories {
   mavenCentral() // searches in Sonatype's repository 'Maven Central'
@@ -80,7 +81,7 @@ dependencies {
   testImplementation "org.junit.jupiter:junit-jupiter:$junitVersion"
   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.17.2' // Mocks of classes
+  testImplementation 'net.bytebuddy:byte-buddy:1.17.5' // Mocks of classes
 
   // testcontainers (docker framework for testing)
   testImplementation "org.testcontainers:testcontainers:$testcontainersVersion"
@@ -96,8 +97,8 @@ dependencies {
   implementation 'org.apache.logging.log4j:log4j-slf4j-impl' // log4j -> slf4j
 
   // Databases
-  implementation 'org.influxdb:influxdb-java:2.24'
-  implementation 'com.couchbase.client:java-client:3.7.8'
+  implementation 'org.influxdb:influxdb-java:2.25'
+  implementation 'com.couchbase.client:java-client:3.7.9'
   runtimeOnly 'org.postgresql:postgresql:42.7.5' // postgresql jdbc driver required during runtime
 
   implementation 'commons-io:commons-io:2.18.0' // I/O functionalities
@@ -114,7 +115,7 @@ tasks.withType(Javadoc){
   failOnError = false // TODO: Temp until JavaDoc issues are resolved
 }
 
-task printVersion {
+tasks.register('printVersion') {
   doLast {
     println project.version
   }

docs/readthedocs/models/input/participant/evcs.md

@@ -58,6 +58,10 @@ station and has some limitations outlined below.
    * - locationType
      -
      - [Charging station location types](#location-types) 
+     
+   * - v2gSupport
+     - Boolean
+     - Vehicle to grid (V2G) support, true if the charging station supports feed in.
 
    * - em
      -

docs/readthedocs/models/input/thermal/thermalhouse.md

@@ -61,7 +61,7 @@ This reflects a simple shoe box with transmission losses
      - –
      - Type of building can either be house or flat
      
-   * - numberInhabititans
+   * - numberInhabitants
      - –
      - Number of people living in the house. Double values to enable modeling based on statistical data sources.
 

gradle/scripts/branchName.gradle

@@ -0,0 +1,26 @@
+tasks.register('checkBranchName') {
+  doLast {
+    if (!project.hasProperty('branchName')) {
+      throw new GradleException("Error: Missing required property 'branchName'.")
+    }
+
+    def branchName = project.property('branchName')
+
+    def patterns = [
+      ~/^(developer|develop|dev)$/,
+      ~/.*rel\/.*/,
+      ~/^dependabot\/.*$/,
+      ~/.*hotfix\/\pL{2}\/#\d+.*/,
+      ~/.*main/,
+      ~/^[a-z]{2}\/#[0-9]+(?:-.+)?$/
+    ]
+
+    def isValid = patterns.any { pattern -> branchName ==~ pattern }
+
+    if (!isValid) {
+      throw new GradleException("Error: Check Branch name format (e.g., ps/#1337-FeatureName). Current branch name is $branchName.")
+    }
+
+    println "Branch name is $branchName"
+  }
+}

gradle/scripts/semVer.gradle

@@ -1,13 +1,13 @@
 // tasks for semantic versioning using semver-gradle https://github.com/ethauvin/semver-gradle
 
-task currentVersion {
-  doFirst{
+tasks.register('currentVersion') {
+  doFirst {
     println semver.semver
   }
 }
 
-task devVersion {
-  doFirst{
+tasks.register('devVersion') {
+  doFirst {
     println "${semver.major}.${semver.minor}-SNAPSHOT"
   }
 }

gradle/scripts/sonarqube.gradle

@@ -14,7 +14,7 @@ sonarqube {
       'src/test/groovy'] // test src dirs
     // reports stuff (for all languages)
     property 'sonar.junit.reportPaths', [
-      'build/test-results/allTests'] // Comma-delimited list of paths to Surefire XML-format reports.
+      'build/test-results/test'] // Comma-delimited list of paths to Surefire XML-format reports.
     // unit tests reports dirs
     property "sonar.coverage.jacoco.xmlReportsPath", [
       "build/reports/jacoco/test/jacocoTestReport.xml"] // Comma-separated list of paths to JaCoCo (jacoco.xml) report files.

gradle/scripts/tests.gradle

@@ -1,40 +1,40 @@
 test {
   useJUnitPlatform()
   testLogging {
-    events "skipped", "failed"
+    events = ["skipped", "failed"]
   }
 
   // Improve logging for failed Spock tests
   testLogging {
-    exceptionFormat "Full"
+    exceptionFormat = "Full"
   }
 }
 
-task unitTest(type: Test) {
-  description 'Run only unit tests.'
-  group 'Verification'
+tasks.register('unitTest', Test) {
+  description = 'Run only unit tests.'
+  group = 'Verification'
 
   filter {
     includeTestsMatching '*Test*.*'
     excludeTestsMatching '*IT'
   }
   useJUnitPlatform()
   testLogging {
-    events "skipped", "failed"
+    events = ["skipped", "failed"]
   }
 }
 
-task integrationTest(type: Test) {
-  description 'Run only the integration tests.'
-  group 'Verification'
+tasks.register('integrationTest', Test) {
+  description = 'Run only the integration tests.'
+  group = 'Verification'
 
   filter {
     includeTestsMatching '*IT.*'
     excludeTestsMatching '*Test*.*'
   }
   useJUnitPlatform()
   testLogging {
-    events "skipped", "failed"
+    events = ["skipped", "failed"]
   }
 
   mustRunAfter unitTest

scripts/branch_type.sh

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+if [ -z "${BRANCH_NAME:-}" ]; then
+  echo "Error: BRANCH_NAME variable is not set."
+  exit 1
+fi
+
+
+pattern_dev='^(developer|develop|dev)$'
+pattern_release='.*rel/.*'
+pattern_dependabot='^dependabot/.*'
+pattern_hotfix='.*hotfix/.*'
+pattern_main='.*main'
+pattern_feature='^[a-z]{2}/#[0-9]+(-.+)?$'
+
+BRANCH_TYPE="unknown"
+
+if [[ "$BRANCH_NAME" =~ $pattern_dev ]]; then
+  BRANCH_TYPE="dev"
+elif [[ "$BRANCH_NAME" =~ $pattern_release ]]; then
+  BRANCH_TYPE="release"
+elif [[ "$BRANCH_NAME" =~ $pattern_dependabot ]]; then
+  BRANCH_TYPE="dependabot"
+elif [[ "$BRANCH_NAME" =~ $pattern_hotfix ]]; then
+  BRANCH_TYPE="hotfix"
+elif [[ "$BRANCH_NAME" =~ $pattern_main ]]; then
+  BRANCH_TYPE="main"
+elif [[ "$BRANCH_NAME" =~ $pattern_feature ]]; then
+  BRANCH_TYPE="feature"
+else
+  echo "Error:'$BRANCH_NAME' does not match any pattern."
+  exit 1
+fi
+
+echo "========================="
+echo "Branch type: $BRANCH_TYPE"
+echo "BRANCH_TYPE=$BRANCH_TYPE" >> "$GITHUB_ENV"
+echo "========================="