Skip to content

Commit

Permalink
Merge pull request #118 from paveljandejsek/reportingDocUpdate
Browse files Browse the repository at this point in the history
Updated reporting markdown doc
  • Loading branch information
thradec authored May 1, 2019
2 parents 7c9b9c6 + 0903aff commit 0923d5d
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions jbehave-support-core/docs/Reporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,16 @@ public XmlReporterFactory xmlReporterFactory() {
}
```

The generated XML report by default contains only information about:
Plus at least one [reporter extension](#reporter-extensions) (bean implementing a XmlReporterExtension interface).

The default generated XML report contains only information about:
- story start time
- story end time
- story duration
- story status (e.g. failed, successful)
- story steps

Rest of the information available in the report depends on the extensions used/registered.

### Reporter extensions
The default report can be extended with other info by registering beans implementing the interface XmlReporterExtension
Expand All @@ -29,7 +32,8 @@ There are several extensions already prepared and ready to use:
- `WsXmlReporterExtension` (copies SOAP requests/responses from [WebServiceSteps](Web-service.md))
- `TestContextXmlReporterExtension` (copies contents of [TestContext](Test-context.md))
- `ServerLogXmlReporterExtension` (copies server log(s) for each system with configured [SshTemplate](Ssh.md))
- `FailScreenshotsReporterExtension` (prints out error screenshots from [Web testing](Web-testing.md) - if any were generated)
- `FailScreenshotsReporterExtension` (prints out error screenshots from [Web testing](Web-testing.md) - if any were generated)
- `SqlXmlReporterExtension` (copies SQL statements/results from [SqlSteps](Sql-steps.md))

To use these extensions simply register the wanted extension as a bean, e.g.:
```
Expand Down

0 comments on commit 0923d5d

Please sign in to comment.