2 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
3 <title>4.5. Die kivitendo-Test-Suite</title><link rel="stylesheet" type="text/css" href="style.css"><meta name="generator" content="DocBook XSL Stylesheets V1.76.1-RC2"><link rel="home" href="index.html" title="kivitendo 3.5.0: Installation, Konfiguration, Entwicklung"><link rel="up" href="ch04.html" title="Kapitel 4. Entwicklerdokumentation"><link rel="prev" href="ch04s04.html" title="4.4. Translations and languages"><link rel="next" href="ch04s06.html" title="4.6. Stil-Richtlinien"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.5. Die kivitendo-Test-Suite</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch04s04.html">Zurück</a> </td><th width="60%" align="center">Kapitel 4. Entwicklerdokumentation</th><td width="20%" align="right"> <a accesskey="n" href="ch04s06.html">Weiter</a></td></tr></table><hr></div><div class="sect1" title="4.5. Die kivitendo-Test-Suite"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="devel.testsuite"></a>4.5. Die kivitendo-Test-Suite</h2></div></div></div><div class="sect2" title="4.5.1. Einführung"><div class="titlepage"><div><div><h3 class="title"><a name="devel.testsuite.intro"></a>4.5.1. Einführung</h3></div></div></div><p>kivitendo enthält eine Suite für automatisierte Tests. Sie
4 basiert auf dem Standard-Perl-Modul
5 <code class="literal">Test::More</code>.</p><p>Die grundlegenden Fakten sind:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Alle Tests liegen im Unterverzeichnis
6 <code class="filename">t/</code>.</p></li><li class="listitem"><p>Ein Script (bzw. ein Test) in <code class="filename">t/</code>
7 enthält einen oder mehrere Testfälle.</p></li><li class="listitem"><p>Alle Dateinamen von Tests enden auf <code class="literal">.t</code>.
8 Es sind selbstständig ausführbare Perl-Scripte.</p></li><li class="listitem"><p>Die Test-Suite besteht aus der Gesamtheit aller Tests,
9 sprich aller Scripte in <code class="filename">t/</code>, deren Dateiname
10 auf <code class="literal">.t</code> endet.</p></li></ul></div></div><div class="sect2" title="4.5.2. Voraussetzungen"><div class="titlepage"><div><div><h3 class="title"><a name="devel.testsuite.prerequisites"></a>4.5.2. Voraussetzungen</h3></div></div></div><p>Für die Ausführung werden neben den für kivitendo eh schon
11 benötigten Module noch weitere Perl-Module benötigt. Diese
12 sind:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
13 <code class="literal">Test::Deep</code> (Debian-Paketname:
14 <code class="literal">libtest-deep-perl</code>; Fedora:
15 <code class="literal">perl-Test-Deep</code>; openSUSE:
16 <code class="literal">perl-Test-Deep</code>)</p></li><li class="listitem"><p>
17 <code class="literal">Test::Exception</code> (Debian-Paketname:
18 <code class="literal">libtest-exception-perl</code>; Fedora:
19 <code class="literal">perl-Test-Exception</code>; openSUSE:
20 <code class="literal">perl-Test-Exception</code>)</p></li><li class="listitem"><p>
21 <code class="literal">Test::Output</code> (Debian-Paketname:
22 <code class="literal">libtest-output-perl</code>; Fedora:
23 <code class="literal">perl-Test-Output</code>; openSUSE:
24 <code class="literal">perl-Test-Output</code>)</p></li><li class="listitem"><p>
25 <code class="literal">Test::Harness</code> 3.0.0 oder höher. Dieses
26 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
27 kann für frühere Versionen aus dem <a class="ulink" href="http://www.cpan.org" target="_top">CPAN</a> bezogen werden.</p></li><li class="listitem"><p>
28 <code class="literal">LWP::Simple</code> aus dem Paket
29 <code class="literal">libwww-perl</code> (Debian-Panetname:
30 <code class="literal">libwww-perl</code>; Fedora:
31 <code class="literal">perl-libwww-perl</code>; openSUSE:
32 <code class="literal">perl-libwww-perl</code>)</p></li><li class="listitem"><p>
33 <code class="literal">URI::Find</code> (Debian-Panetname:
34 <code class="literal">liburi-find-perl</code>; Fedora:
35 <code class="literal">perl-URI-Find</code>; openSUSE:
36 <code class="literal">perl-URI-Find</code>)</p></li><li class="listitem"><p>
37 <code class="literal">Sys::CPU</code> (Debian-Panetname: <code class="literal">libsys-cpu-perl</code>; Fedora und openSUSE: nicht
38 vorhanden)</p></li><li class="listitem"><p>
39 <code class="literal">Thread::Pool::Simple</code> (Debian-Panetname: <code class="literal">libthread-pool-simple-perl</code>; Fedora und
40 openSUSE: nicht vorhanden)</p></li></ul></div><p>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
41 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
42 müssen in der Konfigurationsdatei im Abschnit
43 <code class="literal">testing/database</code> Datenbankverbindungsparameter
44 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
45 Recht haben, Datenbanken anzulegen und zu löschen.</p></div><div class="sect2" title="4.5.3. Existierende Tests ausführen"><div class="titlepage"><div><div><h3 class="title"><a name="devel.testsuite.execution"></a>4.5.3. Existierende Tests ausführen</h3></div></div></div><p>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
46 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
47 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
48 <code class="filename">t/test.pl</code>.</p><p>Will man die komplette Test-Suite ausführen, so muss man einfach
49 nur <code class="filename">t/test.pl</code> ohne weitere Parameter aus dem
50 kivitendo-Basisverzeichnis heraus ausführen.</p><p>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
51 an <code class="filename">t/test.pl</code>. Beispielsweise:</p><pre class="programlisting">t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</pre></div><div class="sect2" title="4.5.4. Bedeutung der verschiedenen Test-Scripte"><div class="titlepage"><div><div><h3 class="title"><a name="devel.testsuite.meaning_of_scripts"></a>4.5.4. Bedeutung der verschiedenen Test-Scripte</h3></div></div></div><p>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
52 Programmierstil. Einige besonders zu erwähnende, weil auch während der
53 Entwicklung nützliche Tests sind:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
54 <code class="filename">t/001compile.t</code> -- compiliert alle
55 Quelldateien und bricht bei Fehlern sofort ab</p></li><li class="listitem"><p>
56 <code class="filename">t/002goodperl.t</code> -- überprüft alle
57 Perl-Dateien auf Anwesenheit von '<code class="literal">use
58 strict</code>'-Anweisungen</p></li><li class="listitem"><p>
59 <code class="filename">t/003safesys.t</code> -- überprüft Aufrufe von
60 <code class="function">system()</code> und <code class="function">exec()</code> auf
61 Gültigkeit</p></li><li class="listitem"><p>
62 <code class="filename">t/005no_tabs.t</code> -- überprüft, ob Dateien
63 Tab-Zeichen enthalten</p></li><li class="listitem"><p>
64 <code class="filename">t/006spelling.t</code> -- sucht nach häufigen
65 Rechtschreibfehlern</p></li><li class="listitem"><p>
66 <code class="filename">t/011pod.t</code> -- überprüft die Syntax von
67 Dokumentation im POD-Format auf Gültigkeit</p></li></ul></div><p>Weitere Test-Scripte überprüfen primär die Funktionsweise
68 einzelner Funktionen und Module.</p></div><div class="sect2" title="4.5.5. Neue Test-Scripte erstellen"><div class="titlepage"><div><div><h3 class="title"><a name="devel.testsuite.create_new"></a>4.5.5. Neue Test-Scripte erstellen</h3></div></div></div><p>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
69 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
70 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
71 werden.</p><div class="sect3" title="4.5.5.1. Ideen für neue Test-Scripte, die keine konkreten Funktionen testen"><div class="titlepage"><div><div><h4 class="title"><a name="devel.testsuite.ideas_for_non_function_tests"></a>4.5.5.1. Ideen für neue Test-Scripte, die keine konkreten Funktionen
72 testen</h4></div></div></div><p>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
73 wurden:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Überprüfung auf fehlende symbolische Links</p></li><li class="listitem"><p>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
74 gewissen Einschränkungen wie das Erlauben von deutschen
75 Umlauten)</p></li><li class="listitem"><p>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</p></li><li class="listitem"><p>Überprüfung auf Leerzeichen am Ende von Zeilen</p></li><li class="listitem"><p>Test, ob alle zu übersetzenden Strings in
76 <code class="filename">locale/de/all</code> vorhanden sind</p></li><li class="listitem"><p>Test, ob alle Webseiten-Templates in
77 <code class="filename">templates/webpages</code> mit vom Perl-Modul
78 <code class="literal">Template</code> compiliert werden können</p></li></ul></div></div><div class="sect3" title="4.5.5.2. Konvention für Verzeichnis- und Dateinamen"><div class="titlepage"><div><div><h4 class="title"><a name="devel.testsuite.directory_and_test_names"></a>4.5.5.2. Konvention für Verzeichnis- und Dateinamen</h4></div></div></div><p>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
79 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
80 und ihnen soweit es geht folgen:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Die Dateiendung muss <code class="filename">.t</code>
81 lauten.</p></li><li class="listitem"><p>Namen sind englisch, komplett klein geschrieben und
82 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
83 <code class="filename">bad_function_params.t</code>).</p></li><li class="listitem"><p>Unterverzeichnisse sollten grob nach dem Themenbereich
84 benannt sein, mit dem sich die Scripte darin befassen
85 (beispielsweise <code class="filename">background_jobs</code> für Tests
86 rund um Hintergrund-Jobs).</p></li><li class="listitem"><p>Test-Scripte sollten einen überschaubaren Bereich von
87 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
88 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
89 Test-Scripte schreiben.</p></li></ul></div></div><div class="sect3" title="4.5.5.3. Minimales Skelett für eigene Scripte"><div class="titlepage"><div><div><h4 class="title"><a name="devel.testsuite.minimal_example"></a>4.5.5.3. Minimales Skelett für eigene Scripte</h4></div></div></div><p>Der folgenden Programmcode enthält das kleinstmögliche
90 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
91 werden:</p><pre class="programlisting">use Test::More tests => 0;
95 use Support::TestSetup;
97 Support::TestSetup::login();</pre><p>Wird eine vollständig initialisierte kivitendo-Umgebung
98 benötigt (Stichwort: alle globalen Variablen wie
99 <code class="varname">$::auth</code>, <code class="varname">$::form</code> oder
100 <code class="varname">$::lxdebug</code>), so muss in der Konfigurationsdatei
101 <code class="filename">config/kivitendo.conf</code> im Abschnitt
102 <code class="literal">testing.login</code> ein gültiger Login-Name eingetragen
103 sein. Dieser wird für die Datenbankverbindung benötigt.</p><p>Wir keine vollständig initialisierte Umgebung benötigt, so
104 kann die letzte Zeile </p><pre class="programlisting">Support::TestSetup::login();</pre><p>
105 weggelassen werden, was die Ausführungszeit des Scripts leicht
106 verringert.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch04s04.html">Zurück</a> </td><td width="20%" align="center"><a accesskey="u" href="ch04.html">Nach oben</a></td><td width="40%" align="right"> <a accesskey="n" href="ch04s06.html">Weiter</a></td></tr><tr><td width="40%" align="left" valign="top">4.4. Translations and languages </td><td width="20%" align="center"><a accesskey="h" href="index.html">Zum Anfang</a></td><td width="40%" align="right" valign="top"> 4.6. Stil-Richtlinien</td></tr></table></div></body></html>
projects / kivitendo-erp.git / blob