diff options
author | VirtualTam <virtualtam@flibidi.net> | 2015-08-04 16:07:13 +0200 |
---|---|---|
committer | VirtualTam <virtualtam@flibidi.net> | 2015-08-04 16:07:13 +0200 |
commit | 27cf2e671d1f35bd8c9383d008cd3733fc1c6e0d (patch) | |
tree | 4726baf18e7057eac3f9b6bdb5991fe6117814fc /doc/Unit-tests.html | |
parent | 96db105e4c0833324f7168edb5673278de8ccd54 (diff) | |
parent | 992af0b9d77cb4fbac2c37ef8d5896042d67a2a3 (diff) | |
download | Shaarli-27cf2e671d1f35bd8c9383d008cd3733fc1c6e0d.tar.gz Shaarli-27cf2e671d1f35bd8c9383d008cd3733fc1c6e0d.tar.zst Shaarli-27cf2e671d1f35bd8c9383d008cd3733fc1c6e0d.zip |
Merge pull request #294 from virtualtam/doc/update
Doc: sync from Wiki, generate HTML
Diffstat (limited to 'doc/Unit-tests.html')
-rw-r--r-- | doc/Unit-tests.html | 186 |
1 files changed, 186 insertions, 0 deletions
diff --git a/doc/Unit-tests.html b/doc/Unit-tests.html new file mode 100644 index 00000000..25873cb0 --- /dev/null +++ b/doc/Unit-tests.html | |||
@@ -0,0 +1,186 @@ | |||
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="Server-requirements.html">Server requirements</a></li> | ||
40 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
41 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
42 | </ul></li> | ||
43 | <li><a href="Usage.html">Usage</a> | ||
44 | <ul> | ||
45 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
46 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
47 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
48 | </ul></li> | ||
49 | <li>How To | ||
50 | <ul> | ||
51 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
52 | <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> | ||
53 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
54 | </ul></li> | ||
55 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
56 | <li><a href="Development.html">Development</a> | ||
57 | <ul> | ||
58 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
59 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
60 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
61 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
62 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
63 | <li><a href="Security.html">Security</a></li> | ||
64 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
65 | <li><a href="Theming.html">Theming</a></li> | ||
66 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
67 | </ul></li> | ||
68 | <li>About | ||
69 | <ul> | ||
70 | <li><a href="FAQ.html">FAQ</a></li> | ||
71 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
72 | <li><a href="TODO.html">TODO</a></li> | ||
73 | </ul></li> | ||
74 | </ul> | ||
75 | </div> | ||
76 | <h1 id="unit-tests">Unit tests</h1> | ||
77 | <h3 id="setup-your-environment-for-tests">Setup your environment for tests</h3> | ||
78 | <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> | ||
79 | <p>Regarding Composer, you can either use:</p> | ||
80 | <ul> | ||
81 | <li>a system-wide version, e.g. installed through your distro's package manager</li> | ||
82 | <li>a local version, downloadable <a href="https://getcomposer.org/download/">here</a><a href=".html"></a></li> | ||
83 | </ul> | ||
84 | <h4 id="sample-usage">Sample usage</h4> | ||
85 | <pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># system-wide version</span> | ||
86 | $ <span class="kw">composer</span> install | ||
87 | $ <span class="kw">composer</span> update | ||
88 | |||
89 | <span class="co"># local version</span> | ||
90 | $ <span class="kw">php</span> composer.phar self-update | ||
91 | $ <span class="kw">php</span> composer.phar install | ||
92 | $ <span class="kw">php</span> composer.phar update</code></pre> | ||
93 | <h4 id="install-shaarli-dev-dependencies">Install Shaarli dev dependencies</h4> | ||
94 | <pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> /path/to/shaarli | ||
95 | $ <span class="kw">composer</span> update</code></pre> | ||
96 | <h4 id="install-and-enable-xdebug-to-generate-phpunit-coverage-reports">Install and enable Xdebug to generate PHPUnit coverage reports</h4> | ||
97 | <p>For Debian-based distros:</p> | ||
98 | <pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">aptitude</span> install php5-xdebug</code></pre> | ||
99 | <p>For ArchLinux:</p> | ||
100 | <pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">pacman</span> -S xdebug</code></pre> | ||
101 | <p>Then add the following line to <code>/etc/php/php.ini</code>:</p> | ||
102 | <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> | ||
103 | <h4 id="run-unit-tests">Run unit tests</h4> | ||
104 | <p>Successful test suite:</p> | ||
105 | <pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">make</span> test | ||
106 | |||
107 | <span class="kw">-------</span> | ||
108 | <span class="kw">PHPUNIT</span> | ||
109 | <span class="kw">-------</span> | ||
110 | <span class="kw">PHPUnit</span> 4.6.9 by Sebastian Bergmann and contributors. | ||
111 | |||
112 | <span class="kw">Configuration</span> read from /home/virtualtam/public_html/shaarli/phpunit.xml | ||
113 | |||
114 | <span class="kw">....................................</span> | ||
115 | |||
116 | <span class="kw">Time</span>: 759 ms, Memory: 8.25Mb | ||
117 | |||
118 | <span class="kw">OK</span> (36 tests, 65 assertions)</code></pre> | ||
119 | <p>Test suite with failures and errors:</p> | ||
120 | <pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">make</span> test | ||
121 | <span class="kw">-------</span> | ||
122 | <span class="kw">PHPUNIT</span> | ||
123 | <span class="kw">-------</span> | ||
124 | <span class="kw">PHPUnit</span> 4.6.9 by Sebastian Bergmann and contributors. | ||
125 | |||
126 | <span class="kw">Configuration</span> read from /home/virtualtam/public_html/shaarli/phpunit.xml | ||
127 | |||
128 | <span class="kw">E..FF...............................</span> | ||
129 | |||
130 | <span class="kw">Time</span>: 802 ms, Memory: 8.25Mb | ||
131 | |||
132 | <span class="kw">There</span> was 1 error: | ||
133 | |||
134 | <span class="kw">1</span>) <span class="kw">LinkDBTest</span>::testConstructLoggedIn | ||
135 | <span class="kw">Missing</span> argument 2 for LinkDB::__construct(), <span class="kw">called</span> in /home/virtualtam/public_html/shaarli/tests/Link\ | ||
136 | DBTest.php on line 79 and defined | ||
137 | |||
138 | <span class="kw">/home/virtualtam/public_html/shaarli/application</span>/LinkDB.php:<span class="kw">58</span> | ||
139 | <span class="kw">/home/virtualtam/public_html/shaarli/tests</span>/LinkDBTest.php:<span class="kw">79</span> | ||
140 | |||
141 | <span class="kw">--</span> | ||
142 | |||
143 | <span class="kw">There</span> were 2 failures: | ||
144 | |||
145 | <span class="kw">1</span>) <span class="kw">LinkDBTest</span>::testCheckDBNew | ||
146 | <span class="kw">Failed</span> asserting that two strings are equal. | ||
147 | <span class="kw">---</span> Expected | ||
148 | <span class="kw">+++</span> Actual | ||
149 | <span class="kw">@@</span> @@ | ||
150 | <span class="kw">-</span><span class="st">'e3edea8ea7bb50be4bcb404df53fbb4546a7156e'</span> | ||
151 | <span class="kw">+</span><span class="st">'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834'</span> | ||
152 | |||
153 | <span class="kw">/home/virtualtam/public_html/shaarli/tests</span>/LinkDBTest.php:<span class="kw">121</span> | ||
154 | |||
155 | <span class="kw">2</span>) <span class="kw">LinkDBTest</span>::testCheckDBLoad | ||
156 | <span class="kw">Failed</span> asserting that two strings are equal. | ||
157 | <span class="kw">---</span> Expected | ||
158 | <span class="kw">+++</span> Actual | ||
159 | <span class="kw">@@</span> @@ | ||
160 | <span class="kw">-</span><span class="st">'e3edea8ea7bb50be4bcb404df53fbb4546a7156e'</span> | ||
161 | <span class="kw">+</span><span class="st">'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834'</span> | ||
162 | |||
163 | <span class="kw">/home/virtualtam/public_html/shaarli/tests</span>/LinkDBTest.php:<span class="kw">133</span> | ||
164 | |||
165 | <span class="kw">FAILURES</span>! | ||
166 | <span class="kw">Tests</span>: 36, Assertions: 63, Errors: 1, Failures: 2.</code></pre> | ||
167 | <h4 id="test-results-and-coverage">Test results and coverage</h4> | ||
168 | <p>By default, PHPUnit will run all suitable tests found under the <code>tests</code> directory.</p> | ||
169 | <p>Each test has 3 possible outcomes:</p> | ||
170 | <ul> | ||
171 | <li><code>.</code> - success</li> | ||
172 | <li><code>F</code> - failure: the test was run but its results are invalid</li> | ||
173 | <li>the code does not behave as expected</li> | ||
174 | <li>dependencies to external elements: globals, session, cache...</li> | ||
175 | <li><code>E</code> - error: something went wrong and the tested code has crashed</li> | ||
176 | <li>typos in the code, or in the test code</li> | ||
177 | <li>dependencies to missing external elements</li> | ||
178 | </ul> | ||
179 | <p>If Xdebug has been installed and activated, two coverage reports will be generated:</p> | ||
180 | <ul> | ||
181 | <li>a summary in the console</li> | ||
182 | <li>a detailed HTML report with metrics for tested code</li> | ||
183 | <li>to open it in a web browser: <code>firefox coverage/index.html &</code></li> | ||
184 | </ul> | ||
185 | </body> | ||
186 | </html> | ||