Tools zur Optimierung von Robot Framework - Zweiter Teil: Praktische Tools im Einsatz

Verständlicher und wartbarer Code ist nicht nur in der Softwareentwicklung wichtig, sondern auch in der Testautomatisierung. Reise mit uns durch das Robot Framework Clean-Code-Universum: Von einfachen Korrekturen bis hin zu umfangreichen Regelkatalogen ist alles dabei. Hierzu stellen wir Dir drei Tools vor, mit denen Du Deinen Code aufräumen kannst. Im Team, beziehungsweise im Unternehmen verankerte, Clean-Code-Regeln auch in der Automatisierung können zudem berücksichtigt werden. 

Einsatz 

Wie bereits in  Teil eins  erwähnt, gibt es vielfältige Unterstützungsmöglichkeiten beider Tools im Hinblick auf die Wartbarkeit, Übersichtlichkeit und Verständlichkeit von Robot-Framework-Skripten. Alle Tools können entweder über Konsolenbefehle oder mit Hilfe der Erweiterungen oder den dazugehörigen Konfigurationsfiles genutzt werden. In den folgenden Abschnitten zeigen wir Euch im Detail, wie ihr die Tools in Eurem Alltag einbinden und einsetzen könnt.

Konsolenbefehle 

Die Struktur aller Konsolbefehle ,unabhängig vom  Clean Code Tool, ist identisch zu den Konsolenbefehlen für Robot Framework. Jeder Konsolbefehl fängt mit dem Namen des benutzen Tools an. Danach stehen die Optionen, die für jedes Tool verfügbar sind. Und am Ende gibt man eine Datei (oder Ordner) an, die die Robot Framework Dateien enthält. Mehrere Beispiele für die Konsolbefehle kann man unter unserem Beispiel finden.  

Erweiterungen

Der Vorteil der Erweiterungen ist, dass sie während der Entwicklung permanent aktiviert sind. Dadurch erhalten die Testautomatisierer:innen direktes Feedback und können dieses entsprechend der Meldungen berücksichtigen. Für Visual Studio Code ist eine Integration der Tools in die Benutzeroberfläche vorhanden. 

Die Funktionalität von Robocop wird durch grafische Hinweise, wie farbliche Unterstreichungen oder Hover-Effekte, auf die vorhandenen Regeln aufmerksam gemacht. Wenn die Maus über solche Stellen bewegt wird, werden die entsprechenden Regeln zu Robocop angezeigt.

Die Funktionalität von Robotidy ermöglicht es den Nutzer:innen, kontinuierlich eine aktuelle Liste mit Warnungen, Regelverstößen oder Hinweisen einzusehen. Mit einem Klick können sie direkt zu der entsprechenden Stelle im Quelltext gelangen.

Da sich Sherlock noch in der Entwicklungsphase befindet, kann man aktuell nur Robocop und Robotidy in der IDE verwenden. Für die Verwendung von Robocop oder Robotidy in VSCode muss die Option in den Einstellungen der Erweiterung ausgewählt werden. Es ist wichtig zu wissen, dass es auch Erweiterungen gibt, die Robocop nicht unterstützen. In diesem Fall müssen Konsolenbefehle verwendet werden. 

Konfiguration und Individualisierung 

Robocop und Robotidy bieten Konfigurationsmöglichkeiten, sodass nur bestimmte Regeln eingeschaltet sind oder die vorhandenen Regeln so angepasst werden können, dass die im Unternehmen oder Team vorhandenen Clean-Code-Regeln eingehalten werden. 

Es gibt zwei Möglichkeiten zur Konfiguration. Die erste Variante besteht darin, die Regeln über die Einstellungen des Tools in der IDE selbst zu konfigurieren. Für Robotidy gibt es lediglich zwei Konfigurationsmöglichkeiten: den Pfad zur Konfigurationsdatei (auf den wir später eingehen werden) und das Ignorieren des Git-Verzeichnisses. Für Robocop stehen drei Konfigurationsmöglichkeiten zur Verfügung: das Hinzufügen von Regeln, die ausgeführt oder einbezogen werden, sowie eine weitere Konfigurationsoption, die wir in einem späteren Abschnitt behandeln werden.

Zweitens kann eine Konfigurationsdatei im Projektverzeichnis auf der obersten Ebene angelegt werden. Diese Datei muss den Namen pyproject.toml besitzen, da nach diesem Namen während der Nutzung gesucht wird. Die Syntax erfolgt im TOML-Format. Zusätzlich zu der Anpassung der bereits in den Tools mitgelieferten Regeln ist die Implementierung eigener Regeln möglich. Mit diesem Angebot kannst Du nahezu alle benötigten Regeln umsetzen. 

Konfigurationsmöglichkeiten

Es gibt viele Robocop und Robotidy Regeln, die konfiguriert werden können. An unserem Beispiel könnt ihr die Auswirkungen und Veränderungen sehen. Im Folgenden stellen wir Euch zuerst eine Auswahl an Konfigurationsmöglichkeiten vor.  

Konfiguration von Robocop 

Konfiguration von Robotidy 

Konfiguration von Sherlock  

Ein Beispiel und unser Fazit der Tools

Haben wir Dein Interesse geweckt? Erhalte durch unser Beispiel im dritten Teil der Blogserie bereits nächste Woche einen tieferen Einblick der vorgestellten Tools und baue dein Verständnis weiter aus.

Die Autorinnen

Alena Drebezgova  arbeitet seit 2024 als Beraterin bei der viadee IT-Unternehmensberatung. Zuvor war sie bereits als Werkstudentin bei der viadee aktiv tätig. Ihr Fokus liegt in den Bereichen Testmanagement, Testautomatisierung und Qualitätssicherung.  

Lisa Sophie Colbatzky unterstützt Individuen sowie Teams dabei ihre Potentiale zu entfalten. Der Einsatz von kreativen Methoden und das Fördern von wertschätzendem Miteinander dürfen bei ihr nicht fehlen