Creating Load Test Printable Reports

Applies to ReadyAPI 3.56, last modified on November 21, 2024

ReadyAPI supports creating printable reports for a load test. You can choose to include additional information about the latest test run results. Your reports will always include an overview graph for the last test run.

By default, ReadyAPI uses the Load test printable report template to create a load test report. For more information about report templates in ReadyAPI, see the Reporting section.

Create Reports

To create a load test printable report, click on the ReadyAPI toolbar. The Create Report dialog will open. In this dialog:

  1. Select the Load test printable report type. This is a default template for creating reports that is provided with ReadyAPI. By default, the report contains execution metrics and the chart from the Load page.

  2. Select one or more of the options to include additional data to your report. See Options Reference below for information about the options available.

  3. Click OK to generate the report.

Options reference

All reports contain the Test Execution Metrics and Overview sections by default.

Test Execution Metrics section provides information about the load test results and functional test run. Here are some notable items:

  • Maximum simultaneous users – The metric is captured at the end of each second of the test run. If your test is executed in under a second, the metric will be 0.

  • Information on target test cases – Provides information about the number of functional test cases simulated during the test. Test cases executed in the load test loops are added to the metric.

  • Executed test step(s) summary – Provides information about test steps run in functional test cases. Includes information on steps run in data source loops.

The overview chart provides a graph with the information about the number of virtual users simulated and time taken during the load test. This is the same graph as the one you can see in the Global Metrics panel of the load test editor.

Adds load test overview. The information added includes test properties, load allocation type, load test overview, and information about scenario load profiles and targets.

Adds a summary of the scenarios included in the load test, test steps executed in the targeted functional test case, 5 quickest and 5 slowest target test case runs. Test case level information is provided for the entire test case and may be longer than the sum of test step execution times.

Adds information about each load test scenario. The scenario report has the following sections:

  • Scenario Metrics – A report on the scenario execution results formatted in the same way as the default load test printable report.

  • Target Metrics – A table with information on the execution of functional test cases targeted by the load scenario.

  • Top 5 Test Case Executions – The information about 5 quickest target test case runs.

  • Bottom 5 Test Case Executions – The information about 5 slowest target test case runs.

  • Top 5 Test Step Executions – The information about 5 quickest target test step runs.

  • Bottom 5 Test Step Executions – The information about 5 quickest target test step runs.

  • Execution dispersion – A graph that shows when 5 top and 5 bottom test case runs happened.

Adds tables and graphs from the Statistics page. If you do not have graphs configured, the page will be empty.

Adds information about test step execution for each second during the test run.

Adds information for each second of the load test for the following statistics: Average, TPS, Errors. The statistic is tracked for each individual test step and a total metric for the entire test case.

Adds the description of terms used in load testing in ReadyAPI to the end of the report. You can refer to these terms when reading the report.

Removes page breaks between report sections. If this option is not selected, each section of the report starts on a separate page.

Export Data

You can export data to a file. For more information about exporting data in this way, see Data Export For Automation.

Customize Report Templates

You can change the report template, or create a new one. For more information about changing report templates in ReadyAPI, see Customizing Templates.

Fonts in Linux

Load test reports use some of Microsoft core fonts. Not all Linux installations include these fonts. If you have issues with creating reports, install the ttf-mscorefonts-installer package, and then copy font files from /usr/share/fonts/truetype/msttcorefonts to JAVA_HOME/jre/lib/fonts.

Backup Reports

If your ReadyAPI instance crashes for some reason while a load test is running, you can still generate a report for this run when you launch ReadyAPI next time.

In order for ReadyAPI to generate such a report successfully, the following requirements must be met:

  • You must use ReadyAPI version 2.5 or later.

  • The load test you want to generate a report for must run in ReadyAPI version 2.5 or later.

  • ReadyAPI must collect data about the test run.

  • The project containing the load test should be saved.

If all these requirements are met, you will be able to generate a report for the interrupted load test run. To do that:

  1. Open your load test editor.

  2. Switch to the Statistics tab and select the interrupted run from the Run drop-down list.

  3. Click Report.

The Create Report dialog will appear, and you will be able to configure the report options as usually.

See Also

Configuring Report Templates
Exporting Results

Highlight search results