Skip to content

Expand JaCoCo exclusion filters for generated code #1697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
meladRaouf wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Expand JaCoCo exclusion filters for generated code #1697

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 48 additions & 27 deletions build-logic/convention/src/main/kotlin/PipelineJacocoConventionPlugin.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,43 @@ class PipelineJacocoConventionPlugin : Plugin<Project> {
}
}

private val fileFilter = listOf(
/**
* Unified exclusion list used for both class-directory filtering in the JacocoReport task
* and the JacocoTaskExtension excludes on each Test task.
*/
private val excludedPatterns = listOf(
// Android generated
"**/R.class",
"**/R$*.class",
"**/BuildConfig.*",
"**/Manifest*.*",
// Test classes
"**/*Test*.*",
// Android framework
"android/**/*.*",
// JDK internals
"jdk.internal.*",
// Kotlin-generated classes — Jacoco cannot handle multiple "$" in class names
Comment thread
meladRaouf marked this conversation as resolved.
"**/*\$\$*",
"**/*\$Lambda$*.*",
"**/*\$inlined\$*.*",
// Dagger / Hilt generated (via KSP)
"**/*Dagger*.*",
Copy link
Copy Markdown
Contributor

@luhmirin-s luhmirin-s Jun 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to do the same for any ksm/generaed code? For example retrofit.

Copy link
Copy Markdown
Collaborator Author

@meladRaouf meladRaouf Jun 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the Room DAOs, but I don't think we need to skip everything.

"**/*MembersInjector*.*",
"**/*_Provide*Factory*.*",
"**/*_Factory*.*",
"**/*_HiltModule*.*",
"**/*_AssistedFactory*.*",
"**/*_AssistedFactory_Impl*.*",
"**/hilt_aggregated_deps/**",
// Room generated (via KSP) — DAO and Database implementations
"**/*Dao_Impl*.*",
"**/*Database_Impl*.*",
// Other generated code
"**/*\$JsonObjectMapper.*",
"**/*\$Icepick.*",
"**/*\$StateSaver.*",
"**/*AutoValue_*.*",
)

private fun Project.createJacocoTask() {
Expand All @@ -35,16 +65,24 @@ class PipelineJacocoConventionPlugin : Plugin<Project> {
reports.xml.required.set(true)
reports.html.required.set(false) // Disable html reports to decrease report upload/download time in github pipeline

val javaTree = fileTree("${project.buildDir}/intermediates/javac/debug") {
include("**/classes/**")
exclude(fileFilter)
}
val kotlinTree = fileTree("${project.buildDir}") {
include("tmp/kotlin-classes/debug/**", "classes/kotlin/debug/**", "classes/kotlin/main/**")
exclude(fileFilter)
val buildDir = layout.buildDirectory.get().asFile

val compiledClassPaths = listOf(
"tmp/kotlin-classes/debug",
"intermediates/javac/debug/classes",
Copy link
Copy Markdown
Contributor

@luhmirin-s luhmirin-s Jun 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this support wildcards? We could just skip the whole "intermeriates/**"

Copy link
Copy Markdown
Collaborator Author

@meladRaouf meladRaouf Jun 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried, but the coverage data disappeared from the XML report

"intermediates/asm_instrumented_project_classes/debug",
"intermediates/classes/debug",
"intermediates/local_classes/debug",
"intermediates/project_classes/debug",
)

val classTrees = compiledClassPaths.map { path ->
fileTree(buildDir.resolve(path)) {
exclude(excludedPatterns)
}
}
classDirectories.setFrom(files(javaTree, kotlinTree))

classDirectories.setFrom(files(classTrees))
sourceDirectories.setFrom(
files(
"${project.projectDir}/src/main/java",
Expand Down Expand Up @@ -73,24 +111,7 @@ class PipelineJacocoConventionPlugin : Plugin<Project> {
tasks.withType<Test> {
extensions.configure<JacocoTaskExtension> {
isIncludeNoLocationClasses = true
excludes = listOf(
"jdk.internal.*",
"**/R.class",
"**/R$*.class",
"**/*$$*",
"**/BuildConfig.*",
"**/Manifest*.*",
"**/*\$Lambda$*.*", // Jacoco can not handle several "$" in class name.
"**/*Dagger*.*", // Dagger auto-generated code.
"**/*MembersInjector*.*", // Dagger auto-generated code.
"**/*_Provide*Factory*.*", // Dagger auto-generated code.
"**/*_Factory*.*", // Dagger auto-generated code.
"**/*\$JsonObjectMapper.*", // LoganSquare auto-generated code.
"**/*\$inlined$*.*", // Kotlin specific, Jacoco can not handle several "$" in class name.
"**/*\$Icepick.*", // Icepick auto-generated code.
"**/*\$StateSaver.*", // android-state auto-generated code.
"**/*AutoValue_*.*", // AutoValue auto-generated code.
)
excludes = excludedPatterns
}
}
}
Expand Down
Loading