Skip to content

Latest commit

 

History

History
80 lines (68 loc) · 3.96 KB

Reporting.md

File metadata and controls

80 lines (68 loc) · 3.96 KB
Raw

Contents

Reporting

There is an out of the box support prepared for XML reports to be generated for each story as well as creating an index file with links to each report.

To use this feature all that is needed is to register a bean of type XmlReporterFactory, e.g.:

@Bean
public XmlReporterFactory xmlReporterFactory() {
    return new XmlReporterFactory();
}

Plus at least one reporter extension (bean implementing a XmlReporterExtension interface).

The default generated XML report contains only information about:

  • story narrative
  • 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.

In case you want to have narrative in report you have to follow JBehave narrative format:

In order to explain how to use narrative
As a development team
I want to show you how to do it

All three fixed part of narrative must be present in given order: In order to, As a and I want to

Reporter extensions

The default report can be extended with other info by registering beans implementing the interface XmlReporterExtension (for convenience an abstract class AbstractXmlReporterExtension containing methods for writing XML elements can be used).

There are several extensions already prepared and ready to use:

  • EnvironmentInfoXmlReporterExtension (copies Spring Environment properties starting with name environmentInfo)
  • RestXmlReporterExtension (copies REST requests/responses from RestServiceSteps)
  • WsXmlReporterExtension (copies SOAP requests/responses from WebServiceSteps)
  • TestContextXmlReporterExtension (copies contents of TestContext)
  • ServerLogXmlReporterExtension (copies server log(s) for each system with configured SshTemplate)
  • FailScreenshotsReporterExtension (prints out error screenshots from Web testing - if any were generated)
  • SqlXmlReporterExtension (copies SQL statements/results from SqlSteps)
  • JmsXmlReporterExtension (copies JMS message headers, prints out the message if it is javax.jms.TextMessage)
  • ScreenshotReporterExtension (prints out screenshots (except error) from Web testing - if any were generated)
    • Frequency of screenshot taking can be controlled by property: 'web.screenshot.reporting.mode'
      • MANUAL: screenshots from a manual step only
      • WAIT: screenshots after every web wait
      • STEP: screenshots after every web step
      • DEBUG: screenshots after every web step and action
  • ServerLogXmlReporterExtension (copies server logs, or their parts used by SshSteps)
    • Content can be controlled by property: ssh.reporting.mode
      • FULL: copies server log(s) for each system with configured SshTemplate
      • TEMPLATE: copies server log(s) for each system with configured SshTemplate with an attribute reportable = true
      • CACHE: copies cached server log(s) used within scenario execution
    • Extension contains fail mode, which acts like TEMPLATE mode if test fails
      • it can be turned on by using property: ssh.reporting.logOnFailure with value "true"
  • SplunkXmlReporterExtension (copies Splunk queries and their results from SplunkSteps)
    • Splunk implementation is still under active development and changes can/will be done.
    • Reporting works with default implementation of OneShotSearchSplunkClient provided by us

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

@Bean
public WsXmlReporterExtension wsXmlReporterExtension() {
    return new WsXmlReporterExtension();
}

Report steps

Following step allows setting specific server log report extension mode Step throws AssertionError when ServerLogXmlReporterExtension isn't registered.

Given ssh reporter mode is set to [TEMPLATE]