diff options
Diffstat (limited to 'www/wiki/tests/phpunit/README')
| -rw-r--r-- | www/wiki/tests/phpunit/README | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/www/wiki/tests/phpunit/README b/www/wiki/tests/phpunit/README new file mode 100644 index 00000000..f555812d --- /dev/null +++ b/www/wiki/tests/phpunit/README @@ -0,0 +1,50 @@ +== MediaWiki PHPUnit Tests == + +The unit tests for MediaWiki are implemented using the PHPUnit testing +framework and require PHPUnit to run. + + +=== WARNING === + +Some of the unit tests are DESTRUCTIVE and WILL ALTER YOUR WIKI'S CONTENTS. + +DO NOT RUN THESE TESTS ON A PRODUCTION SYSTEM OR ON ANY SYSTEM WHERE YOU NEED +TO RETAIN YOUR DATA. + + +== Installation == + +If you used composer to install MediaWiki's dependencies PHPUnit will already be available, unless +you explicitly specified the --no-dev flag during the install. In this case just run "composer update". + +Otherwise follow the installation instructions in the +PHPUnit Manual at: + + https://phpunit.de/manual/current/en/installation.html + + +== Running tests == + +The tests are run from your operating system's command line. + +Ensure that you are in the tests/phpunit directory of your MediaWiki +installation. + + +On Unix-like operating systems, the tests runs are controlled with a makefile. +Run command: + + make help + +for a full list of options for running tests. + + +On Windows-family operating systems, run the 'run-tests.bat' batch file. + + +=== Writing tests === + +A guide to writing PHP unit tests for MediaWiki can be found at: + + https://www.mediawiki.org/wiki/Manual:PHP_unit_testing + |