A danger plugin for enforcing code coverage coverage via a Kover or Jacoco coverage report.
Add this line to your application's Gemfile:
gem 'danger-shroud'Shroud depends on having a Kover coverage report generated for your project. For Android projects, kotlinx-kover works well.
You can use the following parameters to control how shroud operates:
| Param | Type | Description | Example |
|---|---|---|---|
| moduleName | String | the display name of the project or module | 'Module Name ' |
| file | String | file path to a Kover xml coverage report. | 'path/to/kover/report.xml' |
| totalProjectThreshold | Integer | defines the required percentage of total project coverage for a passing build. | default 90 |
| modifiedFileThreshold | Integer | defines the required percentage of files modified in a PR for a passing build. | default 90 |
| failIfUnderProjectThreshold | Boolean | if true, will fail builds that are under the provided thresholds. if false, will only warn. | default true |
| failIfUnderFileThreshold | Boolean | if true, will fail builds that are under the provided thresholds. if false, will only warn. | default true |
Running shroud with default values:
# Report coverage of modified files, fail if either total
# project coverage or any modified file's coverage is under 90%
shroud.reportKover 'Module Name', 'path/to/kover/report.xml'Running shroud with custom coverage thresholds:
# Report coverage of modified files, fail if total project coverage is under 80%,
# or if any modified file's coverage is under 95%
shroud.reportKover 'Module Name', 'path/to/kover/report.xml', 80, 95Warn on builds instead of fail:
# Report coverage of modified files the same as the above example, except the
# builds will only warn instead of fail if below project thresholds
shroud.reportKover 'Module Name', 'path/to/kover/report.xml', 80, 95, false, falseYou can use the following parameters to control how shroud operates:
| Param | Type | Description | Example |
|---|---|---|---|
| moduleName | String | the display name of the project or module | 'Module Name ' |
| file | String | file path to a Kover xml coverage report. | 'path/to/jacoco/report.xml' |
| totalProjectThreshold | Integer | defines the required percentage of total project coverage for a passing build. | default 90 |
| modifiedFileThreshold | Integer | defines the required percentage of files modified in a PR for a passing build. | default 90 |
| failIfUnderProjectThreshold | Boolean | if true, will fail builds that are under the provided thresholds. if false, will only warn. | default true |
| failIfUnderFileThreshold | Boolean | if true, will fail builds that are under the provided thresholds. if false, will only warn. | default true |
Shroud depends on having a Jacoco coverage report generated for your project. For Android projects, jacoco-android-gradle-plugin works well.
Running shroud with default values:
# Report coverage of modified files, fail if either total
# project coverage or any modified file's coverage is under 90%
shroud.reportJacoco 'Module Name', 'path/to/jacoco/report.xml'Running shroud with custom coverage thresholds:
# Report coverage of modified files, fail if total project coverage is under 80%,
# or if any modified file's coverage is under 95%
shroud.reportJacoco 'Module Name', 'path/to/jacoco/report.xml', 80, 95Warn on builds instead of fail:
# Report coverage of modified files the same as the above example, except the
# builds will only warn instead of fail if below thresholds
shroud.reportJacoco 'Module Name', 'path/to/jacoco/report.xml', 80, 95, false, false- Clone this repo
- Run
bundle installto setup dependencies. - Run
bundle exec rake specto run the tests. - Use
bundle exec guardto automatically have tests run as you make changes. - Make your changes.