Jenkins Continuous Integration mit Katalon

Heutzutage ist eine CI/CD Pipeline innerhalb des Softwareenwicklungs-Lifecycle nicht mehr wegzudenken und State of the art.
Mit diesem Blog soll gezeigt werden, wie einfach es möglich ist Katalon in die CI/CD Pipeline von Jenkins zu integrieren. Auch wenn aktuelle CI/CD-Tools, wie GitHub Actions und GitLab CI den «alten» Platzhirsch etwas verdrängt haben, so ist Jenkins durch seine Vielzahl von Plugins und Flexibilität doch noch weit verbreitet.

Übersicht

Folgendes werden wir vornehmen:

• Die Katalon Runtime Engine (KRE) installieren/konfigurieren
• Jenkins für die Ausführung von Katalon-Tests einrichten
• Ein Katalon-Projekt und Jenkins-Pipeline konfigurieren
• Testberichte archivieren (Optional)

Voraussetzungen

Wir stellen sicher, dass folgende Voraussetzungen erfüllt sind:

• Ein Projekt im Katalon Studio (in Git oder an einem zugänglichen Ort gespeichert)
• Die Katalon Runtime Engine (KRE) – erforderlich für die CLI-Ausführung
• Einen gültigen Katalon API-Key (zur Lizenzierung der KRE)
• Jenkins muss lokal oder auf einem Server installiert sein
• Java und Git müssen auf den Jenkins-Agenten installiert sein
• Browser (z. B. Chrome) muss installiert sein, falls gewisse Tests in Browsern ausgeführt werden sollen

Schritt 1:Katalon API-Key abrufen

• Melden wir uns bei Katalon TestOps an.
• Unter Benutzerprofil den API-Key aufrufen.
• Wir klicken auf „Schlüssel erstellen“ → Schlüsse für spätere Verwendung kopieren.

Schritt 2: Die Katalon Runtime Engine (KRE) installieren

Option A: Docker verwenden (empfohlen für Linux-Agents)

Jenkins verwendet ein offizielle Docker-Image für Katalon.

Das Image manuell oder in Jenkins herunterladen:

docker pull katalonstudio/katalon

Option B: Manuelle Installation (Windows/Linux-Agent)

1. KRE herunterladen unter: https://www.katalon.com/download
2. KRE in folgendes Verzeichnis extrahieren:
   – Linux: /opt/katalon
   – Windows: C:\Katalon

Wir stellen sicher, dass sich die ausführbare Datei katalonc im Pfad befindet, oder verweisen direkt im Skript darauf zu.

Schritt 3: API-Key in Jenkins hinzufügen

1. Unter Jenkins-Dashboard > Jenkins verwalten > Anmeldeinformationen
2. Einen geheimen Text eingeben
   ID: katalon-api-key
   API-Key einfügen

Schritt 4: Das Jenkins-Projekt einrichten

Option A: Freestyle-Projekt

Wir können die Katalon-CLI über „Shell ausführen“ oder „Windows-Batchbefehl ausführen“ ausführen.

Beispiel für eine Linux-Shell:

/opt/katalon/katalonc \
-noSplash -runMode=console \
-projectPath="/var/lib/jenkins/workspace/MyProject/MyProject.prj" \
-retry=0 -testSuitePath="Test Suites/SmokeTests" \
-executionProfile="default" -browserType="Chrome" \
-apiKey=$KATALON_API_KEY

Windows-Batch-Beispiel:

C:\Katalon\katalonc.exe ^
-noSplash -runMode=console ^
-projectPath="C:\Jenkins\workspace\MyProject\MyProject.prj" ^
-retry=0 -testSuitePath="Test Suites\SmokeTests" ^
-executionProfile="default" -browserType="Chrome" ^
-apiKey=%KATALON_API_KEY%

Option B: Ein Pipeline-Projekt (empfohlen)

1. Wir erstellen ein neues Pipeline-Projekt in Jenkins.
2. In unserem Repository erstellen wir eine Jenkins-Datei.

Beispiel Docker-Image:

pipeline {
    agent any
    environment {
        KATALON_API_KEY = credentials('katalon-api-key')
    }

    stages {
        stage('Checkout') {
            steps {
                git url: 'https://github.com/your-org/your-katalon-project.git'
            }
        }

        stage('Run Katalon Tests') {
            steps {
                sh '''
                    docker run --rm -v "$WORKSPACE":/katalon/katalon/source katalonstudio/katalon \
                    katalonc -noSplash -runMode=console \
                    -projectPath="/katalon/katalon/source/YourProject.prj" \
                    -retry=0 -testSuitePath="Test Suites/SmokeTests" \
                    -executionProfile="default" -browserType="Chrome" \
                    -apiKey=$KATALON_API_KEY
                '''
            }
        }

        stage('Archive Reports') {
            steps {
                archiveArtifacts artifacts: '**/Reports/**', allowEmptyArchive: true
            }
        }
    }

    post {
        always {
            junit '**/Reports/**/*.xml'
        }
        success {
            echo '✅ Katalon tests passed!'
        }
        failure {
            echo '❌ Katalon tests failed!'
        }
    }
}

Wir ersetzen:

• prj durch unsere aktuelle .prj Datei.
• Test Suites/SmokeTests durch unsere aktuelle Testsuite.

Schritt 5: Ausführen und Überprüfen

1. Wir committen unsere Jenkins-Datei (bei Verwendung einer Pipeline).
2. Wir triggern unseren Jenkins-Job manuell oder richten einen automatischen ein.
3. Wir überprüfen unsere Konsolenprotokolle und stellen diese Testergebnisse zu Verfügung

Schritt 6: Berichte und Protokollierung

Katalon generiert automatisch Berichte im Verzeichnis „Reports/“. Jenkins kann:

• sie mit archiveArtifacts archivieren
• sie mit JUnit analysieren (parsen), wenn es sich um JUnit-XML-Dateien handelt
• sie zur besseren Visualisierung an Katalon TestOps senden

Optionale Erweiterungen

• Parallele Testausführung mit Jenkins-Matrix oder Katalon-Kommandozeilen
• TestOps-Integration: Verwendung von —testOpsProjectId, —testOpsTestRunId
• Builds mit der CRON-Syntax von Jenkins planen
• Slack- oder E-Mail-Benachrichtigungen basierend auf Testergebnissen