Merge pull request #19936 from wordpress-mobile/configure_codecov

Configure Codecov
wordpress-mobile · Jan 16, 2024 · 9427981 · 9427981
2 parents e82d46b + ea9cb25
commit 9427981
Show file tree

Hide file tree

Showing 5 changed files with 82 additions and 45 deletions.
diff --git a/.buildkite/commands/run-unit-tests.sh b/.buildkite/commands/run-unit-tests.sh
@@ -3,14 +3,17 @@
 echo "--- 🧪 Testing"
 set +e
 if [ "$1" == "wordpress" ]; then
-    test_suite="testWordpressVanillaRelease"
+    test_suite="testWordpressVanillaRelease koverXmlReportWordpressVanillaRelease"
     test_log_dir="WordPress/build/test-results/*/*.xml"
+    code_coverage_report="WordPress/build/reports/kover/reportWordpressVanillaRelease.xml"
 elif [ "$1" == "processors" ]; then
-    test_suite=":libs:processors:test"
+    test_suite=":libs:processors:test :libs:processors:koverXmlReport"
     test_log_dir="libs/processors/build/test-results/test/*.xml"
+    code_coverage_report="libs/processors/build/reports/kover/report.xml"
 elif [ "$1" == "image-editor" ]; then
-    test_suite=":libs:image-editor:testReleaseUnitTest"
+    test_suite=":libs:image-editor:testReleaseUnitTest :libs:image-editor:koverXmlReportRelease"
     test_log_dir="libs/image-editor/build/test-results/testReleaseUnitTest/*.xml"
+    code_coverage_report="libs/image-editor/build/reports/kover/reportRelease.xml"
 else
     echo "Invalid Test Suite! Expected 'wordpress', 'processors', or 'image-editor', received '$1' instead"
     exit 1
@@ -46,4 +49,7 @@ echo "--- 🧪 Copying test logs for test collector"
 mkdir buildkite-test-analytics
 cp $test_log_dir buildkite-test-analytics
 
+echo "--- ⚒️ Uploading code coverage"
+.buildkite/commands/upload-code-coverage.sh $code_coverage_report
+
 exit $TESTS_EXIT_STATUS
diff --git a/.buildkite/commands/upload-code-coverage.sh b/.buildkite/commands/upload-code-coverage.sh
@@ -0,0 +1,10 @@
+#!/bin/bash -eu
+
+curl https://keybase.io/codecovsecurity/pgp_keys.asc | gpg --no-default-keyring --keyring trustedkeys.gpg --import
+curl -Os https://uploader.codecov.io/latest/linux/codecov
+curl -Os https://uploader.codecov.io/latest/linux/codecov.SHA256SUM
+curl -Os https://uploader.codecov.io/latest/linux/codecov.SHA256SUM.sig
+gpgv codecov.SHA256SUM.sig codecov.SHA256SUM
+sha256sum -c codecov.SHA256SUM
+chmod +x codecov
+./codecov -t "$CODECOV_TOKEN" -f "$1"
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,8 @@
+comment:
+  require_changes: true
+coverage:
+  status:
+    project: off
+    patch: off
+codecov:
+  max_report_age: off
diff --git a/config/gradle/code_coverage.gradle b/config/gradle/code_coverage.gradle
@@ -15,6 +15,49 @@ subprojects {
                 }
             }
         }
+
+        koverReport {
+            filters {
+                excludes {
+                    packages(
+                            'com.bumptech.glide',
+                            'dagger.*',
+                            '*.compose*',
+                            '*.debug*',
+                            'hilt_aggregated_deps',
+                            '*.databinding',
+                            'org.wordpress.android.modules',
+                            'org.wordpress.android.widgets',
+                    )
+
+                    classes(
+                            '*_Factory*',
+                            '*Activity',
+                            '*Activity$*',
+                            '*Adapter',
+                            '*Adapter$*',
+                            '*BuildConfig',
+                            '*DiffCallback*',
+                            '*Dialog',
+                            '*Dialog$*',
+                            '*Fragment',
+                            '*Fragment$*',
+                            '*FragmentDirections*',
+                            '*FragmentKt*',
+                            '*Module',
+                            '*Module_*',
+                            '*View',
+                            '*View$*',
+                            '*ViewHolder',
+                            '*ViewHolder$*',
+                            '*ViewHolderKt*',
+                            '*.Hilt_*',
+                            '*HiltModules*',
+                            '*_MembersInjector',
+                    )
+                }
+            }
+        }
     }
 }
 
@@ -27,45 +70,3 @@ dependencies {
     )
 }
 
-koverReport {
-    filters {
-        excludes {
-            packages(
-                    'com.bumptech.glide',
-                    'dagger.*',
-                    '*.compose*',
-                    '*.debug*',
-                    'hilt_aggregated_deps',
-                    '*.databinding',
-                    'org.wordpress.android.modules',
-                    'org.wordpress.android.widgets',
-            )
-
-            classes(
-                    '*_Factory*',
-                    '*Activity',
-                    '*Activity$*',
-                    '*Adapter',
-                    '*Adapter$*',
-                    '*BuildConfig',
-                    '*DiffCallback*',
-                    '*Dialog',
-                    '*Dialog$*',
-                    '*Fragment',
-                    '*Fragment$*',
-                    '*FragmentDirections*',
-                    '*FragmentKt*',
-                    '*Module',
-                    '*Module_*',
-                    '*View',
-                    '*View$*',
-                    '*ViewHolder',
-                    '*ViewHolder$*',
-                    '*ViewHolderKt*',
-                    '*.Hilt_*',
-                    '*HiltModules*',
-                    '*_MembersInjector',
-            )
-        }
-    }
-}
diff --git a/docs/code-coverage.md b/docs/code-coverage.md
@@ -0,0 +1,12 @@
+# Code coverage
+
+This project uses [Kover](https://github.com/Kotlin/kotlinx-kover) tool for generating code coverage metrics.
+To run the code coverage report for the whole codebase, run `./gradlew koverHtmlReport` and open the HTML report at `WordPress/build/reports/kover/html/index.html`.
+
+## Coverage exclusions
+
+To get more precise results of the metrics, some classes are excluded from code coverage calculations. Those classes are e.g. Dagger/Hilt generated code, Acitivies, Fragments, databinding etc. A complete list of exclusions is available in the `config/gradle/code_coverage.gradle` file.
+
+## Codecov
+
+We also have `Codecov` integration for getting reports on each PR and observing trends. See [the dashboard](https://app.codecov.io/github/wordpress-mobile/WordPress-Android/) to get more insights.