Getting Started - Robot Framework
In diesem Kapitel geht es darum, UI-Tests mit Robot Framework zu erstellen und diese in einem Docker Container auszuführen.
Was wird benötigt?
Wir benutzen hier das Template (opens in a new tab) aus dem Kapitel Intermediate Tutorial -> Projekt erstellen.
Mit der Option --add-ui-tests werden die UI-Tests und alles für die Ausführung der Tests hinzugefügt.
dotnet new processcubeproject -o "My.Cool.Project" --add-ui-testsSollte schon ein Projekt bestehen, können die UI-Tests auch manuell hinzugefügt werden.
Manuelles Hinzufügen der UI-Tests
Diese Variante sollte nur verwendet werden, wenn die Tests nachträglich zum Projekt hinzugefügt werden. Wir empfehlen die Tests beim Start des Projektes mit zu generieren.
Ordner anlegen
Im Root des Projekts folgenden Befehl ausführen:
mkdir -p integration-tests/scriptsScripte und Dateien anlegen
Docker
Um die UI-Tests in einem Docker-Container ausführen zu können, wird eine docker-compose Datei benötigt.
Im Root muss dafür eine docker-compose.test.yml-Datei erstellt werden.
Inhalt:
version: '3.5'
services:
test:
image: ghcr.io/5minds/testimage:0.0.1
container_name: my_cool_project_tests
depends_on:
- app
- frontend
- engine
- portal
network_mode: host
volumes:
- ./integration-tests:/opt/robotframework/tests
- ./testresults:/opt/robotframework/reports
user: '${UID}:${GID}'
privileged: true
shm_size: 2gb
extra_hosts:
- 'engine:127.0.0.1'
- 'localhost:127.0.0.1'
ipc: hostHier wird das Test-Image (opens in a new tab) von 5Minds benutzt. Dieses Image beinhaltet die Grundlage, um UI-Tests mit dem Robot Framework ausführen zu können.
MSBuild
Um das Ausführen der Tests zu vereinfachen, wird MSBuild verwendet.
Die Targets-Datei wird im Root des Projekts angelegt mit dem Namen MSBuildProjectName.ui-tests.targets.
Hier wird MSBuildProjectName durch den Namen des Projekts ersetzt.
<?xml version="1.0" encoding="utf-8"?>
<Project>
<!-- Main Targets -->
<Target Name="Test">
<Message Importance="High" Text="Starting Project with Docker" />
<CallTarget Targets="BuildTest" />
<CallTarget Targets="TestUp" />
</Target>
<Target Name="BuildTest">
<Message Importance="High" Text="Building Test"/>
<CallTarget Targets="BuildApp" />
<CallTarget Targets="NpmRunBuild"/>
<CallTarget Targets="DockerComposeTestBuild"/>
</Target>
<Target Name="TestUp">
<CallTarget Targets="DockerComposeTestUp"/>
</Target>
<Target Name="TestClean">
<Message Importance="High" Text="Cleanup TestResults"/>
<RemoveDir Directories="$(TestResultsPath)" />
<CallTarget Targets="RemoveTestContainer"/>
</Target>
<!-- Sub Targets to be Called from Main Targets-->
<Target Name="DockerComposeTestBuild">
<Message Importance="High" Text="Docker Compose Build 'Base + Tests'"/>
<Exec Command="docker compose -f docker-compose.yml -f docker-compose.tests.yml build"
WorkingDirectory="$(DockerRoot)" ConsoleToMSBuild="true" />
</Target>
<Target Name="DockerComposeTestUp">
<Message Importance="High" Text="Docker Compose Up 'Base + Tests'"/>
<Exec Command="docker compose -f docker-compose.yml -f docker-compose.tests.yml up --abort-on-container-exit"
WorkingDirectory="$(DockerRoot)" ConsoleToMSBuild="true" />
</Target>
<Target Name="RemoveTestContainer">
<Message Importance="High" Text="docker container rm $(DockerImageName)_tests"/>
<Exec Command="docker container rm $(DockerImageName)_tests"
WorkingDirectory="$(DockerRoot)"
ConsoleToMSBuild="true" />
</Target>
</Project>Die Einbindung der Targets erfolgt durch einen Import in der .csproj.
<Import Project="$(MSBuildProjectName).ui-tests.targets" Condition="Exists('$(MSBuildProjectName).ui-tests.targets')" />Beim Import $(MSBuildProjectName) nicht ersetzen! Hierbei handelt es sich um eine Variable von MSBuild, die
automatisch durch den Namen des Projekts ersetzt wird.
Beispiel-Tests
Die Beispiel-Tests können sich hier heruntergeladen werden.
Diese kommen in den Ordner integration-tests.
In der __init__.robot Datei werden die Settings für die Tests gesetzt.
*** Settings ***
Library OperatingSystem
Library Browser
Suite Setup Run Keywords
... Remove Directory /opt/robotframework/reports/screenshots recursive=true
... AND
... Create Directory /opt/robotframework/reports/screenshots
... AND
... Register Keyword To Run On Failure Browser.Take Screenshot filename=%{ROBOT_REPORTS_DIR}/screenshots/${SUITE_NAME}_{index}
... AND
... New Browser browser=chromium headless=false
... AND
... New Context viewport={'width': 1920, 'height': 1080} locale=de-DE tracing=%{ROBOT_REPORTS_DIR}/trace.zip
Suite Teardown Run Keywords
... Close Context
... AND
... Remove Directory /opt/robotframework/reports/browser/ recursive=trueDer erste Test befindet sich in 0000_boot.robot.
Dort wird eine URL aufgerufen und der Browser Timeout gesetzt.
Hierbei geht es darum, sicherzustellen, dass die Seite innerhalb von 30 Sekunden geladen wird.
*** Settings ***
Library Browser
*** Test Cases ***
Boot
New Page http://localhost:8082/
Set Browser Timeout timeout=30s scope=testIn 0001_check_site_title.robot wird der Titel der Seite geprüft.
*** Settings ***
Library Browser
*** Test Cases ***
Check site title
New Page http://localhost:8082/
Get Text //div[@title="5Minds Portal"] == 5Minds PortalAusführung
Diese beiden Targets haben wir vorhin in der .ui-tests.target Datei hinzugefügt. Alle folgenden Befehle werden vom Root des Projekts ausgeführt.
Start
dotnet msbuild -t:TestJetzt sollten die UI-Tests durchlaufen und ein Result liefern.
Bereinigung
Folgender Befehl
- Löscht den automatisch generierten Ordner
testresults - Löscht den Docker-Container, der für die Tests verwendet wurde
dotnet msbuild -t:TestCleanWie geht es weiter?
Wenn du jetzt wissen willst, wie man Tests schreibt, schau dir das Expert Tutorial zum Thema Robot Framework an.