Make the plugin configure the scalac-plugin classpath and the aggregation task automatically

Author: eyalroth

README.md

@@ -12,11 +12,12 @@ This creates an additional task `testScoverage` which will run tests against ins
 
 A further task `reportScoverage` produces XML and HTML reports for analysing test code coverage.
 
-You need to configure the version of Scoverage that will be used. This plugin should be compatible with all 1+ versions.
+You can configure the version of Scoverage that will be used. This plugin should be compatible with all 1+ versions.
 
 ```groovy
-dependencies {
-    scoverage 'org.scoverage:scalac-scoverage-plugin_2.11:1.1.0', 'org.scoverage:scalac-scoverage-runtime_2.11:1.1.0'
+scoverage {
+    scoverageVersion = "1.3.1"
+    scoverageScalaVersion = "2.12" // will be overridden by the 'scala-library' version (if configured)
 }
 ```
 
@@ -49,14 +50,7 @@ Aggregating Reports
 
 There is now experimental support for aggregating coverage statistics across sub-projects.
 
-The project hosting the aggregation task **must** be configured as the sub-projects are;
-i.e. with the scoverage plugin applied and the scoverage dependencies configured.
-
-You also have to declare this task:
-
-```groovy
-task aggregateScoverage(type: org.scoverage.ScoverageAggregate)
-```
+When applied on a project with sub-projects, the plugin will create the aggregation task `aggregateScoverage`. 
 
 This will produce a report into `build/scoverage-aggregate` directory.
 

build.gradle

@@ -48,7 +48,7 @@ sourceCompatibility = '1.6'
 targetCompatibility = '1.6'
 
 dependencies {
-    compile "org.scoverage:scalac-scoverage-plugin_2.12:1.3.1"
+    compileOnly "org.scoverage:scalac-scoverage-plugin_2.12:1.3.1"
     testCompile 'junit:junit:4.12'
     testCompile 'org.hamcrest:hamcrest-library:1.3'
 }

src/functionalTest/java/org.scoverage/ScalaSingleModuleTest.java

@@ -74,7 +74,7 @@ public void checkScoverage() {
         result.assertTaskOutcome(ScoveragePlugin.getTEST_NAME(), TaskOutcome.SUCCESS);
         result.assertTaskOutcome(ScoveragePlugin.getREPORT_NAME(), TaskOutcome.SUCCESS);
         result.assertTaskOutcome(ScoveragePlugin.getCHECK_NAME(), TaskOutcome.SUCCESS);
-        result.assertTaskSkipped(ScoveragePlugin.getAGGREGATE_NAME());
+        result.assertTaskDoesntExist(ScoveragePlugin.getAGGREGATE_NAME());
     }
 
     @Test
@@ -87,6 +87,6 @@ public void checkScoverageFails() {
         result.assertTaskOutcome(ScoveragePlugin.getTEST_NAME(), TaskOutcome.SUCCESS);
         result.assertTaskOutcome(ScoveragePlugin.getREPORT_NAME(), TaskOutcome.SUCCESS);
         result.assertTaskOutcome(ScoveragePlugin.getCHECK_NAME(), TaskOutcome.FAILED);
-        result.assertTaskSkipped(ScoveragePlugin.getAGGREGATE_NAME());
+        result.assertTaskDoesntExist(ScoveragePlugin.getAGGREGATE_NAME());
     }
 }

src/functionalTest/java/org.scoverage/ScoverageFunctionalTest.java

@@ -23,17 +23,6 @@ protected ScoverageFunctionalTest(String projectName) {
                 .withProjectDir(projectDir())
                 .withPluginClasspath()
                 .forwardOutput();
-
-
-        List<File> filteredPluginClassPath = new ArrayList<File>();
-
-        for (File file : runner.getPluginClasspath()) {
-            if (!file.getName().contains("scalac-scoverage-plugin")) {
-                filteredPluginClassPath.add(file);
-            }
-        }
-
-        runner.withPluginClasspath(filteredPluginClassPath);
     }
 
     protected File projectDir() {
@@ -65,12 +54,11 @@ private void configureArguments(String... arguments) {
         List<String> fullArguments = new ArrayList<String>();
 
         fullArguments.add("-PscalaVersionMajor=2");
-        fullArguments.add("-PscalaVersionMinor=11");
-        fullArguments.add("-PscalaVersionBuild=5");
+        fullArguments.add("-PscalaVersionMinor=12");
+        fullArguments.add("-PscalaVersionBuild=8");
         fullArguments.add("-PjunitVersion=5.3.2");
         fullArguments.add("-PjunitPlatformVersion=1.3.2");
         fullArguments.add("-PscalatestVersion=3.0.5");
-        fullArguments.add("-PscoverageVersion=1.3.1");
         fullArguments.addAll(Arrays.asList(arguments));
 
         runner.withArguments(fullArguments);

src/functionalTest/resources/projects/scala-single-module/build.gradle

@@ -18,11 +18,6 @@ dependencies {
     testCompile group: 'org.junit.platform', name: 'junit-platform-runner', version: junitPlatformVersion
 
     testCompile group: 'org.scalatest', name: "scalatest_${scalaVersionMajor}.${scalaVersionMinor}", version: scalatestVersion
-
-    def fullScoverageVersion = "${scalaVersionMajor}.${scalaVersionMinor}:${scoverageVersion}"
-
-    scoverage "org.scoverage:scalac-scoverage-plugin_${fullScoverageVersion}",
-            "org.scoverage:scalac-scoverage-runtime_${fullScoverageVersion}"
 }
 
 test {

src/main/groovy/org/scoverage/AggregateReportApp.java

@@ -2,6 +2,7 @@ package org.scoverage
 
 import org.gradle.api.DefaultTask
 import org.gradle.api.GradleException
+import org.gradle.api.provider.Property
 import org.gradle.api.tasks.CacheableTask
 import org.gradle.api.tasks.TaskAction
 import org.gradle.internal.impldep.com.google.common.annotations.VisibleForTesting
@@ -46,19 +47,16 @@ class OverallCheckTask extends DefaultTask {
     CoverageType coverageType = CoverageType.Statement
     double minimumRate = 0.75
 
-    /** Set if want to change default from 'reportDir' in scoverage extension. */
-    File reportDir
+    final Property<File> reportDir = project.objects.property(File)
 
     /** Overwrite to test for a specific locale. */
     Locale locale
 
     @TaskAction
     void requireLineCoverage() {
-        def extension = ScoveragePlugin.extensionIn(project)
-
         NumberFormat nf = NumberFormat.getInstance(locale == null ? Locale.getDefault() : locale)
 
-        Exception failure = checkLineCoverage(nf, reportDir == null ? extension.reportDir : reportDir, coverageType, minimumRate)
+        Exception failure = checkLineCoverage(nf, reportDir.get(), coverageType, minimumRate)
 
         if (failure) throw failure
     }

src/main/groovy/org/scoverage/OverallCheckTask.groovy

@@ -1,32 +1,43 @@
 package org.scoverage
 
-import org.gradle.api.tasks.JavaExec
+import org.gradle.api.DefaultTask
+import org.gradle.api.provider.Property
+import org.gradle.api.tasks.TaskAction
+import scoverage.report.CoverageAggregator
 
-class ScoverageAggregate extends JavaExec {
+class ScoverageAggregate extends DefaultTask {
 
+    ScoverageRunner runner
+
+    // TODO - consider separate options for `report` and `aggregate` tasks
+    final Property<Boolean> coverageOutputCobertura = project.objects.property(Boolean)
+    final Property<Boolean> coverageOutputXML = project.objects.property(Boolean)
+    final Property<Boolean> coverageOutputHTML = project.objects.property(Boolean)
+    final Property<Boolean> coverageDebug = project.objects.property(Boolean)
+
+    // TODO get these from extension
     boolean clean = false
     File reportDir
 
-    @Override
-    void exec() {
-        def extension = ScoveragePlugin.extensionIn(project)
-        setClasspath(ScoveragePlugin.extensionIn(project).pluginClasspath)
-        setMain('org.scoverage.AggregateReportApp')
-        def reportPath = reportDirOrDefault()
-        setArgs([
-            project.projectDir,
-            reportPath.absolutePath,
-            clean,
-            // TODO - consider separate options for `report` and `aggregate` tasks
-            extension.coverageOutputCobertura,
-            extension.coverageOutputXML,
-            extension.coverageOutputHTML,
-            extension.coverageDebug
-        ])
-        super.exec()
-    }
+    @TaskAction
+    def aggregate() {
+        runner.run {
+            def rootDir = project.projectDir
+            def reportPath = reportDir ? reportDir : new File(project.buildDir, 'scoverage-aggregate')
+
+            def coverage = CoverageAggregator.aggregate(rootDir, clean)
 
-    def reportDirOrDefault() {
-        return reportDir ? reportDir : new File(project.buildDir, 'scoverage-aggregate')
+            if (coverage.nonEmpty()) {
+                ScoverageWriter.write(
+                        rootDir,
+                        reportPath,
+                        coverage.get(),
+                        coverageOutputCobertura.get(),
+                        coverageOutputXML.get(),
+                        coverageOutputHTML.get(),
+                        coverageDebug.get()
+                )
+            }
+        }
     }
 }