Robotmk v2 Schnellstart

Die für Checkmk 2.4 aktualisierte Schritt-für-Schritt-Anleitung für den gelungenen Einstieg in Synthetic Monitoring mit Robotmk!

In diesem Tutorial lernst Du, wie Du einen Robot Framework-Test mit Hilfe von Robotmk in Checkmk integrierst.
Nur einen Web-Test? Nein!
Der Test soll Dir gleich einen kleinen Vorgeschmack geben auf das, was die Stärke von Robot Framework ist: die schiere Menge an Libraries für jeden erdenklichen Usecase.
Der Test “web-images” öffnet die Seite einer Autoversicherung und prüft, ob die Startseite das Bild eines Motorrads enthält. Zum Einsatz kommen…

• Browser-Library: die einen nennen sie eine Alternative, ich nenne sie den würdgien Nachfolger der Selenium-Library. Unter der Haube arbeitet Playwright, das Feature-technisch das deutlich betagtere Selenium in den Schatten stellt.
• DoctestLibrary: eine echte Allzweckwaffe, um PDF-Dokumente und Bilder zu testen oder mit Referenz-Daten zu vergleichen.

TL’DR - um was geht es hier eigentlich?

• Robot Framework ist das leistungsfähigste und flexibelste Testwerkzeug, das Du finden kannst. Es verschafft Dir die Automatisierungs-Power von Python, ohne Python schreiben zu müssen - denn Robot Framework ist stark auf Lesbarkeit und Wartbarkeit fokussiert.
• Robotmk ist die Integration von Robot Framework in Checkmk. Es ist der Brückenschlag von Testing (1x ausführen und zufrieden sein) zum Monitoring (dauerhaft ausführen, Daten aufzeichnen und überwachen). Robotmk besteht aus
  • Bakery-Regel: zur Konfiguration des Robotmk-Schedulers
  • Robotmk-Scheduler: führt Robot Framework-Tests in regelmäßigen Intervallen aus
  • Robotmk-Agent-Plugin: liest die vom Scheduler geschriebenen Testergebnisse und generiert daraus eine Checkmk-kompatible Agentensektion.
  • Robotmk-Check: das Checkmk-seitige “Gegenstück”: es parst die in der Agentensektion enthaltenen Results und discovert je Test einen Checkmk-Service.

Bereite Dich vor

• einen Robotmk-Testclient: hier wird der Robotmk-Scheduler die Robot Framework-Tests in regelmäßigen intervallen ausführen und über den Checkmk-Agent-Output an Checkmk melden.
  • OS: Windows 11 oder Server 2022/2025 bzw. Ubuntu 22 oder 24 (die Limitierung bei Linux rührt von der Playwright-Bibliothek)
  • Internet-Zugriff (zum Download der Installations-Pakete durch rcc)
  • 8 GB RAM
  • 4, besser 8 CPUs (2 CPUs funktionieren nicht - besser gar nicht erst versuchen)
  • Basis-Monitoring des Hosts durch Checkmk eingerichtet
• Checkmk >= 2.3 (bekommst Du hier for free, wenn Du nicht über 750 Services kommst - reicht zum Testen locker)

(Wir werden in diesem Tutorial exemplarisch auf Windows eingehen; auf Linux funktioniert die Prozedur relativ ähnlich. Ich empfehle hier die siebenteilige Serie des Checkmk-Youtube-Kanals: https://www.youtube.com/playlist?list=PL8DfRO2DvOK2XZVvaZwUztchXWoOYfnDM)

Legen wir los: Einrichtung des Testclients

Download von RCC

Der Checkmk-Agent, den wir gleich zusammen mit dem Scheduler installieren, wird das rcc.exe-Binary mitbringen. Du kannst diesen Schritt hier also überspringen, wenn Du den Robot gar nicht mehr selbst ausführen, sondern direkt mit dem Scheduler beginnen willst.

Für einen vorherigen Test oder aber die Einrichtung eines Entwicklungs-Hosts musst Du Dir das RCC-Binary selbst besorgen.
Lade es hier herunter und speichere es an einem Ort Deiner Wahl unter rcc.exe ab. Ich habe mir angewöhnt, ein Verzeichnis bin im User-Profil anzulegen: c:\Users\simonmeggle\bin\rcc.exe

Hinweis: In Checkmk 2.5 werden wir eine alternative Methode zu RCC bereitstellen, die auf Micromamba basiert und mit einem eigenen Kommandozeilentool csm (Checkmk Synthetic Monitoring) aufwartet.

Füge diesen Ordner nun der User-Umgebungsvariable %PATH% hinzu:

Öffne eine neue CMD und teste, ob Du rcc nun von einem beliebigen Ort ausführen kannst:

Falls es hier zu Problemen kommt, hier sind mögliche Fehlerquellen beschrieben, die ich in meinen Trainings bislang feststellen konnte: RCC Troubleshooting

Download des Minimal-Tests

Nun ist es an der Zeit, das Demo-Repo mit der Robot-Suite herunterzuladen, die wir in Checkmk integrieren wollen.

Das Repository https://github.com/Checkmk/robotmk-examples habe ich extra für Beispiel-Suites angelegt. Speichere es am Besten in Deinen Bookmarks.

Entzippe die Datei master.zip und speichere den Unterordner examples/web/web-images im Ordner C:\robots\ ab. Dieser Ordner dient als sog. Basisverzeichnis für alle Robot-Suites.

Testen des Robots mit RCC

An dieser Stelle sei darauf hingewiesen, dass wir bisher keinerlei Software installiert haben. Jetzt schlägt die Stunde von RCC, welches im Hintergrund Python, NodeJs etc. komplett autonom in einem isolierten Environment installiert.

Öffne eine CMD und wechsle in den eben kopierten Ordner C:\robots\web-images. Nun folgen ein paar Kommandos, die Du in genau dieser Reihenfolge ausführen solltest. Lies meine Erklärung, damit Du verstehst, wie RCC funktioniert:

• where python: Haben wir Python zur Verfügung?
  Das Kommando where ist das Äquivalent zum Linux-Befehl which und versucht, den als Argument übergebenen Befehl (“Python”) über die %PATH%-Variable zu finden.
  Die %PATH-Variable% besteht in der Regel aus einer ganzen Reihe von Suchpfaden, die mit Semikolon voneinander getrennt sind. In genau dieser Reihenfolge der Pfade sucht Windows nach dem angegebenen Programm. Mit diesem Test möchte ich herausfinden, ob auf dem System zufällig schon Python installiert ist - und wenn ja, wo.
  Auf einem frisch installierten System wird vermutlich überhaupt keine Ausgabe kommen.
• rcc task shell: Damit erzeugen wir die Laufzeit-Umgebung für unseren Test.
  Wenn Du diesen Befehl ausführst, wirst Du viele Zeilen sehen, die ich an dieser Stelle gar nicht erklären muss bzw. kann - wichtig zu wissen ist: die Datei conda.yaml enthält alle Pakete, die jetzt installiert werden sollen. Das erledigt RCC vollautomatisch.
  Wenn RCC fertig ist, bist Du im Environment. Man sagt: das Environment ist jetzt “aktiviert”.
• where python: Diesmal erhalten wir von dem Kommando den Pfad zum Python-Interpreter im neu erstellten und jetzt aktivierten Environment zurück.
• where robot: Nicht nur Python, sondern auch Robot Framework ist installiert (ist das nicht cool…? 😎).
• robot tests.robot: Mit dem robot-Befehl können wir nun den RobotFramework-Test starten. Lass Dich überraschen 😉

Dieser Abschnitt hat den Beweis erbracht: der Robot kann über RCC gestartet werden. ✓

Wenn das für Dich bisher unspektakulär aussah, dann öffne jetzt mal das Logfile C:\robots\web-images\log.html.
Der RobotFramework-Test hat nämlich nicht nur eine Webseite geöffnet.
Er hat auch einen visuellen Vergleich durchgeführt, ob eines der Bilder in der “Hero”-Sektion auch wirklich das Motorrad enthält.

Im nächsten Abschnitt wenden wir uns nun der Integration in Checkmk zu.

Checkmk-Server

Auf dem Checkmk-Server (v2.4) ist bisher nicht viel passiert: der Windows-Host wird aktuell nur mit einem Vanilla-CMK-Agent überwacht:

Konfigurieren der Bakery

Der Robotmk-Scheduler kann auf Windows und Linux installiert werden. Es gibt dafür jeweils eine eigene Bakery-Regel, beide sind inhaltlich aber komplett gleich.

Pro Tipp: Alle Robotmk-Regeln findest Du am leichtesten, wenn Du im Setup-Menü den Suchstring “robot” eingibst.

Wir öffnen nun also die Regel-Page “Robotmk Scheduler (Windows)”:

Nachfolgend erkläre ich Dir die Felder der Bakery-Regel mit den einzutragenden Werten:

Ganz unten wird die Regel auf den Host windows beschränkt:

Danach die Regel speichern.

Agenten backen

Nun in die Agent Bakery wechseln…

…und einen neuen Installationsagenten backen:

Sobald die Erzeugung des Agenten-Installers fertig ist, siehst Du eine neue Zeile, in welcher ganz rechts der Host steht, auf den Du die Regel beschränkt hast (windows). Lade von hier das MSI-Paket herunter.

Discovery der Services

Der erste Service, der unmittelbar nach dem Deployment discovert werden kann ist der “Scheduler Status” service:

Er überwacht den Robotmk Scheduler, der als Agent “Extension” dauerhaft neben dem Agenten herläuft.

Der Scheduler durchläuft nach dem Start des Agenten zwei Phasen:

• Phase 1: Sequenzielles Bauen aller RCC Environments
• Phase 2: Scheduling der Plans (=Konfigurierte Robot Framework-Suites) im konfigurierten Intervall.

Bis das Environment im Hintergrund vom Scheduler gebaut wurde, können ein paar Minuten vergehen.
Wann es beendet ist, siehst Du daran, dass sich der Output des Scheduler Services ändert:

Nachdem die erste Ausführung der Suite im Hintergrund (=“headless”) erfolgt ist, lassen sich zwei weitere Services discovern:

• Plan Service: Genau wieder Scheduler Status ein an Administratoren gerichteter Service, der z.B. anschlägt, wenn Ergebnisse zu alt sind (=die Suite nicht mehr ausgeführt wird)
• Test Service: Gerichtet an Applikationsverantwortliche. Repräsentiert den Zustand (PASS/FAIL) des Tests aus Sicht von Robot Framework.

Checkliste

Diese Checkliste fasst noch einmal alle Schritte in Kürze zusammen:

• ✓ Herunterladen und Entpacken des Beispiel-Repos
• ✓ Speichern der Robot-Suite im Basisverzeichnis C:\robots\
• ✓ Die Bakery-Regel in Checkmk benötigt mindestens diese Einstellungen:
  • ✓ Basisverzeichnis (z.B. C:\robots\)
  • ✓ Ausführungsintervall der Gruppe
  • ✓ Application Name
  • ✓ (relativer) Pfad zum Suite-File/Verzeichnis
  • ✓ (relativer) Pfad zur robot.yaml
• ✓ Backen / Deployen / Installieren des Agenten
• ✓ Discovery

(Wenn alles geklappt hat, wäre das doch ein toller Zeitpunkt, das Projekt auf Github mit einem Stern ⭐ zu versehen, oder? 😄 )
Star

Wie geht es weiter?

Das war jetzt nur die Sitze des Eisberges… wir haben gerade mal zwei von über 200 RobotFramework-Libraries eingesetzt.
Für Checkmk-Admins tut sich mit Robotmk eine neue Welt auf:

• Tests von Windows-Desktop-Applikationen
• Tests von RDP- und Citrix-Sessions
• API-Testing (REST/SOAP)
• Kubernetes-Testing
• PDF-Vergleiche
• MFA-Authentifizierungen mit OTP
• usw.

Ich brenne für dieses Thema und habe deswegen ein spezielles Training dafür entwickelt - die Trainingsinhalte findest Du auf https://checkmk.com/trainings/classes.
Falls Du noch Fragen oder Probleme hast, buch doch einfach einen Clarity-Call (einfach oben auf “Support” klicken).

Viel Spaß und tolle UMsetzungserfolge mit Robotmk!