A fully functional Android app built entirely with Kotlin and Jetpack Compose
Sets up jacoco coverage with a combined report and a GHA (#1303)
Jose Alcérreca78e3725f9fb0
diff --git a/.github/workflows/Build.yaml b/.github/workflows/Build.yamlindex 001140a87..db326c380 100644--- a/.github/workflows/Build.yaml+++ b/.github/workflows/Build.yaml@@ -17,6 +17,7 @@ jobs:permissions:contents: write+ pull-requests: writetimeout-minutes: 60@@ -100,12 +101,13 @@ jobs:commit_message: "🤖 Updates screenshots"# Run local tests after screenshot tests to avoid wrong UP-TO-DATE. TODO: Ignore screenshots.- - name: Run local tests+ - name: Run local tests and create reportif: always()run: ./gradlew testDemoDebug :lint:test# Replace task exclusions with `-Pandroidx.baselineprofile.skipgeneration` when# https://android-review.googlesource.com/c/platform/frameworks/support/+/2602790 landed in a# release build+- name: Build all build type and flavor permutationsrun: ./gradlew :app:assemble :benchmarks:assemble-x pixel6Api33ProdNonMinifiedReleaseAndroidTest@@ -119,11 +121,11 @@ jobs:name: APKspath: '**/build/outputs/apk/**/*.apk'- - name: Upload test results (XML)+ - name: Upload JVM local results (XML)if: always()uses: actions/upload-artifact@v4with:- name: test-results+ name: local-test-resultspath: '**/build/test-results/test*UnitTest/**.xml'- name: Check lint@@ -180,10 +182,7 @@ jobs:- name: Setup Gradleuses: gradle/gradle-build-action@v3- - name: Build projects before running emulator- run: ./gradlew packageDemoDebug packageDemoDebugAndroidTest-- - name: Run instrumentation tests+ - name: Build projects and run instrumentation testsuses: reactivecircus/android-emulator-runner@v2with:api-level: ${{ matrix.api-level }}@@ -193,9 +192,41 @@ jobs:heap-size: 600Mscript: ./gradlew connectedDemoDebugAndroidTest --daemon+ - name: Run local tests (including Roborazzi) for the combined coverage report (only API 30)+ if: matrix.api-level == 30+ # There is no need to verify Roborazzi tests to generate coverage.+ run: ./gradlew testDemoDebugUnitTest -Proborazzi.test.verify=false # Add Prod if we ever add JVM tests for prod++ # Add `createProdDebugUnitTestCoverageReport` if we ever add JVM tests for prod+ - name: Generate coverage reports for Debug variants (only API 30)+ if: matrix.api-level == 30+ run: ./gradlew createDemoDebugCombinedCoverageReport+- name: Upload test reportsif: always()uses: actions/upload-artifact@v4with:name: test-reports-${{ matrix.api-level }}path: '**/build/reports/androidTests'++ - name: Display local test coverage (only API 30)+ if: matrix.api-level == 30+ id: jacoco+ uses: madrapps/[email protected]+ with:+ title: Combined test coverage report+ min-coverage-overall: 40+ min-coverage-changed-files: 60+ paths: |+ ${{ github.workspace }}/**/build/reports/jacoco/**/*Report.xml+ token: ${{ secrets.GITHUB_TOKEN }}++ - name: Upload local coverage reports (XML + HTML) (only API 30)+ if: matrix.api-level == 30+ uses: actions/upload-artifact@v4+ with:+ name: coverage-reports+ if-no-files-found: error+ compression-level: 1+ overwrite: false+ path: '**/build/reports/jacoco/'diff --git a/app/build.gradle.kts b/app/build.gradle.ktsindex 9e68ffa7d..2fe18645e 100644--- a/app/build.gradle.kts+++ b/app/build.gradle.kts@@ -21,7 +21,6 @@ plugins {alias(libs.plugins.nowinandroid.android.application.flavors)alias(libs.plugins.nowinandroid.android.application.jacoco)alias(libs.plugins.nowinandroid.android.hilt)- id("jacoco")alias(libs.plugins.nowinandroid.android.application.firebase)id("com.google.android.gms.oss-licenses-plugin")alias(libs.plugins.baselineprofile)diff --git a/build-logic/convention/src/main/kotlin/AndroidApplicationJacocoConventionPlugin.kt b/build-logic/convention/src/main/kotlin/AndroidApplicationJacocoConventionPlugin.ktindex 4c3acc520..ac385b0d9 100644--- a/build-logic/convention/src/main/kotlin/AndroidApplicationJacocoConventionPlugin.kt+++ b/build-logic/convention/src/main/kotlin/AndroidApplicationJacocoConventionPlugin.kt@@ -15,6 +15,7 @@*/import com.android.build.api.variant.ApplicationAndroidComponentsExtension+import com.android.build.gradle.internal.dsl.BaseAppModuleExtensionimport com.google.samples.apps.nowinandroid.configureJacocoimport org.gradle.api.Pluginimport org.gradle.api.Project@@ -23,13 +24,15 @@ import org.gradle.kotlin.dsl.getByTypeclass AndroidApplicationJacocoConventionPlugin : Plugin<Project> {override fun apply(target: Project) {with(target) {- with(pluginManager) {- apply("org.gradle.jacoco")- apply("com.android.application")+ pluginManager.apply("jacoco")+ val androidExtension = extensions.getByType<BaseAppModuleExtension>()++ androidExtension.buildTypes.configureEach {+ enableAndroidTestCoverage = true+ enableUnitTestCoverage = true}- val extension = extensions.getByType<ApplicationAndroidComponentsExtension>()- configureJacoco(extension)++ configureJacoco(extensions.getByType<ApplicationAndroidComponentsExtension>())}}--}\ No newline at end of file+}diff --git a/build-logic/convention/src/main/kotlin/AndroidLibraryJacocoConventionPlugin.kt b/build-logic/convention/src/main/kotlin/AndroidLibraryJacocoConventionPlugin.ktindex 86ca091c3..6f2ff60c5 100644--- a/build-logic/convention/src/main/kotlin/AndroidLibraryJacocoConventionPlugin.kt+++ b/build-logic/convention/src/main/kotlin/AndroidLibraryJacocoConventionPlugin.kt@@ -14,6 +14,8 @@* limitations under the License.*/+import com.android.build.api.dsl.LibraryExtension+import com.android.build.api.variant.ApplicationAndroidComponentsExtensionimport com.android.build.api.variant.LibraryAndroidComponentsExtensionimport com.google.samples.apps.nowinandroid.configureJacocoimport org.gradle.api.Plugin@@ -23,13 +25,15 @@ import org.gradle.kotlin.dsl.getByTypeclass AndroidLibraryJacocoConventionPlugin : Plugin<Project> {override fun apply(target: Project) {with(target) {- with(pluginManager) {- apply("org.gradle.jacoco")- apply("com.android.library")+ pluginManager.apply("jacoco")+ val androidExtension = extensions.getByType<LibraryExtension>()++ androidExtension.buildTypes.configureEach {+ enableAndroidTestCoverage = true+ enableUnitTestCoverage = true}- val extension = extensions.getByType<LibraryAndroidComponentsExtension>()- configureJacoco(extension)++ configureJacoco(extensions.getByType<LibraryAndroidComponentsExtension>())}}--}\ No newline at end of file+}diff --git a/build-logic/convention/src/main/kotlin/com/google/samples/apps/nowinandroid/Jacoco.kt b/build-logic/convention/src/main/kotlin/com/google/samples/apps/nowinandroid/Jacoco.ktindex 596c4f579..7820a978e 100644--- a/build-logic/convention/src/main/kotlin/com/google/samples/apps/nowinandroid/Jacoco.kt+++ b/build-logic/convention/src/main/kotlin/com/google/samples/apps/nowinandroid/Jacoco.kt@@ -1,5 +1,5 @@/*- * Copyright 2022 The Android Open Source Project+ * Copyright 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.@@ -16,8 +16,13 @@package com.google.samples.apps.nowinandroid+import com.android.build.api.artifact.ScopedArtifactimport com.android.build.api.variant.AndroidComponentsExtension+import com.android.build.api.variant.ScopedArtifactsimport org.gradle.api.Project+import org.gradle.api.file.Directory+import org.gradle.api.file.RegularFile+import org.gradle.api.provider.ListPropertyimport org.gradle.api.tasks.testing.Testimport org.gradle.kotlin.dsl.configureimport org.gradle.kotlin.dsl.register@@ -32,13 +37,24 @@ private val coverageExclusions = listOf("**/R.class","**/R\$*.class","**/BuildConfig.*",- "**/Manifest*.*"+ "**/Manifest*.*",+ "**/*_Hilt*.class",+ "**/Hilt_*.class",)private fun String.capitalize() = replaceFirstChar {if (it.isLowerCase()) it.titlecase(Locale.getDefault()) else it.toString()}+/**+ * Creates a new task that generates a combined coverage report with data from local and+ * instrumented tests.+ *+ * `create{variant}CombinedCoverageReport`+ *+ * Note that coverage data must exist before running the task. This allows us to run device+ * tests on CI using a different Github Action or an external device farm.+ */internal fun Project.configureJacoco(androidComponentsExtension: AndroidComponentsExtension<*, *, *>,) {@@ -46,37 +62,53 @@ internal fun Project.configureJacoco(toolVersion = libs.findVersion("jacoco").get().toString()}- val jacocoTestReport = tasks.create("jacocoTestReport")-androidComponentsExtension.onVariants { variant ->- val testTaskName = "test${variant.name.capitalize()}UnitTest"+ val myObjFactory = project.objectsval buildDir = layout.buildDirectory.get().asFile- val reportTask = tasks.register("jacoco${testTaskName.capitalize()}Report", JacocoReport::class) {- dependsOn(testTaskName)+ val allJars: ListProperty<RegularFile> = myObjFactory.listProperty(RegularFile::class.java)+ val allDirectories: ListProperty<Directory> = myObjFactory.listProperty(Directory::class.java)+ val reportTask =+ tasks.register("create${variant.name.capitalize()}CombinedCoverageReport", JacocoReport::class) {- reports {- xml.required.set(true)- html.required.set(true)- }-- classDirectories.setFrom(- fileTree("$buildDir/tmp/kotlin-classes/${variant.name}") {- exclude(coverageExclusions)+ classDirectories.setFrom(+ allJars,+ allDirectories.map { dirs ->+ dirs.map { dir ->+ myObjFactory.fileTree().setDir(dir).exclude(coverageExclusions)+ }+ }+ )+ reports {+ xml.required.set(true)+ html.required.set(true)}- )- sourceDirectories.setFrom(files("$projectDir/src/main/java", "$projectDir/src/main/kotlin"))- executionData.setFrom(file("$buildDir/jacoco/$testTaskName.exec"))- }+ // TODO: This is missing files in src/debug/, src/prod, src/demo, src/demoDebug...+ sourceDirectories.setFrom(files("$projectDir/src/main/java", "$projectDir/src/main/kotlin"))++ executionData.setFrom(+ project.fileTree("$buildDir/outputs/unit_test_code_coverage/${variant.name}UnitTest")+ .matching { include("**/*.exec") },++ project.fileTree("$buildDir/outputs/code_coverage/${variant.name}AndroidTest")+ .matching { include("**/*.ec") }+ )+ }+- jacocoTestReport.dependsOn(reportTask)+ variant.artifacts.forScope(ScopedArtifacts.Scope.PROJECT)+ .use(reportTask)+ .toGet(+ ScopedArtifact.CLASSES,+ { _ -> allJars },+ { _ -> allDirectories },+ )}tasks.withType<Test>().configureEach {configure<JacocoTaskExtension> {// Required for JaCoCo + Robolectric// https://github.com/robolectric/robolectric/issues/2230- // TODO: Consider removing if not we don't add RobolectricisIncludeNoLocationClasses = true// Required for JDK 11 with the abovediff --git a/gradle.properties b/gradle.propertiesindex c0acfeb02..97f940e2e 100644--- a/gradle.properties+++ b/gradle.properties@@ -39,3 +39,6 @@ kotlin.code.style=official# https://developer.android.com/build/releases/gradle-plugin#default-changesandroid.defaults.buildfeatures.resvalues=falseandroid.defaults.buildfeatures.shaders=false++# Run Roborazzi screenshot tests with the local tests+roborazzi.test.verify=true