59.2 Daemon API
Um QF-Test im Daemon-Modus von einer weiteren QF-Test Instanz oder einem anderen Werkzeug zur Durchführung von QF-Test basierten Tests einzusetzen müssen folgende relativ einfache Schritte implementiert werden:
Hinweis Wenn Sie eine auf dem Daemon API basierende Anwendung schreiben, müssen Sie sich über Sicherheitsthemen Gedanken machen und Sicherheit entweder deaktivieren, oder einige RMI-spezifische Properties setzen. Näheres hierzu finden Sie in "Absicherung des QF-Test Daemon".
-
Nutzen Sie den
DaemonLocator, um damit Zugriff auf einenDaemonzu erhalten. -
Holen Sie sich entweder den gemeinsamen
TestRunDaemonoder weisen Sie denDaemonan, einenTestRunDaemonzu erzeugen. Über diesenTestRunDaemonkönnen Sie globale Variablen und das Wurzelverzeichnis der Testsuiten für die kommenden Testläufe definieren. -
Holen Sie sich entweder den gemeinsamen
DaemonRunContextdesTestRunDaemonoder lassen Sie diesen eine oder mehrere Instanzen vonDaemonRunContexterzeugen. EinDaemonRunContextrepräsentiert den Ausführungs-Kontext für einen funktionalen Test oder Lasttest. JederDaemonRunContextist eigenständig, mit Ausnahme von Gruppen die mittelsTestRunDaemon.createContexts(int threads)erstellt wurden. Diese bilden einen gemeinsamen Kontext für Lasttests, analog zum Start von QF-Test mit dem Kommandozeilenargument-threads <Anzahl>. JederDaemonRunContextbelegt eine QF-Test Entwickler- oder Runtime Lizenz für die Dauer seines Bestehens. -
Nun können Sie den
DaemonRunContextanweisen, Tests in Ihrem Namen durchzuführen, wahlweise ganze Testsuiten oder spezifische Testfallsatz oder Testfall Knoten. Mit richtig implementierten Abhängigkeiten können Sie im Daemon-Modus einzelne Testfälle in beliebiger Reihenfolge ausführen, ohne sich um die nötigen Vorbereitungs- und Aufräumarbeiten kümmern zu müssen. -
Der
DaemonRunContextbietet auch Methoden zur Abfrage des aktuellen Status eines Tests oder zum Warten auf sein Ende an. - Schließlich können Sie noch das Protokoll des Testlauf vom Daemon abholen. Im Moment können Sie dieses lediglich in eine Datei speichern. Später planen wir die API weiter zu öffnen, um zum Beispiel Protokolle von verschiedenen Testläufen aus potenziell verschiedenen Daemons in einem Protokoll zusammenzufassen.
Beim Übergang von einem Testfall zum nächsten kann die korrekte Abarbeitung der
Abhängigkeiten - inklusive das Auflösen der nicht mehr benötigten Abhängigkeiten auf dem
Stapel - nur dann funktionieren, wenn immer der selbe DaemonRunContext
verwendet wird. Dies erreichen Sie am einfachsten durch Verwendung der gemeinsamen
TestRunDaemon und DaemonRunContext Objekte. Das Erzeugen von
eigenen Objekten macht nur in Spezialfällen Sinn.
Die folgenden Abschnitte enthalten eine komplette Referenz der gesamten Daemon API. Erläuterungen und Beispiele zu deren Verwendung finden Sie in "Testausführung im Daemonmodus".
59.2.1 Der DaemonLocator
Über die Singleton Klasse de.qfs.apps.qftest.daemon.DaemonLocator kann auf
Daemon Instanzen zugegriffen werden.
Liefert einen Daemon für einen spezifischen Host und Port.
Alle bekannten Daemons lokalisieren.
Legt den Keystore fest, welcher für die Sicherung der Daemon-Kommunikation verwendet werden soll.
Legt das Passwort für den Keystore fest, der mit setKeystore gesetzt wurde.
Legt den Truststore fest, welcher für die Sicherung der Daemon-Kommunikation verwendet werden soll.
Wenn dieser nicht gesetzt ist dann wird der Keystore verwendet, der mit setKeystore gesetzt wurde.
59.2.2 Der Daemon
Das de.qfs.apps.qftest.daemon.Daemon Interface bietet einen Rahmen für
verschiedene Arten von QF-Test Daemons. Aktuell ist nur der TestRunDaemon
verfügbar, weitere Klassen wie ein SUTClientStarterDaemon sind bereits in
Planung und weitere werden eventuell folgen.
Räumt alle TestRunDaemons dieses Daemons und beendet dann alle Clients. Auf ein eventuelles Auflösen von Abhängigkeiten wird maximal 30 Sekunden gewartet.
RemoteExceptionRäumt alle TestRunDaemons dieses Daemons und beendet dann alle Clients.
RemoteExceptionErzeugt einen TestRunDaemon.
RemoteExceptionLiefert den Host des Daemons.
RemoteExceptionLiefert die IP-Adresse des Daemons.
RemoteExceptionLiefert den Port des Daemons.
RemoteExceptionLiefert den gemeinsamen TestRunDaemon.
RemoteExceptionLiefert alle von diesem Daemon erzeugten TestRunDaemons, die noch aktiv sind.
RemoteExceptionBeendet alle Clients, die zur VM des Daemons gehören.
RemoteException59.2.3 Der TestRunDaemon
Der de.qfs.apps.qftest.daemon.TestRunDaemon ist der Einstiegspunkt für die
Ausführung von Tests. Er stellt die Umgebung für Testläufe bereit und erstellt
DaemonRunContext Objekte welche die eigentliche Durchführung übernehmen.
59.2.3.1 Verschiedenes
59.2.3.2 Bearbeiten globaler Variablen
Der TestRunDaemon hält einen eigenen Satz globaler Variablen vor, die zur Initialisierung der globalen Variablen beim Erzeugen eines neuen DaemonRunContext dienen. Die folgenden Methoden haben keinen Einfluss auf bereits laufende DaemonRunContext Instanzen.
Liefert den Wert einer globalen Variable.
RemoteException
9.0+ Liefert den Wert einer globalen Variable.
Bei der Verarbeitung des gelieferten Objekts ist zu beachten, dass die Eigenschaften und Methoden des Objekts auch davon abhängig sind, mit welchem Skriptinterpreter das Objekt erstellt wurden.
RemoteException
9.0+ Liefert die Werte aller globalen Variablen.
Bei der Verarbeitung der gelieferten Objekte ist zu beachten, dass die Eigenschaften und Methoden der Objekte auch davon abhängig sind, mit welchem Skriptinterpreter die Objekte erstellt wurden.
RemoteException59.2.3.3 Testausführung
Räumt alle DaemonRunContexte dieses TestRunDaemons auf und gibts sie frei. Auf ein eventuelles Auflösen von Abhängigkeiten wird maximal 30 Sekunden gewartet.
RemoteExceptionRäumt alle DaemonRunContexte dieses TestRunDaemons auf und gibts sie frei.
RemoteExceptionErzeugt einen einzelnen Daemon Runcontext. Hierfür wird eine Lizenz benötigt und belegt.
RemoteExceptionErzeugt Daemon-Runcontext-Objekte für mehrere Threads. Es wird eine Lizenz je Thread benötigt und belegt.
RemoteExceptionLiefert alle von diesem TestRunDaemon erzeugten DaemonRunContexte, die noch aktiv sind und nicht freigegeben wurden.
RemoteException59.2.3.4 Identifikation
Liefert den Namen zur Identifikation des TestRunDaemons. Wurde kein Name explizit via setIdentifier gesetzt, wird ein Name aus dem Namen des Daemons, zu dem der TestRunDaemon gehört, sowie einem Zähler gebildet.
RemoteException59.2.4 Der DaemonRunContext
Das de.qfs.apps.qftest.daemon.DaemonRunContext Interface dient der
eigentlichen Testdurchführung.
Folgende Laufzustände sind definiert:
| Status | Wert | Beschreibung |
|---|---|---|
STATE_INVALID |
-1 |
Ungültig nach der Freigabe - kann nicht reaktiviert werden. |
STATE_IDLE |
0 |
Kein Lauf geplant. |
STATE_SCHEDULED |
1 |
Lauf geplant aber nicht gestartet. |
STATE_RUNNING |
2 |
Laufend. |
STATE_PAUSED |
3 |
Laufend aber pausiert. |
STATE_FINISHED |
4 |
Lauf beendet, Resultat und Protokoll verfügbar. |
6.0+
Die folgenden Ergebnis-Werte für die Methode getResult() sind die gleichen wie überall in QF-Test:
| Ergebnis | Wert | Beschreibung |
|---|---|---|
RESULT_OK |
0 |
Lauf OK, keine Warnungen, Fehler oder Exceptions. |
RESULT_WARNING |
1 |
Lauf weitgehend OK, einige Warnungen aber keine Fehler oder Exceptions. |
RESULT_ERROR |
2 |
Lauf mit Fehlern aber ohne Exceptions. |
RESULT_EXCEPTION |
3 |
Lauf mit Exception fehlgeschlagen. |
Registriert einen DaemonTestRunListener beim DaemonRunContext.
Führt eine Prozedur in diesem Runcontext aus.
Suite#Procedure,
wobei Procedure der vollständige Name einer Prozedur sein muss.
RemoteExceptionIllegalStateExceptionLöscht die globalen Variablen des DaemonRunContext.
RemoteExceptionLiefert den Wert einer globalen Variable als String im DaemonRunContext.
RemoteException
9.0+ Liefert den Wert einer globalen Variable im DaemonRunContext.
Bei der Verarbeitung des gelieferten Objekts ist zu beachten, dass die Eigenschaften und Methoden des Objekts auch davon abhängig sind, mit welchem Skriptinterpreter das Objekt erstellt wurden.
RemoteException
9.0+ Liefert alle globalen Variablen im DaemonRunContext.
Bei der Verarbeitung der gelieferten Objekte ist zu beachten, dass die Eigenschaften und Methoden der Objekte auch davon abhängig sind, mit welchem Skriptinterpreter die Objekte erstellt wurden.
RemoteExceptionLiefert alle globalen Variablen als Strings im DaemonRunContext.
RemoteException
9.0+ Liefert den Wert eines Gruppen-Objekts (Property oder Ressource) im DaemonRunContext.
Bei der Verarbeitung des gelieferten Objekts ist zu beachten, dass die Eigenschaften und Methoden des Objekts auch davon abhängig sind, mit welchem Skriptinterpreter das Objekt erstellt wurden.
RemoteException
9.0+ Liefert alle Objekte einer Property- oder Ressource-Gruppe im DaemonRunContext.
Bei der Verarbeitung der gelieferten Objekte ist zu beachten, dass die Eigenschaften und Methoden der Objekte auch davon abhängig sind, mit welchem Skriptinterpreter die Objekte erstellt wurden.
RemoteExceptionLiefert den Namen zur Identifikation des DaemonRunContexts. Wurde kein Name explizit via setIdentifier gesetzt, wird ein Name aus dem Namen des TestRunDaemons, zu dem der DaemonRunContext gehört, sowie einem Zähler gebildet.
RemoteExceptionLiefert den Namen der aktuell oder zuletzt von diesem DaemonRunContext ausgeführt wird oder wurde.
RemoteExceptionLiefert die Zahl der Threads in der Gruppe zu welcher der DaemonRunContext gehört.
RemoteExceptionLiefert alle Properties einer Property- oder Ressource-Gruppe als Strings im DaemonRunContext.
RemoteExceptionLiefert den Wert einer Property oder Ressource als String im DaemonRunContext.
RemoteExceptionLiefert das Resultat des Testlaufs.
RemoteExceptionIllegalStateExceptionLiefert das Protokoll des Testlaufs.
RemoteExceptionIllegalStateExceptionLiefert den aktuellen Laufzustand des Runcontext.
RemoteExceptionLiefert den TestRunDaemon zu dem der DaemonRunContext gehört.
RemoteExceptionLiefert den Thread-Index des DaemonRunContext.
RemoteExceptionGibt den DaemonRunContext frei und auch die Lizenz, die dieser belegt hatte. Wenn ein Test läuft, wird dieser angehalten.
RemoteExceptionIllegalStateExceptionEntfernt einen DaemonTestRunListener vom DaemonRunContext.
Löst die Abhängigkeiten dieses DaemonRunContext auf.
RemoteExceptionIllegalStateExceptionStartet einen Test in diesem Runcontext.
Suite#Test, wobei
#Test optional ist und Test der vollständige Name eines
Testfallsatzes oder Testfalls oder ein "." sein kann. Letzteres ist äquivalent zur
Angabe von Suite alleine und bewirkt das Ausführen der ganzen
Testsuite. Beispiele:
MySuite |
Führt die ganze Testsuite MySuite aus. |
|
MySuite#. |
Führt die ganze Testsuite MySuite aus. |
|
MySuite#MyTestSet |
Führt den Testfallsatz MyTestSet in der Testsuite MySuite
aus. |
|
MySuite#MyTestSet.MyTestCase |
Führt den Testfall MyTestCase aus, der sich im Testfallsatz
MyTestSet in der Testsuite MySuite befindet. |
RemoteExceptionIllegalStateExceptionSetzt einen Namen zur Identifikation des DaemonRunContexts. Dies kann nützlich sein, um einen DaemonRunContext zu identifizieren, der via TestRunDaemon.getContexts() ermittelt wurde.
RemoteExceptionSetzt die globalen Variablen des DaemonRunContext.
RemoteExceptionSetzt das Testsuite-Wurzelverzeichnis für den nächsten Testlauf.
RemoteExceptionHält den Testlauf an.
RemoteExceptionIllegalStateExceptionWartet bis der Runcontext einen vorgegebenen Zustand erreicht.
RemoteException59.2.5 Der DaemonTestRunListener
Das Interface de.qfs.apps.qftest.daemon.DaemonTestRunListener ist identisch
zum Interface de.qfs.apps.qftest.extensions.qftest.TestRunListener, welches
in "Listener für den aktuellen Testlauf" beschrieben wird, außer dass seine Methoden
eine RemoteException bei RMI Problemen werfen können.
Wenn Sie dieses Interface implementieren, müssen Sie von der Klasse
java.rmi.server.UnicastRemoteObject ableiten.
Sie können den Listener beim DaemonRunContext mittels seiner Methode
addTestRunListener registrieren, die im vorhergehenden Abschnitt
beschrieben wurde.
Es gibt immer nur ein einziges
DaemonLocatorObjekt und diese Methode ist der einzige Weg, Zugriff auf diese Singleton Instanz zu erlangen.