tests/phpunit/phpunit.php

   1 #!/usr/bin/env php
   2 <?php
   3 /**
   4  * Bootstrapping for MediaWiki PHPUnit tests
   5  *
   6  * @file
   7  */
   8
   9 // Set a flag which can be used to detect when other scripts have been entered
  10 // through this entry point or not.
  11 define( 'MW_PHPUNIT_TEST', true );
  12
  13 // Start up MediaWiki in command-line mode
  14 require_once dirname( dirname( __DIR__ ) ) . "/maintenance/Maintenance.php";
  15
  16 class PHPUnitMaintClass extends Maintenance {
  17
  18         public static $additionalOptions = array(
  19                 'regex' => false,
  20                 'file' => false,
  21                 'use-filebackend' => false,
  22                 'use-bagostuff' => false,
  23                 'use-jobqueue' => false,
  24                 'keep-uploads' => false,
  25                 'use-normal-tables' => false,
  26                 'reuse-db' => false,
  27                 'wiki' => false,
  28         );
  29
  30         public function __construct() {
  31                 parent::__construct();
  32                 $this->addOption(
  33                         'with-phpunitdir',
  34                         'Directory to include PHPUnit from, for example when using a git '
  35                                 . 'fetchout from upstream. Path will be prepended to PHP `include_path`.',
  36                         false, # not required
  37                         true # need arg
  38                 );
  39                 $this->addOption(
  40                         'debug-tests',
  41                         'Log testing activity to the PHPUnitCommand log channel.',
  42                         false, # not required
  43                         false # no arg needed
  44                 );
  45                 $this->addOption( 'regex', 'Only run parser tests that match the given regex.', false, true );
  46                 $this->addOption( 'file', 'File describing parser tests.', false, true );
  47                 $this->addOption( 'use-filebackend', 'Use filebackend', false, true );
  48                 $this->addOption( 'use-bagostuff', 'Use bagostuff', false, true );
  49                 $this->addOption( 'use-jobqueue', 'Use jobqueue', false, true );
  50                 $this->addOption( 'keep-uploads', 'Re-use the same upload directory for each test, don\'t delete it.', false, false );
  51                 $this->addOption( 'use-normal-tables', 'Use normal DB tables.', false, false );
  52                 $this->addOption( 'reuse-db', 'Init DB only if tables are missing and keep after finish.', false, false );
  53         }
  54
  55         public function finalSetup() {
  56                 parent::finalSetup();
  57
  58                 global $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType;
  59                 global $wgLanguageConverterCacheType, $wgUseDatabaseMessages;
  60                 global $wgLocaltimezone, $wgLocalisationCacheConf;
  61                 global $wgDevelopmentWarnings;
  62
  63                 // Inject test autoloader
  64                 require_once __DIR__ . '/../TestsAutoLoader.php';
  65
  66                 // wfWarn should cause tests to fail
  67                 $wgDevelopmentWarnings = true;
  68
  69                 $wgMainCacheType = CACHE_NONE;
  70                 $wgMessageCacheType = CACHE_NONE;
  71                 $wgParserCacheType = CACHE_NONE;
  72                 $wgLanguageConverterCacheType = CACHE_NONE;
  73
  74                 $wgUseDatabaseMessages = false; # Set for future resets
  75
  76                 // Assume UTC for testing purposes
  77                 $wgLocaltimezone = 'UTC';
  78
  79                 $wgLocalisationCacheConf['storeClass'] = 'LCStoreNull';
  80
  81                 // Bug 44192 Do not attempt to send a real e-mail
  82                 Hooks::clear( 'AlternateUserMailer' );
  83                 Hooks::register(
  84                         'AlternateUserMailer',
  85                         function () {
  86                                 return false;
  87                         }
  88                 );
  89                 // xdebug's default of 100 is too low for MediaWiki
  90                 ini_set( 'xdebug.max_nesting_level', 1000 );
  91         }
  92
  93         public function execute() {
  94                 global $IP;
  95
  96                 // Deregister handler from MWExceptionHandler::installHandle so that PHPUnit's own handler
  97                 // stays in tact.
  98                 // Has to in execute() instead of finalSetup(), because finalSetup() runs before
  99                 // doMaintenance.php includes Setup.php, which calls MWExceptionHandler::installHandle().
 100                 restore_error_handler();
 101
 102                 $this->forceFormatServerArgv();
 103
 104                 # Make sure we have --configuration or PHPUnit might complain
 105                 if ( !in_array( '--configuration', $_SERVER['argv'] ) ) {
 106                         //Hack to eliminate the need to use the Makefile (which sucks ATM)
 107                         array_splice( $_SERVER['argv'], 1, 0,
 108                                 array( '--configuration', $IP . '/tests/phpunit/suite.xml' ) );
 109                 }
 110
 111                 # --with-phpunitdir let us override the default PHPUnit version
 112                 # Can use with either or phpunit.phar in the directory or the
 113                 # full PHPUnit code base.
 114                 if ( $this->hasOption( 'with-phpunitdir' ) ) {
 115                         $phpunitDir = $this->getOption( 'with-phpunitdir' );
 116
 117                         # prepends provided PHPUnit directory or phar
 118                         $this->output( "Will attempt loading PHPUnit from `$phpunitDir`\n" );
 119                         set_include_path( $phpunitDir . PATH_SEPARATOR . get_include_path() );
 120
 121                         # Cleanup $args array so the option and its value do not
 122                         # pollute PHPUnit
 123                         $key = array_search( '--with-phpunitdir', $_SERVER['argv'] );
 124                         unset( $_SERVER['argv'][$key] ); // the option
 125                         unset( $_SERVER['argv'][$key + 1] ); // its value
 126                         $_SERVER['argv'] = array_values( $_SERVER['argv'] );
 127                 }
 128
 129                 if ( !wfIsWindows() ) {
 130                         # If we are not running on windows then we can enable phpunit colors
 131                         # Windows does not come anymore with ANSI.SYS loaded by default
 132                         # PHPUnit uses the suite.xml parameters to enable/disable colors
 133                         # which can be then forced to be enabled with --colors.
 134                         # The below code injects a parameter just like if the user called
 135                         # Probably fix bug 29226
 136                         $key = array_search( '--colors', $_SERVER['argv'] );
 137                         if ( $key === false ) {
 138                                 array_splice( $_SERVER['argv'], 1, 0, '--colors' );
 139                         }
 140                 }
 141
 142                 # Makes MediaWiki PHPUnit directory includable so the PHPUnit will
 143                 # be able to resolve relative files inclusion such as suites/*
 144                 # PHPUnit uses stream_resolve_include_path() internally
 145                 # See bug 32022
 146                 $key = array_search( '--include-path', $_SERVER['argv'] );
 147                 if ( $key === false ) {
 148                         array_splice( $_SERVER['argv'], 1, 0,
 149                                 __DIR__
 150                                 . PATH_SEPARATOR
 151                                 . get_include_path()
 152                         );
 153                         array_splice( $_SERVER['argv'], 1, 0, '--include-path' );
 154                 }
 155
 156                 $key = array_search( '--debug-tests', $_SERVER['argv'] );
 157                 if ( $key !== false && array_search( '--printer', $_SERVER['argv'] ) === false ) {
 158                         unset( $_SERVER['argv'][$key] );
 159                         array_splice( $_SERVER['argv'], 1, 0, 'MediaWikiPHPUnitTestListener' );
 160                         array_splice( $_SERVER['argv'], 1, 0, '--printer' );
 161                 }
 162
 163                 foreach ( self::$additionalOptions as $option => $default ) {
 164                         $key = array_search( '--' . $option, $_SERVER['argv'] );
 165                         if ( $key !== false ) {
 166                                 unset( $_SERVER['argv'][$key] );
 167                                 if ( $this->mParams[$option]['withArg'] ) {
 168                                         self::$additionalOptions[$option] = $_SERVER['argv'][$key + 1];
 169                                         unset( $_SERVER['argv'][$key + 1] );
 170                                 } else {
 171                                         self::$additionalOptions[$option] = true;
 172                                 }
 173                         }
 174                 }
 175
 176         }
 177
 178         public function getDbType() {
 179                 return Maintenance::DB_ADMIN;
 180         }
 181
 182         /**
 183          * Force the format of elements in $_SERVER['argv']
 184          *  - Split args such as "wiki=enwiki" into two separate arg elements "wiki" and "enwiki"
 185          */
 186         private function forceFormatServerArgv() {
 187                 $argv = array();
 188                 foreach ( $_SERVER['argv'] as $key => $arg ) {
 189                         if ( $key === 0 ) {
 190                                 $argv[0] = $arg;
 191                         } elseif ( strstr( $arg, '=' ) ) {
 192                                 foreach ( explode( '=', $arg, 2 ) as $argPart ) {
 193                                         $argv[] = $argPart;
 194                                 }
 195                         } else {
 196                                 $argv[] = $arg;
 197                         }
 198                 }
 199                 $_SERVER['argv'] = $argv;
 200         }
 201
 202 }
 203
 204 $maintClass = 'PHPUnitMaintClass';
 205 require RUN_MAINTENANCE_IF_MAIN;
 206
 207 // Prevent segfault when we have lots of unit tests (bug 62623)
 208 if ( version_compare( PHP_VERSION, '5.4.0', '<' ) ) {
 209         register_shutdown_function( function () {
 210                 gc_collect_cycles();
 211                 gc_disable();
 212         } );
 213 }
 214
 215
 216 $ok = false;
 217
 218 if ( class_exists( 'PHPUnit_TextUI_Command' ) ) {
 219         echo "PHPUnit already present\n";
 220         $ok = true;
 221 } else {
 222         foreach ( array(
 223                                 stream_resolve_include_path( 'phpunit.phar' ),
 224                                 'PHPUnit/Runner/Version.php',
 225                                 'PHPUnit/Autoload.php'
 226                         ) as $includePath ) {
 227                 // @codingStandardsIgnoreStart
 228                 @include_once $includePath;
 229                 // @codingStandardsIgnoreEnd
 230                 if ( class_exists( 'PHPUnit_TextUI_Command' ) ) {
 231                         $ok = true;
 232                         echo "Using PHPUnit from $includePath\n";
 233                         break;
 234                 }
 235         }
 236 }
 237
 238 if ( !$ok ) {
 239         echo "Couldn't find a usable PHPUnit.\n";
 240         exit( 1 );
 241 }
 242
 243 $puVersion = PHPUnit_Runner_Version::id();
 244 if ( $puVersion !== '@package_version@' && version_compare( $puVersion, '3.7.0', '<' ) ) {
 245         echo "PHPUnit 3.7.0 or later required; you have {$puVersion}.\n";
 246         exit( 1 );
 247 }
 248
 249 PHPUnit_TextUI_Command::main();