doc/Unit-tests.html

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