X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2FUnit-tests.md;h=a9544656c1012dec098fd1f0b13381446261c52d;hb=6128ab6a55430a2b705be31ff417c0c552a0db1f;hp=d200634f6ea6513ff5094abc7971e0752cd2b543;hpb=c7fcea1347e81072c5b77c1b3c2c6fb13f02c16f;p=github%2Fshaarli%2FShaarli.git diff --git a/doc/md/Unit-tests.md b/doc/md/Unit-tests.md index d200634f..a9544656 100644 --- a/doc/md/Unit-tests.md +++ b/doc/md/Unit-tests.md @@ -1,124 +1,45 @@ -### Setup your environment for tests +The testing framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool. -The framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool. +## Setup a testing environment -Regarding Composer, you can either use: +### Install composer -- a system-wide version, e.g. installed through your distro's package manager -- a local version, downloadable [here](https://getcomposer.org/download/) +You can either use: -#### Sample usage +- a system-wide version, e.g. installed through your distro's package manager (eg. `sudo apt install composer`) +- a local version, downloadable [here](https://getcomposer.org/download/). To update a local composer installation, run `php composer.phar self-update` -```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 +### Install Shaarli development dependencies ```bash $ cd /path/to/shaarli -$ composer update +$ composer install ``` -#### Install and enable Xdebug to generate PHPUnit coverage reports +### Install Xdebug -For Debian-based distros: -```bash -$ aptitude install php5-xdebug -``` -For ArchLinux: -```bash -$ pacman -S xdebug -``` +Xdebug must be installed and enable for PHPUnit to generate coverage reports. See http://xdebug.org/docs/install. -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 +# for Debian-based distributions +$ aptitude install php-xdebug -OK (36 tests, 65 assertions) +# for ArchLinux: +$ pacman -S xdebug ``` -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: +Then add the following line to `/etc/php//cli/php.ini`: -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. +```ini +zend_extension=xdebug.so ``` -#### Test results and coverage +## Run unit tests -By default, PHPUnit will run all suitable tests found under the `tests` directory. +Run `make test` and ensure tests return `OK`. If tests return failures, refer to PHPUnit messages and fix your code/tests accordingly. -Each test has 3 possible outcomes: +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 @@ -153,3 +74,46 @@ To run all tests annotated with `@group WIP`: ```bash $ vendor/bin/phpunit --group WIP tests/ ``` + +### Running tests inside Docker containers + +Test Dockerfiles are located under `tests/docker//Dockerfile`, +and can be used to build Docker images to run Shaarli test suites under common +Linux environments. + +Dockerfiles are provided for the following environments: + +- `alpine36` - [Alpine 3.6](https://www.alpinelinux.org/downloads/) +- `debian8` - [Debian 8 Jessie](https://www.debian.org/DebianJessie) (oldstable) +- `debian9` - [Debian 9 Stretch](https://wiki.debian.org/DebianStretch) (stable) +- `ubuntu16` - [Ubuntu 16.04 Xenial Xerus](http://releases.ubuntu.com/16.04/) (LTS) + +What's behind the curtains: + +- each image provides: + - a base Linux OS + - Shaarli PHP dependencies (OS packages) + - test PHP dependencies (OS packages) + - Composer +- the local workspace is mapped to the container's `/shaarli/` directory, +- the files are rsync'd so tests are run using a standard Linux user account + (running tests as `root` would bypass permission checks and may hide issues) +- the tests are run inside the container. + +To run tests inside a Docker container: + +```bash +# build the Debian 9 Docker image for unit tests +$ cd /path/to/shaarli +$ cd tests/docker/debian9 +$ docker build -t shaarli-test:debian9 . + +# install/update 3rd-party test dependencies +$ composer install --prefer-dist + +# run tests using the freshly built image +$ docker run -v $PWD:/shaarli shaarli-test:debian9 docker_test + +# run the full test campaign +$ docker run -v $PWD:/shaarli shaarli-test:debian9 docker_all_tests +```