- Integration of jacoco for test coverage and exclude the files that should not be a part of test cases.

Author: asadmukhtar28

.github/workflows/weather-app-ci-cd.yml

@@ -54,3 +54,13 @@ jobs:
         with:
           name: unit-test-reports
           path: app/build/reports/tests/
+
+      # -------------------------------
+      # Upload Jacoco Test Reports
+      # -------------------------------
+      - name: Upload Jacoco Test Reports
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: jacoco-test-reports
+          path: app/build/reports/jacoco/jacocoTestReport/

app/build.gradle.kts

@@ -6,14 +6,20 @@ plugins {
     alias(libs.plugins.kotlin.compose)
     alias(libs.plugins.dagger.hilt)
     alias(libs.plugins.kotlin.kapt)
+    alias(libs.plugins.jacoco)
 }
+
 val localProperties = Properties()
 val localPropertiesFile = rootProject.file("local.properties")
 
 if (localPropertiesFile.exists()) {
     localProperties.load(localPropertiesFile.inputStream())
 }
 
+jacoco {
+    toolVersion = "0.8.11"
+}
+
 android {
     namespace = "com.asad.weatherapp"
     compileSdk = 36
@@ -41,6 +47,9 @@ android {
     }
 
     buildTypes {
+        debug {
+            enableUnitTestCoverage = true
+        }
         release {
             isMinifyEnabled = false
             proguardFiles(
@@ -102,4 +111,81 @@ dependencies {
     testImplementation(libs.kotlinx.coroutines.test)
     testImplementation(libs.mockk)
     testImplementation(libs.turbine)
-}
+}
+
+tasks.register<JacocoReport>("jacocoTestReport") {
+    dependsOn("testDebugUnitTest")
+
+    reports {
+        xml.required.set(true)
+        html.required.set(true)
+    }
+
+    val fileFilter = listOf(
+        // Android generated
+        "**/R.class",
+        "**/R$*.class",
+        "**/BuildConfig.*",
+        "**/Manifest*.*",
+
+        // Tests
+        "**/*Test*.*",
+
+        // Dependency Injection / Hilt
+        "**/di/**",
+        "**/*Hilt*.*",
+        "**/*_Factory.*",
+        "**/*_MembersInjector.*",
+
+        // UI Packages to exclude
+        "**/ui/theme/**",
+        "**/ui/components/**",
+        "**/ui/model/**",
+        "**/ui/forecast/previews/**",
+        "**/ui/forecast/WeatherForecastScreenKt.*",
+        "**/*Lambda*.*",
+
+        // Data Packages to exclude
+        "**/data/repository/**",
+        "**/data/remote/**",
+        "**/data/handler/**",
+
+        // Activities / Fragments (optional, if needed)
+        "**/*Activity*.*",
+        "**/*Fragment*.*",
+        "**/*$*.*",
+
+        // Exclude main app classes
+        "**/WeatherApp.class"
+    )
+
+    val javaClasses = fileTree(
+        mapOf(
+            "dir" to "$buildDir/intermediates/javac/debug/classes",
+            "excludes" to fileFilter
+        )
+    )
+
+    val kotlinClasses = fileTree(
+        mapOf(
+            "dir" to "$buildDir/tmp/kotlin-classes/debug",
+            "excludes" to fileFilter
+        )
+    )
+
+    classDirectories.setFrom(files(javaClasses, kotlinClasses))
+
+    sourceDirectories.setFrom(
+        files(
+            "src/main/java",
+            "src/main/kotlin"
+        )
+    )
+
+    executionData.setFrom(
+        fileTree(buildDir).include(
+            "outputs/unit_test_code_coverage/debugUnitTest/testDebugUnitTest.exec"
+        )
+    )
+}
+

gradle/libs.versions.toml

@@ -50,4 +50,5 @@ kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
 kotlin-compose = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
 dagger-hilt = { id = "com.google.dagger.hilt.android", version.ref = "hiltVersion" }
 kotlin-kapt = { id = "org.jetbrains.kotlin.kapt" }
+jacoco = { id = "jacoco" }