Generate browser-based videos in Katalon Studio reports

Requirements

• You need an active Katalon Studio Enterprise license.
• You must be on Katalon Studio version 7.8.0 or later.
• You need to install the FFmpeg library. See: Install FFmpeg library.

From Katalon Studio version 7.8.0 or later, you can record and watch videos to review your failed tests. Katalon Studio supports screen-based recording and browser-based recording. To learn more about screen-based recording, see: Generate screen-based videos in Katalon Studio reports.

Use browser-based recording feature to:

• Record video of browser window only (even if it is hidden behind another window).

• Record video of Headless browser. To learn more about Headless Browser Execution, see: Headless Browsers Execution.

• Record videos of multiple browsers simultaneously (for instance, parallel execution of Test Suite Collection).

Note:

• You can only record videos for Web UI testing.
• This feature supports test suite and test suite collection execution.
• This feature is available for Chrome, Microsoft Edge (Chromium-based), and Headless Chrome. To learn more about Headless Chrome, refer to the Google Developer website here: Getting Started with Headless Chrome

To use browser-based recording feature, you need to enable it in Katalon Studio and install a third-party library (FFmpeg) for video encoding.

Enable Browser-based Recorder in Katalon Studio

Learn how to enable Browser-based Recorder in Katalon Studio.

1. Go to Project > Settings > Execution.
2. In the During-Execution Options panel:
   

   • Enable Video Recorder by checking Record video during execution.

   • Screen Recorder is selected by default. Select Browser-based Recorder and choose between All Test Cases or Only failed Test Cases.

3. Go to Desired Capabilities > Web UI, then select Chrome, Chrome Headless, or Edge Chromium.
   Click the Add button, then type in the following value to set a window size of 1500x1000 for the browser to record, as shown in the sample screenshot below:

   Name	Type	Value
   args	List	--window-size=1500,1000

   

   To learn more about setting desired capabilities for WebUI testing, see: Set up desired capabilities for WebUI testing.

4. Click Apply & Close.

Install FFmpeg library

To install the FFmpeg library:

• For macOS, use the following command with Homebrew:

  $ brew install ffmpeg
• For Linux, use the following command:

  sudo apt-get install ffmpeg
• For Windows users:

  1. Go to the FFmpeg download web page.

  2. Download the package for Windows.

  3. Add the path to the FFmpeg executable file to your PATH environment variable.

  4. Reactivate Katalon Studio for this installation to take effect.

For more information on FFmpeg library, see: FFmpeg library.

For Docker image

Katalon Docker image may be used as a container to execute Katalon Studio tests and write reports to the host's file system.

Katalon Docker image currently does not include an FFmpeg library. Learn how to build your own image by following the steps below.

1. Open any text editor tool (for example, Visual Studio Code), and create a new Shell script file named setup.sh.
2. Open setup.sh and copy-paste the following script:

   #!/bin/sh
   apt update
   apt -y install ffmpeg
3. In the same text editor tool, create a new docker image file with the following content:

   FROM katalonstudio/katalon
   COPY ./setup.sh setup.sh
   RUN chmod a+x ./setup.sh
   RUN ./setup.sh
4. Build your own image in the command-line interface (CLI). For example:

   docker build -t katalon .

You have built your own images for Katalon Docker image. For more information on Katalon Docker image, see: Katalon Docker image.

View recorded videos

Click the Play icon in the Video column to play the video as shown below. Each test step in the video has a description embedded like a subtitle.

After running the test suite, navigate to the Result tab. You can see a list of test cases. A recorded video is attached to each test case.