Extract: JacocoReport task creation into a function (#78)

Author: johnjohndoe

plugin/src/main/kotlin/org/neotech/plugin/rootcoverage/JacocoTaskFactory.kt

@@ -4,13 +4,15 @@ import org.gradle.api.Project
 import org.gradle.testing.jacoco.tasks.JacocoReport
 import org.neotech.plugin.rootcoverage.utilities.getReportOutputFile
 
-private const val TASK_NAME = "coverageReport"
-private const val TASK_GROUP_NAME = "reporting"
-private const val TASK_DESCRIPTION = "Generates a Jacoco for this Gradle module."
 private const val JACOCO_PLUGIN_NAME = "jacoco"
 
-internal fun Project.createJacocoReportTask(rootProjectExtension: RootCoveragePluginExtension): JacocoReport {
-    val task = tasks.create(TASK_NAME, JacocoReport::class.java)
+internal fun Project.createJacocoReportTask(
+    taskName: String,
+    taskGroup: String,
+    taskDescription: String,
+    rootProjectExtension: RootCoveragePluginExtension
+): JacocoReport {
+    val task = tasks.create(taskName, JacocoReport::class.java)
 
     // Make sure to only read from the rootProjectExtension after the project has been evaluated
     afterEvaluate {
@@ -25,17 +27,14 @@ internal fun Project.createJacocoReportTask(rootProjectExtension: RootCoveragePl
     // otherwise the JaCoCoPlugin may override settings in configureJacocoReportsDefaults()
     // https://github.com/gradle/gradle/blob/c177053ff95a1582c7919befe67993e0f1677f53/subprojects/jacoco/src/main/java/org/gradle/testing/jacoco/plugins/JacocoPlugin.java#L211
     pluginManager.withPlugin(JACOCO_PLUGIN_NAME) {
-        task.group = TASK_GROUP_NAME
-        task.description = TASK_DESCRIPTION
-
+        task.group = taskGroup
+        task.description = taskDescription
         task.reports.apply {
             html.outputLocation.set(getReportOutputFile("jacoco"))
             xml.outputLocation.set(getReportOutputFile("jacoco.xml"))
             csv.outputLocation.set(getReportOutputFile("jacoco.csv"))
         }
     }
 
-    // assertAndroidCodeCoverageVariantExists()
-
     return task
 }

plugin/src/main/kotlin/org/neotech/plugin/rootcoverage/RootCoveragePlugin.kt

@@ -18,7 +18,6 @@ import org.neotech.plugin.rootcoverage.utilities.afterAndroidPluginApplied
 import org.neotech.plugin.rootcoverage.utilities.assertMinimumRequiredAGPVersion
 import org.neotech.plugin.rootcoverage.utilities.fileTree
 import org.neotech.plugin.rootcoverage.utilities.onVariant
-import org.neotech.plugin.rootcoverage.utilities.getReportOutputFile
 import java.io.File
 
 class RootCoveragePlugin : Plugin<Project> {
@@ -53,30 +52,23 @@ class RootCoveragePlugin : Plugin<Project> {
 
 
     private fun createSubProjectCoverageTask(subProject: Project) {
-        val task = subProject.createJacocoReportTask(rootProjectExtension)
+        val task = subProject.createJacocoReportTask(
+            taskName = "coverageReport",
+            taskGroup = "reporting",
+            taskDescription = "Generates a Jacoco for this Gradle module.",
+            rootProjectExtension = rootProjectExtension
+        )
+        // subProject.assertAndroidCodeCoverageVariantExists()
         task.addSubProject(task.project)
     }
 
     private fun createCoverageTaskForRoot(project: Project) {
-        val task = project.tasks.create("rootCoverageReport", JacocoReport::class.java)
-
-        // Make sure to only read from the rootProjectExtension after the project has been evaluated
-        project.afterEvaluate {
-            task.reports.html.required.set(rootProjectExtension.generateHtml)
-            task.reports.xml.required.set(rootProjectExtension.generateXml)
-            task.reports.csv.required.set(rootProjectExtension.generateCsv)
-        }
-
-        // Make sure to configure this JacocoReport task after the JaCoCoPlugin itself has been fully applied, otherwise the JaCoCoPlugin
-        // may override settings in configureJacocoReportsDefaults()
-        // https://github.com/gradle/gradle/blob/c177053ff95a1582c7919befe67993e0f1677f53/subprojects/jacoco/src/main/java/org/gradle/testing/jacoco/plugins/JacocoPlugin.java#L211
-        project.pluginManager.withPlugin("jacoco") {
-            task.group = "reporting"
-            task.description = "Generates a Jacoco report with combined results from all the subprojects."
-            task.reports.html.outputLocation.set(project.getReportOutputFile("jacoco"))
-            task.reports.xml.outputLocation.set(project.getReportOutputFile("jacoco.xml"))
-            task.reports.csv.outputLocation.set(project.getReportOutputFile("jacoco.csv"))
-        }
+        val task = project.createJacocoReportTask(
+            taskName = "rootCoverageReport",
+            taskGroup = "reporting",
+            taskDescription = "Generates a Jacoco report with combined results from all the subprojects.",
+            rootProjectExtension = rootProjectExtension
+        )
 
         project.allprojects.forEach { subProject ->
             subProject.assertAndroidCodeCoverageVariantExists()