Report your Ruby app test suite code coverage in Danger.
Before using this plugin, you need to setup your project to use SimpleCov to get code coverage information and simplecov-json to format it as JSON.
File | Coverage |
---|---|
foo.rb | 20.00% |
bar.rb | 40.00% |
baz.rb | 60.00% |
Add this line to your Gemfile:
gem 'danger-simplecov_json', git: 'https://github.com/KeyweeLabs/danger-simplecov_json.git'
To see the table with individual file coverage for new or modified files add this line to your Dangerfile
:
simplecov.individual_report('coverage/coverage.json')
You can specify minimum file coverage by file and fail the danger when unmet:
simplecov.individual_report('coverage/coverage.json', minimum_coverage_by_file: 99.9)
By default it will check coverage of all files that were matched but if you have more exoctic use cases, e.g. you want to exclude legacy files and only enforce it on new files you can pass a proc object instead:
predicate = lambda do |filename, covered_percent|
git.added_files.include?(filename) ? covered_percent >= 80 : true
end
simplecov.individual_report('coverage/coverage.json', minimum_coverage_by_file: predicate)
Additionally, you can pass custom file matcher to match between commited files and files reported in coverage report:
files_matcher = lambda do |commited_files, coverage_file_name| do
coverage_file_name =~ %r{api/v2} && commited_files.include?(coverage_file_name)
end
simplecov.individual_report('coverage/coverage.json', files_matcher: files_matcher)
In case you want just a simple message with a code coverage percentage for your project use #report
method:
simplecov.report 'coverage/coverage.json'
This would report a message like this one:
Code coverage is now at 99.15% (1512/1525 lines)
You can also make the message not sticky:
simplecov.report('coverage/coverage.json', sticky: false)
MIT
- Clone this repo
- Run
bundle install
to setup dependencies. - Run
bundle exec rake
to run the tests. - Use
bundle exec guard
to automatically have tests run as you make changes. - Make your changes.