Azure DevOps Pipelines Integration

This document shows you how to upload Katalon test reports to Katalon TestOps using Azure DevOps Pipelines.

Prerequisites

• Katalon API key – If you haven’t set one up yet, follow this guide to generate your API key.
• Project ID - You can find your Katalon project ID in the URL (typically after /project/, e.g., ".../project/1234567/..."), or refer to this guide for more details.

Upload test reports using Azure DevOps Pipelines

1. Get the local path to your Katalon report folders, e.g. “C:\Users\alex\Katalon Studio\Web Sample\Reports\Test Suite\20190523_143946" that you want to upload.

2. Copy the following .yml file to your repository that is already synced with Azure DevOps Pipelines.

   Warning

   You must replace the placeholder values with your actual information for the following fields:

   • PASSWORD: Enter your actual Katalon API Key.
   • PROJECT_ID: Enter your Katalon Project ID.
   • TYPE: Select one of the following options:
     • katalon
     • junit
     • katalon_recorder
   • REPORT_PATH: Enter the local path to your test report.
   • KATALON_API_KEY: Enter your actual Katalon API Key

   trigger:
     batch: true
     branches:
       include:
         - master
   
   pr:
     - master
   
   stages:
     - stage: Test
       jobs:
         - job: Test
           pool:
             vmImage: 'ubuntu-latest'
   
           steps:
   
             - checkout: self
               fetchDepth: 1
               clean: true
   
             - bash: |
                 npm install
                 npm test
               displayName: Test
             - task: DockerInstaller@0
               displayName: Docker Installer
               inputs:
                 dockerVersion: 18.09.9
                 releaseType: stable
   
             - bash: |
                 set -ex
                 export REPORT_PATH=$(pwd)/report
                 docker run -t --rm -v
                   $REPORT_PATH:
                   -e PASSWORD=your_api_key_value
                   -e PROJECT_ID=your_project_id
                   -e TYPE=your_report_type
                   -e REPORT_PATH=path/to/test/report
                   katalonstudio/report-uploader:0.0.8
               displayName: Upload report to Katalon TestOps
               env:
                 KATALON_API_KEY: your-api-key-value

Result

Once executed successfully, the command will upload your report to Katalon TestOps. Navigate to Reports to view all uploaded test reports.