|
| 1 | +/* |
| 2 | + * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved. |
| 3 | + * |
| 4 | + * Licensed under the Stream License; |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * https://github.com/GetStream/stream-build-conventions-android/blob/main/LICENSE |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | +package io.getstream.android.coverage |
| 17 | + |
| 18 | +import com.android.build.api.dsl.ApplicationExtension |
| 19 | +import com.android.build.api.dsl.CommonExtension |
| 20 | +import com.android.build.api.dsl.LibraryExtension |
| 21 | +import io.getstream.android.StreamProjectExtension |
| 22 | +import io.getstream.android.requireStreamProjectExtension |
| 23 | +import kotlinx.kover.gradle.plugin.dsl.KoverProjectExtension |
| 24 | +import org.gradle.api.Project |
| 25 | +import org.gradle.kotlin.dsl.configure |
| 26 | +import org.sonarqube.gradle.SonarExtension |
| 27 | + |
| 28 | +private object SonarDefaults { |
| 29 | + const val HOST_URL = "https://sonarcloud.io" |
| 30 | + |
| 31 | + const val ORGANIZATION = "getstream" |
| 32 | + |
| 33 | + val EXCLUSIONS = |
| 34 | + listOf( |
| 35 | + "**/test/**", |
| 36 | + "**/androidTest/**", |
| 37 | + "**/R.class", |
| 38 | + "**/R2.class", |
| 39 | + "**/R$*.class", |
| 40 | + "**/BuildConfig.*", |
| 41 | + "**/Manifest*.*", |
| 42 | + "**/*Test*.*", |
| 43 | + ) |
| 44 | +} |
| 45 | + |
| 46 | +object KoverDefaults { |
| 47 | + const val VARIANT_NAME = "coverage" |
| 48 | + const val VARIANT_SUFFIX = "Coverage" |
| 49 | + const val TEST_TASK = "test$VARIANT_SUFFIX" |
| 50 | + |
| 51 | + val CLASS_EXCLUSIONS = listOf("*R", "*R$*", "*BuildConfig", "*Manifest*", "*Composable*") |
| 52 | + |
| 53 | + val ANNOTATION_EXCLUSIONS = arrayOf("androidx.compose.ui.tooling.preview.Preview") |
| 54 | +} |
| 55 | + |
| 56 | +internal fun Project.configureCoverageRoot() { |
| 57 | + pluginManager.apply("org.sonarqube") |
| 58 | + |
| 59 | + afterEvaluate { |
| 60 | + val projectExtension = requireStreamProjectExtension() |
| 61 | + val includedModules = projectExtension.coverage.includedModules.get() |
| 62 | + |
| 63 | + configureKover(projectExtension.coverage, isRoot = true) |
| 64 | + setupKoverDependencyOnModules(includedModules) |
| 65 | + configureSonar(projectExtension) |
| 66 | + registerAggregatedCoverageTask(includedModules) |
| 67 | + } |
| 68 | +} |
| 69 | + |
| 70 | +private fun Project.configureSonar(extension: StreamProjectExtension) { |
| 71 | + val repositoryName = extension.repositoryName.get() |
| 72 | + val exclusions = buildList { |
| 73 | + addAll(SonarDefaults.EXCLUSIONS) |
| 74 | + addAll(extension.coverage.sonarCoverageExclusions.get()) |
| 75 | + } |
| 76 | + |
| 77 | + extensions.configure<SonarExtension> { |
| 78 | + properties { |
| 79 | + property("sonar.host.url", SonarDefaults.HOST_URL) |
| 80 | + property("sonar.token", System.getenv("SONAR_TOKEN")) |
| 81 | + property("sonar.organization", SonarDefaults.ORGANIZATION) |
| 82 | + property("sonar.projectKey", "GetStream_$repositoryName") |
| 83 | + property("sonar.projectName", repositoryName) |
| 84 | + property("sonar.java.coveragePlugin", "jacoco") |
| 85 | + property("sonar.sourceEncoding", "UTF-8") |
| 86 | + property("sonar.java.binaries", "$rootDir/**/build/tmp/kotlin-classes/debug") |
| 87 | + property("sonar.coverage.exclusions", exclusions) |
| 88 | + property( |
| 89 | + "sonar.coverage.jacoco.xmlReportPaths", |
| 90 | + layout.buildDirectory |
| 91 | + .file("/reports/kover/report${KoverDefaults.VARIANT_SUFFIX}.xml") |
| 92 | + .get(), |
| 93 | + ) |
| 94 | + } |
| 95 | + } |
| 96 | +} |
| 97 | + |
| 98 | +private fun Project.setupKoverDependencyOnModules(includedModules: Set<String>) { |
| 99 | + subprojects.forEach { subproject -> |
| 100 | + if (subproject.name in includedModules) { |
| 101 | + dependencies.add("kover", subproject) |
| 102 | + } |
| 103 | + } |
| 104 | +} |
| 105 | + |
| 106 | +internal fun Project.configureCoverageModule() { |
| 107 | + val coverageOptions = requireStreamProjectExtension().coverage |
| 108 | + |
| 109 | + // Do not configure coverage for ignored modules |
| 110 | + if (name !in coverageOptions.includedModules.get()) { |
| 111 | + return |
| 112 | + } |
| 113 | + |
| 114 | + pluginManager.apply("org.sonarqube") |
| 115 | + |
| 116 | + // Configure Android test coverage if this is an Android module |
| 117 | + pluginManager.withPlugin("com.android.library") { configureAndroid<LibraryExtension>() } |
| 118 | + pluginManager.withPlugin("com.android.application") { configureAndroid<ApplicationExtension>() } |
| 119 | + |
| 120 | + configureKover(coverageOptions, isRoot = false) |
| 121 | + registerModuleCoverageTask() |
| 122 | +} |
| 123 | + |
| 124 | +private fun Project.registerAggregatedCoverageTask(includedModules: Set<String>) { |
| 125 | + tasks.register(KoverDefaults.TEST_TASK) { |
| 126 | + group = "verification" |
| 127 | + description = "Run all tests in all modules and generate merged coverage report" |
| 128 | + |
| 129 | + // Depend on all module-specific testCoverage tasks |
| 130 | + val coverageModuleTasks = |
| 131 | + subprojects |
| 132 | + .filter { it.name in includedModules } |
| 133 | + .map { ":${it.name}:${KoverDefaults.TEST_TASK}" } |
| 134 | + dependsOn(coverageModuleTasks) |
| 135 | + |
| 136 | + finalizedBy( |
| 137 | + "koverXmlReport${KoverDefaults.VARIANT_SUFFIX}", |
| 138 | + "koverHtmlReport${KoverDefaults.VARIANT_SUFFIX}", |
| 139 | + ) |
| 140 | + } |
| 141 | +} |
| 142 | + |
| 143 | +private fun Project.registerModuleCoverageTask() { |
| 144 | + // Determine the appropriate test task based on module type and plugins |
| 145 | + val hasPaparazziPlugin = pluginManager.hasPlugin("app.cash.paparazzi") |
| 146 | + val hasAndroidPlugin = |
| 147 | + pluginManager.hasPlugin("com.android.library") || |
| 148 | + pluginManager.hasPlugin("com.android.application") |
| 149 | + |
| 150 | + val testTaskName = |
| 151 | + when { |
| 152 | + hasPaparazziPlugin -> "verifyPaparazziDebug" |
| 153 | + hasAndroidPlugin -> "testDebugUnitTest" |
| 154 | + else -> "test" |
| 155 | + } |
| 156 | + |
| 157 | + tasks.register(KoverDefaults.TEST_TASK) { |
| 158 | + group = "verification" |
| 159 | + description = "Run module-specific tests" |
| 160 | + dependsOn(testTaskName) |
| 161 | + } |
| 162 | +} |
| 163 | + |
| 164 | +private inline fun <reified E : CommonExtension<*, *, *, *, *, *>> Project.configureAndroid() { |
| 165 | + extensions.configure<E> { |
| 166 | + buildTypes { |
| 167 | + getByName("debug") { |
| 168 | + enableUnitTestCoverage = true |
| 169 | + enableAndroidTestCoverage = true |
| 170 | + } |
| 171 | + } |
| 172 | + } |
| 173 | +} |
| 174 | + |
| 175 | +private fun Project.configureKover(options: CoverageOptions, isRoot: Boolean) { |
| 176 | + pluginManager.apply("org.jetbrains.kotlinx.kover") |
| 177 | + |
| 178 | + extensions.configure<KoverProjectExtension> { |
| 179 | + // Create custom variant in each project (including root) for coverage aggregation |
| 180 | + currentProject { |
| 181 | + createVariant(KoverDefaults.VARIANT_NAME) { |
| 182 | + if (isRoot) { |
| 183 | + // Root variant is empty, it just aggregates from dependencies |
| 184 | + } else { |
| 185 | + add("jvm", "debug", optional = true) |
| 186 | + } |
| 187 | + } |
| 188 | + } |
| 189 | + |
| 190 | + reports { |
| 191 | + verify.warningInsteadOfFailure.set(true) |
| 192 | + |
| 193 | + filters.excludes { |
| 194 | + classes(KoverDefaults.CLASS_EXCLUSIONS) |
| 195 | + classes(options.koverClassExclusions.get()) |
| 196 | + |
| 197 | + annotatedBy(*KoverDefaults.ANNOTATION_EXCLUSIONS) |
| 198 | + } |
| 199 | + } |
| 200 | + } |
| 201 | +} |
0 commit comments