Merge branch 'dev' into ms/#794-differentiate-between-different-power…

…-types

CHANGELOG.md

@@ -100,6 +100,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)

src/main/scala/edu/ie3/simona/event/listener/ResultEventListener.scala

@@ -88,7 +88,7 @@ object ResultEventListener extends Transformer3wResultSupport {
 
           filePathFuture.map { fileName =>
             val finalFileName =
-              fileName match {
+              fileName.toString match {
                 case name if name.endsWith(".csv.gz") && enableCompression =>
                   name.replace(".gz", "")
                 case name if name.endsWith(".csv") => name

src/main/scala/edu/ie3/simona/logging/logback/LogbackConfiguration.scala

@@ -16,16 +16,16 @@ import ch.qos.logback.core.filter.Filter
 import com.typesafe.scalalogging.LazyLogging
 import org.slf4j.LoggerFactory
 
-import java.io.File
+import java.nio.file.Path
 import scala.jdk.CollectionConverters._
 
 object LogbackConfiguration extends LazyLogging {
 
-  def default(logPath: String): Unit = {
+  def default(logPath: Path): Unit = {
     LoggerFactory.getILoggerFactory match {
       case loggerContext: LoggerContext =>
         val rootLogger = loggerContext.getLogger("root")
-        val log = logPath.concat(File.separator).concat("simona.log")
+        val log = logPath.resolve("simona.log")
         // stop all appenders
         rootLogger.iteratorForAppenders().asScala.foreach(_.stop())
         /* Identify the filters of existing rolling file appender */
@@ -58,7 +58,7 @@ object LogbackConfiguration extends LazyLogging {
   }
 
   private def fileAppender(
-      logPath: String,
+      logPath: Path,
       appenderName: String,
       maybeFilterList: Option[Seq[Filter[ILoggingEvent]]],
       loggerContext: LoggerContext,
@@ -70,7 +70,7 @@ object LogbackConfiguration extends LazyLogging {
     layoutEncoder.start()
 
     val fileAppender = new FileAppender[ILoggingEvent]
-    fileAppender.setFile(logPath)
+    fileAppender.setFile(logPath.toString)
     fileAppender.setEncoder(layoutEncoder)
     fileAppender.setContext(loggerContext)
     fileAppender.setName(appenderName)

src/main/scala/edu/ie3/simona/main/RunSimona.scala

@@ -57,7 +57,7 @@ trait RunSimona[T <: SimonaSetup] extends LazyLogging {
 
   private def printGoodbye(
       successful: Boolean,
-      outputPath: String = "",
+      logOutputDir: Path,
   ): Unit = {
     val myWords = Array(
       "\"Vielleicht ist heute ein besonders guter Tag zum Sterben.\" - Worf (in Star Trek: Der erste Kontakt)",
@@ -78,7 +78,7 @@ trait RunSimona[T <: SimonaSetup] extends LazyLogging {
       // to ensure that the link to the log is printed last
       Thread.sleep(1000)
 
-      val path = Path.of(outputPath).resolve("simona.log").toUri
+      val path = logOutputDir.resolve("simona.log").toUri
 
       logger.error(
         s"Simulation stopped due to the occurrence of an error! The full log can be found here: $path"

src/main/scala/edu/ie3/simona/sim/setup/SetupHelper.scala

@@ -202,25 +202,21 @@ trait SetupHelper extends LazyLogging {
   /** Build the result file hierarchy based on the provided configuration file.
     * The provided type safe config must be able to be parsed as
     * [[SimonaConfig]], otherwise an exception is thrown
+    *
     * @param config
     *   the configuration file
-    * @param createDirs
-    *   if directories of the result file hierarchy should be created or not
     * @return
     *   the resulting result file hierarchy
     */
-  def buildResultFileHierarchy(
-      config: TypesafeConfig,
-      createDirs: Boolean = true,
-  ): ResultFileHierarchy = {
+  def buildResultFileHierarchy(config: TypesafeConfig): ResultFileHierarchy = {
 
     val simonaConfig = SimonaConfig(config)
 
     /* Determine the result models to write */
     val modelsToWrite =
       SetupHelper.allResultEntitiesToWrite(simonaConfig.simona.output)
 
-    val resultFileHierarchy = ResultFileHierarchy(
+    ResultFileHierarchy(
       simonaConfig.simona.output.base.dir,
       simonaConfig.simona.simulationName,
       ResultEntityPathConfig(
@@ -230,15 +226,10 @@ trait SetupHelper extends LazyLogging {
           simonaConfig.simona.simulationName,
         ),
       ),
+      config = Some(config),
       addTimeStampToOutputDir =
         simonaConfig.simona.output.base.addTimestampToOutputDir,
-      createDirs = createDirs,
     )
-
-    // copy config data to output directory
-    ResultFileHierarchy.prepareDirectories(config, resultFileHierarchy)
-
-    resultFileHierarchy
   }
 }
 

src/main/scala/edu/ie3/simona/sim/setup/SimonaSetup.scala

@@ -21,6 +21,8 @@ import org.apache.pekko.actor.typed.ActorRef
 import org.apache.pekko.actor.typed.scaladsl.ActorContext
 import org.apache.pekko.actor.{ActorRef => ClassicRef}
 
+import java.nio.file.Path
+
 /** Trait that can be used to set up a customized simona simulation by providing
   * implementations for all setup information required by a
   * [[edu.ie3.simona.sim.SimonaSim]]. Most of the time, using or extending
@@ -40,7 +42,7 @@ trait SimonaSetup {
 
   /** Directory of the log output.
     */
-  def logOutputDir: String
+  def logOutputDir: Path
 
   /** Creates the runtime event listener
     *

src/main/scala/edu/ie3/simona/sim/setup/SimonaStandaloneSetup.scala

@@ -50,6 +50,7 @@ import org.apache.pekko.actor.typed.scaladsl.adapter.{
 }
 import org.apache.pekko.actor.{ActorRef => ClassicRef}
 
+import java.nio.file.Path
 import java.util.UUID
 import java.util.concurrent.LinkedBlockingQueue
 import scala.jdk.CollectionConverters._
@@ -68,7 +69,7 @@ class SimonaStandaloneSetup(
     override val args: Array[String],
 ) extends SimonaSetup {
 
-  override def logOutputDir: String = resultFileHierarchy.logOutputDir
+  override def logOutputDir: Path = resultFileHierarchy.logOutputDir
 
   override def gridAgents(
       context: ActorContext[_],