summaryrefslogtreecommitdiff
path: root/_test/README
diff options
context:
space:
mode:
authorTobias Sarnowski <sarnowski@cosmocode.de>2012-04-18 12:08:28 +0200
committerTobias Sarnowski <sarnowski@cosmocode.de>2012-04-18 12:08:28 +0200
commitf8369d7d6e37248d6523fdac6e1d760fca4f1b52 (patch)
tree0848c213ffc191a23b55f07bd2ec55e777ea79ca /_test/README
parentd59108b91e9bf9fd56dc2e697cf31f9bbc7f9cd4 (diff)
downloadrpg-f8369d7d6e37248d6523fdac6e1d760fca4f1b52.tar.gz
rpg-f8369d7d6e37248d6523fdac6e1d760fca4f1b52.tar.bz2
moved _testing to _test
Diffstat (limited to '_test/README')
-rw-r--r--_test/README70
1 files changed, 70 insertions, 0 deletions
diff --git a/_test/README b/_test/README
new file mode 100644
index 000000000..aadd819bf
--- /dev/null
+++ b/_test/README
@@ -0,0 +1,70 @@
+DokuWiki Test Suite
+=============================================================================
+
+Content of this document:
+
+ * Requirements
+ * Installation of PHPUnit via Pear
+ * Running all Tests
+ * Create new Tests
+ * Known Bad Tests
+ * TODO for test framework
+
+
+
+Requirements
+-----------------------------------------------------------------------------
+
+ * PHP Unit 3.7
+
+
+Installation of PHPUnit via Pear
+-----------------------------------------------------------------------------
+
+ > pear config-set auto_discover 1
+ > pear upgrade
+ > pear install pear.phpunit.de/PHPUnit
+
+
+Running all Tests
+-----------------------------------------------------------------------------
+
+ > cd _testing/
+ > phpunit
+
+PHPUnit will fail on some systems with the error 'headers already sent'. The
+known workaround for that is to use the '--stderr' flag for PHPUnit:
+
+ > phpunit --stderr
+
+
+Create new Tests
+-----------------------------------------------------------------------------
+
+To create a test for DokuWiki, create a *.test.php file within the tests/
+folder. Please respect the folder structure and naming convention. Inside the
+file, implement a class, extending 'DokuWikiTest'. Every method, starting
+with 'test' will be called as a test (e.g. 'testIfThisIsValid');
+
+
+TODO for the test framework
+-----------------------------------------------------------------------------
+
+ * test cross platform compatibility: especially test windows
+ * update http://www.dokuwiki.org/devel:unittesting
+ * optional: add helper methods to TestRequest for easy form submission
+ * createForm(), ...
+
+
+Migration Protocol
+-----------------------------------------------------------------------------
+
+The following tests were not migrated:
+
+ * inc/html_hilight (runkit)
+ * inc/indexer_idx_indexlengths (fs dependencies)
+ * inc/mail_send (integration test)
+ * inc/parser/parser_formatting
+ * inc/parser/xhtml_htmlphp (runkit)
+ * inc/parser/xhtml_links
+