Add Kover Code Coverage (#2794)

* build : add kover code coverage gradle plugin * ci : add kover gradle task in github action
Ivy-Apps · Oct 19, 2023 · 9fe7ff9 · 9fe7ff9
1 parent c166a17
commit 9fe7ff9
Show file tree

Hide file tree

Showing 4 changed files with 99 additions and 2 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -30,4 +30,35 @@ jobs:
             ${{ runner.os }}-gradle-
 
       - name: Run unit tests
-        run: ./gradlew testDebugUnitTest
+        run: ./gradlew testDebugUnitTest
+
+  code_coverage:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout GIT
+        uses: actions/checkout@v4
+
+      - name: Setup Java SDK
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'adopt'
+          java-version: '18'
+
+      - name: Enable Gradle Wrapper caching (optimization)
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+      - name: Code Coverage
+        run: ./gradlew koverHtmlReport
+
+      - name: Upload Code Coverage Report
+        uses: actions/upload-artifact@v2
+        with:
+          name: code-coverage-report
+          path: app/build/artifacts/reports/kover/coverageResults/index.html
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -186,3 +186,46 @@ dependencies {
 
     lintChecks(libs.slack.lint.compose)
 }
+
+dependencies {
+    koverReport {
+        defaults {
+            mergeWith("debug")
+            html {
+                onCheck = false
+                setReportDir(layout.buildDirectory.dir("artifacts/reports/kover/coverageResults"))
+            }
+        }
+    }
+
+    kover(projects.ivyBase)
+    kover(projects.ivyData)
+    kover(projects.ivyDomain)
+    kover(projects.ivyNavigation)
+    kover(projects.ivyResources)
+    kover(projects.ivyWidgetBase)
+    kover(projects.screenAttributions)
+    kover(projects.screenBalance)
+    kover(projects.screenBudgets)
+    kover(projects.screenCategories)
+    kover(projects.screenContributors)
+    kover(projects.screenExchangeRates)
+    kover(projects.screenFeatures)
+    kover(projects.screenHome)
+    kover(projects.screenImportData)
+    kover(projects.screenLoans)
+    kover(projects.screenMain)
+    kover(projects.screenOnboarding)
+    kover(projects.screenPiechart)
+    kover(projects.screenPlannedPayments)
+    kover(projects.screenReleases)
+    kover(projects.screenReports)
+    kover(projects.screenSearch)
+    kover(projects.screenSettings)
+    kover(projects.screenTransaction)
+    kover(projects.screenTransactions)
+    kover(projects.tempLegacyCode)
+    kover(projects.tempOldDesign)
+    kover(projects.widgetAddTransaction)
+    kover(projects.widgetBalance)
+}
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -6,6 +6,28 @@ plugins {
     id("ivy.detekt")
 
     alias(libs.plugins.gradleWrapperUpgrade)
+
+    alias(libs.plugins.koverPlugin)
+}
+
+subprojects {
+    apply(plugin = "org.jetbrains.kotlinx.kover")
+    koverReport {
+        // filters for all report types of all build variants
+        filters {
+            excludes {
+                classes(
+                    "*Activity",
+                    "*Activity\$*",
+                    "*.BuildConfig",
+                    "dagger.hilt.*",
+                    "hilt_aggregated_deps.*",
+                    "*.Hilt_*"
+                )
+                annotatedBy("@Composable")
+            }
+        }
+    }
 }
 
 wrapperUpgrade {

diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -205,4 +205,5 @@ opencsv = [
 ]
 
 [plugins]
-gradleWrapperUpgrade = { id = "org.gradle.wrapper-upgrade", version = "0.11.4" }
+gradleWrapperUpgrade = { id = "org.gradle.wrapper-upgrade", version = "0.11.4" }
+koverPlugin = { id = "org.jetbrains.kotlinx.kover", version = "0.7.4" }