tests/phpunit/README

   1 == MediaWiki PHPUnit Tests ==
   2
   3 The unit tests for MediaWiki are implemented using the PHPUnit testing
   4 framework and require PHPUnit to run.
   5
   6
   7 === WARNING ===
   8
   9 Some of the unit tests are DESTRUCTIVE and WILL ALTER YOUR WIKI'S CONTENTS.
  10
  11 DO NOT RUN THESE TESTS ON A PRODUCTION SYSTEM OR ON ANY SYSTEM WHERE YOU NEED
  12 TO RETAIN YOUR DATA.
  13
  14
  15 == Installation ==
  16
  17 If PHPUnit is not installed, follow the installation instructions in the
  18 PHPUnit Manual at:
  19
  20   http://www.phpunit.de/manual/current/en/installation.html
  21
  22 - or -
  23
  24 On Unix-like operating systems, run:
  25
  26   make install
  27
  28
  29 == Running tests ==
  30
  31 The tests are run from your operating system's command line.
  32
  33 Ensure that you are in the tests/phpunit directory of your MediaWiki
  34 installation.
  35
  36
  37 On Unix-like operating systems, the tests runs are controlled with a makefile.
  38 Run command:
  39
  40   make help
  41
  42 for a full list of options for running tests.
  43
  44
  45 On Windows-family operating systems, run the 'run-tests.bat' batch file.
  46
  47
  48 === Writing tests ===
  49
  50 A guide to writing unit tests for MediaWiki can be found at:
  51
  52         http://mediawiki.org/wiki/Unit_Testing
  53