aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Unit-tests.html
diff options
context:
space:
mode:
authorArthur <arthur@hoa.ro>2016-04-14 14:25:50 +0100
committerArthur <arthur@hoa.ro>2016-04-14 14:25:50 +0100
commit62a5ba083d5137feaef9f4293c401521bad603b0 (patch)
tree4c8b55010ad02d91b524b0cb8cc02ddf318fcaa2 /doc/Unit-tests.html
parent9f400b0dad68b82d65692bd6ab6190f6a787fa89 (diff)
parent5409ade28c5f0acf99dbadd4d95e6f8efda5d395 (diff)
downloadShaarli-62a5ba083d5137feaef9f4293c401521bad603b0.tar.gz
Shaarli-62a5ba083d5137feaef9f4293c401521bad603b0.tar.zst
Shaarli-62a5ba083d5137feaef9f4293c401521bad603b0.zip
Merge pull request #540 from ArthurHoaro/doc/update20160414
Update docs from Wiki
Diffstat (limited to 'doc/Unit-tests.html')
-rw-r--r--doc/Unit-tests.html81
1 files changed, 54 insertions, 27 deletions
diff --git a/doc/Unit-tests.html b/doc/Unit-tests.html
index 6d760771..b933bc7c 100644
--- a/doc/Unit-tests.html
+++ b/doc/Unit-tests.html
@@ -4,31 +4,49 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Unit tests</title> 7 <title>Shaarli – Unit tests</title>
8 <style type="text/css">code{white-space: pre;}</style> 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"> 9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
13table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
14 margin: 0; padding: 0; vertical-align: baseline; border: none; } 12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
15table.sourceCode { width: 100%; line-height: 100%; } 13table.sourceCode { width: 100%; line-height: 100%; }
16td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } 14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
17td.sourceCode { padding-left: 5px; } 15td.sourceCode { padding-left: 5px; }
18code > span.kw { color: #007020; font-weight: bold; } 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
19code > span.dt { color: #902000; } 17code > span.dt { color: #902000; } /* DataType */
20code > span.dv { color: #40a070; } 18code > span.dv { color: #40a070; } /* DecVal */
21code > span.bn { color: #40a070; } 19code > span.bn { color: #40a070; } /* BaseN */
22code > span.fl { color: #40a070; } 20code > span.fl { color: #40a070; } /* Float */
23code > span.ch { color: #4070a0; } 21code > span.ch { color: #4070a0; } /* Char */
24code > span.st { color: #4070a0; } 22code > span.st { color: #4070a0; } /* String */
25code > span.co { color: #60a0b0; font-style: italic; } 23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
26code > span.ot { color: #007020; } 24code > span.ot { color: #007020; } /* Other */
27code > span.al { color: #ff0000; font-weight: bold; } 25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
28code > span.fu { color: #06287e; } 26code > span.fu { color: #06287e; } /* Function */
29code > span.er { color: #ff0000; font-weight: bold; } 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 */
30 </style> 45 </style>
31 <link rel="stylesheet" href="github-markdown.css"> 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]-->
32</head> 50</head>
33<body> 51<body>
34<div id="local-sidebar"> 52<div id="local-sidebar">
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
39<li><a href="Download.html">Download</a></li> 57<li><a href="Download.html">Download</a></li>
40<li><a href="Server-requirements.html">Server requirements</a></li> 58<li><a href="Server-requirements.html">Server requirements</a></li>
41<li><a href="Server-configuration.html">Server configuration</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>
42<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
43</ul></li> 64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
44<li><a href="Usage.html">Usage</a> 67<li><a href="Usage.html">Usage</a>
45<ul> 68<ul>
46<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
47<li><a href="Firefox-share.html">Firefox share</a></li> 71<li><a href="Firefox-share.html">Firefox share</a></li>
48<li><a href="RSS-feeds.html">RSS feeds</a></li> 72<li><a href="RSS-feeds.html">RSS feeds</a></li>
49</ul></li> 73</ul></li>
50<li>How To 74<li>How To
51<ul> 75<ul>
52<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</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> 78<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>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
54<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 80<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> 81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
56</ul></li> 82</ul></li>
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
62<li><a href="Directory-structure.html">Directory structure</a></li> 88<li><a href="Directory-structure.html">Directory structure</a></li>
63<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
64<li><a href="Plugin-System.html">Plugin System</a></li> 90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
65<li><a href="Security.html">Security</a></li> 92<li><a href="Security.html">Security</a></li>
66<li><a href="Static-analysis.html">Static analysis</a></li> 93<li><a href="Static-analysis.html">Static analysis</a></li>
67<li><a href="Theming.html">Theming</a></li> 94<li><a href="Theming.html">Theming</a></li>
@@ -84,27 +111,27 @@ code > span.er { color: #ff0000; font-weight: bold; }
84<li>a local version, downloadable <a href="https://getcomposer.org/download/">here</a><a href=".html"></a></li> 111<li>a local version, downloadable <a href="https://getcomposer.org/download/">here</a><a href=".html"></a></li>
85</ul> 112</ul>
86<h4 id="sample-usage">Sample usage</h4> 113<h4 id="sample-usage">Sample usage</h4>
87<pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># system-wide version</span> 114<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># system-wide version</span>
88$ <span class="kw">composer</span> install 115$ <span class="kw">composer</span> install
89$ <span class="kw">composer</span> update 116$ <span class="kw">composer</span> update
90 117
91<span class="co"># local version</span> 118<span class="co"># local version</span>
92$ <span class="kw">php</span> composer.phar self-update 119$ <span class="kw">php</span> composer.phar self-update
93$ <span class="kw">php</span> composer.phar install 120$ <span class="kw">php</span> composer.phar install
94$ <span class="kw">php</span> composer.phar update</code></pre> 121$ <span class="kw">php</span> composer.phar update</code></pre></div>
95<h4 id="install-shaarli-dev-dependencies">Install Shaarli dev dependencies</h4> 122<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 123<div class="sourceCode"><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> 124$ <span class="kw">composer</span> update</code></pre></div>
98<h4 id="install-and-enable-xdebug-to-generate-phpunit-coverage-reports">Install and enable Xdebug to generate PHPUnit coverage reports</h4> 125<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> 126<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> 127<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">aptitude</span> install php5-xdebug</code></pre></div>
101<p>For ArchLinux:</p> 128<p>For ArchLinux:</p>
102<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">pacman</span> -S xdebug</code></pre> 129<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">pacman</span> -S xdebug</code></pre></div>
103<p>Then add the following line to <code>/etc/php/php.ini</code>:</p> 130<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> 131<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>
105<h4 id="run-unit-tests">Run unit tests</h4> 132<h4 id="run-unit-tests">Run unit tests</h4>
106<p>Successful test suite:</p> 133<p>Successful test suite:</p>
107<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">make</span> test 134<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">make</span> test
108 135
109<span class="kw">-------</span> 136<span class="kw">-------</span>
110<span class="kw">PHPUNIT</span> 137<span class="kw">PHPUNIT</span>
@@ -117,9 +144,9 @@ $ <span class="kw">composer</span> update</code></pre>
117 144
118<span class="kw">Time</span>: 759 ms, Memory: 8.25Mb 145<span class="kw">Time</span>: 759 ms, Memory: 8.25Mb
119 146
120<span class="kw">OK</span> (36 tests, 65 assertions)</code></pre> 147<span class="kw">OK</span> (36 tests, 65 assertions)</code></pre></div>
121<p>Test suite with failures and errors:</p> 148<p>Test suite with failures and errors:</p>
122<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">make</span> test 149<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">make</span> test
123<span class="kw">-------</span> 150<span class="kw">-------</span>
124<span class="kw">PHPUNIT</span> 151<span class="kw">PHPUNIT</span>
125<span class="kw">-------</span> 152<span class="kw">-------</span>
@@ -165,7 +192,7 @@ DBTest.php on line 79 and defined
165<span class="kw">/home/virtualtam/public_html/shaarli/tests</span>/LinkDBTest.php:<span class="kw">133</span> 192<span class="kw">/home/virtualtam/public_html/shaarli/tests</span>/LinkDBTest.php:<span class="kw">133</span>
166 193
167<span class="kw">FAILURES</span>! 194<span class="kw">FAILURES</span>!
168<span class="kw">Tests</span>: 36, Assertions: 63, Errors: 1, Failures: 2.</code></pre> 195<span class="kw">Tests</span>: 36, Assertions: 63, Errors: 1, Failures: 2.</code></pre></div>
169<h4 id="test-results-and-coverage">Test results and coverage</h4> 196<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> 197<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> 198<p>Each test has 3 possible outcomes:</p>
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-11 16:01:55 +0000