Test Suite and Test Suite Collection Reports

Test suite report

Starting from version 6.3.0, reports can be viewed directly inside each Test Suite page.

After executing a test suite, to see the test suite report, go to the Result tab.

Results tab
ComponentDescription
Test cases tableList of executed test cases.
SummarySummary information of executed environment.
Execution settings

Settings of executed browsers/devices. For example:


Click the image to enlarge it.

Execution environment

Other information about the executed system. For example:


Click the image to enlarge it.

Test cases List

The summary information of all executed iterations done in the test suite is displayed here. Each time when a test case is executed with a test data row is considered an iteration.

Test cases list

Users can easily determine which type of information to be displayed by using the provided filters:

Filter Description
Passed Show only iterations which are passed.
Failed Show only iterations which are failed.
Error Show only iterations having errors.
Incomplete Show only incomplete iterations

If qTest and JIRA are configured in project settings, you can submit data to those systems. To learn more about qTest and Jira integration, you can refer to the following documents:

Test suite summary

This section gives the summary information of the test suite:

Test suite summary
Field Description
Test Suite ID The ID of the executed test suite in Katalon Studio.
Hostname / OS / Platform The environment where the test suite was executed
Start / End / Elapse Execution start/end date time and duration
Total TC Total number of test cases, along with their executed status.

Test case log details

To view details of the executed logs, in the Test Case Table, select an iteration and click Show Test Case Details.

Show Test Cases Details
  1. Test log tab

    Details regarding all the executed steps and their status are displayed in this tab. 

    Test log tab
    ComponentDescription
    Log InformationInformation of the test step selected in the Test Case's Log section:
    • The Name of the test step (the name of the keyword used in the test step)
    • Execution Start/End date time and duration
    • The Description of the test step
    • Any system Message raised when the test step was executed
    Log Image

    The screenshot taken from the application under test, it is captured in either of following situations:

    • An error occurs during test execution
    • The take screenshot keyword is used. To learn more about the take screenshot keyword, you can refer to the following document: [WebUI] Take Screenshot

    Users can easily determine which type of information to be displayed by using the provided filters:

    Filter Description
    Info Show the messages logged for information/reference.
    Passed Show the steps which are successfully executed.
    Failed Show the steps which are failed to execute.
    Error Show the steps having errors.
    Incomplete Show incomplete steps due to other factors such as wrong syntax, power shortage, disconnected network, etc...
    Warning Show the steps which have warning status.
    Not Run Show the skipped steps.

    If you have configured Jira integration, you can submit a ticket to this system. For further details, you can refer to this document: Submit an issue to Jira. Screenshots are taken for the failed steps and you can hover the mouse cursor over the attachment icon to review.

  2. Information Tab

    Users can find the summary information of the test case in this tab.

    Information tab
    Field Description
    Test Case ID The ID of the executed test case in Katalon Studio.
    Start / End / Elapse Execution start/end date time and duration.
    Description The description of the test case.
    Message Any system message raised when this iteration was executed.
  3. Integration Tab

    The information regarding qTest Integration of this iteration is displayed in this tab.

    Integration tab
    Field Description
    Test Log ID The ID of the integrated qTest Test Run.
    Test Run Alias The alias of the integrated qTest Test Run.
    Attachment Indicate whether all the execution log and report are placed in a zipped file which is sent to qTest as an attachment.

Test Suite Collection Report

Starting in version 6.3.0, reports can be viewed directly inside each Test Suite Collection page.

Test Suite Collection Report are only available for Katalon Studio Enterprise users.

After executing a test suite collection, to see the test suite collection report, go to the Result tab.

Test suite collection report
Field Description
ID The ID of the executed test suite in Katalon Studio.
Environment The environment which the test suite is executed on.
Status Information about whether the execution is completed or not.
Failed Tests / Total Total test cases in the test suite and the number of failed test cases if any.
Test Suite Details Shows test suite reports, see above: Test suite reports.

Report History

Report History is only available for Katalon Studio Enterprise users.

Once a test suite/test suite collection finishes its execution, a historical report will be automatically generated and stored in Reports.

For example:

Test suite history reports
Test suite collection history reports

The report will be named with the following naming convention: YYYYMMDD_HHmmss, which is the datetime when the test suite/ test suite collection starts its execution.

Export reports to other formats

For the purpose of sharing, users can export reports of test suites into other formats such as HTML, CSV, PDF and JUnit.

For Katalon Studio version 6.1.5- 6.3.3, please install Basic Report plugin to use this feature.

Starting in version 7.0, Katalon Studio automatically generates junit report for both Test Suite and Test Suite Collection.

Automatically generate reports

In Project > Settings > Plugins > Report, select the formats of reports that will be automatically generated after each Test Suite execution.

Reports settings

Execute a Test Suite and observe the Log Viewer after the test execution completes. The generated reports will be the same as the settings you've configured above.

Report generator in the log viewer

You can view the generated reports in <project_folder>\\Reports\\<execution_folder> after the test execution finishes.

report folder

Manually export reports

Open the Result view of a Test Suite or a Test Suite Collection > on the top right corner, select Export report > choose a format to export.

Manually export reports

For Test Suite Collection, you can export to HTML format only.

Get generated reports location at runtime

To retrieve current generated reports location, you can use the sample code below:

import com.kms.katalon.core.configuration.RunConfiguration
RunConfiguration.getReportFolder()

You can also retrieve other information through the RunConfiguartion package, please refer to this documentation: RunConfiguration.

Video Capturing

Notes:

  • K-Lite Codec is recommended to play the Katalon Studio test execution videos. You can download K-Lite Codec in the Codec Guide website: K-Lite Codec.
  • Support execution at the test suite level.
  • Support all browsers except for Remote, Headless, Kobiton, Custom. For remote or headless browsers, it's recommended to use Katalium Server to view captured sessions.
  • Recording parallel execution is NOT supported yet.

Debugging can be time-consuming and challenging for many automation testers. Katalon Studio helps solve this problem by supporting users with the ability to capture test execution via video format. Users can enable video capturing feature in Project Settings.

Follow the steps below to see how to work with Katalon Studio video capturing feature:

  1. After creating a test suite in Katalon Studio, select Project > Settings > Execution. Check the Enable Video Recorder during execution option.

    By default, Katalon Studio only captures Failed test cases. However, users can select options to capture only the Passed/Failed test cases or both.

    Enable video capturing

    Video settings can be specified based on the preferences of users. Katalon Studio recommends AVI (.avi) format and low quality to save disk space. The higher the video quality is, the bigger the file size is.

    • Video format: AVI (.avi) or MOV (.mov)

    • Video quality: Low; Medium or High

  2. After executing a test suite, navigate to the Result tab, you can view the list of test cases in the test cases table with its video attached accordingly. To play the video, click on the play icon in the Video column . Test steps descriptions are embedded as a subtitle.

    View video capturing

By watching how the automated test was executed, the testing team can identify exactly where the test failed. Thus, time and resources are managed more efficiently and effectively.

Feedback