diff options
| author | VirtualTam <virtualtam@flibidi.net> | 2017-08-05 11:56:24 +0200 |
|---|---|---|
| committer | VirtualTam <virtualtam@flibidi.net> | 2017-08-05 11:56:24 +0200 |
| commit | 43ad7c8e825057747ccf02049050b323878952a7 (patch) | |
| tree | 3160fd640c42f41a38d6c1df2cd4e020f87942ae /doc/md/Unit-tests.md | |
| parent | b4ff0afb24db6e4cb3543bbd71f01bbb0716b144 (diff) | |
| download | Shaarli-43ad7c8e825057747ccf02049050b323878952a7.tar.gz Shaarli-43ad7c8e825057747ccf02049050b323878952a7.tar.zst Shaarli-43ad7c8e825057747ccf02049050b323878952a7.zip | |
documentation: fix rendering and internal references
This is mainly cleanup after switching from Github-flavoured Markdown
rendered by Github Pages, to standard Markdown rendered by MkDocs.
Changed:
- rephrase some section titles
Fixed:
- list rendering (items, sub-items))
- code rendering
- quotes
- dead links
Removed:
- extraneous navigational elements
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Diffstat (limited to 'doc/md/Unit-tests.md')
| -rw-r--r-- | doc/md/Unit-tests.md | 27 |
1 files changed, 15 insertions, 12 deletions
diff --git a/doc/md/Unit-tests.md b/doc/md/Unit-tests.md index 19838721..d200634f 100644 --- a/doc/md/Unit-tests.md +++ b/doc/md/Unit-tests.md | |||
| @@ -3,8 +3,9 @@ | |||
| 3 | The framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool. | 3 | The framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool. |
| 4 | 4 | ||
| 5 | Regarding Composer, you can either use: | 5 | Regarding Composer, you can either use: |
| 6 | * a system-wide version, e.g. installed through your distro's package manager | 6 | |
| 7 | * a local version, downloadable [here](https://getcomposer.org/download/) | 7 | - a system-wide version, e.g. installed through your distro's package manager |
| 8 | - a local version, downloadable [here](https://getcomposer.org/download/) | ||
| 8 | 9 | ||
| 9 | #### Sample usage | 10 | #### Sample usage |
| 10 | 11 | ||
| @@ -118,18 +119,20 @@ Tests: 36, Assertions: 63, Errors: 1, Failures: 2. | |||
| 118 | By default, PHPUnit will run all suitable tests found under the `tests` directory. | 119 | By default, PHPUnit will run all suitable tests found under the `tests` directory. |
| 119 | 120 | ||
| 120 | Each test has 3 possible outcomes: | 121 | Each test has 3 possible outcomes: |
| 121 | * `.` - success | 122 | |
| 122 | * `F` - failure: the test was run but its results are invalid | 123 | - `.` - success |
| 123 | * the code does not behave as expected | 124 | - `F` - failure: the test was run but its results are invalid |
| 124 | * dependencies to external elements: globals, session, cache... | 125 | - the code does not behave as expected |
| 125 | * `E` - error: something went wrong and the tested code has crashed | 126 | - dependencies to external elements: globals, session, cache... |
| 126 | * typos in the code, or in the test code | 127 | - `E` - error: something went wrong and the tested code has crashed |
| 127 | * dependencies to missing external elements | 128 | - typos in the code, or in the test code |
| 129 | - dependencies to missing external elements | ||
| 128 | 130 | ||
| 129 | If Xdebug has been installed and activated, two coverage reports will be generated: | 131 | If Xdebug has been installed and activated, two coverage reports will be generated: |
| 130 | * a summary in the console | 132 | |
| 131 | * a detailed HTML report with metrics for tested code | 133 | - a summary in the console |
| 132 | * to open it in a web browser: `firefox coverage/index.html &` | 134 | - a detailed HTML report with metrics for tested code |
| 135 | - to open it in a web browser: `firefox coverage/index.html &` | ||
| 133 | 136 | ||
| 134 | ### Executing specific tests | 137 | ### Executing specific tests |
| 135 | 138 | ||