Finish adding Jacoco support

Author: tresat

unified-prototype/unified-plugin/gradle/libs.versions.toml

@@ -7,6 +7,8 @@ ksp = "1.9.22-1.0.18"
 android = "8.3.0"
 hilt = "2.50"
 
+apache-commons = "3.3.1"
+
 [libraries]
 # Kotlin dependencies
 kotlin-multiplatform = { module = "org.jetbrains.kotlin.multiplatform:org.jetbrains.kotlin.multiplatform.gradle.plugin", version.ref = "kotlin" }
@@ -19,3 +21,6 @@ android-kotlin-android = { module = "org.jetbrains.kotlin.android:org.jetbrains.
 hilt-android-plugin = { module = "com.google.dagger:hilt-android-gradle-plugin", version.ref = "hilt" }
 hilt-android = { module = "com.google.dagger:hilt-android", version.ref = "hilt"}
 hilt-compiler = { module = "com.google.dagger:hilt-android-compiler", version.ref = "hilt" }
+
+# Other libraries
+apache-commons-lang = { module = "org.apache.commons:commons-lang3", version.ref = "apache-commons" }

unified-prototype/unified-plugin/plugin-android/build.gradle.kts

@@ -12,6 +12,8 @@ dependencies {
 
     implementation(libs.ksp.plugin)
     implementation(libs.hilt.android.plugin)
+
+    implementation(libs.apache.commons.lang)
 }
 
 gradlePlugin {

unified-prototype/unified-plugin/plugin-android/src/main/java/org/gradle/api/experimental/android/library/AndroidLibrary.java

@@ -56,6 +56,12 @@ public interface AndroidLibrary {
     @Restricted
     Property<Boolean> getIncludeKotlinSerialization();
 
+    /**
+     * Whether or not to set up Jacoco support.
+     */
+    @Restricted
+    Property<Boolean> getConfigureJacoco();
+
     @Nested
     AndroidLibraryDependencies getDependencies();
 

unified-prototype/unified-plugin/plugin-android/src/main/java/org/gradle/api/experimental/android/library/StandaloneAndroidLibraryPlugin.java

@@ -33,6 +33,7 @@ public void apply(Project project) {
         dslModel.getCompileSdk().convention(DEFAULT_SDKS.TARGET_ANDROID_SDK);
         dslModel.getMinSdk().convention(DEFAULT_SDKS.MIN_ANDROID_SDK); // https://developer.android.com/build/multidex#mdex-gradle
         dslModel.getIncludeKotlinSerialization().convention(false);
+        dslModel.getConfigureJacoco().convention(false);
 
         // And Test Options
         dslModel.getTestOptions().getIncludeAndroidResources().convention(false);

unified-prototype/unified-plugin/plugin-android/src/main/java/org/gradle/api/experimental/android/nia/NiaSupport.java

@@ -6,15 +6,21 @@
 import com.android.build.api.variant.BuiltArtifactsLoader;
 import com.android.build.api.variant.HasAndroidTest;
 import com.android.build.api.variant.LibraryAndroidComponentsExtension;
+import org.apache.commons.lang3.StringUtils;
 import org.gradle.api.*;
 import org.gradle.api.experimental.android.DEFAULT_SDKS;
 import org.gradle.api.experimental.android.library.AndroidLibrary;
 import org.gradle.api.file.Directory;
 import org.gradle.api.provider.Provider;
+import org.gradle.api.tasks.testing.Test;
+import org.gradle.testing.jacoco.plugins.JacocoPluginExtension;
+import org.gradle.testing.jacoco.plugins.JacocoTaskExtension;
+import org.gradle.testing.jacoco.tasks.JacocoReport;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.kotlin.gradle.dsl.KotlinJvmOptions;
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile;
 
+import java.io.File;
 import java.lang.reflect.Method;
 import java.util.*;
 import java.util.function.BiConsumer;
@@ -43,6 +49,10 @@ public static void configureNia(Project project,
         configureGradleManagedDevices(androidLib);
         configureLint(androidLib);
         configurePrintApksTask(project, androidLibComponents);
+
+        if (dslModel.getConfigureJacoco().get()) {
+            configureJacoco(project, androidLib);
+        }
     }
 
     private static void configureLint(LibraryExtension androidLib) {
@@ -211,4 +221,67 @@ private static void configurePrintApksTask(Project project, AndroidComponentsExt
             }
         });
     }
+
+    private static List<String> coverageExclusions() {
+        return Arrays.asList(
+                "**/R.class",
+                "**/R$*.class",
+                "**/BuildConfig.*",
+                "**/Manifest*.*"
+        );
+    }
+
+    @SuppressWarnings("deprecation")
+    private static void configureJacoco(Project project, LibraryExtension androidLib) {
+        project.getPlugins().apply("jacoco");
+
+        androidLib.getBuildTypes().configureEach(buildType -> {
+            buildType.setEnableAndroidTestCoverage(true);
+            buildType.setEnableUnitTestCoverage(true);
+        });
+
+        JacocoPluginExtension jacocoPluginExtension = project.getExtensions().getByType(JacocoPluginExtension.class);
+        jacocoPluginExtension.setToolVersion("0.8.7");
+
+        LibraryAndroidComponentsExtension androidLibComponents = project.getExtensions().getByType(LibraryAndroidComponentsExtension.class);
+        androidLibComponents.onVariants(androidLibComponents.selector().all(), variant -> {
+            final String testTaskName = "test" + StringUtils.capitalize(variant.getName()) + "UnitTest";
+            final File buildDir = project.getLayout().getBuildDirectory().get().getAsFile();
+            project.getTasks().register("jacoco" + StringUtils.capitalize(testTaskName) + "Report", JacocoReport.class, task -> {
+                task.dependsOn(testTaskName);
+
+                task.reports(report -> {
+                    report.getXml().getRequired().set(true);
+                    report.getXml().getRequired().set(true);
+                });
+
+                task.getClassDirectories().setFrom(
+                        project.fileTree(project.getBuildDir() + "/tmp/kotlin-classes/" + variant.getName(), tree -> {
+                            tree.exclude(coverageExclusions());
+                        })
+                );
+
+                task.getSourceDirectories().setFrom(
+                        project.files(project.getProjectDir() + "/src/main/java", project.getProjectDir() + "/src/main/kotlin"
+                        ));
+
+                task.getExecutionData().setFrom(
+                        project.files(buildDir + "/jacoco/" + testTaskName + ".exec")
+                );
+            });
+        });
+
+        project.getTasks().withType(Test.class, test -> {
+            JacocoTaskExtension jacocoTaskExtension = test.getExtensions().getByType(JacocoTaskExtension.class);
+
+            // Required for JaCoCo + Robolectric
+            // https://github.com/robolectric/robolectric/issues/2230
+            // Consider removing if not we don't add Robolectric
+            jacocoTaskExtension.setIncludeNoLocationClasses(true);
+
+            // Required for JDK 11 with the above
+            // https://github.com/gradle/gradle/issues/5184#issuecomment-391982009
+            jacocoTaskExtension.setExcludes(Collections.singletonList("jdk.internal.*"));
+        });
+    }
 }