Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated reporting markdown doc #118

Merged
merged 1 commit into from
May 1, 2019
Merged

Updated reporting markdown doc #118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions jbehave-support-core/docs/Reporting.md
View file
Open in desktop
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