From 91a21c272960889afd4eaa431a3d29b7785b6efc Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sat, 16 May 2020 12:54:51 +0200 Subject: **General rewording, proof-reading, deduplication, shortening, reordering, simplification, cleanup/formatting/standardization** - standardize page names, rework documentation structure, update TOC - use same example paths everywhere - level 1 titles on all pages - fix broken links - .md suffix on all page links (works both from readthedocs and github repository views) **Server:** A full and concise installation guide with examples is a frequent request. The documentation should provide such a guide for basic installation needs, while explaining alternative/advanced configuration at the end. Links to reference guides and documentation should be used more frequently to avoid recommending an outdated or excessively complex configuration. - server: move most server-related info to server-configuration.md, cleanup/shorten - server: update list of php dependencies/libraries, link to composer.json - server: installation: support 3 install methods (from release zip, from sources, using docker) - server: installation: use rsync instead of mv as mv results will change depending of taget directory already existing or not - server: add example/basic usage of certbot - server, upgrade, installation: update file permissions setup, use sudo for upgrade operations in webserver document root - server: apache: add comments to configuration, fix and factorize file permissions setup, set cache-control header, deny access to dotfiles, add missing apache config steps, add http->https redirect example - server: nginx: refactor nginx configuration, add comments, DO log access to denied/protected files - server: add links to MDN for x-forwarded-* http headers explanation, cleanup/clarify robots.txt and crawlers section - server: bump file upload size limit to 100MB we have reports of bookmark exports weighing +40MB - i have a 13MB one here - server: simplify phpinfo documentation - server: move backup and restore information to dedicated page - docker: move all docker docs to Docker.md, simplify/ docker setup, add docker-compose.yml example, replace docker-101 with docker cheatsheet - troubleshooting: move all troubleshooting documentation to troubleshooting.md **Usage:** - index: add getting started section on index page - features/usage: move all usage-related documentation to usage.md, add links from the main feature list to corresponding usage docs, clarify/reword features list - shaarli configuration: add note about configuring from web interface **Removed:** - remove obsolete/orphan images - remove obsolete shaarchiver example - remove outdated "decode datastore content" snippet **Development:** - development: move development-related docs (static analysis, CI, unit tests, 3rd party libs, link structure/directory, guidelines, security....) to dev/ directory - development: Merge several pages to development.md - **Breaking change?:** remove mentions of 'stable' branch, switch to new branch/release model (master=latest commit, release=latest tag) - **Breaking change?:** refer to base sharing unit as "Shaare" everywhere (TODO: reflect changes in the code?) doc: update featues list/link to usage.md for details - development: directory structure: add note about required file permissions - .travis-ci.yml: add comments - .htaccess: add comment --- doc/md/Unit-tests.md | 119 --------------------------------------------------- 1 file changed, 119 deletions(-) delete mode 100644 doc/md/Unit-tests.md (limited to 'doc/md/Unit-tests.md') diff --git a/doc/md/Unit-tests.md b/doc/md/Unit-tests.md deleted file mode 100644 index a9544656..00000000 --- a/doc/md/Unit-tests.md +++ /dev/null @@ -1,119 +0,0 @@ -The testing 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 (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` - - -### Install Shaarli development dependencies - -```bash -$ cd /path/to/shaarli -$ composer install -``` - -### Install Xdebug - -Xdebug must be installed and enable for PHPUnit to generate coverage reports. See http://xdebug.org/docs/install. - -```bash -# for Debian-based distributions -$ aptitude install php-xdebug - -# for ArchLinux: -$ pacman -S xdebug -``` - -Then add the following line to `/etc/php//cli/php.ini`: - -```ini -zend_extension=xdebug.so -``` - -## 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. - -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 &` - -### Executing specific tests - -Add a [`@group`](https://phpunit.de/manual/current/en/appendixes.annotations.html#appendixes.annotations.group) annotation in a test class or method comment: - -```php -/** - * Netscape bookmark import - * @group WIP - */ -class BookmarkImportTest extends PHPUnit_Framework_TestCase -{ - [...] -} -``` - -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 -``` -- cgit v1.2.3