Coverage minima: add more fine-grained control

Along with existing statement minimum, add branch minimum. Also, include
this pair of control at the package and file level.

Author: Albert Meltzer

README.md

@@ -89,8 +89,13 @@ coverage report.
 Based on minimum coverage, you can fail the build with the following keys:
 
 ```scala
-coverageMinimum := 80
+coverageMinimum := 95
 coverageFailOnMinimum := true
+coverageMinimumBranchTotal := 90
+coverageMinimumStmtPerPackage := 90
+coverageMinimumBranchPerPackage := 85
+coverageMinimumStmtPerFile := 85
+coverageMinimumBranchPerFile := 80
 ```
 
 These settings will be enforced when the reports are generated.  If you generate

src/main/scala/scoverage/ScoverageKeys.scala

@@ -11,7 +11,12 @@ object ScoverageKeys {
   lazy val coverageAggregate = taskKey[Unit]("aggregate reports from subprojects")
   lazy val coverageExcludedPackages = settingKey[String]("regex for excluded packages")
   lazy val coverageExcludedFiles = settingKey[String]("regex for excluded file paths")
-  lazy val coverageMinimum = settingKey[Double]("scoverage-minimum-coverage")
+  lazy val coverageMinimum = settingKey[Double]("scoverage-minimum-coverage-stmt-total")
+  lazy val coverageMinimumBranchTotal = settingKey[Double]("scoverage-minimum-coverage-branch-total")
+  lazy val coverageMinimumStmtPerPackage = settingKey[Double]("scoverage-minimum-coverage-stmt-per-package")
+  lazy val coverageMinimumBranchPerPackage = settingKey[Double]("scoverage-minimum-coverage-branch-per-package")
+  lazy val coverageMinimumStmtPerFile = settingKey[Double]("scoverage-minimum-coverage-stmt-per-file")
+  lazy val coverageMinimumBranchPerFile = settingKey[Double]("scoverage-minimum-coverage-branch-per-file")
   lazy val coverageFailOnMinimum = settingKey[Boolean]("if coverage is less than this value then fail build")
   lazy val coverageHighlighting = settingKey[Boolean]("enables range positioning for highlighting")
   lazy val coverageOutputCobertura = settingKey[Boolean]("enables cobertura XML report generation")
@@ -21,4 +26,33 @@ object ScoverageKeys {
   lazy val coverageOutputTeamCity = settingKey[Boolean]("turn on teamcity reporting")
   lazy val coverageScalacPluginVersion = settingKey[String]("version of scalac-scoverage-plugin to use")
   // format: on
+
+  def coverageMinima = Def.setting {
+    CoverageMinima(
+      total = CoverageMinimum(
+        statement = coverageMinimum.value,
+        branch = coverageMinimumBranchTotal.value
+      ),
+      perPackage = CoverageMinimum(
+        statement = coverageMinimumStmtPerPackage.value,
+        branch = coverageMinimumBranchPerPackage.value
+      ),
+      perFile = CoverageMinimum(
+        statement = coverageMinimumStmtPerFile.value,
+        branch = coverageMinimumBranchPerFile.value
+      )
+    )
+  }
+
+  case class CoverageMinimum(
+      statement: Double,
+      branch: Double
+  )
+
+  case class CoverageMinima(
+      total: CoverageMinimum,
+      perPackage: CoverageMinimum,
+      perFile: CoverageMinimum
+  )
+
 }

src/main/scala/scoverage/ScoverageSbtPlugin.scala

@@ -35,6 +35,11 @@ object ScoverageSbtPlugin extends AutoPlugin {
       coverageExcludedPackages := "",
       coverageExcludedFiles := "",
       coverageMinimum := 0, // default is no minimum
+      coverageMinimumBranchTotal := 0,
+      coverageMinimumStmtPerPackage := 0,
+      coverageMinimumBranchPerPackage := 0,
+      coverageMinimumStmtPerFile := 0,
+      coverageMinimumBranchPerFile := 0,
       coverageFailOnMinimum := false,
       coverageHighlighting := true,
       coverageOutputXML := true,
@@ -156,7 +161,7 @@ object ScoverageSbtPlugin extends AutoPlugin {
         checkCoverage(
           cov,
           log,
-          coverageMinimum.value,
+          coverageMinima.value,
           coverageFailOnMinimum.value
         )
       case None => log.warn("No coverage data, skipping reports")
@@ -190,7 +195,7 @@ object ScoverageSbtPlugin extends AutoPlugin {
         checkCoverage(
           cov,
           log,
-          coverageMinimum.value,
+          coverageMinima.value,
           coverageFailOnMinimum.value
         )
       case None =>
@@ -329,29 +334,72 @@ object ScoverageSbtPlugin extends AutoPlugin {
   private def checkCoverage(
       coverage: Coverage,
       log: Logger,
-      min: Double,
+      min: CoverageMinima,
       failOnMin: Boolean
   ): Unit = {
+    val ok: Boolean = checkCoverage(coverage, "Total", log, min.total) &&
+      coverage.packages.forall(x =>
+        checkCoverage(x, s"Package:${x.name}", log, min.perPackage)
+      ) &&
+      coverage.files.forall(x =>
+        checkCoverage(x, s"File:${x.filename}", log, min.perFile)
+      )
 
-    val cper = coverage.statementCoveragePercent
-    val cfmt = coverage.statementCoverageFormatted
+    if (!ok && failOnMin)
+      throw new RuntimeException("Coverage minimum was not reached")
 
+    log.info(
+      s"All done. Coverage was [${coverage.statementCoverageFormatted}%]"
+    )
+  }
+
+  private def checkCoverage(
+      metrics: CoverageMetrics,
+      metric: String,
+      log: Logger,
+      min: CoverageMinimum
+  ): Boolean = {
+    checkCoverage(
+      s"Branch:$metric",
+      log,
+      min.branch,
+      metrics.branchCoveragePercent
+    ) &&
+    checkCoverage(
+      s"Stmt:$metric",
+      log,
+      min.statement,
+      metrics.statementCoveragePercent
+    )
+  }
+
+  private def checkCoverage(
+      metric: String,
+      log: Logger,
+      min: Double,
+      cper: Double
+  ): Boolean = {
     // check for default minimum
-    if (min > 0) {
+    if (min <= 0) {
+      true
+    } else {
       def is100(d: Double) = Math.abs(100 - d) <= 0.00001
 
       if (is100(min) && is100(cper)) {
-        log.info(s"100% Coverage !")
-      } else if (min > cper) {
-        log.error(s"Coverage is below minimum [$cfmt% < $min%]")
-        if (failOnMin)
-          throw new RuntimeException("Coverage minimum was not reached")
+        log.debug(s"100% Coverage: $metric")
+        true
       } else {
-        log.info(s"Coverage is above minimum [$cfmt% > $min%]")
+        val ok: Boolean = min <= cper
+        val minfmt = scoverage.DoubleFormat.twoFractionDigits(min)
+        val cfmt = scoverage.DoubleFormat.twoFractionDigits(cper)
+        if (ok) {
+          log.debug(s"Coverage is above minimum [$cfmt% > $minfmt%]: $metric")
+        } else {
+          log.error(s"Coverage is below minimum [$cfmt% < $minfmt%]: $metric")
+        }
+        ok
       }
     }
-
-    log.info(s"All done. Coverage was [$cfmt%]")
   }
 
   private def sourceEncoding(scalacOptions: Seq[String]): Option[String] = {

src/sbt-test/scoverage/bad-coverage-file-branch/build.sbt

@@ -0,0 +1,14 @@
+version := "0.1"
+
+scalaVersion := "2.13.5"
+
+libraryDependencies += "org.scalameta" %% "munit" % "0.7.25" % Test
+
+coverageMinimumBranchPerFile := 80
+
+coverageFailOnMinimum := true
+
+resolvers ++= {
+  if (sys.props.get("plugin.version").map(_.endsWith("-SNAPSHOT")).getOrElse(false)) Seq(Resolver.sonatypeRepo("snapshots"))
+  else Seq.empty
+}

src/sbt-test/scoverage/bad-coverage-file-branch/project/plugins.sbt

@@ -0,0 +1,14 @@
+val pluginVersion = sys.props.getOrElse(
+  "plugin.version",
+  throw new RuntimeException(
+    """|The system property 'plugin.version' is not defined.
+       |Specify this property using the scriptedLaunchOpts -D.""".stripMargin))
+
+addSbtPlugin("org.scoverage" % "sbt-scoverage" % pluginVersion)
+
+resolvers ++= {
+  if (pluginVersion.endsWith("-SNAPSHOT"))
+    Seq(Resolver.sonatypeRepo("snapshots"))
+  else
+    Seq.empty
+}

src/sbt-test/scoverage/bad-coverage-file-branch/src/main/scala/one/BadCoverage.scala

@@ -0,0 +1,9 @@
+package one
+
+object BadCoverage {
+
+  def sum(num1: Int, num2: Int) = {
+    if (0 == num1) num2 else if (0 == num2) num1 else num1 + num2
+  }
+
+}

src/sbt-test/scoverage/bad-coverage-file-branch/src/main/scala/two/BadCoverage.scala

@@ -0,0 +1,9 @@
+package two
+
+object BadCoverage {
+
+  def sum(num1: Int, num2: Int) = {
+    if (0 == num1) num2 else if (0 == num2) num1 else num1 + num2
+  }
+
+}

src/sbt-test/scoverage/bad-coverage-file-branch/src/test/scala/BadCoverageSpec.scala

@@ -0,0 +1,16 @@
+import munit.FunSuite
+
+class BadCoverageSpec extends FunSuite {
+
+  test("one.BadCoverage should sum two numbers") {
+    assertEquals(one.BadCoverage.sum(1, 2), 3)
+    assertEquals(one.BadCoverage.sum(0, 3), 3)
+    assertEquals(one.BadCoverage.sum(3, 0), 3)
+  }
+
+  test("two.BadCoverage should sum two numbers") {
+    assertEquals(two.BadCoverage.sum(1, 2), 3)
+    assertEquals(two.BadCoverage.sum(0, 3), 3)
+  }
+
+}

src/sbt-test/scoverage/bad-coverage-file-branch/test

@@ -0,0 +1,5 @@
+# run scoverage
+> clean
+> coverage
+> test
+-> coverageReport

src/sbt-test/scoverage/bad-coverage-file-stmt/build.sbt

@@ -0,0 +1,14 @@
+version := "0.1"
+
+scalaVersion := "2.13.5"
+
+libraryDependencies += "org.scalameta" %% "munit" % "0.7.25" % Test
+
+coverageMinimumStmtPerFile := 90
+
+coverageFailOnMinimum := true
+
+resolvers ++= {
+  if (sys.props.get("plugin.version").map(_.endsWith("-SNAPSHOT")).getOrElse(false)) Seq(Resolver.sonatypeRepo("snapshots"))
+  else Seq.empty
+}

src/sbt-test/scoverage/bad-coverage-file-stmt/project/plugins.sbt

@@ -0,0 +1,14 @@
+val pluginVersion = sys.props.getOrElse(
+  "plugin.version",
+  throw new RuntimeException(
+    """|The system property 'plugin.version' is not defined.
+       |Specify this property using the scriptedLaunchOpts -D.""".stripMargin))
+
+addSbtPlugin("org.scoverage" % "sbt-scoverage" % pluginVersion)
+
+resolvers ++= {
+  if (pluginVersion.endsWith("-SNAPSHOT"))
+    Seq(Resolver.sonatypeRepo("snapshots"))
+  else
+    Seq.empty
+}

src/sbt-test/scoverage/bad-coverage-file-stmt/src/main/scala/one/BadCoverage.scala

@@ -0,0 +1,9 @@
+package one
+
+object BadCoverage {
+
+  def sum(num1: Int, num2: Int) = {
+    if (0 == num1) num2 else if (0 == num2) num1 else num1 + num2
+  }
+
+}

src/sbt-test/scoverage/bad-coverage-file-stmt/src/main/scala/two/BadCoverage.scala

@@ -0,0 +1,9 @@
+package two
+
+object BadCoverage {
+
+  def sum(num1: Int, num2: Int) = {
+    if (0 == num1) num2 else if (0 == num2) num1 else num1 + num2
+  }
+
+}

src/sbt-test/scoverage/bad-coverage-file-stmt/src/test/scala/BadCoverageSpec.scala

@@ -0,0 +1,15 @@
+import munit.FunSuite
+
+class BadCoverageSpec extends FunSuite {
+
+  test("one.BadCoverage should sum two numbers") {
+    assertEquals(one.BadCoverage.sum(1, 2), 3)
+    assertEquals(one.BadCoverage.sum(0, 3), 3)
+    assertEquals(one.BadCoverage.sum(3, 0), 3)
+  }
+
+  test("two.BadCoverage should sum two numbers") {
+    assertEquals(two.BadCoverage.sum(1, 2), 3)
+  }
+
+}

src/sbt-test/scoverage/bad-coverage-file-stmt/test

@@ -0,0 +1,5 @@
+# run scoverage
+> clean
+> coverage
+> test
+-> coverageReport

src/sbt-test/scoverage/bad-coverage-package-branch/build.sbt

@@ -0,0 +1,14 @@
+version := "0.1"
+
+scalaVersion := "2.13.5"
+
+libraryDependencies += "org.scalameta" %% "munit" % "0.7.25" % Test
+
+coverageMinimumBranchPerPackage := 80
+
+coverageFailOnMinimum := true
+
+resolvers ++= {
+  if (sys.props.get("plugin.version").map(_.endsWith("-SNAPSHOT")).getOrElse(false)) Seq(Resolver.sonatypeRepo("snapshots"))
+  else Seq.empty
+}

src/sbt-test/scoverage/bad-coverage-package-branch/project/plugins.sbt

@@ -0,0 +1,14 @@
+val pluginVersion = sys.props.getOrElse(
+  "plugin.version",
+  throw new RuntimeException(
+    """|The system property 'plugin.version' is not defined.
+       |Specify this property using the scriptedLaunchOpts -D.""".stripMargin))
+
+addSbtPlugin("org.scoverage" % "sbt-scoverage" % pluginVersion)
+
+resolvers ++= {
+  if (pluginVersion.endsWith("-SNAPSHOT"))
+    Seq(Resolver.sonatypeRepo("snapshots"))
+  else
+    Seq.empty
+}

src/sbt-test/scoverage/bad-coverage-package-branch/src/main/scala/one/BadCoverage.scala

@@ -0,0 +1,9 @@
+package one
+
+object BadCoverage {
+
+  def sum(num1: Int, num2: Int) = {
+    if (0 == num1) num2 else if (0 == num2) num1 else num1 + num2
+  }
+
+}

src/sbt-test/scoverage/bad-coverage-package-branch/src/main/scala/two/BadCoverage.scala

@@ -0,0 +1,9 @@
+package two
+
+object BadCoverage {
+
+  def sum(num1: Int, num2: Int) = {
+    if (0 == num1) num2 else if (0 == num2) num1 else num1 + num2
+  }
+
+}

src/sbt-test/scoverage/bad-coverage-package-branch/src/test/scala/BadCoverageSpec.scala

@@ -0,0 +1,16 @@
+import munit.FunSuite
+
+class BadCoverageSpec extends FunSuite {
+
+  test("one.BadCoverage should sum two numbers") {
+    assertEquals(one.BadCoverage.sum(1, 2), 3)
+    assertEquals(one.BadCoverage.sum(0, 3), 3)
+    assertEquals(one.BadCoverage.sum(3, 0), 3)
+  }
+
+  test("two.BadCoverage should sum two numbers") {
+    assertEquals(two.BadCoverage.sum(1, 2), 3)
+    assertEquals(two.BadCoverage.sum(0, 3), 3)
+  }
+
+}

src/sbt-test/scoverage/bad-coverage-package-branch/test

@@ -0,0 +1,5 @@
+# run scoverage
+> clean
+> coverage
+> test
+-> coverageReport