Add priorReport

Author: reibitto

src/main/scala/sbttestshards/ShardingAlgorithm.scala

@@ -1,6 +1,6 @@
 package sbttestshards
 
-import sbttestshards.parsers.JUnitReportParser
+import sbttestshards.parsers.{FullTestReport, JUnitReportParser}
 
 import java.nio.charset.StandardCharsets
 import java.nio.file.Path
@@ -10,6 +10,8 @@ import scala.util.hashing.MurmurHash3
 // This trait is open so that users can implement a custom `ShardingAlgorithm` if they'd like
 trait ShardingAlgorithm {
 
+  def priorReport: Option[FullTestReport]
+
   def check(suiteName: String, shardContext: ShardContext): ShardResult
 
   /** Determines whether the specified suite will run on this shard or not. */
@@ -31,6 +33,8 @@ object ShardingAlgorithm {
 
       ShardResult(Some(testShard))
     }
+
+    def priorReport: Option[FullTestReport] = None
   }
 
   /** Will always mark the test to run on this shard. Useful for debugging or
@@ -40,6 +44,8 @@ object ShardingAlgorithm {
 
     def check(suiteName: String, shardContext: ShardContext): ShardResult =
       ShardResult(Some(shardContext.testShard))
+
+    def priorReport: Option[FullTestReport] = None
   }
 
   /** Will never mark the test to run on this shard. Useful for debugging or for
@@ -49,6 +55,8 @@ object ShardingAlgorithm {
 
     def check(suiteName: String, shardContext: ShardContext): ShardResult =
       ShardResult(None)
+
+    def priorReport: Option[FullTestReport] = None
   }
 
   object Balance {
@@ -57,14 +65,18 @@ object ShardingAlgorithm {
         reportDirectories: Seq[Path],
         shardsInfo: ShardingInfo,
         fallbackShardingAlgorithm: ShardingAlgorithm = ShardingAlgorithm.SuiteName
-    ): Balance =
+    ): Balance = {
+      val priorReport = JUnitReportParser.parseDirectoriesRecursively(reportDirectories)
+
       ShardingAlgorithm.Balance(
-        JUnitReportParser.parseDirectoriesRecursively(reportDirectories).testReports.map { r =>
+        priorReport.testReports.map { r =>
           SuiteInfo(r.name, Some(Duration.ofMillis((r.timeTaken * 1000).toLong)))
         },
         shardsInfo,
-        fallbackShardingAlgorithm
+        fallbackShardingAlgorithm,
+        Some(priorReport)
       )
+    }
   }
 
   /** Attempts to balance the shards by execution time so that no one shard
@@ -73,7 +85,8 @@ object ShardingAlgorithm {
   final case class Balance(
       suites: Seq[SuiteInfo],
       shardsInfo: ShardingInfo,
-      fallbackShardingAlgorithm: ShardingAlgorithm = ShardingAlgorithm.SuiteName
+      fallbackShardingAlgorithm: ShardingAlgorithm = ShardingAlgorithm.SuiteName,
+      priorReport: Option[FullTestReport] = None
   ) extends ShardingAlgorithm {
 
     // TODO: Median might be better here?

src/main/scala/sbttestshards/TestShardsPlugin.scala

@@ -2,9 +2,7 @@ package sbttestshards
 
 import sbt.*
 import sbt.Keys.*
-import sbttestshards.parsers.JUnitReportParser
-
-import java.nio.file.Paths
+import sbttestshards.parsers.FullTestReport
 
 object TestShardsPlugin extends AutoPlugin {
 
@@ -20,11 +18,6 @@ object TestShardsPlugin extends AutoPlugin {
 
   override def trigger = allRequirements
 
-  def stringConfig(key: String, default: String): String = {
-    val propertyKey = key.replace('_', '.').toLowerCase
-    sys.props.get(propertyKey).orElse(sys.env.get(key)).getOrElse(default)
-  }
-
   override lazy val projectSettings: Seq[Def.Setting[?]] =
     Seq(
       testShard := stringConfig("TEST_SHARD", "0").toInt,
@@ -50,24 +43,19 @@ object TestShardsPlugin extends AutoPlugin {
         val shardContext = ShardContext(testShard.value, testShardCount.value, sLog.value)
         val logger = shardContext.logger
         val algorithm = shardingAlgorithm.value
-
-        // TODO:: Make path customizable
-        val fullTestReport = JUnitReportParser.parseDirectoriesRecursively(
-          Seq(Paths.get(s"test-reports/main/resources/test-reports", moduleName.value))
-        )
-
+        val priorReport = algorithm.priorReport.getOrElse(FullTestReport.empty)
         val sbtSuiteNames = (Test / definedTestNames).value.toSet
-        val missingSuiteNames = sbtSuiteNames diff fullTestReport.testReports.map(_.name).toSet
+        val missingSuiteNames = sbtSuiteNames diff priorReport.testReports.map(_.name).toSet
 
-        val results = fullTestReport.testReports.map { suiteReport =>
+        val results = priorReport.testReports.map { suiteReport =>
           val shardResult = algorithm.check(suiteReport.name, shardContext)
 
           shardResult.testShard -> suiteReport
         }.collect { case (Some(shard), report) => shard -> report }
           .groupBy(_._1)
 
         results.toSeq.sortBy(_._1).foreach { case (k, v) =>
-          val totalTime = v.map(_._2.timeTaken).sum
+          val totalTime = BigDecimal(v.map(_._2.timeTaken).sum).setScale(3, BigDecimal.RoundingMode.HALF_UP)
 
           logger.info(s"[${moduleName.value}] Shard $k expected to take $totalTime s")
 
@@ -76,7 +64,7 @@ object TestShardsPlugin extends AutoPlugin {
           }
         }
 
-        if(missingSuiteNames.nonEmpty) {
+        if (missingSuiteNames.nonEmpty) {
           logger.warn(s"Detected ${missingSuiteNames.size} suites that don't have a test report")
 
           missingSuiteNames.foreach { s =>
@@ -86,4 +74,9 @@ object TestShardsPlugin extends AutoPlugin {
       }
     )
 
+  private def stringConfig(key: String, default: String): String = {
+    val propertyKey = key.replace('_', '.').toLowerCase
+    sys.props.get(propertyKey).orElse(sys.env.get(key)).getOrElse(default)
+  }
+
 }

src/main/scala/sbttestshards/parsers/JUnitReportParser.scala

@@ -1,6 +1,7 @@
 package sbttestshards.parsers
 
-import java.nio.file.{Files, Path, Paths}
+import java.nio.file.Files
+import java.nio.file.Path
 import scala.jdk.CollectionConverters.*
 import scala.xml.XML
 
@@ -18,6 +19,10 @@ final case class FullTestReport(testReports: Seq[SuiteReport]) {
   def ++(other: FullTestReport): FullTestReport = FullTestReport(testReports ++ other.testReports)
 }
 
+object FullTestReport {
+  def empty: FullTestReport = FullTestReport(Seq.empty)
+}
+
 final case class SuiteReport(
     name: String,
     testCount: Int,
@@ -83,9 +88,8 @@ object JUnitReportParser {
         val testName = (node \@ "name").trim
 
         Some(testName)
-      } else {
+      } else
         None
-      }
     }.collect { case Some(testName) =>
       testName
     }