X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2FUnit-tests.html;h=7934e34602aa05a5f17d173f1093cddabc46c3bb;hb=5e148f8a529abf72256ef74ed149d56a5b27bd72;hp=25873cb01ea2e9fb4f26780f02326838228245fb;hpb=27cf2e671d1f35bd8c9383d008cd3733fc1c6e0d;p=github%2Fshaarli%2FShaarli.git diff --git a/doc/Unit-tests.html b/doc/Unit-tests.html index 25873cb0..7934e346 100644 --- a/doc/Unit-tests.html +++ b/doc/Unit-tests.html @@ -4,31 +4,49 @@ - Shaarli - Unit tests + Shaarli – Unit tests - +
@@ -36,21 +54,30 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Home
  • Installation
  • +
  • Docker
  • Usage
  • How To
  • Troubleshooting
  • Development @@ -60,6 +87,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Directory structure
  • 3rd party libraries
  • Plugin System
  • +
  • Release Shaarli
  • Security
  • Static analysis
  • Theming
  • @@ -82,27 +110,27 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • a local version, downloadable here
  • Sample usage

    -
    # system-wide version
    +
    # system-wide version
     $ composer install
     $ composer update
     
     # local version
     $ php composer.phar self-update
     $ php composer.phar install
    -$ php composer.phar update
    +$ php composer.phar update

    Install Shaarli dev dependencies

    -
    $ cd /path/to/shaarli
    -$ composer update
    +
    $ cd /path/to/shaarli
    +$ composer update

    Install and enable Xdebug to generate PHPUnit coverage reports

    For Debian-based distros:

    -
    $ aptitude install php5-xdebug
    +
    $ aptitude install php5-xdebug

    For ArchLinux:

    -
    $ pacman -S xdebug
    +
    $ pacman -S xdebug

    Then add the following line to /etc/php/php.ini:

    -
    zend_extension=xdebug.so
    +
    zend_extension=xdebug.so

    Run unit tests

    Successful test suite:

    -
    $ make test
    +
    $ make test
     
     -------
     PHPUNIT
    @@ -115,9 +143,9 @@ $ composer update
    Time: 759 ms, Memory: 8.25Mb -OK (36 tests, 65 assertions)
    +OK (36 tests, 65 assertions)

    Test suite with failures and errors:

    -
    $ make test
    +
    $ make test
     -------
     PHPUNIT
     -------
    @@ -163,7 +191,7 @@ DBTest.php on line 79 and defined
     /home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:133
     
     FAILURES!
    -Tests: 36, Assertions: 63, Errors: 1, Failures: 2.
    +Tests: 36, Assertions: 63, Errors: 1, Failures: 2.

    Test results and coverage

    By default, PHPUnit will run all suitable tests found under the tests directory.

    Each test has 3 possible outcomes: