JarCasting
Donut is an open-source framework by the teams at MagenTys & Mechanical Rock and is designed to produce clear and concise test execution reports of your unit, integration and acceptance tests. Donut currently supports any tool that produces cucumber JSON (i.e. cucumber-jvm etc.). For other frameworks like SpecFlow, JUnit, NUnit, RSpec you can use the adapters listed below to generate cucumber JSON, which can then be processed by donut.
Live Demos => Only Scenarios Scenarios and Unit Tests Scenarios and Orphaned Unit Tests Only Unit Tests
Quickstart
You can either use Donut directly or check out the available plugins:
Release Notes
See what's new here
download
wget http://repo1.maven.org/maven2/report/donut/donut/1.2.2/donut-1.2.2-one-jar.jar
or download the latest release from: here
run from command line
java -jar donut-<Version>.jar -s cucumber:/my/path/cucumber-reports -n myProjectName
or
java -jar donut-<Version>.jar -s cucumber:/my/path/cucumber-reports,cucumber:/my/unit-test-reports -n myProjectName
or
java -jar donut-<Version>.jar -s /my/path/cucumber-reports,/my/unit-test-reports -n myProjectName
options
-n or --projectName is a mandatory parameter, and it should be the name of the project.
-s or --resultSources is a mandatory parameter, and it should be a comma separated list of the paths to the directories that hold the result files optionally prefixed with a format. The format defaults to cucumber.
Other parameters can also be specified as below:
Donut help
Usage: Donut reports [options]
-s <value> | --resultSources <value>
Use --resultSources cucumber:/my/path/cucumber-reports,cucumber:/my/adapted/nunit-reports
-o <value> | --outputPath <value>
Use --outputPath /my/path/output/donut
-p <value> | --prefix <value>
Use --prefix fileNamePrefix
-d <value> | --datetime <value>
Use --datetime yyyy-MM-dd-HHmm
-t <value> | --template <value>
Use --template default/light
--skippedFails <value>
Use --skippedFails true/false
--pendingFails <value>
Use --pendingFails true/false
--undefinedFails <value>
Use --undefinedFails true/false
--missingFails <value>
Use --missingFails true/false
-n <value> | --projectName <value>
Use --projectName myProject
-v <value> | --projectVersion <value>
Use --projectVersion 1.0
-c <value> | --customAttributes <value>
Use --customAttributes k1=v1,k2=v2...
default values:
- outputPath : by default a
donutfolder will be generated - prefix : the generated file is
donut-report.html, however you can specify prefix i.e.myproject- - datetime : refers to the start time of your execution. If not specified by the user reports will use
now - template : donut supports 2 themes,
defaultandlight.defaultis the default value
Use as a dependency
- Maven
<dependency>
<groupId>report.donut</groupId>
<artifactId>donut</artifactId>
<version>1.2.2</version>
</dependency>
- SBT
libraryDependencies += "report.donut" % "donut" % "1.2.2"
- Gradle
compile 'report.donut:donut:1.2.2'
Example usage of the Generator
ReportConsole report =
Generator.apply(resultSources, outputPath, filePrefix, timestamp, template, countSkippedAsFailure,
countPendingAsFailure, countUndefinedAsFailure, countMissingAsFailure, projectName, projectVersion, customAttributes);
This will create a html report at the outputPath and will return a ReportConsole output object:
allFeatures: List[Feature]
allTags: List[ReportTag]
totalFeatures: Int
numberOfPassedFeatures: Int
numberOfFailedFeatures: Int
totalScenarios: Int
numberOfPassedScenarios: Int
numberOfFailedScenarios: Int
totalSteps: Int
numberOfPassedSteps: Int
numberOfFailedSteps: Int
numberOfSkippedSteps: Int
numberOfPendingSteps: Int
numberOfUndefinedSteps: Int
duration: String
buildFailed: Boolean
Build from source
prerequisites
- install java 8+
- install scala 2.11+
- install SBT (www.scala-sbt.org)
run from sbt
sbt "run-main report.donut.Boot -s cucumber:/my/path/cucumber-reports -n myProjectName"
credits
- JQuery
- Bootstrap
- Highcharts
- handlebars-scala
Road map
We currently have plans to support:
- jasmine
- rspec (With the support available for JUnit, you can use this JUnit adapter for rspec - https://github.com/sj26/rspec_junit_formatter, to generate JUnit xmls, which can then be adapted to JSONs using the donut-junit-adapter
- jbehave
Contributing
- Fork it
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create new Pull Request
License
This project is under an MIT license
Powered by: MagenTys & Mechanical Rock