]> git.immae.eu Git - github/shaarli/Shaarli.git/blame - doc/Unit-tests.html
projects / github / shaarli / Shaarli.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Bump version to v0.8.0
[github/shaarli/Shaarli.git] / doc / Unit-tests.html
CommitLineData
da9b0e3e 1<!DOCTYPE html>
2<html>
3<head>
4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
5409ade2 7 <title>Shaarli – Unit tests</title>
da9b0e3e 8 <style type="text/css">code{white-space: pre;}</style>
da9b0e3e 9 <style type="text/css">
5409ade2 10div.sourceCode { overflow-x: auto; }
da9b0e3e 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
13table.sourceCode { width: 100%; line-height: 100%; }
14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
15td.sourceCode { padding-left: 5px; }
5409ade2
A		 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
17code > span.dt { color: #902000; } /* DataType */
18code > span.dv { color: #40a070; } /* DecVal */
19code > span.bn { color: #40a070; } /* BaseN */
20code > span.fl { color: #40a070; } /* Float */
21code > span.ch { color: #4070a0; } /* Char */
22code > span.st { color: #4070a0; } /* String */
23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
24code > span.ot { color: #007020; } /* Other */
25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
26code > span.fu { color: #06287e; } /* Function */
27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
da9b0e3e 45 </style>
46 <link rel="stylesheet" href="github-markdown.css">
5409ade2
A		 47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
da9b0e3e 50</head>
51<body>
992af0b9
V		 52<div id="local-sidebar">
53<ul>
54<li><a href="Home.html">Home</a></li>
fdf88d19 55<li>Setup
992af0b9 56<ul>
fdf88d19
A		 57<li><a href="Download-and-Installation.html">Download and Installation</a></li>
58<li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
992af0b9
V		 59<li><a href="Server-requirements.html">Server requirements</a></li>
60<li><a href="Server-configuration.html">Server configuration</a></li>
5409ade2 61<li><a href="Server-security.html">Server security</a></li>
992af0b9 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
08dcd8ea 63<li><a href="Plugins.html">Plugins</a></li>
992af0b9 64</ul></li>
5409ade2 65<li><a href="Docker.html">Docker</a></li>
992af0b9
V		 66<li><a href="Usage.html">Usage</a>
67<ul>
68<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
5409ade2 69<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
992af0b9
V		 70<li><a href="Firefox-share.html">Firefox share</a></li>
71<li><a href="RSS-feeds.html">RSS feeds</a></li>
72</ul></li>
73<li>How To
74<ul>
75<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
76<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
5409ade2 77<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
992af0b9 78<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
6335a0fc 79<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
992af0b9
V		 80</ul></li>
81<li><a href="Troubleshooting.html">Troubleshooting</a></li>
82<li><a href="Development.html">Development</a>
83<ul>
84<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
85<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
86<li><a href="Directory-structure.html">Directory structure</a></li>
87<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
88<li><a href="Plugin-System.html">Plugin System</a></li>
5409ade2 89<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
992af0b9
V		 90<li><a href="Security.html">Security</a></li>
91<li><a href="Static-analysis.html">Static analysis</a></li>
92<li><a href="Theming.html">Theming</a></li>
93<li><a href="Unit-tests.html">Unit tests</a></li>
94</ul></li>
95<li>About
96<ul>
97<li><a href="FAQ.html">FAQ</a></li>
98<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
992af0b9
V		 99</ul></li>
100</ul>
101</div>
102<h1 id="unit-tests">Unit tests</h1>
da9b0e3e 103<h3 id="setup-your-environment-for-tests">Setup your environment for tests</h3>
992af0b9 104<p>The framework used is <a href="https://phpunit.de/">PHPUnit</a>; it can be installed with <a href="https://getcomposer.org/">Composer</a>, which is a dependency management tool.<a href=".html"></a></p>
da9b0e3e 105<p>Regarding Composer, you can either use:</p>
106<ul>
992af0b9
V		 107<li>a system-wide version, e.g. installed through your distro's package manager</li>
108<li>a local version, downloadable <a href="https://getcomposer.org/download/">here</a><a href=".html"></a></li>
da9b0e3e 109</ul>
110<h4 id="sample-usage">Sample usage</h4>
5409ade2 111<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># system-wide version</span>
fdf88d19
A		 112$ <span class="ex">composer</span> install
113$ <span class="ex">composer</span> update
da9b0e3e 114
115<span class="co"># local version</span>
fdf88d19
A		 116$ <span class="ex">php</span> composer.phar self-update
117$ <span class="ex">php</span> composer.phar install
118$ <span class="ex">php</span> composer.phar update</code></pre></div>
da9b0e3e 119<h4 id="install-shaarli-dev-dependencies">Install Shaarli dev dependencies</h4>
fdf88d19
A		 120<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="bu">cd</span> /path/to/shaarli
121$ <span class="ex">composer</span> update</code></pre></div>
da9b0e3e 122<h4 id="install-and-enable-xdebug-to-generate-phpunit-coverage-reports">Install and enable Xdebug to generate PHPUnit coverage reports</h4>
123<p>For Debian-based distros:</p>
fdf88d19 124<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="ex">aptitude</span> install php5-xdebug</code></pre></div>
da9b0e3e 125<p>For ArchLinux:</p>
fdf88d19 126<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="ex">pacman</span> -S xdebug</code></pre></div>
da9b0e3e 127<p>Then add the following line to <code>/etc/php/php.ini</code>:</p>
5409ade2 128<div class="sourceCode"><pre class="sourceCode ini"><code class="sourceCode ini"><span class="dt">zend_extension</span><span class="ot">=</span><span class="st">xdebug.so</span></code></pre></div>
da9b0e3e 129<h4 id="run-unit-tests">Run unit tests</h4>
130<p>Successful test suite:</p>
fdf88d19 131<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">make</span> test
da9b0e3e 132
fdf88d19
A		 133<span class="ex">-------</span>
134<span class="ex">PHPUNIT</span>
135<span class="ex">-------</span>
136<span class="ex">PHPUnit</span> 4.6.9 by Sebastian Bergmann and contributors.
da9b0e3e 137
fdf88d19 138<span class="ex">Configuration</span> read from /home/virtualtam/public_html/shaarli/phpunit.xml
da9b0e3e 139
fdf88d19 140<span class="ex">....................................</span>
da9b0e3e 141
fdf88d19 142<span class="ex">Time</span>: 759 ms, Memory: 8.25Mb
da9b0e3e 143
fdf88d19 144<span class="ex">OK</span> (36 tests, 65 assertions)</code></pre></div>
da9b0e3e 145<p>Test suite with failures and errors:</p>
fdf88d19
A		 146<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="fu">make</span> test
147<span class="ex">-------</span>
148<span class="ex">PHPUNIT</span>
149<span class="ex">-------</span>
150<span class="ex">PHPUnit</span> 4.6.9 by Sebastian Bergmann and contributors.
da9b0e3e 151
fdf88d19 152<span class="ex">Configuration</span> read from /home/virtualtam/public_html/shaarli/phpunit.xml
da9b0e3e 153
fdf88d19 154<span class="ex">E..FF...............................</span>
da9b0e3e 155
fdf88d19 156<span class="ex">Time</span>: 802 ms, Memory: 8.25Mb
da9b0e3e 157
fdf88d19 158<span class="ex">There</span> was 1 error:
da9b0e3e 159
fdf88d19
A		 160<span class="ex">1</span>) <span class="ex">LinkDBTest</span>::testConstructLoggedIn
161<span class="ex">Missing</span> argument 2 for LinkDB::__construct(), <span class="ex">called</span> in /home/virtualtam/public_html/shaarli/tests/Link\
992af0b9 162DBTest.php on line 79 and defined
da9b0e3e 163
fdf88d19
A		 164<span class="ex">/home/virtualtam/public_html/shaarli/application</span>/LinkDB.php:<span class="ex">58</span>
165<span class="ex">/home/virtualtam/public_html/shaarli/tests</span>/LinkDBTest.php:<span class="ex">79</span>
da9b0e3e 166
fdf88d19 167<span class="ex">--</span>
da9b0e3e 168
fdf88d19 169<span class="ex">There</span> were 2 failures:
da9b0e3e 170
fdf88d19
A		 171<span class="ex">1</span>) <span class="ex">LinkDBTest</span>::testCheckDBNew
172<span class="ex">Failed</span> asserting that two strings are equal.
173<span class="ex">---</span> Expected
174<span class="ex">+++</span> Actual
175<span class="ex">@@</span> @@
176<span class="ex">-</span><span class="st">&#39;e3edea8ea7bb50be4bcb404df53fbb4546a7156e&#39;</span>
177<span class="ex">+</span><span class="st">&#39;85eab0c610d4f68025f6ed6e6b6b5fabd4b55834&#39;</span>
da9b0e3e 178
fdf88d19 179<span class="ex">/home/virtualtam/public_html/shaarli/tests</span>/LinkDBTest.php:<span class="ex">121</span>
da9b0e3e 180
fdf88d19
A		 181<span class="ex">2</span>) <span class="ex">LinkDBTest</span>::testCheckDBLoad
182<span class="ex">Failed</span> asserting that two strings are equal.
183<span class="ex">---</span> Expected
184<span class="ex">+++</span> Actual
185<span class="ex">@@</span> @@
186<span class="ex">-</span><span class="st">&#39;e3edea8ea7bb50be4bcb404df53fbb4546a7156e&#39;</span>
187<span class="ex">+</span><span class="st">&#39;85eab0c610d4f68025f6ed6e6b6b5fabd4b55834&#39;</span>
da9b0e3e 188
fdf88d19 189<span class="ex">/home/virtualtam/public_html/shaarli/tests</span>/LinkDBTest.php:<span class="ex">133</span>
da9b0e3e 190
fdf88d19
A		 191<span class="ex">FAILURES</span>!
192<span class="ex">Tests</span>: 36, Assertions: 63, Errors: 1, Failures: 2.</code></pre></div>
da9b0e3e 193<h4 id="test-results-and-coverage">Test results and coverage</h4>
194<p>By default, PHPUnit will run all suitable tests found under the <code>tests</code> directory.</p>
195<p>Each test has 3 possible outcomes:</p>
196<ul>
992af0b9
V		 197<li><code>.</code> - success</li>
198<li><code>F</code> - failure: the test was run but its results are invalid</li>
199<li>the code does not behave as expected</li>
200<li>dependencies to external elements: globals, session, cache...</li>
201<li><code>E</code> - error: something went wrong and the tested code has crashed</li>
202<li>typos in the code, or in the test code</li>
da9b0e3e 203<li>dependencies to missing external elements</li>
204</ul>
205<p>If Xdebug has been installed and activated, two coverage reports will be generated:</p>
206<ul>
992af0b9
V		 207<li>a summary in the console</li>
208<li>a detailed HTML report with metrics for tested code</li>
da9b0e3e 209<li>to open it in a web browser: <code>firefox coverage/index.html &amp;</code></li>
210</ul>
211</body>
212</html>
The personal, minimalist, super-fast, database free, bookmarking service - community repo