From 53ed6d7d1e678d7486337ce67a2f17b30bac21ac Mon Sep 17 00:00:00 2001 From: nodiscc Date: Thu, 26 Jan 2017 18:52:54 +0100 Subject: Generate HTML documentation using MkDocs (WIP) MkDocs is a static site generator geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML file. * http://www.mkdocs.org/ * http://www.mkdocs.org/user-guide/configuration/ Ref. #312 * remove pandoc-generated HTML documentation * move markdown doc to doc/md/, * mkdocs.yml: * generate HTML doc in doc/html * add pages TOC/ordering * use index.md as index page * Makefile: remove execute permissions from generated files * Makefile: rewrite htmlpages GFM to markdown conversion using sed: awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks * Add mkdocs.yml to .gitattributes, exclude this file from release archives * Makefile: rename: htmldoc -> doc_html target * run make doc: pull latest markdown documentation from wiki * run make htmlpages: update html documentation --- doc/Unit-tests.html | 226 ---------------------------------------------------- 1 file changed, 226 deletions(-) delete mode 100644 doc/Unit-tests.html (limited to 'doc/Unit-tests.html') diff --git a/doc/Unit-tests.html b/doc/Unit-tests.html deleted file mode 100644 index 09611463..00000000 --- a/doc/Unit-tests.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - - Shaarli – Unit tests - - - - - - -
- -
-

Unit tests

-

Setup your environment for tests

-

The framework used is PHPUnit; it can be installed with Composer, which is a dependency management tool.

-

Regarding Composer, you can either use:

- -

Sample usage

-
# 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

-
$ cd /path/to/shaarli
-$ composer update
-

Install and enable Xdebug to generate PHPUnit coverage reports

-

For Debian-based distros:

-
$ aptitude install php5-xdebug
-

For ArchLinux:

-
$ pacman -S xdebug
-

Then add the following line to /etc/php/php.ini:

-
zend_extension=xdebug.so
-

Run unit tests

-

Successful test suite:

-
$ 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:

-
$ 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

-

By default, PHPUnit will run all suitable tests found under the tests directory.

-

Each test has 3 possible outcomes:

- -

If Xdebug has been installed and activated, two coverage reports will be generated:

- -

Executing specific tests

-

Add a @group annotation in a test class or method comment:

-
/**
- * Netscape bookmark import
- * @group WIP
- */
-class BookmarkImportTest extends PHPUnit_Framework_TestCase
-{
-   [...][](.html)
-}
-

To run all tests annotated with @group WIP:

-
$ vendor/bin/phpunit --group WIP tests/
- - -- cgit v1.2.3