Das checkerberry-atdd-html-maven-plugin
ermöglicht es aus den XML-Dateien, die bei der Auswertung der User
Stories entstehen, einen HTML-Report zu generieren. Dazu wird die Datei
acceptancetest.xml benötigt, die von dem
checkerberry-atdd-maven-plugin erzeugt wird (siehe
Abschnitt 4.3.1, „Maven-Plugin“).
Um einen HTML-Report aus der Datei
acceptancetest.xml zu generieren, ist es notwendig,
das checkerberry-atdd-html-maven-plugin mit dem
Maven-Goal html-acceptance-tests aufzurufen. Der
vollständige Name des Maven-Goals lautet
de.conceptpeople.checkerberry:checkerberry-atdd-maven-plugin:3.1.x:html-acceptance-tests.
Das Plugin erzeugt aus der Datei acceptancetest.xml
einen HTML-Report. Die Akzeptanztests werden zum einen tabellarisch
angezeigt und zum anderen auch als Tortengrafik dargestellt. Diese
Grafik wird ebenfalls von dem Plugin erzeugt und im gleichen Ordner
wie die HTML-Datei des Reports abgespeichert.
Der informative Inhalt der HTML-Datei wird aus der Datei
acceptancetest.xml generiert. Diese Datei wird von
dem checkerberry-atdd-maven-plugin erzeugt (siehe
dazu Abschnitt 4.3.1, „Maven-Plugin“). Standardmäßig wird die
Datei in src/resources/acceptancetest.xml erwartet.
Über den Parameter <pathXmlTestFile> lässt
sich ein alternativer Pfad setzen.
Mit der Datei acceptanceTestHtmlTemplate.vm
wird die Struktur des HTML-Reports bestimmt. Es ist möglich ein
eigenes Template anzugeben und so das Aussehen des HTML-Reports zu
verändern. Standardmäßig liegt die Datei
acceptanceTestHtmlTemplate.vm in
src/main/rescources und kann über den Parameter
<pathTemplateFile> angepasst werden.
Ebenfalls ist es mögliche andere CSS-Dateien anzugeben um den
Style des HTML-Reports anzupassen. Die Farben für die Statusanzeige
werden in der Datei styleColor.vm, angepasst,
während die Datei style.vm, den eigentlichen Style
des HTML-Reports festgelegt. Standardmäßig findet man diese Dateien in
src/main/resources. Wenn eine andere Datei oder ein
anderes Verzeichnis verwenden werden soll, kann das über den Parameter
<pathColorCssFile> bzw. den Parameter
<pathCssFile> gesetzt werden.
Über den Parameter <siteName> ist es
möglich den Namen des HTML-Reports zu setzen. Standardmäßig wird der
Name „Akzeptanztests“ verwendet.
Das Encoding der Ausgabedatei
Akzeptantztest.html kann über den Parameter
<encoding> gesetzt werden. Darüber hinaus
kann über den Parameter <outputDirectory>
bestimmt werden, wohin die Ausgabedatei geschrieben wird. In der
nachfolgenden Tabelle sind die verschiedenen Parameter
zusammengefasst.
| Name | Type | Description |
|---|---|---|
| encoding | String | Setzt das Encoding, welches beim Schreiben der
Ausgabedatei verwendet wird. Default value is: UTF-8 |
| siteName | String | Setzt den Dateinamen des HTML-Reports. Default value is: Akzeptanztests |
| pathColorCssFile | String | Setzt den Pfad für die CSS-Datei, die die
Farbeinstellungen für den Status regelt. Default value is: src/main/resources/templates/styleColor.vm |
| pathCssFile | String | Setzt den Pfad für die CSS-Datei, die für den Style des
HTML-Reports verantwortlich ist. Default value is: src/main/resources/templates/style.vm |
| outputDirectory | String | Setzt den Pfad zu dem Zielverzeichnis des HTML-Reports
(inklusive der Grafik). Default value is: src/main/resources |
| pathXmlTestFile | String | Setzt den Pfad auf die XML-Datei mit den Testfällen.
Default value is: src/main/resources/acceptancetest.xml |
| pathTemplateFile | String | Setzt den Pfad für die Template-Datei aus der der
HTML-Report generiert wird. Default value is: src/main/resources/templates/acceptanceTestHtmlTemplate.vm |