From 5409ade28c5f0acf99dbadd4d95e6f8efda5d395 Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Thu, 14 Apr 2016 14:20:23 +0200 Subject: Update docs from Wiki --- doc/Unit-tests.html | 81 +++++++++++++++++++++++++++++++++++------------------ 1 file changed, 54 insertions(+), 27 deletions(-) (limited to 'doc/Unit-tests.html') diff --git a/doc/Unit-tests.html b/doc/Unit-tests.html index 6d760771..b933bc7c 100644 --- a/doc/Unit-tests.html +++ b/doc/Unit-tests.html @@ -4,31 +4,49 @@ - Shaarli - Unit tests + Shaarli – Unit tests - +
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Download
  • Server requirements
  • Server configuration
    • +
  • Server security
    • +
  • Shaarli installation
  • Shaarli configuration
    • +
  • Plugin installation & configuration
    • +
  • Docker
    • +
  • Plugin list
  • Usage
  • How To
    • @@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Directory structure
  • 3rd party libraries
  • Plugin System
    • +
  • Release Shaarli
  • Security
  • Static analysis
  • Theming
    • @@ -84,27 +111,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
@@ -117,9 +144,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
 -------
@@ -165,7 +192,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:

    -- cgit v1.2.3