Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

doc: reword simplify xdebug installation/unit tests

Browse source
This commit is contained in:
nodiscc 2020-01-19 13:11:11 +01:00
parent 7a7a523782
commit a8a38401f0
1 changed files with 4 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/md/Unit-tests.md
View file

@ -18,9 +18,9 @@ $ composer install
$ composer update $ composer update
``` ```
#### Install and enable Xdebug to generate PHPUnit coverage reports #### Install Xdebug
See http://xdebug.org/docs/install Xdebug must be installed and enable for PHPUnit to generate coverage reports. See http://xdebug.org/docs/install.
```bash ```bash
# for Debian-based distributions # for Debian-based distributions
@ -31,6 +31,7 @@ $ pacman -S xdebug
``` ```
Then add the following line to `/etc/php/php.ini`: Then add the following line to `/etc/php/php.ini`:
```ini ```ini
zend_extension=xdebug.so zend_extension=xdebug.so
``` ```
@ -39,12 +40,7 @@ zend_extension=xdebug.so
Run `make test` and ensure tests return `OK`. If tests return failures, refer to PHPUnit messages and fix your code/tests accordingly. Run `make test` and ensure tests return `OK`. If tests return failures, refer to PHPUnit messages and fix your code/tests accordingly.
By default, PHPUnit will run all suitable tests found under the `tests` directory. Each test has 3 possible outcomes:
#### Test results and coverage
By default, PHPUnit will run all suitable tests found under the `tests` directory.
Each test has 3 possible outcomes:
- `.` - success - `.` - success
- `F` - failure: the test was run but its results are invalid - `F` - failure: the test was run but its results are invalid