SWTBot ist ein Open-Source-Projekt bei Eclipse für das funktionale Testen von SWT-Anwendungen [1]. Das Projekt stellt ein Java-API bereit, mit dem sich das Verhalten einer zu testenden UI-Anwendung spezifizieren lässt. SWTBot verfolgt also einen rein programmatischen Ansatz für das Testen von UIs. Im Gegensatz zu anderen funktionalen Testframeworks wie Jubula und das RCP Testing Tool wird das erwartete Verhalten nicht über einen visuellen Editor oder ein Modell zur Repräsentation auszuführender Aktionen festgelegt. Stattdessen schreibt man in SWTBot Standard-JUnit-Tests mithilfe des SWTBot Fluent Java API, das einen Großteil der Komplexität von SWT und Eclipse versteckt.
Ab Version 2.1.0 bietet SWTBot einen Test Recorder und einen Generator [2], der dabei hilft, schnell einen Entwurf eines SWTBot-Szenarios zu erstellen und so die Kosten für das Schreiben von Tests zu reduzieren. Das Projekt integriert sich in Eclipse PDE und typischen Build-Tools wie Maven/Tycho, Ant und Buckminster, sodass es einfach ist, SWTBot-Tests sowohl in Eclipse als auch in CI-Servern durchzuführen. SWTBot kann auch verwendet werden, um e4-Anwendungen zu testen.
Die Installation von SWTBot kann über die Updateseite unter [3] durchgeführt werden. Folgende Features sollten in einer minimalen Installation enthalten sein:
-
SWTBot for Eclipse Testing
-
SWTBot IDE Features
-
SWTBot Recorder and Test Generator
In diesem Artikel wollen wir eine Einführung in das funktionale Testen mit SWTBot geben und zeigen, wie sich solche Tests in Continuous-Integration-Systeme integrieren lassen. Dabei setzen wir grundlegendes Wissen über Eclipse-Plug-in-Entwicklung, SWT-Konzepte und JUnit-Tests voraus. Wir werden im Folgenden zwei Eclipse-Plug-ins entwickeln, die wir im Anschluss mit SWTBot testen wollen. Der komplette Quellcode der Beispiele dieses Artikels ist auf GitHub unter [4] zu finden. Idealerweise implementieren Sie die Quellcodebeispiele parallel zum Lesen selbst, um die Einführung besser nachvollziehen zu können.
Grundkonzepte
Das SWTBot-API basiert auf dem Konzept von „Bots“. Ein Bot ist ein Objekt, das typische Aufgaben der Userinteraktion ausführen kann, beispielsweise SWT Widgets finden, einen Button klicken, ein Menü auswählen oder ein Eingabefeld mit Inhalt füllen. Da alle Zugriffe auf das SWT-UI über einen Bot durchgeführt werden, ist das erste, das man in einer Testklasse tun muss, einen solchen Bot zu instanziieren und ihn in einem Feld der Testklasse zu speichern. Der Bot kann ein einziges Mal für alle Testmethoden initialisiert werden, etwa in Form eines statischen Felds, das in einer @BeforeClass-Methode instanziiert wird:
private static SWTWorkbenchBot bot;
@BeforeClass
public static void beforeClass() throws Exception {
bot = new SWTWorkbenchBot();
}
In den Testmethoden kann der Bot nun genutzt werden, um auf SWT-Elemente wie Menüs, Views, Eingabewidgets oder Buttons zuzugreifen. Wenn eines dieser Elemente nicht vorhanden ist, wird der Bot natürlich eine Exception werfen und den Test scheitern lassen. Die Testlogik liegt somit in den Aktionen, die mit dem Bot ausgeführt werden. Denken Sie daran, dass das, was wir testen wollen, die Userinteraktion mit unseren UI-Elementen ist.
Das SWTBot-Java-API wurde so entworfen, dass es möglichst lesbar, flüssig und einfach zu nutzen ist. Statt also im SWTBot Javadoc nachzuschauen, ist es am einfachsten, das API mittels der Content-Assist-Funktion auf einem Bot-Objekt zu nutzen. Darüber hinaus sind die Methodenaufrufe auf den Bot verkettet konzipiert. Das ist möglich, da das API statisch typisiert ist. Die Methoden, die während einer Methodenaufrufkette verfügbar sind, spiegeln also nur die Aktionen wider, die auf dem spezifischen Widget ausgeführt werden können, das von einer Methode zurückgegeben wird. Selbst wer nicht mit SWTBot vertraut ist, sollte die folgende Codezeile einfach verstehen können:
bot.menu("File").menu("New").menu("Project...").click();
Wir versuchen, auf das Menü "Project" im Untermenü "News" im Menü "File" zuzugreifen – und darauf zu klicken. Obwohl es nicht zwingend erforderlich ist, raten wir dazu, die Testklassen wie folgt zu annotieren:
@RunWith(SWTBotJunit4ClassRunner.class)
Auf diese Weise erstellt SWTBot automatisch einen Screenshot der laufenden Anwendung, wenn etwas während der Testausführung schief geht – sehr nützlich für die Analyse von Problemen. Diese Screenshots werden im Ordner Screenshots des Projekts mit den SWTBot-Tests abgelegt.
Ein erstes Beispiel
Beginnen wir mit einem sehr einfachen Beispiel zur Nutzung von SWTBot. Zuallererst erstellen wir ein Plug-in-Projekt, das wir swtbot.example.menu nennen. Das Projekt soll einen Beitrag zum UI leisten und das PDE-Template „Hello World Command“ mit allen Default-Einstellungen verwenden. Das Projekt wird ein Menü „Sample Menu“ mit dem Untermenü „Sample Command“ enthalten. Wählt man dieses aus, soll die Nachricht „Hello, Eclipse world“ angezeigt werden, die den Titel „Example Menu“ trägt. Wir starten eine neue Eclipse-Instanz, um die korrekte Funktionsweise des Plug-ins manuell zu überprüfen.
Jetzt wollen wir dieses Verhalten mittels SWTBot testen. Wir erzeugen dazu ein weiteres Plug-in-Projekt namens swtbot.example.tests, in das wir alle unsere SWTBot-Tests schreiben werden. Wir spezifizieren in diesem Projekt als Abhängigkeit das Bundle org.eclipse.swtbot.go, das alle Komponenten enthält, um SWTBot-Tests auszuführen, inklusive JUnit selbst. Dann schreiben wir den JUnit-Test aus Listing 1.
Listing 1
package swtbot.example.tests;
import static org.eclipse.swtbot.swt.finder.waits.Conditions.shellCloses;
import org.eclipse.swtbot.eclipse.finder.SWTWorkbenchBot;
import org.eclipse.swtbot.swt.finder.junit.SWTBotJunit4ClassRunner;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotShell;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.runner.RunWith;
@RunWith(SWTBotJunit4ClassRunner.class)
public class SampleMenuTest {
private static SWTWorkbenchBot bot;
@BeforeClass
public static void initBot() {
bot = new SWTWorkbenchBot();
bot.viewByTitle("Welcome").close();
}
@AfterClass
public static void afterClass() {
bot.resetWorkbench();
}
@Test
public void testSampleMenu() {
bot.menu("Sample Menu").menu("Sample Command").click();
SWTBotShell dialog = bot.shell("Example Menu");
dialog.activate();
bot.label("Hello, Eclipse world");
.button("OK").click();
bot.waitUntil(shellCloses(dialog));
}
}Wie im vorherigen Abschnitt erwähnt, nutzen wir den spezifischen SWTBot Test Runner, um in den Genuss der automatischen Screenshots im Falle von Testfehlschlägen zu kommen. Wir initialisieren den Bot in der statischen @BeforeClass-Methode und schließen die Standard-Welcome-View, sodass sie die laufenden Tests nicht stören kann. Zudem setzen wir über den Bot in der @AfterClass-Methode die Workbench zurück.
In der Testmethode nutzen wir das SWTBot Fluent API, um das erwartete Verhalten zu testen. Dabei ist zu beachten, dass SWTBot auf die Userinteraktion mit dem UI abzielt. Wir wollen in diesem Test deshalb die Useraktionen simulieren und prüfen, ob unsere Menüimplementierung...

