480 lines
15 KiB
HTML
480 lines
15 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
|
<link rel="shortcut icon" href="../img/favicon.ico">
|
|
<title>Unit tests - Shaarli Documentation</title>
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/highlight.css">
|
|
<link href="../github-markdown.css" rel="stylesheet">
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Unit tests";
|
|
var mkdocs_page_input_path = "Unit-tests.md";
|
|
var mkdocs_page_url = "/Unit-tests/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-2.1.1.min.js"></script>
|
|
<script src="../js/modernizr-2.8.3.min.js"></script>
|
|
<script type="text/javascript" src="../js/highlight.pack.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Shaarli Documentation</a>
|
|
<div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="..">Home</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">Setup</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../Download-and-Installation/">Download and Installation</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Server-requirements/">Server requirements</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Server-configuration/">Server configuration</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Server-security/">Server security</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Plugins/">Plugins</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">Docker</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../docker/docker-101/">Docker 101</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../docker/shaarli-images/">Shaarli images</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../docker/resources/">Docker resources</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">Usage</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../Features/">Features</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Bookmarklet/">Bookmarklet</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Browsing-and-searching/">Browsing and searching</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Firefox-share/">Firefox share</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../RSS-feeds/">RSS feeds</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../REST-API/">REST API</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">How To</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Various-hacks/">Various hacks</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../Troubleshooting/">Troubleshooting</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">Development</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../Development-guidelines/">Development guidelines</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../GnuPG-signature/">GnuPG signature</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Coding-guidelines/">Coding guidelines</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Directory-structure/">Directory structure</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../3rd-party-libraries/">3rd party libraries</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Plugin-System/">Plugin System</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Release-Shaarli/">Release Shaarli</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Security/">Security</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Static-analysis/">Static analysis</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Theming/">Theming</a>
|
|
</li>
|
|
<li class=" current">
|
|
|
|
<a class="current" href="./">Unit tests</a>
|
|
<ul class="subnav">
|
|
|
|
<li class="toctree-l3"><a href="#setup-your-environment-for-tests">Setup your environment for tests</a></li>
|
|
|
|
<ul>
|
|
|
|
<li><a class="toctree-l4" href="#sample-usage">Sample usage</a></li>
|
|
|
|
<li><a class="toctree-l4" href="#install-shaarli-dev-dependencies">Install Shaarli dev dependencies</a></li>
|
|
|
|
<li><a class="toctree-l4" href="#install-and-enable-xdebug-to-generate-phpunit-coverage-reports">Install and enable Xdebug to generate PHPUnit coverage reports</a></li>
|
|
|
|
<li><a class="toctree-l4" href="#run-unit-tests">Run unit tests</a></li>
|
|
|
|
<li><a class="toctree-l4" href="#test-results-and-coverage">Test results and coverage</a></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<li class="toctree-l3"><a href="#executing-specific-tests">Executing specific tests</a></li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">About</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../FAQ/">FAQ</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Community-&-Related-software/">Community & Related software</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">Shaarli Documentation</a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="..">Docs</a> »</li>
|
|
|
|
|
|
|
|
<li>Development »</li>
|
|
|
|
|
|
|
|
<li>Unit tests</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
<a href="https://github.com/shaarli/Shaarli/edit/master/docs/Unit-tests.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
|
|
<h3 id="setup-your-environment-for-tests">Setup your environment for tests</h3>
|
|
<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.</p>
|
|
<p>Regarding Composer, you can either use:
|
|
<em> a system-wide version, e.g. installed through your distro's package manager
|
|
</em> a local version, downloadable <a href="https://getcomposer.org/download/">here</a></p>
|
|
<h4 id="sample-usage">Sample usage</h4>
|
|
<pre><code class="bash"># system-wide version
|
|
$ composer install
|
|
$ composer update
|
|
|
|
# local version
|
|
$ php composer.phar self-update
|
|
$ php composer.phar install
|
|
$ php composer.phar update
|
|
</code></pre>
|
|
|
|
<h4 id="install-shaarli-dev-dependencies">Install Shaarli dev dependencies</h4>
|
|
<pre><code class="bash">$ cd /path/to/shaarli
|
|
$ composer update
|
|
</code></pre>
|
|
|
|
<h4 id="install-and-enable-xdebug-to-generate-phpunit-coverage-reports">Install and enable Xdebug to generate PHPUnit coverage reports</h4>
|
|
<p>For Debian-based distros:</p>
|
|
<pre><code class="bash">$ aptitude install php5-xdebug
|
|
</code></pre>
|
|
|
|
<p>For ArchLinux:</p>
|
|
<pre><code class="bash">$ pacman -S xdebug
|
|
</code></pre>
|
|
|
|
<p>Then add the following line to <code>/etc/php/php.ini</code>:</p>
|
|
<pre><code class="ini">zend_extension=xdebug.so
|
|
</code></pre>
|
|
|
|
<h4 id="run-unit-tests">Run unit tests</h4>
|
|
<p>Successful test suite:</p>
|
|
<pre><code class="bash">$ make test
|
|
|
|
-------
|
|
PHPUNIT
|
|
-------
|
|
PHPUnit 4.6.9 by Sebastian Bergmann and contributors.
|
|
|
|
Configuration read from /home/virtualtam/public_html/shaarli/phpunit.xml
|
|
|
|
....................................
|
|
|
|
Time: 759 ms, Memory: 8.25Mb
|
|
|
|
OK (36 tests, 65 assertions)
|
|
</code></pre>
|
|
|
|
<p>Test suite with failures and errors:</p>
|
|
<pre><code class="bash">$ make test
|
|
-------
|
|
PHPUNIT
|
|
-------
|
|
PHPUnit 4.6.9 by Sebastian Bergmann and contributors.
|
|
|
|
Configuration read from /home/virtualtam/public_html/shaarli/phpunit.xml
|
|
|
|
E..FF...............................
|
|
|
|
Time: 802 ms, Memory: 8.25Mb
|
|
|
|
There was 1 error:
|
|
|
|
1) LinkDBTest::testConstructLoggedIn
|
|
Missing argument 2 for LinkDB::__construct(), called in /home/virtualtam/public_html/shaarli/tests/Link\
|
|
DBTest.php on line 79 and defined
|
|
|
|
/home/virtualtam/public_html/shaarli/application/LinkDB.php:58
|
|
/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:79
|
|
|
|
--
|
|
|
|
There were 2 failures:
|
|
|
|
1) LinkDBTest::testCheckDBNew
|
|
Failed asserting that two strings are equal.
|
|
--- Expected
|
|
+++ Actual
|
|
@@ @@
|
|
-'e3edea8ea7bb50be4bcb404df53fbb4546a7156e'
|
|
+'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834'
|
|
|
|
/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:121
|
|
|
|
2) LinkDBTest::testCheckDBLoad
|
|
Failed asserting that two strings are equal.
|
|
--- Expected
|
|
+++ Actual
|
|
@@ @@
|
|
-'e3edea8ea7bb50be4bcb404df53fbb4546a7156e'
|
|
+'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834'
|
|
|
|
/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:133
|
|
|
|
FAILURES!
|
|
Tests: 36, Assertions: 63, Errors: 1, Failures: 2.
|
|
</code></pre>
|
|
|
|
<h4 id="test-results-and-coverage">Test results and coverage</h4>
|
|
<p>By default, PHPUnit will run all suitable tests found under the <code>tests</code> directory.</p>
|
|
<p>Each test has 3 possible outcomes:
|
|
<em> <code>.</code> - success
|
|
</em> <code>F</code> - failure: the test was run but its results are invalid
|
|
* the code does not behave as expected
|
|
* dependencies to external elements: globals, session, cache...
|
|
* <code>E</code> - error: something went wrong and the tested code has crashed
|
|
* typos in the code, or in the test code
|
|
* dependencies to missing external elements</p>
|
|
<p>If Xdebug has been installed and activated, two coverage reports will be generated:
|
|
<em> a summary in the console
|
|
</em> a detailed HTML report with metrics for tested code
|
|
* to open it in a web browser: <code>firefox coverage/index.html &</code></p>
|
|
<h3 id="executing-specific-tests">Executing specific tests</h3>
|
|
<p>Add a <a href="https://phpunit.de/manual/current/en/appendixes.annotations.html#appendixes.annotations.group"><code>@group</code></a> annotation in a test class or method comment:</p>
|
|
<pre><code class="php">/**
|
|
* Netscape bookmark import
|
|
* @group WIP
|
|
*/
|
|
class BookmarkImportTest extends PHPUnit_Framework_TestCase
|
|
{
|
|
[...]
|
|
}
|
|
</code></pre>
|
|
|
|
<p>To run all tests annotated with <code>@group WIP</code>:</p>
|
|
<pre><code class="bash">$ vendor/bin/phpunit --group WIP tests/
|
|
</code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../FAQ/" class="btn btn-neutral float-right" title="FAQ">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../Theming/" class="btn btn-neutral" title="Theming"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
|
|
|
|
|
<span><a href="../Theming/" style="color: #fcfcfc;">« Previous</a></span>
|
|
|
|
|
|
<span style="margin-left: 15px"><a href="../FAQ/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script src="../js/theme.js"></script>
|
|
|
|
</body>
|
|
</html>
|