Projekt

Allgemein

Profil

« Zurück | Weiter » 

Revision 42298d2c

Von Moritz Bunkus vor mehr als 5 Jahren hinzugefügt

  • ID 42298d2ceb5206a3d8df0a5cd9989eff5ebb843e
  • Vorgänger 60b17b30
  • Nachfolger 822f5cf7

Dokumentation: HTML & PDF gebaut

Unterschiede anzeigen:

doc/html/ch04s05.html
1 1
<html><head>
2 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.3: 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>&nbsp;</td><th width="60%" align="center">Kapitel 4. Entwicklerdokumentation</th><td width="20%" align="right">&nbsp;<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:
38
            <code class="literal">libsys-cpu-perl</code>; Fedora und openSUSE: nicht
39
            vorhanden)</p></li><li class="listitem"><p>
40
                     <code class="literal">Thread::Pool::Simple</code> (Debian-Panetname:
41
            <code class="literal">libthread-pool-simple-perl</code>; Fedora und
42
            openSUSE: nicht vorhanden)</p></li></ul></div><p>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
43
        Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
44
        müssen in der Konfigurationsdatei im Abschnit
45
        <code class="literal">testing/database</code> Datenbankverbindungsparameter
46
        angegeben werden. Der hier angegebene Benutzer muss weiterhin das
47
        Recht haben, Datenbanken anzulegen und zu löschen.</p><p>Der so angegebene Benutzer muss nicht zwingend über
48
        Super-User-Rechte verfügen. Allerdings gibt es einige
49
        Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall
50
        kann man in diesem Konfigurationsabschnitt einen weiteren
51
        Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und
52
        mit dem die betroffenen Upgrades durchgeführt werden. In der
53
        Beispiel-Konfigurationsdatei finden Sie die benötigten
54
        Parameter.</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,
55
        man lässt alle Tests auf einmal ausführen, oder man führt gezielt
56
        einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
57
        <code class="filename">t/test.pl</code>.</p><p>Will man die komplette Test-Suite ausführen, so muss man einfach
58
        nur <code class="filename">t/test.pl</code> ohne weitere Parameter aus dem
59
        kivitendo-Basisverzeichnis heraus ausführen.</p><p>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
60
        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
61
        Programmierstil. Einige besonders zu erwähnende, weil auch während der
62
        Entwicklung nützliche Tests sind:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
63
                     <code class="filename">t/001compile.t</code> -- compiliert alle
64
            Quelldateien und bricht bei Fehlern sofort ab</p></li><li class="listitem"><p>
65
                     <code class="filename">t/002goodperl.t</code> -- überprüft alle
66
            Perl-Dateien auf Anwesenheit von '<code class="literal">use
67
            strict</code>'-Anweisungen</p></li><li class="listitem"><p>
68
                     <code class="filename">t/003safesys.t</code> -- überprüft Aufrufe von
69
            <code class="function">system()</code> und <code class="function">exec()</code> auf
70
            Gültigkeit</p></li><li class="listitem"><p>
71
                     <code class="filename">t/005no_tabs.t</code> -- überprüft, ob Dateien
72
            Tab-Zeichen enthalten</p></li><li class="listitem"><p>
73
                     <code class="filename">t/006spelling.t</code> -- sucht nach häufigen
74
            Rechtschreibfehlern</p></li><li class="listitem"><p>
75
                     <code class="filename">t/011pod.t</code> -- überprüft die Syntax von
76
            Dokumentation im POD-Format auf Gültigkeit</p></li></ul></div><p>Weitere Test-Scripte überprüfen primär die Funktionsweise
77
        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
78
        mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
79
        und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
80
        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
81
          testen</h4></div></div></div><p>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
82
          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
83
              gewissen Einschränkungen wie das Erlauben von deutschen
84
              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
85
              <code class="filename">locale/de/all</code> vorhanden sind</p></li><li class="listitem"><p>Test, ob alle Webseiten-Templates in
86
              <code class="filename">templates/webpages</code> mit vom Perl-Modul
87
              <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
88
          benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
89
          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>
90
              lauten.</p></li><li class="listitem"><p>Namen sind englisch, komplett klein geschrieben und
91
              einzelne Wörter mit Unterstrichten getrennt (beispielsweise
92
              <code class="filename">bad_function_params.t</code>).</p></li><li class="listitem"><p>Unterverzeichnisse sollten grob nach dem Themenbereich
93
              benannt sein, mit dem sich die Scripte darin befassen
94
              (beispielsweise <code class="filename">background_jobs</code> für Tests
95
              rund um Hintergrund-Jobs).</p></li><li class="listitem"><p>Test-Scripte sollten einen überschaubaren Bereich von
96
              Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
97
              Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
98
              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
99
          Testscript und kann als Ausgangspunkt für eigene Tests verwendet
100
          werden:</p><pre class="programlisting">use Test::More tests =&gt; 0;
3
   <title>4.5. Translations and languages</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.3: Installation, Konfiguration, Entwicklung"><link rel="up" href="ch04.html" title="Kapitel 4. Entwicklerdokumentation"><link rel="prev" href="ch04s04.html" title="4.4. SQL-Upgradedateien"><link rel="next" href="ch04s06.html" title="4.6. Die kivitendo-Test-Suite"></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. Translations and languages</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch04s04.html">Zurück</a>&nbsp;</td><th width="60%" align="center">Kapitel 4. Entwicklerdokumentation</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch04s06.html">Weiter</a></td></tr></table><hr></div><div class="sect1" title="4.5. Translations and languages"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="translations-languages"></a>4.5. Translations and languages</h2></div></div></div><div class="sect2" title="4.5.1. Introduction"><div class="titlepage"><div><div><h3 class="title"><a name="translations-languages.introduction"></a>4.5.1. Introduction</h3></div></div></div><div class="note" title="Anmerkung" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Anmerkung]" src="system/docbook-xsl/images/note.png"></td><th align="left">Anmerkung</th></tr><tr><td align="left" valign="top"><p>Dieser Abschnitt ist in Englisch geschrieben, um
4
          internationalen Übersetzern die Arbeit zu erleichtern.</p></td></tr></table></div><p>This section describes how localization packages in kivitendo
5
        are built. Currently the only language fully supported is German, and
6
        since most of the internal messages are held in English the English
7
        version is usable too.</p></div><div class="sect2" title="4.5.2. Character set"><div class="titlepage"><div><div><h3 class="title"><a name="translations-languages.character-set"></a>4.5.2. Character set</h3></div></div></div><p>All files included in a language pack must use UTF-8 as their
8
        encoding.</p></div><div class="sect2" title="4.5.3. File structure"><div class="titlepage"><div><div><h3 class="title"><a name="translations-languages.file-structure"></a>4.5.3. File structure</h3></div></div></div><p>The structure of locales in kivitendo is:</p><pre class="programlisting">kivitendo/locale/&lt;langcode&gt;/</pre><p>where &lt;langcode&gt; stands for an abbreviation of the
9
        language package. The builtin packages use two letter <a class="ulink" href="http://en.wikipedia.org/wiki/ISO_639-1" target="_top">ISO 639-1</a> codes,
10
        but the actual name is not relevant for the program and can easily be
11
        extended to <a class="ulink" href="http://en.wikipedia.org/wiki/IETF_language_tag" target="_top">IETF language
12
        tags</a> (i.e. "en_GB"). In fact the original language packages
13
        from SQL Ledger are named in this way.</p><p>In such a language directory the following files are
14
        recognized:</p><div class="variablelist"><dl><dt><span class="term">LANGUAGE</span></dt><dd><p>This file is mandatory.</p><p>The <code class="filename">LANGUAGE</code> file contains the self
15
              descripted name of the language. It should contain a native
16
              representation first, and in parenthesis an english translation
17
              after that. Example:</p><pre class="programlisting">Deutsch (German)</pre></dd><dt><span class="term">all</span></dt><dd><p>This file is mandatory.</p><p>The central translation file. It is essentially an inline
18
              Perl script autogenerated by <span class="command"><strong>locales.pl</strong></span>. To
19
              generate it, generate the directory and the two files mentioned
20
              above, and execute the following command:</p><pre class="programlisting">scripts/locales.pl &lt;langcode&gt;</pre><p>Otherwise you can simply copy one of the other languages.
21
              You will be told how many are missing like this:</p><pre class="programlisting">$ scripts/locales.pl en
22
English - 0.6% - 2015/2028 missing</pre><p>A file named "<code class="filename">missing</code>" will be
23
              generated and can be edited. You can also edit the
24
              "<code class="filename">all</code>" file directly. Edit everything you
25
              like to fit the target language and execute
26
              <span class="command"><strong>locales.pl</strong></span> again. See how the missing words
27
              get fewer.</p></dd><dt><span class="term">Num2text</span></dt><dd><p>Legacy code from SQL Ledger. It provides a means for
28
              numbers to be converted into natural language, like
29
              <code class="literal">1523 =&gt; one thousand five hundred twenty
30
              three</code>. If you want to provide it, it must be inlinable
31
              Perl code which provides a <code class="function">num2text</code> sub. If
32
              an <code class="function">init</code> sub exists it will be executed
33
              first.</p><p>Only used in the check and receipt printing module.</p></dd><dt><span class="term">special_chars</span></dt><dd><p>kivitendo comes with a lot of interfaces to different
34
              formats, some of which are rather picky with their accepted
35
              charset. The <code class="filename">special_chars</code> file contains a
36
              listing of chars not suited for different file format and
37
              provides substitutions. It is written in "Simple Ini" style,
38
              containing a block for every file format.</p><p>First entry should be the order of substitution for
39
              entries as a whitespace separated list. All entries are
40
              interpolated, so <code class="literal">\n</code>, <code class="literal">\x20</code>
41
              and <code class="literal">\\</code> all work.</p><p>After that every entry is a special char that should be
42
              translated when writing text into such a file.</p><p>Example:</p><pre class="programlisting">[Template/XML]
43
order=&amp; &lt; &gt; \n
44
&amp;=&amp;amp;
45
&lt;=&amp;lt;
46
&gt;=&amp;gt;
47
\n=&lt;br&gt;</pre><p>Note the importance of the order in this example.
48
              Substituting &lt; and &gt; befor &amp; would lead to $gt; become
49
              &amp;amp;gt;</p><p>For a list of valid formats, see the German
50
              <code class="filename">special_chars</code> entry. As of this writing the
51
              following are recognized:</p><pre class="programlisting">HTML
52
URL@HTML
53
Template/HTML
54
Template/XML
55
Template/LaTeX
56
Template/OpenDocument
57
filenames</pre><p>The last of which is very machine dependant. Remember that
58
              a lot of characters are forbidden by some filesystems, for
59
              example MS Windows doesn't like ':' in its files where Linux
60
              doesn't mind that. If you want the files created with your
61
              language pack to be portable, find all chars that could cause
62
              trouble.</p></dd><dt><span class="term">missing</span></dt><dd><p>This file is not a part of the language package
63
              itself.</p><p>This is a file generated by
64
              <span class="command"><strong>scripts/locales.pl</strong></span> while processing your
65
              locales. It's only to have the missing entries singled out and
66
              does not belong to a language package.</p></dd><dt><span class="term">lost</span></dt><dd><p>This file is not a part of the language package
67
              itself.</p><p>Another file generated by
68
              <span class="command"><strong>scripts/locales.pl</strong></span>. If for any reason a
69
              translation does not appear anymore and can be deleted, it gets
70
              moved here. The last 50 or so entries deleted are saved here in
71
              case you made a typo, so that you don't have to translate
72
              everything again. If a tranlsation is missing, the lost file is
73
              checked first. If you maintain a language package, you might
74
              want to keep this safe somewhere.</p></dd><dt><span class="term">more/all</span></dt><dd><p>This subdir and file is not a part of the language package
75
              itself.</p><p>If the directory more exists and contains a file called
76
              all it will be parsed in addition to the mandatory all (see
77
              above). The file is useful if you want to change some
78
              translations for the current installation without conflicting
79
              further upgrades. The file is not autogenerated and has the same
80
              format as the all, but needs another key (more_texts). See the
81
              german translation for an example or copy the following code:
82
              </p><pre class="programlisting">
83
#!/usr/bin/perl
84
# -*- coding: utf-8; -*-
85
# vim: fenc=utf-8
101 86

  
102
use lib 't';
87
use utf8;
103 88

  
104
use Support::TestSetup;
89
# These are additional texts for custom translations.
90
# The format is the same as for the normal file all, only
91
# with another key (more_texts instead of texts).
92
# The file has the form of 'english text'  =&gt; 'foreign text',
105 93

  
106
Support::TestSetup::login();</pre><p>Wird eine vollständig initialisierte kivitendo-Umgebung
107
          benötigt (Stichwort: alle globalen Variablen wie
108
          <code class="varname">$::auth</code>, <code class="varname">$::form</code> oder
109
          <code class="varname">$::lxdebug</code>), so muss in der Konfigurationsdatei
110
          <code class="filename">config/kivitendo.conf</code> im Abschnitt
111
          <code class="literal">testing.login</code> ein gültiger Login-Name eingetragen
112
          sein. Dieser wird für die Datenbankverbindung benötigt.</p><p>Wir keine vollständig initialisierte Umgebung benötigt, so
113
          kann die letzte Zeile </p><pre class="programlisting">Support::TestSetup::login();</pre><p>
114
          weggelassen werden, was die Ausführungszeit des Scripts leicht
115
          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>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch04.html">Nach oben</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch04s06.html">Weiter</a></td></tr><tr><td width="40%" align="left" valign="top">4.4. Translations and languages&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Zum Anfang</a></td><td width="40%" align="right" valign="top">&nbsp;4.6. Stil-Richtlinien</td></tr></table></div></body></html>
94
$self-&gt;{more_texts} = {
95

  
96
  'Ship via'                    =&gt; 'Terms of delivery',
97
  'Shipping Point'              =&gt; 'Delivery time',
98
}
99
              </pre><p>
100
                     </p></dd></dl></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>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch04.html">Nach oben</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch04s06.html">Weiter</a></td></tr><tr><td width="40%" align="left" valign="top">4.4. SQL-Upgradedateien&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Zum Anfang</a></td><td width="40%" align="right" valign="top">&nbsp;4.6. Die kivitendo-Test-Suite</td></tr></table></div></body></html>

Auch abrufbar als: Unified diff