Merge branch 'dev' into df/#856-tap-water

# Conflicts:
#	CHANGELOG.md
#	src/main/scala/edu/ie3/simona/model/participant/HpModel.scala

.github/workflows/ci.yml

@@ -0,0 +1,77 @@
+# © 2024. 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: 1
+          ref: ${{ github.event.pull_request.head.ref || github.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name || github.repository }}
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: 17
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Build Project
+        run: ./gradlew --refresh-dependencies clean assemble spotlessCheck
+
+      - name: Run Tests
+        run: ./gradlew test reportScoverage checkScoverage
+
+      - name: Build Scala-Docs
+        run: ./gradlew scaladoc
+
+      - name: SonarQube
+        run: |
+          ./gradlew sonar \
+          -Dsonar.projectKey=${{ vars.SONAR_PROJECT_KEY }} \
+          -Dsonar.host.url=${{ vars.SONAR_HOST_URL }} \
+          -Dsonar.login=${{ secrets.SONAR_TOKEN }}
+
+          SONAR_STATUS_URL="${{ vars.SONAR_HOST_URL }}/api/qualitygates/project_status?projectKey=${{ vars.SONAR_PROJECT_KEY }}"
+          QUALITY_GATE_STATUS=$(curl -s -u "${{ secrets.SONAR_TOKEN }}:" "$SONAR_STATUS_URL" | jq -r '.projectStatus.status')
+            
+          echo "Quality Gate Status: $QUALITY_GATE_STATUS"
+          if [ "$QUALITY_GATE_STATUS" != "OK" ]; then
+            echo "Quality Gate failed!"
+            exit 1
+          fi
+
+      - name: Deploy
+        if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev'
+        run: |
+          ./gradlew publish\
+            -Puser=${{ secrets.MAVENCENTRAL_USER }} \
+            -Ppassword=${{ secrets.MAVENCENTRAL_PASS }} \
+            -Psigning.keyId=${{ secrets.MAVENCENTRAL_SIGNINGKEYID }} \
+            -Psigning.password=${{ secrets.MAVENCENTRAL_SIGNINGPASS }} \
+            -Psigning.secretKeyRingFile=${{ secrets.MAVENCENTRAL_SIGNINGKEY }}

CHANGELOG.md

@@ -37,6 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added weatherData HowTo for Copernicus ERA5 data [#967](https://github.com/ie3-institute/simona/issues/967)
 - Add some quote to 'printGoodbye' [#997](https://github.com/ie3-institute/simona/issues/997)
 - Add unapply method for ThermalHouseResults [#934](https://github.com/ie3-institute/simona/issues/934)
+- Added `ApparentPower` to differentiate between different power types [#794](https://github.com/ie3-institute/simona/issues/794)
 - Integration test for thermal grids [#878](https://github.com/ie3-institute/simona/issues/878)
 
 ### Changed
@@ -100,6 +101,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated `ExtEvSimulationClasses` [#898](https://github.com/ie3-institute/simona/issues/898)
 - Refactoring of `ThermalGrid.energyGrid` to distinguish between demand of house and storage [#928](https://github.com/ie3-institute/simona/issues/928)
 - Refactoring to use zeroKW and zeroKWH in thermal grid unit tests [#1023](https://github.com/ie3-institute/simona/issues/1023)
+- Refactor `ResultFileHierarchy` [#1031](https://github.com/ie3-institute/simona/issues/1031)
 
 ### Fixed
 - Fix rendering of references in documentation [#505](https://github.com/ie3-institute/simona/issues/505)
@@ -136,6 +138,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix filter for thermal result checking for lastTick not for currentTick [#1008](https://github.com/ie3-institute/simona/issues/1008)
 - Fixed `CHANGELOG` entry for issue ([#103](https://github.com/ie3-institute/simona/issues/103)) [#941](https://github.com/ie3-institute/simona/issues/941)
 - Fix grammar and spelling in docs and comments [#1022](https://github.com/ie3-institute/simona/issues/1022)
+- Fix some minor issues and findings from inspections [#1019](https://github.com/ie3-institute/simona/issues/1019)
+- Fix initialisation freezing on empty primary data [#981](https://github.com/ie3-institute/simona/issues/981)
 
 ## [3.0.0] - 2023-08-07
 

Jenkinsfile

@@ -111,7 +111,7 @@ node {
 
         sh 'java -version'
 
-        gradle('--refresh-dependencies spotlessCheck pmdMain pmdTest', projectName)
+        gradle('--refresh-dependencies spotlessCheck test', projectName)
 
         sh(script: """set +x && cd $projectName""" + ''' set +x; ./gradlew javadoc''', returnStdout: true)
       }
@@ -421,9 +421,6 @@ def publishReports(String relativeProjectDir) {
   // publish test reports
   publishHTML([allowMissing: true, alwaysLinkToLastBuild: true, escapeUnderscores: false, keepAll: true, reportDir: relativeProjectDir + '/build/reports/tests/allTests', reportFiles: 'index.html', reportName: "${relativeProjectDir}_java_tests_report", reportTitles: ''])
 
-  // publish pmd report for main project only
-  publishHTML([allowMissing: true, alwaysLinkToLastBuild: true, escapeUnderscores: false, keepAll: true, reportDir: relativeProjectDir + '/build/reports/pmd', reportFiles: 'main.html', reportName: "${relativeProjectDir}_pmd_report", reportTitles: ''])
-
   // publish scalatest reports for main project only (currently the only one with scala sources!)
   publishHTML([allowMissing: false, alwaysLinkToLastBuild: true, escapeUnderscores: false, keepAll: true, reportDir: relativeProjectDir + '/build/reports/tests/scalatest', reportFiles: 'index.html', reportName: "${relativeProjectDir}_scala_tests_report", reportTitles: ''])
 

build.gradle

@@ -6,7 +6,6 @@ plugins {
   id 'scala' // scala support
   id 'signing'
   id 'maven-publish' // publish to a maven repo (local or mvn central, has to be defined)
-  id 'pmd' // code check, working on source code
   id 'com.diffplug.spotless' version '6.25.0'// code format
   id "com.github.ben-manes.versions" version '0.51.0'
   id "de.undercouch.download" version "5.6.0" // downloads plugin
@@ -45,7 +44,6 @@ java {
   targetCompatibility = javaVersion
 }
 
-apply from: scriptsLocation + 'pmd.gradle'
 apply from: scriptsLocation + 'spotless.gradle'
 apply from: scriptsLocation + 'checkJavaVersion.gradle'
 apply from: scriptsLocation + 'tscfg.gradle' // config tasks

docs/readthedocs/requirements.txt

@@ -3,5 +3,5 @@ sphinx-rtd-theme==3.0.2
 sphinxcontrib-plantuml==0.30
 myst-parser==4.0.0
 markdown-it-py==3.0.0
-sphinx-hoverxref==1.4.1
+sphinx-hoverxref==1.4.2
 sphinxcontrib-bibtex==2.6.3

gradle/scripts/sonarqube.gradle

@@ -34,8 +34,6 @@ sonarqube {
 }
 
 // sonarqube task dependencies
-project.tasks["sonarqube"].dependsOn "pmdMain"
-project.tasks["sonarqube"].dependsOn "pmdTest"
 project.tasks["sonarqube"].dependsOn "test"
 project.tasks["sonarqube"].dependsOn "reportScoverage"
 project.tasks["sonarqube"].dependsOn "checkScoverage"

src/main/scala/edu/ie3/simona/agent/em/EmAgent.scala

@@ -8,7 +8,7 @@ package edu.ie3.simona.agent.em
 
 import edu.ie3.datamodel.models.input.EmInput
 import edu.ie3.datamodel.models.result.system.{EmResult, FlexOptionsResult}
-import edu.ie3.simona.agent.participant.data.Data.PrimaryData.ApparentPower
+import edu.ie3.simona.agent.participant.data.Data.PrimaryData.ComplexPower
 import edu.ie3.simona.agent.participant.statedata.BaseStateData.FlexControlledData
 import edu.ie3.simona.config.SimonaConfig.EmRuntimeConfig
 import edu.ie3.simona.event.ResultEvent
@@ -409,7 +409,7 @@ object EmAgent {
     // After initialization, there are no results yet.
     val maybeResult = inactiveCore.getResults
       .reduceOption { (power1, power2) =>
-        ApparentPower(power1.p + power2.p, power1.q + power2.q)
+        ComplexPower(power1.p + power2.p, power1.q + power2.q)
       }
 
     maybeResult.foreach { result =>

src/main/scala/edu/ie3/simona/agent/em/EmDataCore.scala

@@ -8,7 +8,7 @@ package edu.ie3.simona.agent.em
 
 import edu.ie3.simona.agent.em.EmAgent.Actor
 import edu.ie3.simona.agent.em.FlexCorrespondenceStore.WithTime
-import edu.ie3.simona.agent.participant.data.Data.PrimaryData.ApparentPower
+import edu.ie3.simona.agent.participant.data.Data.PrimaryData.ComplexPower
 import edu.ie3.simona.exceptions.CriticalFailureException
 import edu.ie3.simona.ontology.messages.flex.FlexibilityMessage._
 import edu.ie3.simona.util.SimonaConstants.INIT_SIM_TICK
@@ -163,7 +163,7 @@ object EmDataCore {
 
     /** Returns relevant results for all connected agents.
       */
-    def getResults: Iterable[ApparentPower] =
+    def getResults: Iterable[ComplexPower] =
       correspondences.store.values.flatMap(_.receivedResult.map(_.get))
 
   }

src/main/scala/edu/ie3/simona/agent/em/FlexCorrespondenceStore.scala

@@ -10,7 +10,7 @@ import edu.ie3.simona.agent.em.FlexCorrespondenceStore.{
   FlexCorrespondence,
   WithTime,
 }
-import edu.ie3.simona.agent.participant.data.Data.PrimaryData.ApparentPower
+import edu.ie3.simona.agent.participant.data.Data.PrimaryData.ComplexPower
 import edu.ie3.simona.ontology.messages.flex.FlexibilityMessage.{
   IssueFlexControl,
   ProvideFlexOptions,
@@ -88,7 +88,7 @@ final case class FlexCorrespondenceStore(
     */
   def updateResult(
       modelUuid: UUID,
-      result: ApparentPower,
+      result: ComplexPower,
       tick: Long,
   ): FlexCorrespondenceStore =
     updateCorrespondence(
@@ -124,7 +124,7 @@ object FlexCorrespondenceStore {
   final case class FlexCorrespondence(
       receivedFlexOptions: Option[WithTime[ProvideFlexOptions]] = None,
       issuedCtrlMsg: Option[WithTime[IssueFlexControl]] = None,
-      receivedResult: Option[WithTime[ApparentPower]] = None,
+      receivedResult: Option[WithTime[ComplexPower]] = None,
   )
 
   /** Wrapper that allows storing a tick with an object

src/main/scala/edu/ie3/simona/agent/grid/GridResultsSupport.scala

@@ -201,8 +201,9 @@ private[grid] trait GridResultsSupport {
     * @return
     *   a set of [[PartialTransformer3wResult]] s
     */
-  def buildTransformer3wResults(transformers3w: Set[Transformer3wModel])(
-      implicit
+  private def buildTransformer3wResults(
+      transformers3w: Set[Transformer3wModel]
+  )(implicit
       sweepValueStoreData: Map[UUID, SweepValueStoreData],
       iNominal: ElectricCurrent,
       timestamp: ZonedDateTime,