Help documentation

HTML Reports

Twist generates HTML Reports in the following ways:

  1. Reports are generated under <your project>/reports/<date,time of execution> after each execution of one or more scenarios in Twist. The actual path of the generated report is displayed in the Console view.

    Note that generate_local_report property in twist.properties file must be set to true in order to generate Html Reports locally. You can read about editing the properties file here.

  2. Reports are also generated when the scenarios are executed using Ant. The folder where reports must be stored is specified as an argument to the Ant target.

Sample Execution Report

Sample Scenario Execution Report

The top section of the report gives details such as the total number of tests executed with number of failures, errors, success rate and total time taken to execute.

This section is followed by the Scenarios summary where it lists out all the executed and failed scenarios with results and time taken to execute. You can search for a particular scenario in either the executed or failed scenarios list.

This is followed by individual test execution reports.

In case of error/failure, report shows more details such as a screenshot of the application at the point of failure and execution stack traces (if any). The failed workflow step will be highlighted in red.

From Twist 13.1 the details of a Twist execution are available in a JSON format in the reports directory in a execution_results.js file. This contains the test execution results in JSON. See here for the structure.

You could copy the stack trace and paste it in the Console View in Twist. The stack trace elements are now click-able and can be used to quickly navigate to the point of failure.

The older version of the Twist reports are still generated as _index.html in the reports directory.

Customizing reports

In your project directory Twist generates a report-templates directory which contains template files to customize your reports.

The index.html is the HTML template used for the Twist reports.

The scenarios.js under report-templates/js contains the javascript that fills the HTML template using the execution results JSON that is generated on execution. See execution results structure for details of the structure.

These files can be modified by the user to customize the reports based on their requirements.

More on Report Customization