1 ### Setup your environment for tests
3 The framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool.
9 - a system-wide version, e.g. installed through your distro's package manager (eg. `sudo apt install composer`)
10 - a local version, downloadable [here](https://getcomposer.org/download/). To update a local composer installation, run `php composer.phar self-update`
13 #### Install Shaarli dev dependencies
23 Xdebug must be installed and enable for PHPUnit to generate coverage reports. See http://xdebug.org/docs/install.
26 # for Debian-based distributions
27 $ aptitude install php5-xdebug
33 Then add the following line to `/etc/php/php.ini`:
36 zend_extension=xdebug.so
41 Run `make test` and ensure tests return `OK`. If tests return failures, refer to PHPUnit messages and fix your code/tests accordingly.
43 By default, PHPUnit will run all suitable tests found under the `tests` directory. Each test has 3 possible outcomes:
46 - `F` - failure: the test was run but its results are invalid
47 - the code does not behave as expected
48 - dependencies to external elements: globals, session, cache...
49 - `E` - error: something went wrong and the tested code has crashed
50 - typos in the code, or in the test code
51 - dependencies to missing external elements
53 If Xdebug has been installed and activated, two coverage reports will be generated:
55 - a summary in the console
56 - a detailed HTML report with metrics for tested code
57 - to open it in a web browser: `firefox coverage/index.html &`
59 ### Executing specific tests
61 Add a [`@group`](https://phpunit.de/manual/current/en/appendixes.annotations.html#appendixes.annotations.group) annotation in a test class or method comment:
65 * Netscape bookmark import
68 class BookmarkImportTest extends PHPUnit_Framework_TestCase
74 To run all tests annotated with `@group WIP`:
76 $ vendor/bin/phpunit --group WIP tests/