From 992af0b9d77cb4fbac2c37ef8d5896042d67a2a3 Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Wed, 22 Jul 2015 05:02:10 +0200 Subject: Doc: sync from Wiki, generate HTML Closes #291 Fixes #227 Modifications - HTML content: match the new Wiki structure - Makefile - generate a custom HTML sidebar - include the sidebar on all pages - infer and prepend page titles - handle relative links - add title metadata, e.g. Shaarli - Signed-off-by: VirtualTam --- doc/Running-unit-tests.md | 127 ---------------------------------------------- 1 file changed, 127 deletions(-) delete mode 100644 doc/Running-unit-tests.md (limited to 'doc/Running-unit-tests.md') diff --git a/doc/Running-unit-tests.md b/doc/Running-unit-tests.md deleted file mode 100644 index 94e99591..00000000 --- a/doc/Running-unit-tests.md +++ /dev/null @@ -1,127 +0,0 @@ - -### Setup your environment for tests -The framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool. - -Regarding Composer, you can either use: -* a system-wide version, e.g. installed through your distro's package manager -* a local version, downloadable [here](https://getcomposer.org/download/) - -#### Sample usage -```bash -# system-wide version -$ composer install -$ composer update - -# local version -$ php composer.phar self-update -$ php composer.phar install -$ php composer.phar update -``` - -#### Install Shaarli dev dependencies -```bash -$ cd /path/to/shaarli -$ composer update -``` - -#### Install and enable Xdebug to generate PHPUnit coverage reports -For Debian-based distros: -```bash -$ aptitude install php5-xdebug -``` -For ArchLinux: -```bash -$ pacman -S xdebug -``` - -Then add the following line to `/etc/php/php.ini`: -```ini -zend_extension=xdebug.so -``` - -#### Run unit tests -Successful test suite: -```bash -$ make test - -------- -PHPUNIT -------- -PHPUnit 4.6.9 by Sebastian Bergmann and contributors. - -Configuration read from /home/virtualtam/public_html/shaarli/phpunit.xml - -.................................... - -Time: 759 ms, Memory: 8.25Mb - -OK (36 tests, 65 assertions) -``` - -Test suite with failures and errors: -```bash -$ make test -------- -PHPUNIT -------- -PHPUnit 4.6.9 by Sebastian Bergmann and contributors. - -Configuration read from /home/virtualtam/public_html/shaarli/phpunit.xml - -E..FF............................... - -Time: 802 ms, Memory: 8.25Mb - -There was 1 error: - -1) LinkDBTest::testConstructLoggedIn -Missing argument 2 for LinkDB::__construct(), called in /home/virtualtam/public_html/shaarli/tests/Link\ -DBTest.php on line 79 and defined - -/home/virtualtam/public_html/shaarli/application/LinkDB.php:58 -/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:79 - --- - -There were 2 failures: - -1) LinkDBTest::testCheckDBNew -Failed asserting that two strings are equal. ---- Expected -+++ Actual -@@ @@ --'e3edea8ea7bb50be4bcb404df53fbb4546a7156e' -+'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834' - -/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:121 - -2) LinkDBTest::testCheckDBLoad -Failed asserting that two strings are equal. ---- Expected -+++ Actual -@@ @@ --'e3edea8ea7bb50be4bcb404df53fbb4546a7156e' -+'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834' - -/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:133 - -FAILURES! -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: -* `.` - success -* `F` - failure: the test was run but its results are invalid - * the code does not behave as expected - * dependencies to external elements: globals, session, cache... -* `E` - error: something went wrong and the tested code has crashed - * typos in the code, or in the test code - * dependencies to missing external elements - -If Xdebug has been installed and activated, two coverage reports will be generated: -* a summary in the console -* a detailed HTML report with metrics for tested code - * to open it in a web browser: `firefox coverage/index.html &` \ No newline at end of file -- cgit v1.2.3