doc/md/Unit-tests.md

   1 ### Setup your environment for tests
   2
   3 The framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool.
   4
   5 ### Install composer
   6
   7 You can either use:
   8
   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`
  11
  12
  13 #### Install Shaarli dev dependencies
  14
  15 ```bash
  16 $ cd /path/to/shaarli
  17 $ composer install
  18 $ composer update
  19 ```
  20
  21 #### Install and enable Xdebug to generate PHPUnit coverage reports
  22
  23 See http://xdebug.org/docs/install
  24
  25 ```bash
  26 # for Debian-based distributions
  27 $ aptitude install php5-xdebug
  28
  29 # for ArchLinux:
  30 $ pacman -S xdebug
  31 ```
  32
  33 Then add the following line to `/etc/php/php.ini`:
  34 ```ini
  35 zend_extension=xdebug.so
  36 ```
  37
  38 #### Run unit tests
  39
  40 Run `make test` and ensure tests return `OK`. If tests return failures, refer to PHPUnit messages and fix your code/tests accordingly.
  41
  42
  43 #### Test results and coverage
  44
  45 By default, PHPUnit will run all suitable tests found under the `tests` directory.
  46
  47 Each test has 3 possible outcomes:
  48
  49 - `.` - success
  50 - `F` - failure: the test was run but its results are invalid
  51     - the code does not behave as expected
  52     - dependencies to external elements: globals, session, cache...
  53 - `E` - error: something went wrong and the tested code has crashed
  54     - typos in the code, or in the test code
  55     - dependencies to missing external elements
  56
  57 If Xdebug has been installed and activated, two coverage reports will be generated:
  58
  59 - a summary in the console
  60 - a detailed HTML report with metrics for tested code
  61     - to open it in a web browser: `firefox coverage/index.html &`
  62
  63 ### Executing specific tests
  64
  65 Add a [`@group`](https://phpunit.de/manual/current/en/appendixes.annotations.html#appendixes.annotations.group) annotation in a test class or method comment:
  66
  67 ```php
  68 /**
  69  * Netscape bookmark import
  70  * @group WIP
  71  */
  72 class BookmarkImportTest extends PHPUnit_Framework_TestCase
  73 {
  74    [...]
  75 }
  76 ```
  77
  78 To run all tests annotated with `@group WIP`:
  79 ```bash
  80 $ vendor/bin/phpunit --group WIP tests/
  81 ```