Merge pull request #1403 from shaarli/doc-composer

doc: simplify composer installation procedure, merge Unit tests related pages, reword/shorten, fix references to old php versions

diff --git a/doc/md/Server-configuration.md b/doc/md/Server-configuration.md
index bd293c37919e47a24dbec6a3bf1c92db595fdff7..f9ea2ed2145801f79c99819750f06b700b7876c8 100644 (file)
--- a/doc/md/Server-configuration.md
+++ b/doc/md/Server-configuration.md
@@ -187,7 +187,7 @@ http {
 ```
 
 ```ini
-# /etc/php5/fpm/php.ini
+# /etc/php/<PHP_VERSION>/fpm/php.ini
 
 [...]
 post_max_size = 10M

diff --git a/doc/md/Server-security.md b/doc/md/Server-security.md
index 700084e272d8ebfed88f9afc41f9104570570ca3..ea1b637dfd2c54058558441152f1cdd93f9a71ec 100644 (file)
--- a/doc/md/Server-security.md
+++ b/doc/md/Server-security.md
@@ -1,10 +1,10 @@
 ## php.ini
 PHP settings are defined in:
 
-- a main configuration file, usually found under `/etc/php5/php.ini`; some distributions provide different configuration environments, e.g.
-    - `/etc/php5/php.ini` - used when running console scripts
-    - `/etc/php5/apache2/php.ini` - used when a client requests PHP resources from Apache
-    - `/etc/php5/php-fpm.conf` - used when PHP requests are proxied to PHP-FPM
+- a main configuration file, usually found under `/etc/php/$php_version/php.ini`; some distributions provide different configuration environments, e.g.
+    - `/etc/php/$php_version/cli/php.ini` - used when running console scripts
+    - `/etc/php/$php_version/apache2/php.ini` - used when a client requests PHP resources from Apache
+    - `/etc/php/$php_version/php-fpm.conf` - used when PHP requests are proxied to PHP-FPM
 - additional configuration files/entries, depending on the installed/enabled extensions:
     - `/etc/php/conf.d/xdebug.ini`
 

diff --git a/doc/md/Unit-tests-Docker.md b/doc/md/Unit-tests-Docker.md
deleted file mode 100644 (file)
index 59bd5b4..0000000
--- 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/<distribution>/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 f6030d5c2f6134848b58ed8987f1458c8dd4df23..a9544656c1012dec098fd1f0b13381446261c52d 100644 (file)
--- a/doc/md/Unit-tests.md
+++ b/doc/md/Unit-tests.md
@@ -1,126 +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
 
 ### Install 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/).
+- 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
 
-See http://xdebug.org/docs/install
+Xdebug must be installed and enable for PHPUnit to generate coverage reports. See http://xdebug.org/docs/install.
 
-For Debian-based distros:
-```bash
-$ aptitude install php5-xdebug
-```
-For ArchLinux:
 ```bash
+# for Debian-based distributions
+$ aptitude install php-xdebug
+
+# for ArchLinux:
 $ pacman -S xdebug
 ```
 
-Then add the following line to `/etc/php/php.ini`:
+Then add the following line to `/etc/php/<PHP_VERSION>/cli/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
+## 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
@@ -155,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/<distribution>/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 248fdbfe3923dafab6cca711a4f4278eaf6a583b..cee2c5fbddd1c00096cd200df3e5f683a44b5359 100644 (file)
--- 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