Skripting (Jython, Groovy und JavaScript)

Version 7.0.6

Dieser Abschnitt erläutert die technischen Details der Integration von Jython, Groovy und JavaScript in QF-Test. Er enthält eine vollständige Referenz der API, die Jython, Groovy und JavaScript Skripten zur Interaktion mit QF-Test zur Verfügung steht. Eine weniger technische Einführung finden Sie in Kapitel 11.

Der Loadpath für Module werden in den Skriptsprachen aus verschiedenen Teilen in folgender Reihenfolge zusammengesetzt:

Das benutzerdefinierte Skript-Verzeichnis.
Das Verzeichnis qftest/qftest-7.0.6/<Name der Skriptsprache>

Zusätzlich wird dem Pfad während der Ausführung eines 'Server Skript' oder 'SUT Skript' Knotens das Verzeichnis der Testsuite vorangestellt.

Das Verzeichnis qftest/qftest-7.0.6/<Skriptsprache> enthält interne Module der jeweiligen Skriptsprache. Sie sollten diese Dateien nicht modifizieren, da sie sich jederzeit ändern können und auf die jeweilige Version von QF-Test zugeschnitten sind.

Ihre eigenen Module sollten Sie in das benutzerdefinierte Skript-Verzeichnis legen. Die Pfade zu diesen Verzeichnissen finden Sie via »Hilfe«-»Info« unter "Systeminfo" als dir.<Skriptsprache>. Dabei müssen die Module die jeweilige Endung haben (.py für Jython, .groovy für Groovy und .js für JavaScript) haben.

In Jython können Sie die System Property python.path nutzen, um weitere Verzeichnisse zum Loadpath hinzuzufügen.

Mit den Skriptsprachen kann auch auf Java Klassen und Methoden zugegriffen werden, die nichts speziell mit QF-Test zu tun haben, indem diese Klassen einfach importiert werden, z.B.:

from java.util import Date
from java.text import SimpleDateFormat
print SimpleDateFormat("yyyy-MM-dd").format(Date())

Beispiel 48.1: Zugriff auf Java Klassen mittels Jython

Zugriff gibt es auf alle Klassen, die sich beim Start von QF-Test bzw. des SUT auf dem CLASSPATH befinden, alle Klassen des Standard Java API, sowie QF-Test's eigene Klassen. Für das SUT hängt vieles vom verwendeten ClassLoader Konzept ab. Insbesondere bei WebStart und Eclipse/RCP ist es schwierig, Klassen des SUT direkt zu importieren.

Zusätzlich gibt es Plugin Verzeichnisse, in die Sie einfach eine jar Datei stellen können, um sie in Skripten verfügbar zu machen. QF-Test sucht dazu nach einem plugin Verzeichnis. Das aktuell verwendete Plugin-Verzeichnis finden Sie via »Hilfe«-»Info« unter "Systeminfo" als dir.plugin. Das Plugin-Verzeichnis kann auch über das Kommandozeilenargument -plugindir <Verzeichnis> geändert werden.

Jar Dateien im primären Plugin Verzeichnis stehen sowohl 'Server Skript', als auch 'SUT Skript' Knoten zur Verfügung. Um eine jar Datei ausschließlich für 'Server Skripte' oder ausschließlich für 'SUT Skripte' bereitzustellen, stellen Sie diese stattdessen in das zugehörige Unterverzeichnis namens qftest bzw. sut.

Beim Start von QF-Test und des SUT wird ein Jython Interpreter erzeugt und in die Applikation eingebettet. Für QF-Test wird dabei das Modul qftest geladen, für das SUT das Modul qfclient. Beide basieren auf dem Modul qfcommon, das den gemeinsamen Code enthält. Diese Module werden benötigt, um die Schnittstelle zum Runcontext und den globalen Namespace bereitzustellen.

Anschließend wird der Loadpath sys.path nach Ihren persönlichen Modulen für die Initialisierung durchsucht. Für QF-Test wird die Datei qfserver.py geladen, für das SUT die Datei qfsut.py. In beiden fällen werden die Dateien mittels execfile ausgeführt, womit der Inhalt der Dateien direkt im globalen Namespace landet. Dies ist für Initialisierungsdateien von Vorteil, da alle Module, die von diesen importiert werden, direkt für 'Server Skript' und 'SUT Skript' Knoten zur Verfügung stehen. Bedenken Sie bei Ihren Initialisierungsdateien, dass zu diesem Zeitpunkt noch kein Runcontext und kein Testsuite-spezifisches Verzeichnis in sys.path zur Verfügung stehen.

Die Umgebung in der 'Server Skripte' oder 'SUT Skripte' ausgeführt werden, wird durch den globalen und lokalen Namespace bestimmt, die während der Ausführung definiert sind. Namespaces sind Jython Dictionaries, welche die Bindungen für die globalen und lokalen Variablen beinhalten.

Der globale Namespace wird von allen Skripten, die in demselben Jython Interpreter laufen, gemeinsam genutzt. Er enthält zunächst nur die Klassen TestException und UserException, das Modul qftest bzw. qfclient für QF-Test bzw. das SUT, und alles, was in qfserver.py bzw. qfsut.py definiert und importiert wurde. Wenn Sie in einem Skript eine Variable mit Hilfe des global Statements als global deklarieren und ihr einen Wert zuweisen, wird diese in den globalen Namespace aufgenommen und steht damit für weitere Skripte zur Verfügung. Zusätzlich nimmt QF-Test automatisch alle Module in den globalen Namespace auf, die während der Ausführung eines Skripts importiert werden.

Der lokale Namespace wird für jedes Skript neu erstellt. Beim Aufruf des Skripts enthält er das Objekt rc, die Schnittstelle zu QF-Tests Runcontext, sowie true und false mit den Werten 1 und 0 zur besseren Integration mit QF-Test.

Für den Zugriff auf und das Setzen von Variablen in einem fremden Jython Interpreter, stehen die Runcontext Methoden fromServer, fromSUT, toServer und toSUT zur Verfügung.

Das Runcontext Objekt rc ist die Schnittstelle zum Ausführungszustand des laufenden Tests in QF-Test. Die Verwendung einer zusätzlichen Schicht erlaubt Änderungen an der Implementierung von QF-Test, ohne die Schnittstelle für Skripte zu gefährden.

Es folgt eine alphabetische Aufstellung aller Methoden des Runcontext Objekts rc. Die verwendete Syntax ist ein Gemisch aus Java und Python. Python unterstützt zwar selbst keine statische Typisierung, die Parameter werden jedoch an Java weitergereicht, so dass falsche Typen Exceptions auslösen können. Folgt einem Parameter ein '=' Zeichen und ein Wert, ist dies der Defaultwert des Parameters und eine Angabe beim Aufruf ist optional.

Hinweis Die Groovy Syntax für Keyword-Parameter unterscheidet sich von Jython. Groovy verwendet ':' statt '='. Dies ist besonders tückisch, weil z.B. rc.logMessage("bla", report=true) durchaus legaler Groovy Code ist, der allerdings nicht den gewünschten Effekt hat. Das '=' ist hierbei eine Zuweisung mit dem Wert true, der dann ganz einfach als zweiter Parameter übergeben wird, so dass der Aufruf äquivalent ist zu rc.logMessage("bla", true). Hierbei wird true aber für dontcompactify statt report verwendet. Die korrekte Version für Groovy lautet rc.logMessage("bla", report:true).


`void addDaemonLog(byte[] data, String name=None, String comment=None, String externalizename=None)`
Fügt ein von einem DaemonRunContext abgeholtes Protokoll in das aktuelle Protokoll ein.
Parameter
`data`	Das Bytearray, das mittels DaemonRunContext.getRunLog() abgeholt wurde.
`name`	Ein optionaler Name für den Knoten des Daemon-Protokolls. Falls nicht angegeben wird die ID des Daemon verwendet.
`comment`	Ein optionaler Kommentar für den Knoten des Daemon-Protokolls.
`externalizename`	Ein optionaler Name zum extrahieren des Daemon-Protokolls, um es als Teil eines geteilten Protokolls zu speichern.

`void addResetListener(ResetListener listener)`
Nur Server. Registriert einen `ResetListener` beim aktuellen Runcontext.
Parameter
`listener`	Den Listener der registriert werden soll. Der Listener sollte das Interface de.qfs.apps.qftest.extensions.qftest.ResetListener implementieren.

`void addTestRunListener(TestRunListener listener)`
Registriert einen `TestRunListener` beim aktuellen Runcontext. Im interaktiven Modus und im Batchmodus gibt es nur einen gemeinsamen Runcontext, so dass der Listener so lange aktiv bleibt, bis er via `removeTestRunListener` oder `clearTestRunListeners` entfernt wird. Im Daemonmodus hat jeder `DaemonRunContext` seinen eigenen Satz von TestRunListenern. Details zum `TestRunListener` API finden Sie in Abschnitt 52.7.
Parameter
`listener`	Der zu registrierende Listener.

`String callProcedure(String name, dictionary parameters=None)`
Ruft eine 'Prozedur' in einer Testsuite auf. Hinweis Diese Methode kann auch aus einem 'SUT Skript' aufgerufen werden. Dabei können allerdings seltsame Seiteneffekte auftreten, da das Skript im AWT Event Dispatch Thread ausgeführt wird. Obwohl QF-Test diese Effekte sauber abfängt, sollten Sie, wann immer möglich, 'Prozeduren' aus einem 'Server Skript' heraus aufrufen.
Parameter
`name`	Der vollständige Name der 'Prozedur'.
`parameters`	Die Parameter für die 'Prozedur', ein Dictionary. Die Schlüssel und Werte können beliebige Objekte sein. Diese werden beim Aufruf in Zeichenketten umgewandelt.
Rückgabewert	Der von der 'Prozedur' mittels eines optionalen 'Return' Knotens zurückgegebene Wert.

`int callTest(String name, dictionary parameters=None)`
Nur Server. Ruft einen 'Testfall' oder 'Testfallsatz' aus einer Testsuite oder eine ganze Testsuite auf.
Parameter
`name`	Der vollständige Name des 'Testfall' oder 'Testfallsatz'.
`parameters`	Die Parameter für den aufzurufenden Knoten, ein Dictionary. Die Schlüssel und Werte können beliebige Objekte sein. Diese werden beim Aufruf in Zeichenketten umgewandelt.
Rückgabewert	Der Status der Testausführung. Entweder rc.OK, rc.WARNING, rc.ERROR, rc.EXCEPTION, rc.SKIPPED oder rc.NOT_IMPLEMENTED.

`int callTestAsProcedure(String name, dictionary parameters=None)`
Nur Server. Ruft einen 'Testfall', 'Testfallsatz' aus einer Testsuite oder eine ganze Testsuite auf, allerdings analog zu einen Prozeduraufruf, so dass eine unbehandelte Exception den gesamten Aufruf beendet und nicht nur den gerade ausgeführten 'Testfall'.
Parameter
`name`	Der vollständige Name des 'Testfall' oder 'Testfallsatz'.
`parameters`	Die Parameter für den aufzurufenden Knoten, ein Dictionary. Die Schlüssel und Werte können beliebige Objekte sein. Diese werden beim Aufruf in Zeichenketten umgewandelt.
Rückgabewert	Der Status der Testausführung. Entweder rc.OK, rc.WARNING, rc.ERROR, rc.EXCEPTION, rc.SKIPPED oder rc.NOT_IMPLEMENTED.

`Boolean check(boolean condition, String message, int level=rc.ERROR, boolean report=true, boolean nowrap=false)`
Prüft, ob eine Bedingung zutrifft und gibt eine entsprechende Meldung aus.
Parameter
`condition`	Die zu überprüfende Bedingung.
`message`	Die Meldung, die ausgegeben werden soll. Abhängig vom Ergebnis wird "Check OK: " oder "Check fehlgeschlagen: " vorangestellt. Für den alten XML oder HTML-Report wird die Meldung wie ein 'Check' Knoten behandelt, wenn sie mit einem '!' beginnt.
`level`	Die Gewichtung des Fehlers, falls der Check fehlschlägt. Die folgenden Konstanten sind hierfür im Runcontext definiert: `rc.OK` `rc.WARNING` `rc.ERROR` `rc.EXCEPTION` Für die Stufe `rc.EXCEPTION` wird im Fehlerfall eine `UserException` geworfen.
`report`	Fall true wird der Check im Report aufgeführt. Nur anwendbar wenn level <= rc.WARNING.
`nowrap`	Falls true werden die Zeilen der Meldung im Report nicht umgebrochen. Sinnvoll für potentiell lange Meldungen.
Rückgabewert	Das Ergebnis des Checks.

`Boolean checkEqual(Object actual, Object expected, String message, int level=rc.ERROR, boolean report=true, boolean nowrap=false)`
Prüft, ob ein Objekt einen vorgegebenen Wert hat und gibt eine entsprechende Meldung aus.
Parameter
`actual`	Der tatsächliche Wert.
`expected`	Der erwartete Wert.
`message`	Die Meldung, die ausgegeben werden soll. Abhängig vom Ergebnis wird "Check OK: " oder "Check fehlgeschlagen: " vorangestellt. Im Fehlerfall werden auch der erwartete und der tatsächliche Wert ausgegeben.
`level`	Die Gewichtung des Fehlers, falls der Check fehlschlägt. Die folgenden Konstanten sind hierfür im Runcontext definiert: `rc.OK` `rc.WARNING` `rc.ERROR` `rc.EXCEPTION` Für die Stufe `rc.EXCEPTION` wird im Fehlerfall eine `UserException` geworfen.
`report`	Fall true wird der Check im Report aufgeführt. Nur anwendbar wenn level <= rc.WARNING.
`nowrap`	Falls true werden die Zeilen der Meldung im Report nicht umgebrochen. Sinnvoll für potentiell lange Meldungen.
Rückgabewert	Das Ergebnis des Checks.

`Boolean checkImage(ImageRep actual, ImageRep expected, String message, int level=rc.ERROR, boolean report=true, boolean nowrap=false)`
Prüft, ob zwei `ImageRep` (siehe Abschnitt 52.10.1) Objekte gleich sind und gibt eine entsprechende Meldung aus. Der Vergleich wird mittels der `equals` Methode des `ImageComparator` (siehe Abschnitt 52.10.2) Objektes des erwarteten `ImageRep` Objektes durchgeführt.
Parameter
`actual`	Das aktuelle `ImageRep` Objekt.
`expected`	Das erwartete `ImageRep` Objekt.
`message`	Die Meldung, die ausgegeben werden soll. Abhängig vom Ergebnis wird "Check OK: " oder "Check fehlgeschlagen: " vorangestellt. Im Fehlerfall werden auch der erwartete und der tatsächliche Wert ausgegeben. Für den alten XML oder HTML-Report wird die Meldung wie ein 'Check' Knoten behandelt, wenn sie mit einem '!' beginnt.
`level`	Die Gewichtung des Fehlers, falls der Check fehlschlägt. Die folgenden Konstanten sind hierfür im Runcontext definiert: `rc.OK` `rc.WARNING` `rc.ERROR` `rc.EXCEPTION` Für die Stufe `rc.EXCEPTION` wird im Fehlerfall eine `UserException` geworfen.
`report`	Fall true wird der Check im Report aufgeführt. Nur anwendbar wenn level <= rc.WARNING.
`nowrap`	Falls true werden die Zeilen der Meldung im Report nicht umgebrochen. Sinnvoll für potentiell lange Meldungen.
Rückgabewert	Das Ergebnis des Checks.

`Object[] checkImageAdvanced(ImageRep actual, ImageRep expected, String message, String algorithm, int level=rc.ERROR, boolean report=true, boolean nowrap=false)`
Prüft, ob zwei `ImageRep` (siehe Abschnitt 52.10.1) Objekte gleich sind und gibt eine entsprechende Meldung aus. Der Vergleich wird mittels des angegebenen Algorithmus durchgeführt.
Parameter
`actual`	Das aktuelle `ImageRep` Objekt.
`expected`	Das erwartete `ImageRep` Objekt.
`message`	Die Meldung, die ausgegeben werden soll. Abhängig vom Ergebnis wird "Check OK: " oder "Check fehlgeschlagen: " vorangestellt. Im Fehlerfall werden auch der erwartete und der tatsächliche Wert ausgegeben. Für den alten XML oder HTML-Report wird die Meldung wie ein 'Check' Knoten behandelt, wenn sie mit einem '!' beginnt.
`algorithm`	Spezifiziert den für den Vergleich zu nutzenden Algorithmus wie in Kapitel 57 beschrieben.
`level`	Die Gewichtung des Fehlers, falls der Check fehlschlägt. Die folgenden Konstanten sind hierfür im Runcontext definiert: `rc.OK` `rc.WARNING` `rc.ERROR` `rc.EXCEPTION` Für die Stufe `rc.EXCEPTION` wird im Fehlerfall eine `UserException` geworfen.
`report`	Fall true wird der Check im Report aufgeführt. Nur anwendbar wenn level <= rc.WARNING.
`nowrap`	Falls true werden die Zeilen der Meldung im Report nicht umgebrochen. Sinnvoll für potentiell lange Meldungen.
Rückgabewert	Ein Array mit dem Inhalt: Das Ergebnis des Checks als Boolean. Das Ergebnis des Checks als Wahrscheinlichkeit der Übereinstimmung. Abhängig vom Algorithmus das transformierte Bild des erwarteten Abbildes als `ImageRep`. Abhängig vom Algorithmus das transformierte Bild des erhaltenen Abbildes als `ImageRep`. Gegebenenfalls weitere Informationen.

`void clearGlobals()`
Nur Server. Löscht alle globalen Variablen.

`void clearProperties(String group)`
Nur Server. Löscht einen Satz von geladenen Properties oder Ressourcen.
Parameter
`group`	Der Name der Gruppe von Properties oder Ressourcen.

`void clearTestRunListeners()`
Entfernt alle `TestRunListener` aus dem aktuellen Runcontext.

`String expand(String text)`
Expandiert eine Zeichenkette unter Verwendung der üblichen QF-Test Variablensyntax für `$(...)` oder `${...:...}`. Hinweis Denken Sie daran, die '$' Zeichen zu verdoppeln, damit die Expansion nicht bereits vor dem Aufruf des Skripts geschieht (vgl. Abschnitt 47.5).
Parameter
`text`	Der zu expandierende Text.
Rückgabewert	Der expandierte Text.

`Object fromServer(String name)`
Nur SUT. Ermittelt den Wert einer globalen Variablen im Jython oder Groovy Interpreter von QF-Test.
Parameter
`name`	Der Name der Variablen.
Rückgabewert	Der Wert der Variablen.

`Object fromSUT(String client, String name)`
Nur Server. Ermittelt den Wert einer globalen Variablen im Jython oder Groovy Interpreter des SUT.
Parameter
`client`	Der Name des SUT Clients.
`name`	Der Name der Variablen.
Rückgabewert	Der Wert der Variablen.

`Boolean getBool(String varname)`
Ermittelt den Wert einer QF-Test Variable analog zu `lookup()` und interpretiert ihn als Boolean.
Parameter
`varname`	Der Name der Variable.
Rückgabewert	Der Wert der Variable.

`Boolean getBool(String group, String name)`
Ermittelt den Wert einer QF-Test Ressource oder Property analog zu `lookup()` und interpretiert ihn als Boolean.
Parameter
`group`	Der Name der Gruppe.
`name`	Der Name der Ressource oder Property.
Rückgabewert	Der Wert der Ressource oder Property.

`Exception getCaughtException()`
Nur Server. Wird das Skript unterhalb eines 'Catch' Knotens ausgeführt, liefert diese Methode die darin gefangene Exception. In allen anderen Fällen ist der Rückgabewert `None`.
Rückgabewert	Die gefangene Exception.

`Component getComponent(String id, int timeout=0, boolean hidden=false)`
Nur SUT. Ermittelt eine Komponente oder ein Unterelement mit Hilfe von QF-Tests Algorithmus zur Wiedererkennung.
Parameter
`id`	Die 'QF-Test ID' des 'Komponente' Knotens, der die Komponente in der Testsuite repräsentiert.
`timeout`	Dieser Parameter wird ignoriert und ist immer 0 für SUT Skripte, die auf dem Event Dispatch Thread der jeweiligen GUI Engine ausgeführt werden, da dieser Thread nicht auf sichere weise freigegeben werden kann, um auf die Komponente zu warten.
`hidden`	Legt fest, ob auch nach unsichtbaren Komponenten gesucht wird, was z.B. für Menüeinträge sinnvoll ist.
Rückgabewert	Die tatsächliche Java Komponente. Für Unterelemente wird ein Paar der Form `(component, index)` zurückgeliefert, wobei der Typ von `index` von der Art des Unterelements abhängt. Für Baumknoten ist `index` ein `javax.swing.tree.TreePath` Objekt, für Zellen von Tabellen ein Paar der Form `(row, column)` und ansonsten ein Integer Wert. Hinweis Spaltenindizes werden immer im Bezugssystem der Tabelle zurückgeliefert, nicht im Bezugssystem des Modells.

`List getConnectedClients()`
Liefert die Namen der aktuell verbundenen SUT Clients.
Rückgabewert	Eine Liste mit den Namen der aktuell verbundenen SUT Clients, eine leere Liste, falls es keine gibt.

`Properties getGlobals()`
Liefert die globalen Variablen des aktuellen Runcontexts.
Rückgabewert	Die globalen Variablen des aktuellen Runcontexts.

`Integer getInt(String varname)`
Ermittelt den Wert einer QF-Test Variable analog zu `lookup()` und interpretiert ihn als Integer.
Parameter
`varname`	Der Name der Variable.
Rückgabewert	Der Wert der Variable.

`Integer getInt(String group, String name)`
Ermittelt den Wert einer QF-Test Ressource oder Property analog zu `lookup()` und interpretiert ihn als Integer.
Parameter
`group`	Der Name der Gruppe.
`name`	Der Name der Ressource oder Property.
Rückgabewert	Der Wert der Ressource oder Property.

`Object getLastComponent()`
Nur SUT. Liefert die letzte Komponente, die von QF-Test für einen Event, einen Check oder eine sonstige Operation adressiert wurde. Ein Aufruf von `rc.getComponent()` hat hierauf keinen Einfluss.
Rückgabewert	Die letzte von QF-Test adressierte Komponente.

`Exception getLastException()`
Nur Server. Gibt die letzte Exception zurück, die während des Testlaufs geworfen wurde, unabhängig davon, ob und wie diese gefangen wurde. In den meisten Situationen ist `getCaughtException` die bessere Variante.
Rückgabewert	Die zuletzt geworfene Exception.

`Object getLastItem()`
Nur SUT. Liefert das letzte Unterelement, das von QF-Test für einen Event, einen Check oder eine sonstige Operation adressiert wurde. Ein Aufruf von `rc.getComponent()` hat hierauf keinen Einfluss.
Rückgabewert	Das letzte von QF-Test adressierte Unterelement.

`Properties getLocals(nonEmpty=false)`
Liefert die innersten lokalen Variablen des aktuellen Runcontexts. Hauptsächlich innerhalb einer Prozedur sinnvoll, um die Parameter der Aufrufs zu erhalten, vergleichbar mit Keyword-Argumenten in Jython oder Groovy.
Parameter
`nonEmpty`	Falls true, wird der erste nicht-leere Satz von Variablen geliefert, andernfalls immer der innerste Satz, auch wenn dieser leer ist.
Rückgabewert	Die innersten lokalen Variablen des aktuellen Runcontexts.

`Number getNum(String varname)`
Ermittelt den Wert einer QF-Test Variable analog zu `lookup()` und interpretiert ihn als Zahl, d.h als int oder float für Jython bzw. Integer oder BigDecimal für Groovy.
Parameter
`varname`	Der Name der Variable.
Rückgabewert	Der Wert der Variable.

`Number getNum(String group, String name)`
Ermittelt den Wert einer QF-Test Ressource oder Property analog zu `lookup()` und interpretiert ihn als Zahl, d.h als int oder float für Jython bzw. Integer oder BigDecimal für Groovy.
Parameter
`group`	Der Name der Gruppe.
`name`	Der Name der Ressource oder Property.
Rückgabewert	Der Wert der Ressource oder Property.

`Object getOption(String name)`
Liest den Wert einer Option zur Laufzeit. Diese Methode ist eher der vollständigkeit halber vorhanden, Sie werden diese vermutlich nicht brauchen. Für den naheliegenden Anwendungsfall, den Wert einer Option nach einer Änderung mittels `setOption` wieder zurückzusetzen, sollten Sie stattdessen `unsetOption` verwenden, da auf Skript-Ebene gesetzte Optionen den interaktiv im Optionen-Dialog eingestellten Wert verdecken. Für temporäre Änderungen einer Option ist `pushOption` / `popOption` am besten geeignet.
Parameter
`name`	Der Name der Option, eine Konstante aus der Klasse `Options`, welche in Jython und Groovy Skripten automatisch importiert ist. Die Namen der Optionen, die auf diese Weise gelesen werden können, sind in Kapitel 39 dokumentiert.
Rückgabewert	Der aktuelle Wert der Option.

`Pattern getPattern(String varname)`
Ermittelt den Wert einer QF-Test Variable analog zu `lookup()` und interpretiert ihn als regulären Ausdruck (vgl. Abschnitt 47.3).
Parameter
`varname`	Der Name der Variable.
Rückgabewert	Ein Java Pattern-Object mit dem Wert der Variable als regulärem Ausdruck.

`Pattern getPattern(String group, String name)`
Ermittelt den Wert einer QF-Test Ressource oder Property analog zu `lookup()` und interpretiert ihn als regulären Ausdruck (vgl. Abschnitt 47.3).
Parameter
`group`	Der Name der Gruppe.
`name`	Der Name der Ressource oder Property.
Rückgabewert	Ein Java Pattern-Object mit dem Wert der Ressource oder Property als regulärem Ausdruck.

`Properties getProperties(String group)`
Liefert einen Satz von geladenen Properties oder Ressourcen.
Parameter
`group`	Der Name der Gruppe von Properties oder Ressourcen.
Rückgabewert	Die für die angegebene Gruppe gebundenen Variablen oder None falls keine solche Gruppe existiert.

`String getPropertyGroupNames()`
Listet alle benutzerdefinierten Propertygruppen auf. Die Rückgabe ist alphabetisch sortiert.
Rückgabewert	Eine Zeichenkette welche alle vom benutzerdefinierten Propertygruppen auflistet. Die Namen der definierten Propertygruppen sind alphabetisch sortiert und durch Zeilenumbrüche getrennt.

`String getStr(String varname, boolean expand=true)`
Ermittelt den Wert einer QF-Test Variable analog zu `lookup()`.
Parameter
`varname`	Der Name der Variable.
`expand`	Legt fest, ob die Variable rekursiv expandiert werden soll. Ist z.B. der Wert von `$(varname)` wörtlich `"$(othervar)"`, liefert diese Methode den expandierten Wert von `$(othervar)`, wenn `expand` wahr ist, andernfalls die Zeichenkette `"$(othervar)"`. Wenn Sie diesen Parameter angeben wollen, müssen Sie die Python Keyword Syntax verwenden, um Konflikte mit der Methode `getStr(String group, String name)` zu vermeiden, also `rc.getStr("var", expand=0)` an Stelle von `rc.getStr("var", 0)`.
Rückgabewert	Der Wert der Variable.

`String getStr(String group, String name, boolean expand=true)`
Ermittelt den Wert einer QF-Test Ressource oder Property analog zu `lookup()`.
Parameter
`group`	Der Name der Gruppe.
`name`	Der Name der Ressource oder Property.
`expand`	Legt fest, ob der Wert rekursiv expandiert werden soll. Ist z.B. der Wert von `${group:name}` wörtlich `"$(othervar)"`, liefert diese Methode den expandierten Wert von `$(othervar)`, wenn `expand` wahr ist, andernfalls die Zeichenkette `"$(othervar)"`.
Rückgabewert	Der Wert der Ressource oder Property.

`String id(String id)`
Liefert die QF-Test ID der angegebenen Komponente zurück, also immer den Parameter selbst. Diese Methode sollte in Skripten zur Kennzeichnung von QF-Test IDs verwendet werden, so dass diese Referenzen nach Verschieben bzw. Änderung der verwendeten QF-Test IDs angepasst werden können.
Parameter
`id`	Die QF-Test ID der Komponente.
Rückgabewert	Die QF-Test ID der Komponente.

`boolean isOptionSet(String name)`
Prüft, ob eine Option per Skript gesetzt wurde.
Parameter
`name`	Der Name der Option, eine Konstante aus der Klasse `Options`, welche in Jython und Groovy Skripten automatisch importiert ist. Die Namen der Optionen, die auf diese Weise gelesen werden können, sind in Kapitel 39 dokumentiert.
Rückgabewert	True falls die Option gesetzt wurde, andernfalls false.

`boolean isResetListenerRegistered(ResetListener listener)`
Nur Server. Überprüft, ob ein ResetListener registriert wurde.
Parameter
`listener`	Den zu überprüfenden ResetListener.
Rückgabewert	True wenn der ResetListener registriert wurde, sonst False.

`void logDiagnostics(String client)`
Nur Server. Schreibt Event-Informationen, die für eine mögliche Fehlerdiagnose im SUT Client zwischengespeichert wurden, in das Protokoll.
Parameter
`client`	Der Name des SUT Clients, von dem die Informationen abgeholt werden sollen.

`void logError(String msg, boolean nowrap=false)`
Schreibt eine benutzerdefinierte Fehlermeldung in das Protokoll.
Parameter
`msg`	Die Meldung.
`nowrap`	Falls true werden die Zeilen der Meldung im Report nicht umgebrochen. Sinnvoll für potentiell lange Meldungen.

`void logImage(ImageRep image, String title=None, boolean dontcompactify=false, boolean report=false)`
Schreibt ein `ImageRep` (Abschnitt 52.10.1) Objekt in das Protokoll.
Parameter
`title`	Ein optionaler Titel für das Abbild.
`image`	Das `ImageRep` Objekt.
`dontcompactify`	Falls true wird das Abbild nicht aus kompakten Protokollen entfernt.
`report`	Falls true wird das Abbild im Report angezeigt (impliziert dontcompactify).

`void logMessage(String msg, boolean dontcompactify=false, boolean report=false, boolean nowrap=false)`
Schreibt eine Meldung in das Protokoll.
Parameter
`msg`	Die Meldung.
`dontcompactify`	Falls true wird die Meldung nicht aus kompakten Protokollen entfernt
`report`	Falls true wird die Meldung im Report aufgeführt.
`nowrap`	Falls true werden die Zeilen der Meldung im Report nicht umgebrochen. Sinnvoll für potentiell lange Meldungen.

`void logWarning(String msg, boolean report=true, boolean nowrap=false)`
Schreibt eine benutzerdefinierte Warnmeldung in das Protokoll.
Parameter
`msg`	Die Meldung.
`report`	Falls true (default) wird die Warnung im Report aufgeführt. Sie können diese spezielle Warnung vom Report ausschließen, indem Sie diesen Parameter auf false setzen.
`nowrap`	Falls true werden die Zeilen der Meldung im Report nicht umgebrochen. Sinnvoll für potentiell lange Meldungen.

`String lookup(String varname, boolean expand=true)`
Ermittelt den Wert einer QF-Test Variable, vergleichbar mit `$(varname)`.
Parameter
`varname`	Der Name der Variable.
`expand`	Legt fest, ob die Variable rekursiv expandiert werden soll. Ist z.B. der Wert von `$(varname)` wörtlich `"$(othervar)"`, liefert diese Methode den expandierten Wert von `$(othervar)`, wenn `expand` wahr ist, andernfalls die Zeichenkette `"$(othervar)"`. Wenn Sie diesen Parameter angeben wollen, müssen Sie die Python Keyword Syntax verwenden, um Konflikte mit der Methode `lookup(String group, String name)` zu vermeiden, also `rc.lookup("var", expand=0)` an Stelle von `rc.lookup("var", 0)`.
Rückgabewert	Der Wert der Variable.

`String lookup(String group, String name, boolean expand=true)`
Ermittelt den Wert einer QF-Test Ressource oder Property, vergleichbar mit `${group:name}`.
Parameter
`group`	Der Name der Gruppe.
`name`	Der Name der Ressource oder Property.
`expand`	Legt fest, ob der Wert rekursiv expandiert werden soll. Ist z.B. der Wert von `${group:name}` wörtlich `"$(othervar)"`, liefert diese Methode den expandierten Wert von `$(othervar)`, wenn `expand` wahr ist, andernfalls die Zeichenkette `"$(othervar)"`.
Rückgabewert	Der Wert der Ressource oder Property.

`void overrideElement(String id, Component com)`
Nur SUT. Überschreibt die Zielkomponente für die Wiedererkennung einer Komponente mit der angegebenen QF-Test ID. Bei einem Zugriff auf diese QF-Test ID ignoriert QF-Test alle zugehörigen Informationen und liefert direkt die registrierte Komponente.
Parameter
`id`	Die QF-Test ID der zu überschreibenden Komponente.
`com`	Die Komponente, welche angesprochen werden soll. None/null um zum normalen Mechanismus zurückzukehren.

`void popOption(String name)`
Negiert einen vorangegangen `pushOption` Aufruf.
Parameter
`name`	Der Name der zurückzusetzenden Option, eine Konstante aus der Klasse `Options`, welche in Jython und Groovy Skripten automatisch importiert ist. Die Namen der Optionen, die auf diese Weise gesetzt werden können, sind in Kapitel 39 dokumentiert.

`void pushOption(String name, object value)`
Der Aufruf setzt den Wert einer Option zur Laufzeit, analog zu `setOption`. Im Gegensatz zu letzterem wird für jeden verschachtelten Aufruf der ursprüngliche Wert gespeichert, um mittels `popOption` wiederhergestellt zu werden. Die `pushOption` und `popOption` Aufrufe, die am besten in einer 'Try' / 'Finally' Kombination genutzt werden, sind Ideal für Prozeduren geeignet, um eine Option temporär auf einen bestimmten Wert zu setzen, ohne einen eventuell früher erfolgten `setOption` Aufruf zu negieren.
Parameter
`name`	Der Name der Option, eine Konstante aus der Klasse `Options`, welche in Jython und Groovy Skripten automatisch importiert ist. Die Namen der Optionen, die auf diese Weise gesetzt werden können, sind in Kapitel 39 dokumentiert.
`value`	Der zu setzende Wert, üblicherweise ein Boolean, eine Zahl oder eine Konstante aus der `Options` Klasse für solche Optionen, die über eine Auswahlliste gesetzt werden. Für Optionen wie die "Keine Panik" Taste, deren Wert ein Tastenkürzel ist, muss diese Kürzel als Text wie "F12" oder "Shift-F6" angegeben werden. Mögliche Modifier sind "Shift", "Control" oder "Ctrl", "Alt" und "Meta", sowie deren Kombinationen. Der angegebenen Taste wird ein "VK_" vorangestellt und ihr Wert dann der Klasse `java.awt.event.KeyEvent` entnommen. Groß-/Kleinschreibung ist für beide irrelevant, so dass auch "shift-alt-enter" funktioniert.

`void removeResetListener(ResetListener listener)`
Nur Server. Entfernt einen ResetListener.
Parameter
`listener`	Den zu entfernenden ResetListener.

`void removeTestRunListener(TestRunListener listener)`
Entfernt einen `TestRunListener` aus dem aktuellen Runcontext.
Parameter
`listener`	Der zu entfernende Listener.

`void resetDependencies(String namespace=None)`
Setzt den Stapel von Abhängigkeiten zurück, ohne Aufräumsequenzen auszuführen.
Parameter
`namespace`	Ein optionaler Namensraum für die Abhängigkeiten.

`void resolveDependency(String dependency, String namespace=None, dictionary parameters=None)`
Löst eine 'Abhängigkeit' auf.
Parameter
`dependency`	Der vollständige Name der 'Abhängigkeit'.
`namespace`	Ein optionaler Namensraum für die 'Abhängigkeit'.
`parameters`	Die Parameter für die 'Abhängigkeit', ein Dictionary. Die Schlüssel und Werte können beliebige Objekte sein. Diese werden beim Aufruf in Zeichenketten umgewandelt.

`void rollbackDependencies(String namespace=None)`
Baut den Stapel von Abhängigkeiten ab.
Parameter
`namespace`	Ein optionaler Namensraum für die Abhängigkeiten.

`void setGlobal(String name, object value)`
Definiert eine globale QF-Test Variable.
Parameter
`name`	Der Name der Variable.
`value`	Ein beliebiger Wert für die Variable. Er wird automatisch in eine Zeichenkette konvertiert. Der Wert `None` führt zum Löschen der Variablen.

`void setLocal(String name, object value)`
Definiert eine lokale QF-Test Variable.
Parameter
`name`	Der Name der Variable.
`value`	Ein beliebiger Wert für die Variable. Er wird automatisch in eine Zeichenkette konvertiert. Der Wert `None` führt zum Löschen der Variablen.

`void setOption(String name, object value)`
Setzt den Wert einer Option zur Laufzeit. Dieser Wert hat Vorrang vor dem Wert, der aus der Konfigurationsdatei gelesen oder im Optionen-Dialog eingestellt wurde und wird selbst weder im Dialog angezeigt, noch in eine Konfigurationsdatei gespeichert. Der ursprüngliche Wert aus der Konfiguration kann via `unsetOption` wieder hergestellt werden. Der Wert eines eventuell vorhergegangenen Aufrufs von `setOption` wird dagegen überschrieben. Soll dieser nicht verloren gehen, muss stattdessen `pushOption` / `popOption` verwendet werden.
Parameter
`name`	Der Name der Option, eine Konstante aus der Klasse `Options`, welche in Jython und Groovy Skripten automatisch importiert ist. Die Namen der Optionen, die auf diese Weise gesetzt werden können, sind in Kapitel 39 dokumentiert.
`value`	Der zu setzende Wert, üblicherweise ein Boolean, eine Zahl oder eine Konstante aus der `Options` Klasse für solche Optionen, die über eine Auswahlliste gesetzt werden. Für Optionen wie die "Keine Panik" Taste, deren Wert ein Tastenkürzel ist, muss diese Kürzel als Text wie "F12" oder "Shift-F6" angegeben werden. Mögliche Modifier sind "Shift", "Control" oder "Ctrl", "Alt" und "Meta", sowie deren Kombinationen. Der angegebenen Taste wird ein "VK_" vorangestellt und ihr Wert dann der Klasse `java.awt.event.KeyEvent` entnommen. Groß-/Kleinschreibung ist für beide irrelevant, so dass auch "shift-alt-enter" funktioniert.

`void setProperty(String group, String name, object value)`
Setz den Wert einer Ressource oder Property in einer Gruppe.
Parameter
`group`	Der Name der Gruppe. Falls noch nicht vorhanden wird die Gruppe neu angelegt.
`name`	Der Name der Ressource oder Property.
`value`	Ein beliebiger Wert für die Property. Er wird automatisch in eine Zeichenkette konvertiert. Der Wert `None` führt zum Löschen der Property. Hinweis Diese Methode funktioniert auch für die Sonder-Gruppen 'env' und 'system'. Auf diesem Weg können Environment-Variablen oder System-Properties definiert werden. Werte in der Sonder-Gruppe 'qftest' können nicht überschrieben werden.

`void skipTestCase()`
Beendet die Ausführung des aktuellen Testfalls und markiert diesen als übersprungen.

`void skipTestSet()`
Beendet die Ausführung des aktuellen Testfallsatzes und markiert diesen als übersprungen.

`void stopTest()`
Beendet den aktuellen Testlauf.

`void stopTestCase(boolean expectedFail=false)`
Beendet die Ausführung des aktuellen Testfalls.
Parameter
`expectedFail`	Falls true, werden eventuelle Fehler in diesem Testfall als erwartete Fehler behandelt.

`void stopTestSet()`
Beendet die Ausführung des aktuellen Testfallsatzes.

`void syncThreads(String name, int timeout, int count=-1, boolean throw=true, int remote=0)`
Nur Server. Synchronisiert eine Anzahl von parallelen Threads für Lasttests. Der aktuelle Thread wird blockiert, bis alle Threads den Synchronisationspunkt erreicht haben oder die Wartezeit überschritten wird. In letzterem Fall wird eine `TestException` geworfen oder ein Fehler ausgegeben.
Parameter
`name`	Ein Identifikator für den Synchronisationspunkt.
`timeout`	Die maximale Wartezeit in Millisekunden.
`count`	Die Zahl der Threads auf die gewartet wird. Standardwert -1 bedeutet alle Threads in der aktuellen QF-Test Instanz.
`throw`	Entscheidet ob bei Überschreitung der Wartezeit eine Exception geworfen (Standard) oder eine Fehlermeldung ausgegeben wird.
`remote`	Die Zahl der QF-Test Instanzen - eventuell auf unterschiedlichen Rechnern - die synchronisiert werden sollen. Standardwert 0 bedeutet nur interne Synchronisation.

`void toServer(...)`
Nur SUT. Setzt globale Variablen im Jython oder Groovy Interpreter von QF-Test. Folgende Arten von Argumenten sind möglich: Ein String Dieser wird als Name einer globalen Variablen im lokalen Interpreter aufgefasst. Die Variable des selben Namens im Interpreter von QF-Test wird auf ihren Wert gesetzt. Ein Dictionary mit String Schlüsseln Für jeden Schlüssel im Dictionary wird einer globalen Variable dieses Namens der entsprechende Wert aus dem Dictionary zugewiesen. Ein Keyword Argument der Form `name=value` Die globale Variable namens `name` wird auf den Wert `value` gesetzt.

`void toSUT(String client, ...)`
Nur Server. Setzt globale Variablen im Jython oder Groovy Interpreter des SUT. Mit Ausnahme von `client` sind folgende Arten von Argumenten möglich: Ein String Dieser wird als Name einer globalen Variablen im lokalen Interpreter aufgefasst. Die Variable des selben Namens im Interpreter des SUT wird auf ihren Wert gesetzt. Ein Dictionary mit String Schlüsseln Für jeden Schlüssel im Dictionary wird einer globalen Variable dieses Namens der entsprechende Wert aus dem Dictionary zugewiesen. Ein Keyword Argument der Form `name=value` Die globale Variable namens `name` wird auf den Wert `value` gesetzt.
Parameter
`client`	Der Name des SUT Clients.

`void unsetOption(String name)`
Stellt den ursprünglichen Wert einer Option wieder her indem der Wert aus einem vorhergehenden Aufruf von `setOption` gelöscht wird.
Parameter
`name`	Der Name der zu löschenden Option, eine Konstante aus der Klasse `Options`, welche in Jython und Groovy Skripten automatisch importiert ist. Die Namen der Optionen, die auf diese Weise gesetzt werden können, sind in Kapitel 39 dokumentiert.

In manchen Fällen ist kein Runcontext verfügbar, insbesondere wenn eines der in den folgenden Abschnitten beschiebenen Interfaces zur Erweiterung von QF-Test implementiert wird. Das Modul qf ermöglicht Logging auch in diesen Fällen und bietet weitere allgemein hilfreiche Methoden, die keinen Runcontext benötigen. Es folgt eine alphabetische Aufstellung aller Methoden des qf Moduls. Sofern nicht anders angegeben sind die Methoden in Jython und Groovy sowohl für 'Server Skript' als auch 'SUT Skript' Knoten verfügbar.

Hinweis Die Groovy Syntax für Keyword-Parameter unterscheidet sich von Jython. Groovy verwendet ':' statt '='. Dies ist besonders tückisch, weil z.B. qf.logMessage("bla", report=true) durchaus legaler Groovy Code ist, der allerdings nicht den gewünschten Effekt hat. Das '=' ist hierbei eine Zuweisung mit dem Wert true, der dann ganz einfach als zweiter Parameter übergeben wird, so dass der Aufruf äquivalent ist zu qf.logMessage("bla", true). Hierbei wird true aber für dontcompactify statt report verwendet. Die korrekte Version für Groovy lautet qf.logMessage("bla", report:true).


`Pattern asPattern(String regexp)`
Diese Methode interpretiert die Eingabe als regulären Ausdruck (vgl. Abschnitt 47.3) und liefert das entsprechende Java Pattern-Objekt zurück. Die möglichen Eingabewerte sind in der Java API des Pattern-Objekts definiert.
Parameter
`regexp`	Der reguläre Ausdruck
Rückgabewert	Ein Pattern-Objekt, welches für Stringvergleiche genutzt werden kann.

`String getClassName(Object objectOrClass)`
Liefert den qualifizierten Namen der Klasse eines Java Objekts bzw. einer Java Klasse. Hauptsächlich für Jython sinnvoll, wo das Ermitteln des Namens einer Klasse richtig lästig werden kann.
Parameter
`objectOrClass`	Das Java Objekts oder die Klasse, deren Name ermittelt werden soll.
Rückgabewert	Der Name der Klasse oder None falls kein Java Objekt übergeben wird.

`Object getProperty(Object object, String name)`
Liest eine Property für ein Objekt, die vorher via `setProperty` gesetzt wurde.
Parameter
`object`	Das Objekt, für das die Property gelesen werden soll.
`name`	Der Name der Property.
Rückgabewert	Der Wert der Property.

`boolean isInstance(Object object, String className)`
Diese Methode ist eine Alternative zu `instanceof` in Groovy oder `isinstance()` in Jython, die gezielt nur Namen von Klassen oder Interfaces vergleicht und so Probleme mit unterschiedlichen ClassLoadern vermeidet.
Parameter
`object`	Das zu prüfende Object.
`className`	Der Name der Klasse oder des Interfaces auf das getestet wird.
Rückgabewert	True, wenn das Objekt einer Instanz der angegeben Klasse ist oder das angegebene Interface implementiert.

`void logError(String msg, boolean nowrap=false)`
Schreibt eine benutzerdefinierte Fehlermeldung in das Protokoll. Falls ein Runcontext verfügbar ist wird dieser genutzt und die Meldung sofort geschrieben. Andernfalls wird sie gepuffert und bei nächster Gelegenheit in das Protokoll übernommen.
Parameter
`msg`	Die Meldung.
`nowrap`	Falls true werden die Zeilen der Meldung im Report nicht umgebrochen. Sinnvoll für potentiell lange Meldungen. Falls die Meldung gepuffert werden muss, hat dieser Parameter keine Wirkung.

`void logMessage(String msg, boolean dontcompactify=false, boolean report=false, boolean nowrap=false)`
Schreibt eine Meldung in das Protokoll. Falls ein Runcontext verfügbar ist wird dieser genutzt und die Meldung sofort geschrieben. Andernfalls wird sie gepuffert und bei nächster Gelegenheit in das Protokoll übernommen.
Parameter
`msg`	Die Meldung.
`dontcompactify`	Falls true wird die Meldung nicht aus kompakten Protokollen entfernt
`report`	Falls true wird die Meldung im Report aufgeführt.
`nowrap`	Falls true werden die Zeilen der Meldung im Report nicht umgebrochen. Sinnvoll für potentiell lange Meldungen. Falls die Meldung gepuffert werden muss, hat dieser Parameter keine Wirkung.

`void logWarning(String msg, boolean report=true, boolean nowrap=false)`
Schreibt eine benutzerdefinierte Warnmeldung in das Protokoll. Falls ein Runcontext verfügbar ist wird dieser genutzt und die Meldung sofort geschrieben. Andernfalls wird sie gepuffert und bei nächster Gelegenheit in das Protokoll übernommen.
Parameter
`msg`	Die Meldung.
`report`	Falls true (default) wird die Warnung im Report aufgeführt. Sie können diese spezielle Warnung vom Report ausschließen, indem Sie diesen Parameter auf false setzen.
`nowrap`	Falls true werden die Zeilen der Meldung im Report nicht umgebrochen. Sinnvoll für potentiell lange Meldungen. Falls die Meldung gepuffert werden muss, hat dieser Parameter keine Wirkung.

`void print(Object object, ...)`
Schreibt eine Zeichenkette oder die String-Repräsentation eines Objektes in das Terminal. Sind mehrere Objekte angeben, werden deren Repräsentationen mit Leerzeichen getrennt aneinander gehängt. Im Gegensatz zu einem einfachen `print`-Ausdruck wird der Text nicht über die Standard-Ausgabe geleitet.
Parameter
`object`	Das Objekt, welches ausgegeben werden soll.

`void println(Object object)`
Schreibt eine Zeichenkette oder die String-Repräsentation eines Objektes in das Terminal und beginnt eine neue Zeile. Sind mehrere Objekte angeben, werden deren Repräsentationen mit Leerzeichen getrennt aneinander gehängt. Im Gegensatz zu einem einfachen `println`-Ausdruck wird der Text nicht über die Standard-Ausgabe geleitet.
Parameter
`object`	Das Objekt, welches ausgegeben werden soll.

`void setProperty(Object object, String name, Object value)`
Setzt eine beliebige Property für ein Objekt. Im Fall einer Swing, JavaFX, SWT oder Web Komponente wird der Wert in den Anwender-Daten via `putClientProperty`, `setData` oder `setProperty` gesetzt. Für alles andere kommt eine `WeakHashMap` zum Einsatz. In keinem Fall wird die Garbage Collection des Objekts durch die Property verhindert.
Parameter
`object`	Das Objekt, für das die Property gesetzt werden soll.
`name`	Der Name der Property.
`value`	Der zu setzende Wert. Null um die Property zu löschen.

`String toString(Object object, String nullValue)`
Liefert die String-Darstellung eines Objekts. Vor allem für Jython hilfreich, aber auch für Groovy dank der Default-Konvertierung von None in den leeren String hilfreich.
Parameter
`object`	Das zu konvertierende Objekt.
`nullValue`	Der zu liefernde Wert falls das Objekt None ist, Default ist der leere String.
Rückgabewert	Jython 8-bit oder Unicode Strings werden unverändert zurückgegeben, Java Objekte werden via `toString` in einen String verwandelt. In Jython wird alles andere in einen 8-bit Jython String konvertiert.

Die Image API stellt Klassen und Interfaces bereit, um Bildschirmabbilder zu erstellen, Bilder in Dateien zu speichern oder zu aus Dateien zu laden. Es können auch eigene Bildvergleiche durchgeführt werden. The image API ist so konzipiert, dass im Allgemeinen keine Exceptions geworfen werden. Um dennoch auf mögliche Fehler eingehen zu können, werden Warnungen geloggt.

Um Bildschirmabbilder zu erstellen, können Sie die Jython Klasse ImageWrapper aus dem Modul imagewrapper.py verwenden. Dieses Modul wird mit dem QF-Test Installationspaket mitgeliefert.

Hier sehen Sie ein kleines Jython Beispiel, um die Verwendung der Image API darzustellen:

from imagewrapper import ImageWrapper

#create ImageWrapper instance
iw = ImageWrapper(rc)

#take screenshot of the whole screen
currentScreenshot = iw.grabScreenshot()

#save screenshot to a file
iw.savePng("/tmp/screenshot.png", currentScreenshot)

Beispiel 48.2: Image API in Jython

Das gleiche mit Groovy:

import de.qfs.ImageWrapper

def iw = new ImageWrapper(rc)
def currentScreenshot = iw.grabScreenshot()
iw.savePng("/tmp/screenshot.png", currentScreenshot)

Beispiel 48.3: Image API in Groovy

Es folgt eine alphabetische Aufstellung aller Methoden der ImageWrapper Klasse. Die verwendete Syntax ist ein Gemisch aus Java und Python. Python unterstützt zwar selbst keine statische Typisierung, die Parameter werden jedoch an Java weitergereicht, so dass falsche Typen Exceptions auslösen können. Folgt einem Parameter ein '=' Zeichen und ein Wert, ist dies der Defaultwert des Parameters und eine Angabe beim Aufruf ist optional.


`ImageWrapper ImageWrapper(RunContext rc)`
Konstruktor der `ImageWrapper` Klasse.
Parameter
`rc`	Der aktuell Runcontext von QF-Test.

`int getMonitorCount()`
Liefert die Anzahl aller Monitor zurück.
Rückgabewert	Die Anzahl der Monitore.

`ImageRep grabImage(Object com, int x=None, int y=None, int width=None, int height=None)`
Erstellt ein Bildschirmabbild einer spezifischen Komponente. Wenn die Parameter x, y, with und height gesetzt werden, dann wird ein Bildschirmabbild des beschriebenen Teilbereiches der Komponente erstellt.
Parameter
`com`	Die QF-Test ID der Komponente.
`x`	Die X-Koordinate der linken oberen Ecke des Teilbereiches.
`y`	Die Y-Koordinate der linken oberen Ecke des Teilbereiches.
`width`	Die Breite des Teilbereiches.
`height`	Die Höhe des Teilbereiches.
Rückgabewert	Ein `ImageRep` Objekt, welches das aktuelle Bildschirmabbild beinhaltet.

`ImageRep grabScreenshot(int x=None, int y=None, int width=None, int height=None)`
Erstellt ein Bildschirmabbild des gesamten Bildschirms. Wenn die Parameter x, y, with und height gesetzt werden, dann wird ein Bildschirmabbild des beschriebenen Teilbereiches erstellt.
Parameter
`x`	Die X-Koordinate der linken oberen Ecke des Teilbereiches.
`y`	Die Y-Koordinate der linken oberen Ecke des Teilbereiches.
`width`	Die Breite des Teilbereiches.
`height`	Die Höhe des Teilbereiches.
Rückgabewert	Ein `ImageRep` Objekt, welches das aktuelle Bildschirmabbild beinhaltet.

`ImageRep[] grabScreenshots(int monitor=None)`
Erstellt Bildschirmabbilder aller vorhandenen Monitore. Diese Methode ist von Nutzen, wenn Sie mehr als einen Monitor verwenden. Wenn Sie ein Bildschirmabbild eines speziellen Monitors machen wollen, dann können Sie das mit Hilfe des `monitor` Parameters.
Parameter
`monitor`	Index des Monitors. Der Index für den ersten ist 0, der für den zweiten 1 etc.
Rückgabewert	Ein Feld von `ImageRep` Objekten aller Bildschirmabbilder oder das spezielle `ImageRep` Objekt, wenn der `monitor` Parameter gesetzt wurde.

`ImageRep loadPng(String filename)`
Lädt ein Bild aus einer angegebenen Datei und liefert ein `ImageRep` Objekt zurück. Die Datei muss im PNG Format sein.
Parameter
`filename`	Die Datei, in der das Bild gespeichert ist.
Rückgabewert	Ein `ImageRep` Objekt, das das geladene Bild enthält.

`void savePng(String filename, ImageRep image)`
Speichert ein angegebenes `ImageRep` Objekt in eine Datei. Das Bild wird PNG formatiert.
Parameter
`filename`	Der Pfad zu Zieldatei, wo das Bild gespeichert werden soll.
`image`	Das abzuspeichernde `ImageRep` Objekt.

Alle QF-Test Exceptions, die in Kapitel 41 aufgeführt sind, werden in Jython automatisch importiert und stehen in Skripts für try/except zur Verfügung, z.B.:

try:
    com = rc.getComponent("someId")
except ComponentNotFoundException:
    ...

In Groovy müssen die Exceptions erst importiert werden:

import de.qfs.apps.qftest.shared.exceptions.
      ComponentNotFoundException

try {
    com = rc.getComponent("someId")
} catch (ComponentNotFoundException) {
    ...
}

Explizit sollten aus Skriptcode nur die folgenden Exceptions geworfen werden (mit raise bzw. throw new):

UserException("Irgendeine Meldung...") dient als Signal für eine außergewöhnliche Fehlersituation.
BreakException() oder raise BreakException("loopId") kann dazu verwendet werden, um aus einer 'Schleife' oder einem 'While' Knoten auszubrechen. Die Variante ohne Parameter unterbricht die innerste Schleife, mit der QF-Test ID als Parameter kann gezielt eine bestimmte Schleife abgebrochen werden.
ReturnException() oder ReturnException("value") kann - mit oder ohne Rückgabewert - zur Rückkehr aus einer 'Prozedur' verwendet werden, analog zu einem 'Return' Knoten.

Wenn Sie mit Jython Modulen arbeiten, müssen Sie nach der Änderung eines Moduls QF-Test oder das SUT nicht neu starten sondern können mit Hilfe von reload(<Modulname>) das Modul erneut laden.

Das Debuggen von Skripten in einem eingebetteten Interpreter kann etwas mühsam sein. Um es zu vereinfachen bietet QF-Test Terminalfenster für die Kommunikation mit allen Jython Interpretern an. Diese Terminals sind über das »Clients« Menü oder über »Extras«-»Jython Terminal...« zugänglich.

Alternativ können Sie eine Netzwerkverbindung zu einem Jython Interpreter aufbauen, um eine interaktive Kommandozeile zu erhalten. Dies funktioniert sowohl mit QF-Test als auch mit dem SUT. Um dieses Feature zu aktivieren, müssen Sie QF-Test mit dem Kommandozeilenargument -jythonport <Nummer> starten, mit dem Sie die Portnummer für den Zugang zum Jython Interpreter angeben. Für das SUT definieren Sie diese mit Hilfe eines 'Programm-Parameter' in der "Extra" Tabelle des 'Java SUT Client starten' oder 'SUT Client starten' Knotens. Setzen Sie dieses auf -jythonport=<Portnummer>. Anschließend können Sie sich mittels

telnet localhost <Portnummer>

mit dem entsprechenden Jython Interpreter verbinden. Dank Jythons Möglichkeiten zum Zugriff auf das gesamte Java API erhalten Sie auf diesem Weg sogar eine ganz allgemeine interaktive Debugging-Schnittstelle zu Ihrer Applikation.

48
Skripting (Jython, Groovy und JavaScript)

48.1
Pfad für das Laden der Module

48.2
Das Plugin Verzeichnis

48.3
Initialisierung (Jython)

48.4
Die Namespace Umgebung für Skript Knoten (Jython)

48.5
Das API des Runcontexts

48.6
Das `qf` Modul

3.0+48.7
Image API

48.7.1
Die `ImageWrapper` Klasse

48.8
Exceptions

48.9
Debuggen von Skripten (Jython)

3.0+48.7Image API

3.0+48.7
Image API