Merge pull request #133 from RichardBradley/132-coverageMinimum

#132 clarify when reports are generated and when minimums are applied

Author: sksamuel

README.md

@@ -57,7 +57,11 @@ Next, the keys have been renamed slightly. The new names begin with coverageXXX,
 
 ## Multi project reports
 
-By default, scoverage will generate reports for each project seperately. You can merge them into an aggregated report by invoking `sbt coverageAggregate`. Note, you must do this after all the coverage data is complete as a separate command, so you cannot do `sbt coverage test coverageAggregate` (at least until a way around this is found).
+By default, scoverage will generate reports for each project seperately. You can merge them into an aggregated report by invoking `sbt coverageAggregate`.
+
+(Note, you must do this after all the coverage data is complete as a separate command, so you cannot do `sbt coverage test coverageAggregate` (at least until a way around this is found).)
+
+(You must have first run `sbt coverageReport` for `coverageAggregate` to work. It aggregates over the sub-projects' report xml rather than over the coverage data directly.)
 
 ## Exclude classes and packages
 
@@ -92,6 +96,9 @@ coverageMinimum := 80
 coverageFailOnMinimum := true
 ```
 
+These settings will be enforced when the reports are generated.
+If you generate an aggregate report using `coverageAggregate` then these settings will apply to that report.
+
 ## Highlighting
 
 If you are using Scala 2.11.1 or less, then highlighting will not work (due to this bug which was fixed in 2.11.2 https://github.com/scala/scala/pull/3799). In that case you must disable highlighting by adding the following to your build:

src/main/scala/scoverage/ScoverageSbtPlugin.scala

@@ -25,8 +25,6 @@ object ScoverageSbtPlugin extends AutoPlugin {
     commands += Command.command("coverage", "enable compiled code with instrumentation", "")(toggleCoverage(true)),
     commands += Command.command("coverageOff", "disable compiled code with instrumentation", "")(toggleCoverage(false)),
     coverageReport <<= coverageReport0,
-    testOptions in Test += postTestReport.value,
-    testOptions in IntegrationTest += postTestReport.value,
     coverageAggregate <<= coverageAggregate0,
     libraryDependencies ++= Seq(
       OrgScoverage % (ScalacRuntimeArtifact + "_" + scalaBinaryVersion.value) % ScoverageVersion % "provided" intransitive(),
@@ -67,15 +65,19 @@ object ScoverageSbtPlugin extends AutoPlugin {
     Thread.sleep(1000) // have noticed some delay in writing on windows, hacky but works
 
     loadCoverage(target, log) match {
-      case Some(cov) => writeReports(target,
-        (sourceDirectories in Compile).value,
-        cov,
-        coverageOutputCobertura.value,
-        coverageOutputXML.value,
-        coverageOutputHTML.value,
-        coverageOutputDebug.value,
-        coverageOutputTeamCity.value,
-        log)
+      case Some(cov) =>
+        writeReports(
+          target,
+          (sourceDirectories in Compile).value,
+          cov,
+          coverageOutputCobertura.value,
+          coverageOutputXML.value,
+          coverageOutputHTML.value,
+          coverageOutputDebug.value,
+          coverageOutputTeamCity.value,
+          log)
+
+        checkCoverage(cov, log, coverageMinimum.value, coverageFailOnMinimum.value)
       case None => log.warn("No coverage data, skipping reports")
     }
   }
@@ -87,7 +89,8 @@ object ScoverageSbtPlugin extends AutoPlugin {
     val xmlReportFiles = crossTarget.all(aggregateFilter).value map (_ / "scoverage-report" / Constants.XMLReportFilename) filter (_.isFile())
     CoverageAggregator.aggregate(xmlReportFiles, coverageCleanSubprojectFiles.value) match {
       case Some(cov) =>
-        writeReports(crossTarget.value,
+        writeReports(
+          crossTarget.value,
           sourceDirectories.all(aggregateFilter).value.flatten,
           cov,
           coverageOutputCobertura.value,
@@ -98,6 +101,8 @@ object ScoverageSbtPlugin extends AutoPlugin {
           log)
         val cfmt = cov.statementCoverageFormatted
         log.info(s"Aggregation complete. Coverage was [$cfmt]")
+
+        checkCoverage(cov, log, coverageMinimum.value, coverageFailOnMinimum.value)
       case None =>
         log.info("No subproject data to aggregate, skipping reports")
     }
@@ -117,30 +122,6 @@ object ScoverageSbtPlugin extends AutoPlugin {
     }
   }
 
-  private lazy val postTestReport = Def.task {
-    val log = streams.value.log
-    val target = crossTarget.value
-    Tests.Cleanup {
-      () => if (coverageEnabled.value) {
-        loadCoverage(target, log) foreach { c =>
-          writeReports(
-            target,
-            (sourceDirectories in Compile).value,
-            c,
-            coverageOutputCobertura.value,
-            coverageOutputXML.value,
-            coverageOutputHTML.value,
-            coverageOutputDebug.value,
-            coverageOutputTeamCity.value,
-            log
-          )
-          checkCoverage(c, log, coverageMinimum.value, coverageFailOnMinimum.value)
-        }
-        ()
-      }
-    }
-  }
-
   private def scalaArgs(coverageEnabled: Boolean,
                         pluginPath: File,
                         target: File,

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

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