Merge remote-tracking branch 'eyalroth/issues/93/multiple-check-tasks'

Author: maiflai

README.md

@@ -55,10 +55,51 @@ be overridden by the version of the `scala-library` compile dependency (if the d
 * `minimumRate = <double>` (default `0.75`): The minimum amount of coverage in decimal proportion (`1.0` == 100%)
 required for the validation to pass (otherwise `checkScoverage` will fail the build). 
 
-* `coverageType = <"Statement" | "Branch" | "Line">` (default `"Statement"`): The type of coverage validated by the
+* `coverageType = <CoverageType.Statement | CoverageType.Branch | CoverageType.Line>` (default `CoverageType.Statement`): The type of coverage validated by the
 `checkScoverage` task. For more information on the different types, please refer to the documentation of the scalac
 plugin (https://github.com/scoverage/scalac-scoverage-plugin).
 
+#### Multiple check tasks
+
+It is possible to configure multiple checks; for instance, one check for a statement rate and another for a branch rate:
+```
+scoverage {
+    check {
+        minimumRate = 0.5
+        coverageType = CoverageType.Statement
+    }
+    check {
+        minimumRate = 0.8
+        coverageType = CoverageType.Branch
+    }
+}
+```
+
+Note that you cannot mix multiple-checks syntax with plain check configuration:
+```
+// ok
+scoverage {
+    check {
+        minimumRate = 0.5
+        coverageType = CoverageType.Statement
+    }
+}
+
+// ok
+scoverage {
+    minimumRate = 0.2
+}
+
+// NOT ok
+scoverage {
+    minimumRate = 0.2
+    check {
+        minimumRate = 0.5
+        coverageType = CoverageType.Statement
+    }
+}
+``` 
+
 ### Run without normal compilation
 
 By default, running any of the plugin tasks will compile the code both using "normal" compilation (`compileScala`)

build.gradle

@@ -45,17 +45,21 @@ sourceCompatibility = '1.8'
 targetCompatibility = '1.8'
 
 dependencies {
-    compileOnly "org.scoverage:scalac-scoverage-plugin_2.12:1.4.0"
-    compile group: 'commons-io', name: 'commons-io', version: '2.6'
-    testCompile 'junit:junit:4.12'
-    testCompile 'org.hamcrest:hamcrest-library:1.3'
+    compileOnly "org.scoverage:scalac-scoverage-plugin_2.12:1.4.1"
+    implementation group: 'commons-io', name: 'commons-io', version: '2.6'
+
+    testImplementation 'junit:junit:4.12'
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.5.2'
+    testRuntimeOnly 'org.junit.vintage:junit-vintage-engine:5.5.2'
+
+    testImplementation 'org.hamcrest:hamcrest-library:1.3'
 }
 
 sourceSets {
     functionalTest {
         java.srcDir file('src/functionalTest/java')
         resources.srcDir file('src/functionalTest/resources')
-        compileClasspath += sourceSets.main.output + configurations.testRuntime
+        compileClasspath += sourceSets.main.output  + configurations.testRuntimeClasspath
         runtimeClasspath += output + compileClasspath
     }
 }

src/functionalTest/java/org.scoverage/MultipleCheckTasksTest.java

@@ -0,0 +1,91 @@
+package org.scoverage;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+public abstract class MultipleCheckTasksTest extends ScoverageFunctionalTest {
+
+    /* --- Abstract Test ---- */
+
+    private final boolean shouldSucceed;
+
+    public MultipleCheckTasksTest(String projectDir, boolean shouldSucceed) {
+        super("multiple-check-tasks/" + projectDir);
+        this.shouldSucceed = shouldSucceed;
+    }
+
+    @Test
+    public void test() {
+        assertResult(run());
+    }
+
+    protected abstract void assertResult(AssertableBuildResult result);
+
+    protected void assertOutput(AssertableBuildResult result, CoverageType type, double minimumRate) {
+        String expectedMessage = String.format("Checking coverage. Type: %s. Minimum rate: %s", type, minimumRate);
+        Assert.assertTrue(result.getResult().getOutput().contains(expectedMessage));
+    }
+
+    private AssertableBuildResult run() {
+        if (shouldSucceed) {
+            return run("clean", ScoveragePlugin.getCHECK_NAME(), "--info");
+        } else {
+            return runAndFail(ScoveragePlugin.getCHECK_NAME(), "--info");
+        }
+    }
+
+    /* --- Test Classes ---- */
+
+    public static class MultipleChecks extends MultipleCheckTasksTest {
+        public MultipleChecks() {
+            super("multiple-checks", true);
+        }
+        @Override
+        protected void assertResult(AssertableBuildResult result) {
+
+            result.assertTaskSucceeded(ScoveragePlugin.getCHECK_NAME());
+            assertOutput(result, CoverageType.Line, 0.3);
+            assertOutput(result, CoverageType.Branch, 0.1);
+            assertOutput(result, CoverageType.Statement, 0.6);
+
+        }
+    }
+    public static class SingleCheckNewSyntax extends MultipleCheckTasksTest {
+        public SingleCheckNewSyntax() {
+            super("single-check-new-syntax", true);
+        }
+        @Override
+        protected void assertResult(AssertableBuildResult result) {
+            result.assertTaskSucceeded(ScoveragePlugin.getCHECK_NAME());
+            assertOutput(result, CoverageType.Line, 0.3);
+        }
+    }
+    public static class SingleCheckOldSyntax extends MultipleCheckTasksTest {
+        public SingleCheckOldSyntax() {
+            super("single-check-old-syntax", true);
+        }
+        @Override
+        protected void assertResult(AssertableBuildResult result) {
+            result.assertTaskSucceeded(ScoveragePlugin.getCHECK_NAME());
+            assertOutput(result, CoverageType.Line, 0.3);
+        }
+    }
+    public static class OldAndNewSyntax extends MultipleCheckTasksTest {
+        public OldAndNewSyntax() {
+            super("old-and-new-syntax", false);
+        }
+        @Override
+        protected void assertResult(AssertableBuildResult result) {
+        }
+    }
+    public static class NoCheck extends MultipleCheckTasksTest {
+        public NoCheck() {
+            super("no-check", true);
+        }
+        @Override
+        protected void assertResult(AssertableBuildResult result) {
+            result.assertTaskSucceeded(ScoveragePlugin.getCHECK_NAME());
+            assertOutput(result, ScoverageExtension.DEFAULT_COVERAGE_TYPE, ScoverageExtension.DEFAULT_MINIMUM_RATE);
+        }
+    }
+}

src/functionalTest/resources/projects/multiple-check-tasks/multiple-checks/build.gradle

@@ -0,0 +1,40 @@
+plugins {
+    id 'org.scoverage'
+}
+
+repositories {
+    jcenter()
+}
+
+description = 'a single-module Scala project that has multiple check configurations'
+
+apply plugin: 'java'
+apply plugin: 'scala'
+
+dependencies {
+    compile group: 'org.scala-lang', name: 'scala-library', version: "${scalaVersionMajor}.${scalaVersionMinor}.${scalaVersionBuild}"
+
+    testRuntime group: 'org.junit.vintage', name: 'junit-vintage-engine', version: junitVersion
+    testCompile group: 'org.junit.platform', name: 'junit-platform-runner', version: junitPlatformVersion
+
+    testCompile group: 'org.scalatest', name: "scalatest_${scalaVersionMajor}.${scalaVersionMinor}", version: scalatestVersion
+}
+
+test {
+    useJUnitPlatform()
+}
+
+scoverage {
+    check {
+        minimumRate = 0.3
+        coverageType = org.scoverage.CoverageType.Line
+    }
+    check {
+        minimumRate = 0.1
+        coverageType = org.scoverage.CoverageType.Branch
+    }
+    check {
+        minimumRate = 0.6
+        coverageType = org.scoverage.CoverageType.Statement
+    }
+}

src/functionalTest/resources/projects/multiple-check-tasks/multiple-checks/settings.gradle

@@ -0,0 +1,8 @@
+package org.hello
+
+class World {
+
+  def foo(): String = {
+    "a" + "b"
+  }
+}

src/functionalTest/resources/projects/multiple-check-tasks/multiple-checks/src/main/scala/org/hello/World.scala

@@ -0,0 +1,13 @@
+package org.hello
+
+import org.junit.runner.RunWith
+import org.scalatest.FunSuite
+import org.scalatest.junit.JUnitRunner
+
+@RunWith(classOf[JUnitRunner])
+class WorldSuite extends FunSuite {
+
+  test("foo") {
+    new World().foo()
+  }
+}

src/functionalTest/resources/projects/multiple-check-tasks/multiple-checks/src/test/scala/org/hello/WorldSuite.scala

@@ -0,0 +1,25 @@
+plugins {
+    id 'org.scoverage'
+}
+
+repositories {
+    jcenter()
+}
+
+description = 'a single-module Scala project with no check configured'
+
+apply plugin: 'java'
+apply plugin: 'scala'
+
+dependencies {
+    compile group: 'org.scala-lang', name: 'scala-library', version: "${scalaVersionMajor}.${scalaVersionMinor}.${scalaVersionBuild}"
+
+    testRuntime group: 'org.junit.vintage', name: 'junit-vintage-engine', version: junitVersion
+    testCompile group: 'org.junit.platform', name: 'junit-platform-runner', version: junitPlatformVersion
+
+    testCompile group: 'org.scalatest', name: "scalatest_${scalaVersionMajor}.${scalaVersionMinor}", version: scalatestVersion
+}
+
+test {
+    useJUnitPlatform()
+}

src/functionalTest/resources/projects/multiple-check-tasks/no-check/build.gradle

@@ -0,0 +1,8 @@
+package org.hello
+
+class World {
+
+  def foo(): String = {
+    "a" + "b"
+  }
+}

src/functionalTest/resources/projects/multiple-check-tasks/no-check/settings.gradle

@@ -0,0 +1,13 @@
+package org.hello
+
+import org.junit.runner.RunWith
+import org.scalatest.FunSuite
+import org.scalatest.junit.JUnitRunner
+
+@RunWith(classOf[JUnitRunner])
+class WorldSuite extends FunSuite {
+
+  test("foo") {
+    new World().foo()
+  }
+}

src/functionalTest/resources/projects/multiple-check-tasks/no-check/src/main/scala/org/hello/World.scala

@@ -0,0 +1,38 @@
+plugins {
+    id 'org.scoverage'
+}
+
+repositories {
+    jcenter()
+}
+
+description = 'a single-module Scala project that has multiple check configurations - some new syntax, some old'
+
+apply plugin: 'java'
+apply plugin: 'scala'
+
+dependencies {
+    compile group: 'org.scala-lang', name: 'scala-library', version: "${scalaVersionMajor}.${scalaVersionMinor}.${scalaVersionBuild}"
+
+    testRuntime group: 'org.junit.vintage', name: 'junit-vintage-engine', version: junitVersion
+    testCompile group: 'org.junit.platform', name: 'junit-platform-runner', version: junitPlatformVersion
+
+    testCompile group: 'org.scalatest', name: "scalatest_${scalaVersionMajor}.${scalaVersionMinor}", version: scalatestVersion
+}
+
+test {
+    useJUnitPlatform()
+}
+
+scoverage {
+    minimumRate = 0.3
+    coverageType = org.scoverage.CoverageType.Line
+    check {
+        minimumRate = 0.1
+        coverageType = org.scoverage.CoverageType.Branch
+    }
+    check {
+        minimumRate = 0.6
+        coverageType = org.scoverage.CoverageType.Statement
+    }
+}

src/functionalTest/resources/projects/multiple-check-tasks/no-check/src/test/scala/org/hello/WorldSuite.scala

@@ -0,0 +1,8 @@
+package org.hello
+
+class World {
+
+  def foo(): String = {
+    "a" + "b"
+  }
+}

src/functionalTest/resources/projects/multiple-check-tasks/old-and-new-syntax/build.gradle

@@ -0,0 +1,13 @@
+package org.hello
+
+import org.junit.runner.RunWith
+import org.scalatest.FunSuite
+import org.scalatest.junit.JUnitRunner
+
+@RunWith(classOf[JUnitRunner])
+class WorldSuite extends FunSuite {
+
+  test("foo") {
+    new World().foo()
+  }
+}

src/functionalTest/resources/projects/multiple-check-tasks/old-and-new-syntax/settings.gradle

@@ -0,0 +1,32 @@
+plugins {
+    id 'org.scoverage'
+}
+
+repositories {
+    jcenter()
+}
+
+description = 'a single-module Scala project that has a single check configurations (with the new syntax)'
+
+apply plugin: 'java'
+apply plugin: 'scala'
+
+dependencies {
+    compile group: 'org.scala-lang', name: 'scala-library', version: "${scalaVersionMajor}.${scalaVersionMinor}.${scalaVersionBuild}"
+
+    testRuntime group: 'org.junit.vintage', name: 'junit-vintage-engine', version: junitVersion
+    testCompile group: 'org.junit.platform', name: 'junit-platform-runner', version: junitPlatformVersion
+
+    testCompile group: 'org.scalatest', name: "scalatest_${scalaVersionMajor}.${scalaVersionMinor}", version: scalatestVersion
+}
+
+test {
+    useJUnitPlatform()
+}
+
+scoverage {
+    check {
+        minimumRate = 0.3
+        coverageType = org.scoverage.CoverageType.Line
+    }
+}

src/functionalTest/resources/projects/multiple-check-tasks/old-and-new-syntax/src/main/scala/org/hello/World.scala

@@ -0,0 +1,8 @@
+package org.hello
+
+class World {
+
+  def foo(): String = {
+    "a" + "b"
+  }
+}