Doctags

Neben den Eigenschaften der unterschiedlichen Knoten bietet QF-Test noch weitere Möglichkeiten an, um das Verhalten bei der Testausführung bzw. die Darstellung der Knoten im Report zu beeinflussen. Im Attribut 'Bemerkung' von Knoten können Doctags der Form @teststep oder @noreport node eingetragen werden. Diese müssen nach der allgemeinen Beschreibung des Knotens stehen.

Doctags für Reporting und Dokumentation

Doctags, die für die Formatierung der Testdokumentation von 'Testfallsätzen' und 'Testfällen' genutzt werden können, sind in Abschnitt 21.2 beschrieben, für die Formatierung der Dokumentation für 'Packages' und 'Prozeduren' in Abschnitt 21.3.

Die nachstehend beschriebenen Doctags beeinflussen die Darstellung der Knoten im Report.

DoctagKnotenBeschreibung
@teststep [name]Alle Knoten Ist dieses Doctag gesetzt, so wird dieser Knoten als 'Testschritt' im Report behandelt. Es kann ein optionaler Name angegeben werden.
@report'Check' Knoten, 'Sequenz mit Zeitlimit', 'Server HTTP Request' KnotenIst dieses Doctag gesetzt, so wird dieser Knoten auf jeden Fall im Report als Check aufgeführt.
@noreport [type],[errorlevel]Alle Sequenzknoten wie 'Testfallsatz','Testfall' oder 'Testschritt' sowie alle Check Knoten, Sequenz mit Zeitlimit, Request KnotenIst dieses Doctag gesetzt, so wird dieser Knoten nicht im HTML Report aufgeführt. Details zur Konfiguration, siehe Abschnitt 58.1.1.
@link [filePath/url]Alle Knoten Dieses Doctag kann - bei Bedarf mehrfach - verwendet werden, um eine externe Datei oder Ressource zu verknüpfen. Diese kann dann per Rechtsklick und Auswahl des entsprechenden Eintrags im Popup-Menü entweder mit dem passenden Standardprogramm geöffnet, oder im Datei-Manager angezeigt werden (»Verknüpfung öffnen« bzw. »Datei im Explorer anzeigen«). Dateien werden relativ zur aktuellen Testsuite aufgelöst.
Tabelle 58.1:  Doctags für Report und Dokumentation

4.2+58.1.1
@noreport Doctag

Das @noreport Doctag kann bestimmte Knoten aus dem Report herausfiltern. Um die Filterung genauer zu spezifizieren, können Sie auch die zwei optionalen Parameter type und errorlevel konfigurieren. Syntaxbeispiel: @noreport tree;errorlevel<=WARNING.

type
Hier können Sie entweder 'tree' oder 'node' angeben. 'tree' ist hier auch die Standardbelegung, falls nichts angegeben wurde. Die Angabe von 'tree' filtert diesen Knoten und alle Kindknoten aus der Reporterstellung. 'node' filtert nur diesen einen Knoten aus dem Report heraus, die Kindknoten werden aber wieder im Report dargestellt.
errorlevel
Dieser Parameter ist nur bei Sequenzknoten wie 'Testfallsatz', 'Testfall' oder 'Testschritt' aktiv. Mit diesem Parameter ist es möglich, Knoten nur zu filtern, wenn eine Fehlerstufe erreicht wurde. Hier können Sie die Fehlerstufen EXCEPTION, ERROR, WARNING oder MESSAGE mit >,<,<= oder >= angeben. Mit errorlevel<ERROR wird der Knoten nur gefiltert, wenn kein Fehler und keine Exception aufgetreten ist, dies ist auch die Standardbelegung. errorlevel>=MESSAGE wird der Knoten immer gefiltert, egal, welches Ergebnis. Das ist natürlich sehr gefährlich und sollte nur bei sehr guten Gründen verwendet werden.

Doctags für Robot Framework

Die folgenden Doctags dienen dazu, 'Prozeduren' oder ganze 'Packages' von QF-Test für die Nutzung in Robot Framework auszuzeichnen. Weitere Informationen zur Integration mit Robot Framework finden Sie in Kapitel 28.

DoctagKnotenBeschreibung
@keyword [name]Prozeduren

Bei Verwendung in einem 'Prozedur' Knoten wird der Name der Prozedur - oder der optional nach dem Doctag angebene Name - als Keyword an Robot Framework übergeben. Es genügt dabei, eine der von Robot Framework unterstützten Formen anzugeben, die anderen konvertiert Robot Framework selbst. So kann z.B. eine Prozedur namens doClick automatisch auch über die Keywords "Do Click" oder "do_click" aufgerufen werden. Das Doctag kann mehrfach angegeben werden, um die Prozedur für mehrere Keywords zu nutzen. Der implizite Parameter "__keyword" gibt dabei immer das aufgerufene Keyword in der von QF-Test spezifizierten Form an.

@keywordPackages In 'Package' Knoten dient das @keyword Doctag ohne Argument dazu, alle direkt oder indirekt enthaltenen Prozeduren - basierend auf ihrem Namen - als Keywords auszuzeichnen.
@tag [name]Prozeduren Mit dem Doctag @tag in 'Prozedur' Knoten angegebene Namen werden an Robot Framework als Tags durchgereicht.
Tabelle 58.2:  Doctags für die Robot Framework Integration

Doctags für die Ausführung

Dieses Doctag beeinflusst das Verhalten von Knoten während der Testausführung.

DoctagKnotenBeschreibung
@rerun [parameters]Alle KnotenHiermit wird die sofortige Neuausführung von Knoten im Fehlerfall konfiguriert. Details, siehe Abschnitt 22.3.2.
@outputFilter keep [regexp]Alle SUT Client Starter Knoten Nur die Zeilen in der Ausgabe des vom Knoten gestarteten Prozesses, welche den angegebenen regulären Ausdruck enthalten, werden im QF-Test Terminal angezeigt.
@outputFilter drop [regexp]Alle SUT Client Starter Knoten Zeilen in der Ausgabe des vom Knoten gestarteten Prozesses, welche den angegebenen regulären Ausdruck enthalten, werden nicht im QF-Test Terminal angezeigt.
Tabelle 58.3:  Doctags für die Ausführung

Doctags für das Editieren

Diese Doctags beeinflussen das Verhalten von QF-Test während des Editierens.

DoctagKnotenBeschreibung
@blueAlle KnotenBeim nächsten Laden der Testsuite wird dieser Knoten mit einer blauen Marke versehen.
@breakpointAlle KnotenSetzt einen Breakpoint auf diesen Knoten beim nächsten Laden der Testsuite.
@greenAlle KnotenBeim nächsten Laden der Testsuite wird dieser Knoten mit einer grünen Marke versehen.
@redAlle KnotenBeim nächsten Laden der Testsuite wird dieser Knoten mit einer roten Marke versehen.
@yellowAlle KnotenBeim nächsten Laden der Testsuite wird dieser Knoten mit einer gelben Marke versehen.
Tabelle 58.4:  Doctags für das Editieren

Doctags für den Prozedurgenerator

Diese Doctags werden ausschließlich in der Definitionsdatei des Prozedurgenerators verwendet und beeinflussen dessen Wirkung. Eine detaillierte Beschreibung finden Sie in Kapitel 52. Allgemeine Informationen zum Prozedurgenerator finden Sie in Kapitel 24.