Code Coverage sample

CodeCoverage/.gitignore

@@ -0,0 +1,15 @@
+*.iml
+.gradle
+/local.properties
+/.idea/caches
+/.idea/libraries
+/.idea/modules.xml
+/.idea/workspace.xml
+/.idea/navEditor.xml
+/.idea/assetWizardSettings.xml
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+.cxx
+local.properties

CodeCoverage/README.md

@@ -0,0 +1,6 @@
+# Code coverage sample
+
+This project showcases
+ - Code coverage support in the Android Gradle Plugin
+ - Custom task to create combined reports (local + instrumented tests)
+

CodeCoverage/app/.gitignore

@@ -0,0 +1 @@
+/build

CodeCoverage/app/build.gradle.kts

@@ -0,0 +1,188 @@
+/*
+ * Copyright (C) 2024 The Android Open Source Project
+ *
+ * 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.
+ */
+
+import com.android.build.api.artifact.ScopedArtifact
+import com.android.build.api.variant.AndroidComponentsExtension
+import com.android.build.api.variant.ScopedArtifacts
+import io.netty.handler.codec.compression.StandardCompressionOptions.gzip
+import java.util.Locale
+
+plugins {
+    alias(libs.plugins.android.application)
+    alias(libs.plugins.jetbrains.kotlin.android)
+}
+
+android {
+    namespace = "com.example.android.codecoverage"
+    compileSdk = 34
+
+    defaultConfig {
+        applicationId = "com.example.android.codecoverage"
+        minSdk = 24
+        targetSdk = 34
+        versionCode = 1
+        versionName = "1.0"
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+    }
+
+    buildTypes {
+        // Enable code coverage in AGP
+        debug {
+            enableAndroidTestCoverage = true // Instrumented
+            enableUnitTestCoverage = true // Local
+        }
+        release {
+            isMinifyEnabled = false
+            proguardFiles(
+                getDefaultProguardFile("proguard-android-optimize.txt"),
+                "proguard-rules.pro"
+            )
+        }
+    }
+
+    flavorDimensions += "version"
+    productFlavors {
+        create("flavor1") {
+            dimension = "version"
+        }
+        create("flavor2") {
+            dimension = "version"
+        }
+    }
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
+
+    testOptions {
+        managedDevices {
+            localDevices {
+                // run with ../gradlew pixel2api30DebugAndroidTest
+                create("pixel2api30") {
+                    // Use device profiles you typically see in Android Studio.
+                    device = "Pixel 2"
+                    // Use only API levels 27 and higher.
+                    apiLevel = 30
+                    // To include Google services, use "google".
+                    systemImageSource = "aosp"
+                }
+            }
+        }
+    }
+
+    setupCombinedReportTestCoverage()
+}
+
+dependencies {
+
+    implementation(libs.androidx.core.ktx)
+    implementation(libs.androidx.appcompat)
+    implementation(libs.material)
+    testImplementation(libs.junit)
+    androidTestImplementation(libs.androidx.junit)
+    androidTestImplementation(libs.androidx.espresso.core)
+}
+
+interface Injected {
+    @get:Inject val archiveOperations: ArchiveOperations
+}
+/**
+ * Replace with https://issuetracker.google.com/329683722 when available.
+ */
+fun setupCombinedReportTestCoverage() {
+    val coverageExclusions = listOf(
+        // Android
+        "**/R.class",
+        "**/R\$*.class",
+        "**/BuildConfig.*",
+        "**/Manifest*.*",
+        "**/*_Hilt*.class",
+        "**/Hilt_*.class",
+    )
+
+    val androidComponents =
+        project.extensions.getByType(AndroidComponentsExtension::class.java)
+
+    androidComponents.onVariants { variant ->
+        val projectObjFactory = project.objects
+        val archiveOperations = project.objects.newInstance<Injected>().archiveOperations
+        val buildDir = layout.buildDirectory.get().asFile
+        val allJars: ListProperty<RegularFile> = projectObjFactory.listProperty(RegularFile::class.java)
+        val allDirectories: ListProperty<Directory> = projectObjFactory.listProperty(Directory::class.java)
+
+
+        val reportTask =
+            tasks.register("create${variant.name.capitalize()}CombinedCoverageReport", JacocoReport::class) {
+
+                classDirectories.setFrom(
+                    allJars.map { it: MutableList<RegularFile> ->
+                        it.map {
+                            archiveOperations.zipTree(it).matching {
+                                exclude(coverageExclusions)
+                            }
+                        }
+                    },
+                    allDirectories.map { dirs ->
+                        dirs.map { dir ->
+                            projectObjFactory.fileTree().setDir(dir).exclude(coverageExclusions)
+                        }
+                    }
+                )
+                reports {
+                    xml.required.set(true)
+                    html.required.set(true)
+                }
+
+                val sources = variant.sources
+                sourceDirectories.setFrom(files(sources.kotlin?.all, sources.java?.all))
+
+                // TODO: Use a proper API when https://issuetracker.google.com/332830826 is fixed
+                executionData.setFrom(
+                    // Local tests
+                    project.fileTree("$buildDir/outputs/unit_test_code_coverage/${variant.name}UnitTest")
+                        .matching { include("**/*.exec") },
+
+                    // Instrumented tests
+                    project.fileTree("$buildDir/outputs/code_coverage/${variant.name}AndroidTest")
+                        .matching { include("**/*.ec") },
+
+                    // Instrumented tests with GMD
+                    project.fileTree("$buildDir/outputs/managed_device_code_coverage/${variant.name}")
+                        .matching { include("**/*.ec") },
+
+                    // Instrumented tests with GMD and flavors
+                    project.fileTree("$buildDir/outputs/managed_device_code_coverage/${variant.buildType}/flavors/${variant.flavorName}/")
+                        .matching { include("**/*.ec") },
+                )
+            }
+
+        variant.artifacts.forScope(ScopedArtifacts.Scope.PROJECT)
+            .use(reportTask)
+            .toGet(
+                ScopedArtifact.CLASSES,
+                { _ -> allJars },
+                { _ -> allDirectories },
+            )
+    }
+}
+
+fun String.capitalize() = replaceFirstChar {
+    if (it.isLowerCase()) it.titlecase(Locale.getDefault()) else it.toString()
+}

CodeCoverage/app/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

CodeCoverage/app/src/androidTest/java/com/example/android/codecoverage/ExampleInstrumentedTest.kt

@@ -0,0 +1,38 @@
+/*
+ * Copyright (C) 2024 The Android Open Source Project
+ *
+ * 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.
+ */
+
+package com.example.android.codecoverage
+
+import androidx.test.platform.app.InstrumentationRegistry
+import androidx.test.ext.junit.runners.AndroidJUnit4
+
+import org.junit.Test
+import org.junit.runner.RunWith
+
+import org.junit.Assert.*
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * See [testing documentation](http://d.android.com/tools/testing).
+ */
+@RunWith(AndroidJUnit4::class)
+class ExampleInstrumentedTest {
+    @Test
+    fun sumInstr() {
+        assertEquals(4, sumInstr(2, 2))
+    }
+}

CodeCoverage/app/src/main/AndroidManifest.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  ~ Copyright (C) 2024 The Android Open Source Project
+  ~
+  ~ 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.
+  -->
+
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools">
+
+    <application
+        android:allowBackup="true"
+        android:dataExtractionRules="@xml/data_extraction_rules"
+        android:fullBackupContent="@xml/backup_rules"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:theme="@style/Theme.CodeCoverage"
+        tools:targetApi="31" />
+
+</manifest>

CodeCoverage/app/src/main/java/com/example/android/codecoverage/Math.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright (C) 2024 The Android Open Source Project
+ *
+ * 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.
+ */
+
+package com.example.android.codecoverage
+
+// Function covered by a local test
+fun sumLocal(a: Int, b: Int): Int = a + b
+
+// Function covered by an instrumented test
+fun sumInstr(a: Int, b: Int): Int = a + b