Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bischoffdev committed Nov 14, 2017
1 parent d1b97a3 commit 3cb40f9
Showing 1 changed file with 36 additions and 31 deletions.
67 changes: 36 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@


- [Cluecumber Report Maven Plugin](#cluecumber-report-maven-plugin)
- [Test suite overview page](#test-suite-overview-page)
- [Scenario detail pages](#scenario-detail-pages)
- [Example POM snippet](#example-pom-snippet)
- [Parameters](#parameters)
- [Prerequisites](#prerequisites)
- [Maven POM settings](#maven-pom-settings)
- [Configuration Parameters](#configuration-parameters)
- [Generated pages](#generated-pages)
- [Test suite overview page](#test-suite-overview-page)
- [Scenario detail pages](#scenario-detail-pages)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand All @@ -31,28 +32,18 @@ This project was created because
- some other projects consume a large amount of memory when generating reports from large JSON files
- it will allow to completely customize the report appearance and information

## Test suite overview page

This page shows the most important information about the test suite:
- run time
- number of passed, failed and skipped scenarios
- grouped scenarios by status

![report_overview](documentation/img/report_overview.png)

## Scenario detail pages

The scenario detail pages can be reached by clicking on the scenario name in the test suite overview page.
## Prerequisites

It shows:
- scenario name and description
- step runtimes and status
- stack traces of failed steps
- screenshots
In order to have the JSON files as a source for the Cluecumber Report generation, you need to specify this option in your Cucumber runner configuration:
```
@CucumberOptions(
format = {"json:target/cucumber-report/cucumber.json"}
)
```

![report_detail](documentation/img/report_detail.png)
This will generate JSON results for all Cucumber tests.

## Example POM snippet
## Maven POM settings

```xml
<plugin>
Expand All @@ -75,7 +66,7 @@ It shows:
</plugin>
```

## Parameters
### Configuration Parameters

There are two parameters that have to be specified:

Expand All @@ -87,11 +78,25 @@ There are two parameters that have to be specified:
**Note:**
Typically, both properties point to directories inside the Maven ```target``` directory.

## Prerequisites
## Generated pages

In order to have the JSON files as a source for the Cluecumber Report generation, you need to specify this option in your Cucumber runner configuration:
```
@CucumberOptions(
format = {"json:target/cucumber-report/cucumber.json"}
)
```
### Test suite overview page

This page shows the most important information about the test suite:
- run time
- number of passed, failed and skipped scenarios
- grouped scenarios by status

![report_overview](documentation/img/report_overview.png)

### Scenario detail pages

The scenario detail pages can be reached by clicking on the scenario name in the test suite overview page.

It shows:
- scenario name and description
- step runtimes and status
- stack traces of failed steps
- screenshots

![report_detail](documentation/img/report_detail.png)

0 comments on commit 3cb40f9

Please sign in to comment.