aboutsummaryrefslogtreecommitdiffstats
path: root/tests/RUNNING_TESTS.txt
diff options
context:
space:
mode:
authorOleg Pudeyev <oleg@bsdpower.com>2010-05-08 16:41:18 -0400
committerAndreas Fischer <bantu@phpbb.com>2010-07-07 16:10:13 +0200
commit030f9c03c66950d4ec94567108f4baa8da709ab6 (patch)
tree4a79ec9383c1c826e1254516a3285f504d54ad40 /tests/RUNNING_TESTS.txt
parent91399fd3571fc2fe95eb680564cad6103adadf59 (diff)
downloadforums-030f9c03c66950d4ec94567108f4baa8da709ab6.tar
forums-030f9c03c66950d4ec94567108f4baa8da709ab6.tar.gz
forums-030f9c03c66950d4ec94567108f4baa8da709ab6.tar.bz2
forums-030f9c03c66950d4ec94567108f4baa8da709ab6.tar.xz
forums-030f9c03c66950d4ec94567108f4baa8da709ab6.zip
[ticket/9593] A readme file for unit tests and running unit tests.
Added a readme file explaining prerequisites for unit tests, and how to run unit tests. PHPBB3-9593
Diffstat (limited to 'tests/RUNNING_TESTS.txt')
-rw-r--r--tests/RUNNING_TESTS.txt33
1 files changed, 33 insertions, 0 deletions
diff --git a/tests/RUNNING_TESTS.txt b/tests/RUNNING_TESTS.txt
new file mode 100644
index 0000000000..f1b40f71ad
--- /dev/null
+++ b/tests/RUNNING_TESTS.txt
@@ -0,0 +1,33 @@
+Running Tests
+-------------
+
+Prerequisites
+-------------
+
+PHPUnit
+=======
+
+phpBB unit tests use PHPUnit framework. Version 3.3 or better is required
+to run the tests. PHPUnit prefers to be installed via PEAR; refer to
+http://www.phpunit.de/ for more information.
+
+PHP extensions
+==============
+
+Unit tests use several PHP extensions that board code does not use. Currently
+the following PHP extensions must be installed and enabled to run unit tests:
+
+- ctype
+
+Running
+-------
+
+Once the prerequisites are installed, run the tests from tests directory:
+
+$ phpunit all_tests.php
+
+More Information
+----------------
+
+Further information is available on phpbb wiki:
+http://wiki.phpbb.com/display/DEV/Unit+Tests