Skip to main content

Use Katalon Report Uploader

Katalon Report Uploader is a utility to upload reports to Katalon TestOps. The utility supports JUnit, Katalon Studio, and Katalon Recorder report format. It can be used with CLI, Docker, GitHub Action, and other CIs.

Usage in CLI​

Follow these steps to use Katalon Report Uploader in CLI.
  1. Download Reports Uploader and install Java JRE and Java JDK.
  2. Get the path to your Katalon report folders, e.g. C:\Users\alex\Katalon Studio\Web Sample\Reports\Test Suite\20190523_143946.
  3. Open command prompt and paste in the command:
    java -jar katalon-report-uploader-0.0.5.jar --projectId=3 --path="d:\katalon-reports" --email=admin@mail.me --password=admin --type=katalon --push-to-xray=true
    • projectId: Your project ID in Katalon TestOps.
    • path: The local path of Katalon Studio Reports folder identified in step 2.
    • email: The email registered for your Katalon account. If an API Key is used as password, this field is not required.
    • password: The password used for signing in Katalon TestOps or an API Key of that account. Using API Key is recommended as it will not expose your password.
    • type: One of the values "katalon", "junit", or "katalon_recorder".
    • server: (Optional) The Katalon TestOps server endpoint, by default it is https://analytics.katalon.com.
    • --push-to-xray=true (optional): If your TestOps project is integrated with Xray test management, this option enables pushing the test results to Xray.
Alternatively, you can use the TestOps interface to specify the parameters.
  1. Open TestOps dashboard and go to Settings > Integrations > Report Uploader.
    TestOps report uploader
  2. Follow the on-screen instructions to produce the command.

Usage for Docker​

Environment variables​

SERVER The URL of Katalon TestOps. Default https://analytics.katalon.com.

EMAIL The email registered for your Katalon account.

PASSWORD The password used for signing in Katalon TestOps or an API Key.

PROJECT_ID Your project ID in Katalon TestOps.

TYPE One of the values including "katalon", "junit", or "katalon_recorder".

REPORT_PATH The path of the report folder. The physical report folder should be mounted as a Docker volume first.

Example​

docker run -t --rm -v <path>:/katalon/report -e PASSWORD=<APIKey> -e PROJECT_ID=<ProjectId>-e TYPE=katalon -e REPORT_PATH=/katalon/report katalonstudio/report-uploader:0.0.8

Usage for Continuous Integration (CI) systems​

Jenkins Pipeline​

Example on our GitHub repository: Jenkinsfile.

GitHub action​

Marketplace Listing on GitHub: katalon-report-uploader.

Example:

 - name: Katalon Report Uploader
    uses: katalon-studio/report-uploader@v0.0.7.11
    env:
      PASSWORD: ${{ secrets.KATALON_API_KEY }}
      PROJECT_ID: 50236
      TYPE: junit
      REPORT_PATH: ${{ github.workspace }}/junit-report-sample

CircleCI​

Example on our GitHub repository: circleci/config.yml.

GitLab CI​

Example on our GitHub repository: .gitlab-ci.yml.

AWS Codebuild​

Example on our GitHub repository: buildspec.yml.

Azure DevOps Pipeline​

Example on our GitHub repository: azure-pipelines.yml.