From 54ab5636e3a4f496ed96178470f50dec6c6196b2 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 19 Jan 2020 13:18:29 +0100 Subject: [PATCH] doc: merge unit tests/docker unit tests pages, simplfy, reword --- doc/md/Unit-tests-Docker.md | 56 ------------------------------------- doc/md/Unit-tests.md | 53 +++++++++++++++++++++++++++++++---- mkdocs.yml | 1 - 3 files changed, 48 insertions(+), 62 deletions(-) delete mode 100644 doc/md/Unit-tests-Docker.md diff --git a/doc/md/Unit-tests-Docker.md b/doc/md/Unit-tests-Docker.md deleted file mode 100644 index 59bd5b45..00000000 --- a/doc/md/Unit-tests-Docker.md +++ /dev/null @@ -1,56 +0,0 @@ -## Running tests inside Docker containers - -Read first: - -- [Docker 101](docker/docker-101.md) -- [Docker resources](docker/resources.md) -- [Unit tests](Unit-tests.md) - -### Docker test images - -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. - -### Building test images - -```bash -# build the Debian 9 Docker image -$ cd /path/to/shaarli -$ cd tests/docker/debian9 -$ docker build -t shaarli-test:debian9 . -``` - -### Running tests - -```bash -$ cd /path/to/shaarli - -# 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 -``` diff --git a/doc/md/Unit-tests.md b/doc/md/Unit-tests.md index 651b546d..c45f957d 100644 --- a/doc/md/Unit-tests.md +++ b/doc/md/Unit-tests.md @@ -1,6 +1,6 @@ -### 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 ### Install composer @@ -10,7 +10,7 @@ You can either use: - a local version, downloadable [here](https://getcomposer.org/download/). To update a local composer installation, run `php composer.phar self-update` -#### Install Shaarli dev dependencies +### Install Shaarli development dependencies ```bash $ cd /path/to/shaarli @@ -18,7 +18,7 @@ $ composer install $ composer update ``` -#### Install Xdebug +### Install Xdebug Xdebug must be installed and enable for PHPUnit to generate coverage reports. See http://xdebug.org/docs/install. @@ -36,7 +36,7 @@ Then add the following line to `/etc/php/php.ini`: zend_extension=xdebug.so ``` -#### Run unit tests +## Run unit tests Run `make test` and ensure tests return `OK`. If tests return failures, refer to PHPUnit messages and fix your code/tests accordingly. @@ -75,3 +75,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 +``` diff --git a/mkdocs.yml b/mkdocs.yml index 248fdbfe..cee2c5fb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -51,6 +51,5 @@ pages: - Translations: Translations.md - Theming: Theming.md - Unit tests: Unit-tests.md - - Unit tests inside Docker: Unit-tests-Docker.md - FAQ: FAQ.md - Troubleshooting: Troubleshooting.md -- 2.41.0