Sweet reports for the icing over your automated tests
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
project
src
.gitignore
.travis.yml
LICENSE.txt
README.md
_config.yml
build.sbt
contribute.md
deploy-baked-donut.sh
release-notes.md

README.md

Build Status Maven Central Javadoc

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 gherkin json (ie. cucumber-jvm etc.). For other frameworks like SpecFlow, JUnit, NUnit, RSpec you can use the adapters listed below to generate the gherkin jsons, 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/1.1/donut-1.1-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 /my/unit-test-reports -n myProjectName

or

java -jar donut-<Version>.jar -s cucumber:/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 --sourcedirs is a mandatory parameter, and it should be a comma separated list of the paths to the directories that hold the generated result files.

Other parameters can also be specified as below:

Donut help
Usage: Donut reports [options]

  -s <value> | --sourcedirs <value>
        Use --sourcedirs cucumber:/my/path/cucumber-reports -> Required, or Use --sourcedirs specflow:/my/path/specflow-reports,/my/nunit-reports
  -o <value> | --outputdir <value>
        Use --outputdir /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:

  • outputDir : by default a donut folder 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, default and light. default is the default value

Use as a dependency

  • Maven
<dependency>
  <groupId>report.donut</groupId>
  <artifactId>donut</artifactId>
  <version>1.1</version>
</dependency>

For older versions:

<dependency>
  <groupId>io.magentys</groupId>
  <artifactId>donut</artifactId>
  <version>1.0</version>
</dependency>
  • SBT
libraryDependencies += "report.donut" % "donut" % "1.1"

For older versions:

libraryDependencies += "io.magentys" % "donut" % "1.0"
  • Gradle
compile 'report.donut:donut:1.1'

For older versions:

compile 'io.magentys:donut:1.0'

Example usage of the Generator

ReportConsole report = 
       Generator.apply(sourceDirectory, outputDirectory, filePrefix, timestamp, template, countSkippedAsFailure,         
       countPendingAsFailure, countUndefinedAsFailure, countMissingAsFailure, projectName, projectVersion, customAttributes);

This will create an html report at the outputDirectory 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

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

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

This project is under an MIT license

Powered by: MagenTys & Mechanical Rock