Lets you report your test suite problems back to the PR elegantly
MIT License
This Danger Plugin allows you to standardise the output for all of your testing runs. Most test runners include an ability to have a reporter that conforms to the JUnit XML standard. This plugin will understand that file and offer a way to introspect it, and to report on it.
$ gem install danger-junit
For Rspec, add the gem rspec_junit_formatter
to your project. Then use a .rspec
file to configure your tests to have multiple reporters. This file looks like:
...
--format documentation
--format RspecJunitFormatter --out junit-results.xml
...
Then you can pass the junit-results.xml
file to the plugin in your Dangerfile
.
In a Jasmine, or Jest testing project, you want to install the module jasmine-reporters
. Then as you are setting up your Jasmine runner, add the following:
var junitReporter = new jasmineReporters.JUnitXmlReporter({
savePath: 'junit-results.xml',
consolidateAll: false
});
jasmine.getEnv().addReporter(junitReporter);
Then you can pass the junit-results.xml
file to the plugin in your Dangerfile
.
You have a lot of options:
Report, or inspect any JUnit XML formatted test suite report.
Testing frameworks have standardized on the JUnit XML format for reporting results, this means that projects using Rspec, Jasmine, Mocha, XCTest and more - can all use the same Danger error reporting. Perfect.
You can see some examples on this page from Circle CI and on this project's README about how you can add JUnit XML output for your testing projects.
tests
- All the tests for introspection
passes
- An array of XML elements that represent passed tests.
failures
- An array of XML elements that represent failed tests.
errors
- An array of XML elements that represent passed tests.
skipped
- An array of XML elements that represent skipped tests.
show_skipped_tests
- An attribute to make the plugin show a warning on skipped tests.
headers
- An array of symbols that become the columns of your tests,
if nil
, the default, it will be all of the attributes.
skipped_headers
- An array of symbols that become the columns of your skipped tests,
if nil
, the default, it will be all of the attributes for a single parse
or all of the common attributes between multiple files
parse
- Parses an XML file, which fills all the attributes,
will raise
for errors
report
- Causes a build fail if there are test failures,
and outputs a markdown table of the results.
bundle install
to setup dependencies.bundle exec rake spec
to run the tests.bundle exec guard
to automatically have tests run as you make changes.