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 = [
  19                 'file' => false,
  20                 'use-filebackend' => false,
  21                 'use-bagostuff' => false,
  22                 'use-jobqueue' => false,
  23                 'use-normal-tables' => false,
  24                 'reuse-db' => false,
  25                 'wiki' => false,
  26                 'profiler' => false,
  27         ];
  28
  29         public function __construct() {
  30                 parent::__construct();
  31                 $this->addOption(
  32                         'with-phpunitclass',
  33                         'Class name of the PHPUnit entry point to use',
  34                         false,
  35                         true
  36                 );
  37                 $this->addOption(
  38                         'debug-tests',
  39                         'Log testing activity to the PHPUnitCommand log channel.',
  40                         false, # not required
  41                         false # no arg needed
  42                 );
  43                 $this->addOption( 'file', 'File describing parser tests.', false, true );
  44                 $this->addOption( 'use-filebackend', 'Use filebackend', false, true );
  45                 $this->addOption( 'use-bagostuff', 'Use bagostuff', false, true );
  46                 $this->addOption( 'use-jobqueue', 'Use jobqueue', false, true );
  47                 $this->addOption( 'use-normal-tables', 'Use normal DB tables.', false, false );
  48                 $this->addOption(
  49                         'reuse-db', 'Init DB only if tables are missing and keep after finish.',
  50                         false,
  51                         false
  52                 );
  53         }
  54
  55         public function finalSetup() {
  56                 parent::finalSetup();
  57
  58                 // Inject test autoloader
  59                 self::requireTestsAutoloader();
  60
  61                 TestSetup::applyInitialConfig();
  62         }
  63
  64         public function execute() {
  65                 global $IP;
  66
  67                 // Deregister handler from MWExceptionHandler::installHandle so that PHPUnit's own handler
  68                 // stays in tact.
  69                 // Has to in execute() instead of finalSetup(), because finalSetup() runs before
  70                 // doMaintenance.php includes Setup.php, which calls MWExceptionHandler::installHandle().
  71                 restore_error_handler();
  72
  73                 $this->forceFormatServerArgv();
  74
  75                 # Make sure we have --configuration or PHPUnit might complain
  76                 if ( !in_array( '--configuration', $_SERVER['argv'] ) ) {
  77                         // Hack to eliminate the need to use the Makefile (which sucks ATM)
  78                         array_splice( $_SERVER['argv'], 1, 0,
  79                                 [ '--configuration', $IP . '/tests/phpunit/suite.xml' ] );
  80                 }
  81
  82                 $phpUnitClass = 'PHPUnit_TextUI_Command';
  83
  84                 if ( $this->hasOption( 'with-phpunitclass' ) ) {
  85                         $phpUnitClass = $this->getOption( 'with-phpunitclass' );
  86
  87                         # Cleanup $args array so the option and its value do not
  88                         # pollute PHPUnit
  89                         $key = array_search( '--with-phpunitclass', $_SERVER['argv'] );
  90                         unset( $_SERVER['argv'][$key] ); // the option
  91                         unset( $_SERVER['argv'][$key + 1] ); // its value
  92                         $_SERVER['argv'] = array_values( $_SERVER['argv'] );
  93                 }
  94
  95                 $key = array_search( '--debug-tests', $_SERVER['argv'] );
  96                 if ( $key !== false && array_search( '--printer', $_SERVER['argv'] ) === false ) {
  97                         unset( $_SERVER['argv'][$key] );
  98                         array_splice( $_SERVER['argv'], 1, 0, 'MediaWikiPHPUnitTestListener' );
  99                         array_splice( $_SERVER['argv'], 1, 0, '--printer' );
 100                 }
 101
 102                 foreach ( self::$additionalOptions as $option => $default ) {
 103                         $key = array_search( '--' . $option, $_SERVER['argv'] );
 104                         if ( $key !== false ) {
 105                                 unset( $_SERVER['argv'][$key] );
 106                                 if ( $this->mParams[$option]['withArg'] ) {
 107                                         self::$additionalOptions[$option] = $_SERVER['argv'][$key + 1];
 108                                         unset( $_SERVER['argv'][$key + 1] );
 109                                 } else {
 110                                         self::$additionalOptions[$option] = true;
 111                                 }
 112                         }
 113                 }
 114
 115                 if ( !class_exists( 'PHPUnit_Framework_TestCase' ) ) {
 116                         echo "PHPUnit not found. Please install it and other dev dependencies by
 117                 running `composer install` in MediaWiki root directory.\n";
 118                         exit( 1 );
 119                 }
 120                 if ( !class_exists( $phpUnitClass ) ) {
 121                         echo "PHPUnit entry point '" . $phpUnitClass . "' not found. Please make sure you installed
 122                 the containing component and check the spelling of the class name.\n";
 123                         exit( 1 );
 124                 }
 125
 126                 echo defined( 'HHVM_VERSION' ) ?
 127                         'Using HHVM ' . HHVM_VERSION . ' (' . PHP_VERSION . ")\n" :
 128                         'Using PHP ' . PHP_VERSION . "\n";
 129
 130                 // Prepare global services for unit tests.
 131                 MediaWikiTestCase::prepareServices( new GlobalVarConfig() );
 132
 133                 $phpUnitClass::main();
 134         }
 135
 136         public function getDbType() {
 137                 return Maintenance::DB_ADMIN;
 138         }
 139
 140         protected function addOption( $name, $description, $required = false,
 141                 $withArg = false, $shortName = false, $multiOccurrence = false
 142         ) {
 143                 // ignore --quiet which does not really make sense for unit tests
 144                 if ( $name !== 'quiet' ) {
 145                         parent::addOption( $name, $description, $required, $withArg, $shortName, $multiOccurrence );
 146                 }
 147         }
 148
 149         /**
 150          * Force the format of elements in $_SERVER['argv']
 151          *  - Split args such as "wiki=enwiki" into two separate arg elements "wiki" and "enwiki"
 152          */
 153         private function forceFormatServerArgv() {
 154                 $argv = [];
 155                 foreach ( $_SERVER['argv'] as $key => $arg ) {
 156                         if ( $key === 0 ) {
 157                                 $argv[0] = $arg;
 158                         } elseif ( strstr( $arg, '=' ) ) {
 159                                 foreach ( explode( '=', $arg, 2 ) as $argPart ) {
 160                                         $argv[] = $argPart;
 161                                 }
 162                         } else {
 163                                 $argv[] = $arg;
 164                         }
 165                 }
 166                 $_SERVER['argv'] = $argv;
 167         }
 168
 169 }
 170
 171 $maintClass = 'PHPUnitMaintClass';
 172 require RUN_MAINTENANCE_IF_MAIN;