Upgrade Kover to 0.7.4

element-hq · Nov 9, 2023 · 867a456 · 867a456
1 parent b13172a
commit 867a456
Show file tree

Hide file tree

Showing 6 changed files with 187 additions and 161 deletions.
diff --git a/.github/workflows/nightlyReports.yml b/.github/workflows/nightlyReports.yml
@@ -33,15 +33,15 @@ jobs:
         run: ./gradlew verifyPaparazziDebug $CI_GRADLE_ARG_PROPERTIES
 
       - name: 📈 Generate kover report and verify coverage
-        run: ./gradlew koverMergedReport koverMergedVerify $CI_GRADLE_ARG_PROPERTIES -Pci-build=true
+        run: ./gradlew koverHtmlReportRelease koverVerifyRelease $CI_GRADLE_ARG_PROPERTIES -Pci-build=true
 
       - name: ✅ Upload kover report
         if: always()
         uses: actions/upload-artifact@v3
         with:
           name: kover-results
           path: |
-            **/build/reports/kover/merged
+            **/build/reports/kover
 
       - name: 🔊 Publish results to Sonar
         env:

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -55,15 +55,16 @@ jobs:
         run: ./gradlew verifyPaparazziDebug $CI_GRADLE_ARG_PROPERTIES
 
       - name: 📈Generate kover report and verify coverage
-        run: ./gradlew koverMergedReport koverMergedVerify $CI_GRADLE_ARG_PROPERTIES -Pci-build=true
+        run: ./gradlew koverHtmlReportRelease koverVerifyRelease $CI_GRADLE_ARG_PROPERTIES -Pci-build=true
 
       - name: 🚫 Upload kover failed coverage reports
         if: failure()
         uses: actions/upload-artifact@v3
         with:
           name: kover-error-report
+          # TODO
           path: |
-            **/kover/merged/verification/errors.txt
+            **/kover/verify.err
 
       - name: ✅ Upload kover report (disabled)
         if: always()
@@ -83,4 +84,4 @@ jobs:
         if: always()
         uses: codecov/codecov-action@v3
         # with:
-        #  files: build/reports/kover/merged/xml/report.xml
+        #  files: build/reports/kover/xml/report.xml
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -194,6 +194,179 @@ knit {
     }
 }
 
+/**
+ * Kover configuration
+ */
+
+dependencies {
+    // Add all sub projects to kover except some of them
+    project.rootProject.subprojects
+        .filter {
+            it.project.projectDir.resolve("build.gradle.kts").exists()
+        }
+        .map { it.path }
+        .sorted()
+        .filter {
+            it !in listOf(
+                ":app",
+                ":samples",
+                ":anvilannotations",
+                ":anvilcodegen",
+                ":samples:minimal",
+                ":tests:testutils",
+            )
+        }
+        .forEach {
+            // println("Add $it to kover")
+            kover(project(it))
+        }
+}
+
+// https://kotlin.github.io/kotlinx-kover/
+// Run `./gradlew koverHtmlReportRelease` to get report at ./build/reports/kover
+// Run `./gradlew koverXmlReportRelease` to get XML report
+koverReport {
+    filters {
+        excludes {
+            classes(
+                // Exclude generated classes.
+                "*_ModuleKt",
+                "anvil.hint.binding.io.element.*",
+                "anvil.hint.merge.*",
+                "anvil.hint.multibinding.io.element.*",
+                "anvil.module.*",
+                "com.airbnb.android.showkase*",
+                "io.element.android.libraries.designsystem.showkase.*",
+                "io.element.android.x.di.DaggerAppComponent*",
+                "*_Factory",
+                "*_Factory_Impl",
+                "*_Factory$*",
+                "*_Module",
+                "*_Module$*",
+                "*Module_Provides*",
+                "Dagger*Component*",
+                "*ComposableSingletons$*",
+                "*_AssistedFactory_Impl*",
+                "*BuildConfig",
+                // Generated by Showkase
+                "*Ioelementandroid*PreviewKt$*",
+                "*Ioelementandroid*PreviewKt",
+                // Other
+                // We do not cover Nodes (normally covered by maestro, but code coverage is not computed with maestro)
+                "*Node",
+                "*Node$*",
+                // Exclude `:libraries:matrix:impl` module, it contains only wrappers to access the Rust Matrix SDK api, so it is not really relevant to unit test it: there is no logic to test.
+                "io.element.android.libraries.matrix.impl.*",
+                "*Presenter\$present\$*",
+                // Forked from compose
+                "io.element.android.libraries.designsystem.theme.components.bottomsheet.*",
+            )
+            annotatedBy(
+                "*Preview",
+            )
+        }
+    }
+
+    defaults {
+        verify {
+            onCheck = true
+            // General rule: minimum code coverage.
+            rule("Global minimum code coverage.") {
+                entity = kotlinx.kover.gradle.plugin.dsl.GroupingEntityType.APPLICATION
+                bound {
+                    minValue = 60
+                    // Setting a max value, so that if coverage is bigger, it means that we have to change minValue.
+                    // For instance if we have minValue = 20 and maxValue = 30, and current code coverage is now 31.32%, update
+                    // minValue to 25 and maxValue to 35.
+                    maxValue = 70
+                    metric = kotlinx.kover.gradle.plugin.dsl.MetricType.INSTRUCTION
+                    aggregation = kotlinx.kover.gradle.plugin.dsl.AggregationType.COVERED_PERCENTAGE
+                }
+            }
+            // Rule to ensure that coverage of Presenters is sufficient.
+            rule("Check code coverage of presenters") {
+                entity = kotlinx.kover.gradle.plugin.dsl.GroupingEntityType.CLASS
+                filters {
+                    includes {
+                        classes(
+                            "*Presenter",
+                        )
+                    }
+                    excludes {
+                        classes(
+                            "*Fake*Presenter",
+                            "io.element.android.appnav.loggedin.LoggedInPresenter$*",
+                            // Some options can't be tested at the moment
+                            "io.element.android.features.preferences.impl.developer.DeveloperSettingsPresenter$*",
+                            "*Presenter\$present\$*",
+                        )
+                    }
+                }
+                bound {
+                    minValue = 85
+                    metric = kotlinx.kover.gradle.plugin.dsl.MetricType.INSTRUCTION
+                    aggregation = kotlinx.kover.gradle.plugin.dsl.AggregationType.COVERED_PERCENTAGE
+                }
+            }
+            // Rule to ensure that coverage of States is sufficient.
+            rule("Check code coverage of states") {
+                entity = kotlinx.kover.gradle.plugin.dsl.GroupingEntityType.CLASS
+                filters {
+                    includes {
+                        classes(
+                            "^*State$",
+                        )
+                    }
+                    excludes {
+                        classes(
+                            "io.element.android.appnav.root.RootNavState*",
+                            "io.element.android.libraries.matrix.api.timeline.item.event.OtherState$*",
+                            "io.element.android.libraries.matrix.api.timeline.item.event.EventSendState$*",
+                            "io.element.android.libraries.matrix.api.room.RoomMembershipState*",
+                            "io.element.android.libraries.matrix.api.room.MatrixRoomMembersState*",
+                            "io.element.android.libraries.push.impl.notifications.NotificationState*",
+                            "io.element.android.features.messages.impl.media.local.pdf.PdfViewerState",
+                            "io.element.android.features.messages.impl.media.local.LocalMediaViewState",
+                            "io.element.android.features.location.impl.map.MapState*",
+                            "io.element.android.libraries.matrix.api.timeline.item.event.LocalEventSendState*",
+                            "io.element.android.libraries.designsystem.swipe.SwipeableActionsState*",
+                            "io.element.android.features.messages.impl.timeline.components.ExpandableState*",
+                            "io.element.android.features.messages.impl.timeline.model.bubble.BubbleState*",
+                            "io.element.android.libraries.maplibre.compose.CameraPositionState*",
+                            "io.element.android.libraries.maplibre.compose.SaveableCameraPositionState",
+                            "io.element.android.libraries.maplibre.compose.SymbolState*",
+                            "io.element.android.features.ftue.api.state.*",
+                            "io.element.android.features.ftue.impl.welcome.state.*",
+                        )
+                    }
+                }
+                bound {
+                    minValue = 90
+                    metric = kotlinx.kover.gradle.plugin.dsl.MetricType.INSTRUCTION
+                    aggregation = kotlinx.kover.gradle.plugin.dsl.AggregationType.COVERED_PERCENTAGE
+                }
+            }
+            // Rule to ensure that coverage of Views is sufficient (deactivated for now).
+            rule("Check code coverage of views") {
+                entity = kotlinx.kover.gradle.plugin.dsl.GroupingEntityType.CLASS
+                filters {
+                    includes {
+                        classes(
+                            "*ViewKt",
+                        )
+                    }
+                }
+                bound {
+                    // TODO Update this value, for now there are too many missing tests.
+                    minValue = 0
+                    metric = kotlinx.kover.gradle.plugin.dsl.MetricType.INSTRUCTION
+                    aggregation = kotlinx.kover.gradle.plugin.dsl.AggregationType.COVERED_PERCENTAGE
+                }
+            }
+        }
+    }
+}
+
 dependencies {
     allLibrariesImpl()
     allServicesImpl()