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   <!--[if lt IE 9]>
  10     <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
  11   <![endif]-->
  12   <style type="text/css">
  13 table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
  14   margin: 0; padding: 0; vertical-align: baseline; border: none; }
  15 table.sourceCode { width: 100%; line-height: 100%; }
  16 td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
  17 td.sourceCode { padding-left: 5px; }
  18 code > span.kw { color: #007020; font-weight: bold; }
  19 code > span.dt { color: #902000; }
  20 code > span.dv { color: #40a070; }
  21 code > span.bn { color: #40a070; }
  22 code > span.fl { color: #40a070; }
  23 code > span.ch { color: #4070a0; }
  24 code > span.st { color: #4070a0; }
  25 code > span.co { color: #60a0b0; font-style: italic; }
  26 code > span.ot { color: #007020; }
  27 code > span.al { color: #ff0000; font-weight: bold; }
  28 code > span.fu { color: #06287e; }
  29 code > span.er { color: #ff0000; font-weight: bold; }
  30   </style>
  31   <link rel="stylesheet" href="github-markdown.css">
  32 </head>
  33 <body>
  34 <div id="local-sidebar">
  35 <ul>
  36 <li><a href="Home.html">Home</a></li>
  37 <li>Installation
  38 <ul>
  39 <li><a href="Download.html">Download</a></li>
  40 <li><a href="Server-requirements.html">Server requirements</a></li>
  41 <li><a href="Server-configuration.html">Server configuration</a></li>
  42 <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
  43 </ul></li>
  44 <li><a href="Usage.html">Usage</a>
  45 <ul>
  46 <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
  47 <li><a href="Firefox-share.html">Firefox share</a></li>
  48 <li><a href="RSS-feeds.html">RSS feeds</a></li>
  49 </ul></li>
  50 <li>How To
  51 <ul>
  52 <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
  53 <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>
  54 <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
  55 <li><a href="Datastore-hacks.html">Datastore hacks</a></li>
  56 </ul></li>
  57 <li><a href="Troubleshooting.html">Troubleshooting</a></li>
  58 <li><a href="Development.html">Development</a>
  59 <ul>
  60 <li><a href="GnuPG-signature.html">GnuPG signature</a></li>
  61 <li><a href="Coding-guidelines.html">Coding guidelines</a></li>
  62 <li><a href="Directory-structure.html">Directory structure</a></li>
  63 <li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
  64 <li><a href="Plugin-System.html">Plugin System</a></li>
  65 <li><a href="Security.html">Security</a></li>
  66 <li><a href="Static-analysis.html">Static analysis</a></li>
  67 <li><a href="Theming.html">Theming</a></li>
  68 <li><a href="Unit-tests.html">Unit tests</a></li>
  69 </ul></li>
  70 <li>About
  71 <ul>
  72 <li><a href="FAQ.html">FAQ</a></li>
  73 <li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
  74 <li><a href="TODO.html">TODO</a></li>
  75 </ul></li>
  76 </ul>
  77 </div>
  78 <h1 id="unit-tests">Unit tests</h1>
  79 <h3 id="setup-your-environment-for-tests">Setup your environment for tests</h3>
  80 <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>
  81 <p>Regarding Composer, you can either use:</p>
  82 <ul>
  83 <li>a system-wide version, e.g. installed through your distro's package manager</li>
  84 <li>a local version, downloadable <a href="https://getcomposer.org/download/">here</a><a href=".html"></a></li>
  85 </ul>
  86 <h4 id="sample-usage">Sample usage</h4>
  87 <pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># system-wide version</span>
  88 $ <span class="kw">composer</span> install
  89 $ <span class="kw">composer</span> update
  90
  91 <span class="co"># local version</span>
  92 $ <span class="kw">php</span> composer.phar self-update
  93 $ <span class="kw">php</span> composer.phar install
  94 $ <span class="kw">php</span> composer.phar update</code></pre>
  95 <h4 id="install-shaarli-dev-dependencies">Install Shaarli dev dependencies</h4>
  96 <pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> /path/to/shaarli
  97 $ <span class="kw">composer</span> update</code></pre>
  98 <h4 id="install-and-enable-xdebug-to-generate-phpunit-coverage-reports">Install and enable Xdebug to generate PHPUnit coverage reports</h4>
  99 <p>For Debian-based distros:</p>
 100 <pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">aptitude</span> install php5-xdebug</code></pre>
 101 <p>For ArchLinux:</p>
 102 <pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">pacman</span> -S xdebug</code></pre>
 103 <p>Then add the following line to <code>/etc/php/php.ini</code>:</p>
 104 <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>
 105 <h4 id="run-unit-tests">Run unit tests</h4>
 106 <p>Successful test suite:</p>
 107 <pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">make</span> test
 108
 109 <span class="kw">-------</span>
 110 <span class="kw">PHPUNIT</span>
 111 <span class="kw">-------</span>
 112 <span class="kw">PHPUnit</span> 4.6.9 by Sebastian Bergmann and contributors.
 113
 114 <span class="kw">Configuration</span> read from /home/virtualtam/public_html/shaarli/phpunit.xml
 115
 116 <span class="kw">....................................</span>
 117
 118 <span class="kw">Time</span>: 759 ms, Memory: 8.25Mb
 119
 120 <span class="kw">OK</span> (36 tests, 65 assertions)</code></pre>
 121 <p>Test suite with failures and errors:</p>
 122 <pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">make</span> test
 123 <span class="kw">-------</span>
 124 <span class="kw">PHPUNIT</span>
 125 <span class="kw">-------</span>
 126 <span class="kw">PHPUnit</span> 4.6.9 by Sebastian Bergmann and contributors.
 127
 128 <span class="kw">Configuration</span> read from /home/virtualtam/public_html/shaarli/phpunit.xml
 129
 130 <span class="kw">E..FF...............................</span>
 131
 132 <span class="kw">Time</span>: 802 ms, Memory: 8.25Mb
 133
 134 <span class="kw">There</span> was 1 error:
 135
 136 <span class="kw">1</span>) <span class="kw">LinkDBTest</span>::testConstructLoggedIn
 137 <span class="kw">Missing</span> argument 2 for LinkDB::__construct(), <span class="kw">called</span> in /home/virtualtam/public_html/shaarli/tests/Link\
 138 DBTest.php on line 79 and defined
 139
 140 <span class="kw">/home/virtualtam/public_html/shaarli/application</span>/LinkDB.php:<span class="kw">58</span>
 141 <span class="kw">/home/virtualtam/public_html/shaarli/tests</span>/LinkDBTest.php:<span class="kw">79</span>
 142
 143 <span class="kw">--</span>
 144
 145 <span class="kw">There</span> were 2 failures:
 146
 147 <span class="kw">1</span>) <span class="kw">LinkDBTest</span>::testCheckDBNew
 148 <span class="kw">Failed</span> asserting that two strings are equal.
 149 <span class="kw">---</span> Expected
 150 <span class="kw">+++</span> Actual
 151 <span class="kw">@@</span> @@
 152 <span class="kw">-</span><span class="st">&#39;e3edea8ea7bb50be4bcb404df53fbb4546a7156e&#39;</span>
 153 <span class="kw">+</span><span class="st">&#39;85eab0c610d4f68025f6ed6e6b6b5fabd4b55834&#39;</span>
 154
 155 <span class="kw">/home/virtualtam/public_html/shaarli/tests</span>/LinkDBTest.php:<span class="kw">121</span>
 156
 157 <span class="kw">2</span>) <span class="kw">LinkDBTest</span>::testCheckDBLoad
 158 <span class="kw">Failed</span> asserting that two strings are equal.
 159 <span class="kw">---</span> Expected
 160 <span class="kw">+++</span> Actual
 161 <span class="kw">@@</span> @@
 162 <span class="kw">-</span><span class="st">&#39;e3edea8ea7bb50be4bcb404df53fbb4546a7156e&#39;</span>
 163 <span class="kw">+</span><span class="st">&#39;85eab0c610d4f68025f6ed6e6b6b5fabd4b55834&#39;</span>
 164
 165 <span class="kw">/home/virtualtam/public_html/shaarli/tests</span>/LinkDBTest.php:<span class="kw">133</span>
 166
 167 <span class="kw">FAILURES</span>!
 168 <span class="kw">Tests</span>: 36, Assertions: 63, Errors: 1, Failures: 2.</code></pre>
 169 <h4 id="test-results-and-coverage">Test results and coverage</h4>
 170 <p>By default, PHPUnit will run all suitable tests found under the <code>tests</code> directory.</p>
 171 <p>Each test has 3 possible outcomes:</p>
 172 <ul>
 173 <li><code>.</code> - success</li>
 174 <li><code>F</code> - failure: the test was run but its results are invalid</li>
 175 <li>the code does not behave as expected</li>
 176 <li>dependencies to external elements: globals, session, cache...</li>
 177 <li><code>E</code> - error: something went wrong and the tested code has crashed</li>
 178 <li>typos in the code, or in the test code</li>
 179 <li>dependencies to missing external elements</li>
 180 </ul>
 181 <p>If Xdebug has been installed and activated, two coverage reports will be generated:</p>
 182 <ul>
 183 <li>a summary in the console</li>
 184 <li>a detailed HTML report with metrics for tested code</li>
 185 <li>to open it in a web browser: <code>firefox coverage/index.html &amp;</code></li>
 186 </ul>
 187 </body>
 188 </html>