Introduce task for JaCoCo plugin for enforcing code coverage metrics

subprojects/docs/src/docs/dsl/org.gradle.testing.jacoco.tasks.JacocoCheck.xml

@@ -0,0 +1,43 @@
+<!--
+  ~ Copyright 2016 the original author or authors.
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~      http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+
+<section>
+    <section>
+        <title>Properties</title>
+        <table>
+            <thead>
+                <tr>
+                    <td>Name</td>
+                    <td>Default with <literal>jacoco</literal> plugin</td>
+                </tr>
+            </thead>
+            <tr>
+                <td>violationRules</td>
+                <td/>
+            </tr>
+        </table>
+    </section>
+    <section>
+        <title>Methods</title>
+        <table>
+            <thead>
+                <tr>
+                    <td>Name</td>
+                </tr>
+            </thead>
+        </table>
+    </section>
+</section>

subprojects/docs/src/docs/dsl/org.gradle.testing.jacoco.tasks.JacocoReport.xml

@@ -21,32 +21,9 @@
             <thead>
                 <tr>
                     <td>Name</td>
-                    <td>Default with
-                        <literal>jacoco</literal>
-                        plugin
-                    </td>
+                    <td>Default with <literal>jacoco</literal> plugin</td>
                 </tr>
             </thead>
-            <tr>
-                <td>executionData</td>
-                <td/>
-            </tr>
-            <tr>
-                <td>sourceDirectories</td>
-                <td/>
-            </tr>
-            <tr>
-                <td>classDirectories</td>
-                <td/>
-            </tr>
-            <tr>
-                <td>additionalClassDirs</td>
-                <td/>
-            </tr>
-            <tr>
-                <td>additionalSourceDirs</td>
-                <td/>
-            </tr>
             <tr>
                 <td>reports</td>
                 <td/>
@@ -61,9 +38,6 @@
                     <td>Name</td>
                 </tr>
             </thead>
-            <tr>
-                <td>executionData</td>
-            </tr>
         </table>
     </section>
 </section>

subprojects/docs/src/docs/dsl/org.gradle.testing.jacoco.tasks.JacocoReportBase.xml

@@ -0,0 +1,62 @@
+<!--
+  ~ Copyright 2016 the original author or authors.
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~      http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+
+<section>
+    <section>
+        <title>Properties</title>
+        <table>
+            <thead>
+                <tr>
+                    <td>Name</td>
+                    <td>Default with <literal>jacoco</literal> plugin</td>
+                </tr>
+            </thead>
+            <tr>
+                <td>executionData</td>
+                <td/>
+            </tr>
+            <tr>
+                <td>sourceDirectories</td>
+                <td/>
+            </tr>
+            <tr>
+                <td>classDirectories</td>
+                <td/>
+            </tr>
+            <tr>
+                <td>additionalClassDirs</td>
+                <td/>
+            </tr>
+            <tr>
+                <td>additionalSourceDirs</td>
+                <td/>
+            </tr>
+        </table>
+    </section>
+    <section>
+        <title>Methods</title>
+        <table>
+            <thead>
+                <tr>
+                    <td>Name</td>
+                </tr>
+            </thead>
+            <tr>
+                <td>executionData</td>
+            </tr>
+        </table>
+    </section>
+</section>

subprojects/docs/src/docs/userguide/jacocoPlugin.xml

@@ -81,6 +81,32 @@
         </imageobject>
     </section>
 
+    <section id="sec:jacoco_report_violation_rules">
+        <title>Enforcing code coverage metrics</title>
+        <note>
+            <para>
+                This feature requires the use of JaCoCo version 0.6.3 or higher.
+            </para>
+        </note>
+        <para>
+            The <apilink class="org.gradle.testing.jacoco.tasks.JacocoCheck"/> task can be used to verify if code coverage
+            metrics are met based on configured rules. Its API exposes two methods,
+            <apilink class="org.gradle.testing.jacoco.tasks.JacocoCheck" method="violationRules(groovy.lang.Closure)"/> and
+            <apilink class="org.gradle.testing.jacoco.tasks.JacocoCheck" method="violationRules(org.gradle.api.Action)"/>,
+            the main entry point for configuring rules.
+            Invoking any of those methods returns an instance of <apilink class="org.gradle.testing.jacoco.tasks.rules.JacocoViolationRulesContainer"/> providing
+            extensive configuration options. The build fails if any of the configured rules are not met. JaCoCo only reports the first violated rule.
+        </para>
+        <para>
+            Code coverage requirements can be specified for a project as a whole, for individual files, and for
+            particular JaCoCo-specific types of coverage, e.g., lines covered or branches covered. The following example
+            describes the syntax.
+        </para>
+        <sample id="configViolationRules" dir="testing/jacoco/quickstart" title="Configuring violation rules">
+            <sourcefile file="build.gradle" snippet="violation-rules-configuration"/>
+        </sample>
+    </section>
+
     <section id="sec:jacoco_specific_task_configuration">
         <title>JaCoCo specific task configuration</title>
         <para>The JaCoCo plugin adds a
@@ -215,6 +241,16 @@
                 </td>
                 <td>Generates code coverage report for the test task.</td>
             </tr>
+            <tr>
+                <td>
+                    <literal>jacocoTestCheck</literal>
+                </td>
+                <td>-</td>
+                <td>
+                    <apilink class="org.gradle.testing.jacoco.tasks.JacocoCheck"/>
+                </td>
+                <td>Verifies code coverage metrics based on specified rules for the test task.</td>
+            </tr>
         </table>
     </section>
 

subprojects/docs/src/samples/testing/jacoco/quickstart/build.gradle

@@ -56,3 +56,27 @@ jacocoTestReport {
     }
 }
 // END SNIPPET report-configuration
+
+// START SNIPPET violation-rules-configuration
+jacocoTestCheck {
+    violationRules {
+        rule {
+            limit {
+                minimum = 0.5
+            }
+        }
+
+        rule {
+            enabled = false
+            element = 'CLASS'
+            includes = ['org.gradle.*']
+
+            limit {
+                counter = 'LINE'
+                value = 'TOTALCOUNT'
+                maximum = 0.3
+            }
+        }
+    }
+}
+// END SNIPPET violation-rules-configuration

subprojects/jacoco/src/integTest/groovy/org/gradle/testing/jacoco/plugins/JacocoCachingIntegrationTest.groovy

@@ -18,31 +18,21 @@ package org.gradle.testing.jacoco.plugins
 
 import org.gradle.integtests.fixtures.AbstractIntegrationSpec
 import org.gradle.integtests.fixtures.LocalBuildCacheFixture
+import org.gradle.testing.jacoco.plugins.fixtures.JavaProjectUnderTest
 import org.gradle.util.Requires
 
 import static org.gradle.util.TestPrecondition.FIX_TO_WORK_ON_JAVA9
 
 @Requires(FIX_TO_WORK_ON_JAVA9)
 class JacocoCachingIntegrationTest extends AbstractIntegrationSpec implements LocalBuildCacheFixture {
 
+    private final JavaProjectUnderTest javaProjectUnderTest = new JavaProjectUnderTest(testDirectory)
+
     def "jacoco file results are cached"() {
-        file("src/main/java/org/gradle/Class1.java") <<
-            "package org.gradle; public class Class1 { public boolean isFoo(Object arg) { return true; } }"
-        file("src/test/java/org/gradle/Class1Test.java") <<
-            "package org.gradle; import org.junit.Test; public class Class1Test { @Test public void someTest() { new Class1().isFoo(\"test\"); } }"
+        javaProjectUnderTest.writeBuildScript().writeSourceFiles()
         def reportFile = file("build/reports/jacoco/test/html/index.html")
 
         buildFile << """
-            apply plugin: "java"
-            apply plugin: "jacoco"
-
-            repositories {
-                mavenCentral()
-            }
-            dependencies {
-                testCompile 'junit:junit:4.12'
-            }
-
             jacocoTestReport.dependsOn test
 
             sourceSets.test.output.classesDir = file("build/classes/test")

subprojects/jacoco/src/integTest/groovy/org/gradle/testing/jacoco/plugins/JacocoPluginIntegrationTest.groovy

@@ -20,6 +20,7 @@ import org.gradle.api.Project
 import org.gradle.api.reporting.ReportingExtension
 import org.gradle.integtests.fixtures.AbstractIntegrationSpec
 import org.gradle.integtests.fixtures.executer.GradleContextualExecuter
+import org.gradle.testing.jacoco.plugins.fixtures.JavaProjectUnderTest
 import org.gradle.util.Requires
 import spock.lang.IgnoreIf
 import spock.lang.Issue
@@ -28,24 +29,14 @@ import static org.gradle.util.TestPrecondition.FIX_TO_WORK_ON_JAVA9
 
 class JacocoPluginIntegrationTest extends AbstractIntegrationSpec {
 
+    private final JavaProjectUnderTest javaProjectUnderTest = new JavaProjectUnderTest(testDirectory)
     private static final String REPORTING_BASE = "${Project.DEFAULT_BUILD_DIR_NAME}/${ReportingExtension.DEFAULT_REPORTS_DIR_NAME}"
     private static final String REPORT_HTML_DEFAULT_PATH = "${REPORTING_BASE}/jacoco/test/html/index.html"
     private static final String REPORT_XML_DEFAULT_PATH = "${REPORTING_BASE}/jacoco/test/jacocoTestReport.xml"
     private static final String REPORT_CSV_DEFAULT_REPORT = "${REPORTING_BASE}/jacoco/test/jacocoTestReport.csv"
 
     def setup() {
-        buildFile << """
-            apply plugin: "java"
-            apply plugin: "jacoco"
-
-            repositories {
-                mavenCentral()
-            }
-            dependencies {
-                testCompile 'junit:junit:4.12'
-            }
-        """
-        createTestFiles()
+        javaProjectUnderTest.writeBuildScript().writeSourceFiles()
     }
 
     def "jacoco plugin adds coverage report for test task when java plugin applied"() {
@@ -320,12 +311,5 @@ public class ThingTest {
     private JacocoReportFixture htmlReport(String basedir = "${REPORTING_BASE}/jacoco/test/html") {
         return new JacocoReportFixture(file(basedir))
     }
-
-    private void createTestFiles() {
-        file("src/main/java/org/gradle/Class1.java") <<
-                "package org.gradle; public class Class1 { public boolean isFoo(Object arg) { return true; } }"
-        file("src/test/java/org/gradle/Class1Test.java") <<
-                "package org.gradle; import org.junit.Test; public class Class1Test { @Test public void someTest() { new Class1().isFoo(\"test\"); } }"
-    }
 }
 

subprojects/jacoco/src/integTest/groovy/org/gradle/testing/jacoco/plugins/JacocoReportRelocationIntegrationTest.groovy

@@ -17,35 +17,26 @@
 package org.gradle.testing.jacoco.plugins
 
 import org.gradle.integtests.fixtures.AbstractTaskRelocationIntegrationTest
+import org.gradle.testing.jacoco.plugins.fixtures.JavaProjectUnderTest
 import org.gradle.util.Requires
 
 import static org.gradle.util.TestPrecondition.FIX_TO_WORK_ON_JAVA9
 
 @Requires(FIX_TO_WORK_ON_JAVA9)
 class JacocoReportRelocationIntegrationTest extends AbstractTaskRelocationIntegrationTest {
+
+    private final JavaProjectUnderTest javaProjectUnderTest = new JavaProjectUnderTest(testDirectory)
+
     @Override
     protected String getTaskName() {
         return ":jacocoTestReport"
     }
 
     @Override
     protected void setupProjectInOriginalLocation() {
-        file("src/main/java/org/gradle/Class1.java") <<
-            "package org.gradle; public class Class1 { public boolean isFoo(Object arg) { return true; } }"
-        file("src/test/java/org/gradle/Class1Test.java") <<
-            "package org.gradle; import org.junit.Test; public class Class1Test { @Test public void someTest() { new Class1().isFoo(\"test\"); } }"
+        javaProjectUnderTest.writeBuildScript().writeSourceFiles()
 
         buildFile << """
-            apply plugin: "java"
-            apply plugin: "jacoco"
-
-            repositories {
-                mavenCentral()
-            }
-            dependencies {
-                testCompile 'junit:junit:4.12'
-            }
-
             sourceSets.test.output.classesDir = file("build/classes/test")
         """
 

subprojects/jacoco/src/integTest/groovy/org/gradle/testing/jacoco/plugins/JacocoTestRelocationIntegrationTest.groovy

@@ -17,6 +17,7 @@
 package org.gradle.testing.jacoco.plugins
 
 import org.gradle.integtests.fixtures.AbstractTaskRelocationIntegrationTest
+import org.gradle.testing.jacoco.plugins.fixtures.JavaProjectUnderTest
 import org.gradle.util.Requires
 
 import static org.gradle.util.BinaryDiffUtils.levenshteinDistance
@@ -25,29 +26,17 @@ import static org.gradle.util.TestPrecondition.FIX_TO_WORK_ON_JAVA9
 
 @Requires(FIX_TO_WORK_ON_JAVA9)
 class JacocoTestRelocationIntegrationTest extends AbstractTaskRelocationIntegrationTest {
+
+    private final JavaProjectUnderTest javaProjectUnderTest = new JavaProjectUnderTest(testDirectory)
+
     @Override
     protected String getTaskName() {
         return ":test"
     }
 
     @Override
     protected void setupProjectInOriginalLocation() {
-        file("src/main/java/org/gradle/Class1.java") <<
-            "package org.gradle; public class Class1 { public boolean isFoo(Object arg) { return true; } }"
-        file("src/test/java/org/gradle/Class1Test.java") <<
-            "package org.gradle; import org.junit.Test; public class Class1Test { @Test public void someTest() { new Class1().isFoo(\"test\"); } }"
-
-        buildFile << """
-            apply plugin: "java"
-            apply plugin: "jacoco"
-
-            repositories {
-                mavenCentral()
-            }
-            dependencies {
-                testCompile 'junit:junit:4.12'
-            }
-        """
+        javaProjectUnderTest.writeBuildScript().writeSourceFiles()
     }
 
     @Override