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 you used composer to install MediaWiki's dependencies PHPUnit will already be available, unless
  18 you explicitly specified the --no-dev flag during the install. In this case just run "composer update".
  19
  20 Otherwise follow the installation instructions in the
  21 PHPUnit Manual at:
  22
  23   https://phpunit.de/manual/current/en/installation.html
  24
  25
  26 == Running tests ==
  27
  28 The tests are run from your operating system's command line.
  29
  30 Ensure that you are in the tests/phpunit directory of your MediaWiki
  31 installation.
  32
  33
  34 On Unix-like operating systems, the tests runs are controlled with a makefile.
  35 Run command:
  36
  37   make help
  38
  39 for a full list of options for running tests.
  40
  41
  42 On Windows-family operating systems, run the 'run-tests.bat' batch file.
  43
  44
  45 === Writing tests ===
  46
  47 A guide to writing PHP unit tests for MediaWiki can be found at:
  48
  49         https://www.mediawiki.org/wiki/Manual:PHP_unit_testing
  50