summaryrefslogtreecommitdiffstats
path: root/mobile/android/android-components/docs/contribute/code_coverage.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-15 03:35:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-15 03:35:49 +0000
commitd8bbc7858622b6d9c278469aab701ca0b609cddf (patch)
treeeff41dc61d9f714852212739e6b3738b82a2af87 /mobile/android/android-components/docs/contribute/code_coverage.md
parentReleasing progress-linux version 125.0.3-1~progress7.99u1. (diff)
downloadfirefox-d8bbc7858622b6d9c278469aab701ca0b609cddf.tar.xz
firefox-d8bbc7858622b6d9c278469aab701ca0b609cddf.zip
Merging upstream version 126.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'mobile/android/android-components/docs/contribute/code_coverage.md')
-rw-r--r--mobile/android/android-components/docs/contribute/code_coverage.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/mobile/android/android-components/docs/contribute/code_coverage.md b/mobile/android/android-components/docs/contribute/code_coverage.md
new file mode 100644
index 0000000000..3a3eb6f540
--- /dev/null
+++ b/mobile/android/android-components/docs/contribute/code_coverage.md
@@ -0,0 +1,25 @@
+---
+layout: page
+title: Code coverage
+permalink: /contributing/code-coverage
+---
+
+# Code Coverage
+
+> In computer science, test coverage is a measure used to describe the degree to which the source code of a program is executed when a particular test suite runs. A program with high test coverage, measured as a percentage, has had more of its source code executed during testing, which suggests it has a lower chance of containing undetected software bugs compared to a program with low test coverage. ([Wikipedia](https://en.wikipedia.org/wiki/Code_coverage))
+
+# Automated reports
+
+For pull requests and main pushes we generate code coverage reports on taskcluster and they can be accessed via the GitHub checks.
+
+# Generating reports locally
+
+Locally you can generate a coverage report for a module with the following command:
+```bash
+./gradlew -Pcoverage <module>:build
+```
+
+After that you'll find an HTML report at the following location:
+```
+components/<path to module>/build/reports/jacoco/jacocoTestReport/html/index.html
+```