summaryrefslogtreecommitdiff
path: root/www/wiki/skins/chameleon/docs/testing.md
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/skins/chameleon/docs/testing.md')
-rw-r--r--www/wiki/skins/chameleon/docs/testing.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/www/wiki/skins/chameleon/docs/testing.md b/www/wiki/skins/chameleon/docs/testing.md
new file mode 100644
index 00000000..87c4180a
--- /dev/null
+++ b/www/wiki/skins/chameleon/docs/testing.md
@@ -0,0 +1,26 @@
+## Testing
+
+This skin provides unit tests that can be run by a [continuous integration
+platform][travis] or manually by executing the `mw-phpunit-runner.php` script or
+[`phpunit`][mw-testing] together with the PHPUnit configuration file found in
+the root directory of the skin.
+```sh
+php tests/mw-phpunit-runner.php [options]
+```
+
+Useful optional parameters:
+```
+--coverage-html ../../../report
+--debug
+```
+
+To test against an external HTML validation service
+(http://validator.w3.org/check) set the `USE_EXTERNAL_HTML_VALIDATOR` setting to
+`true` in `phpunit.xml.dist`. Please be careful with their resources and use
+this setting sparingly. If you do this, you may also want to set
+`printerClass="Skins\Chameleon\Tests\Util\ColoringTextUIResultPrinter"` as an
+additional attribute in the `phpunit` element to colorize then tests that
+connect to the external service.
+
+[travis]: https://travis-ci.org/cmln/chameleon
+[mw-testing]: https://www.mediawiki.org/wiki/Manual:PHP_unit_testing