tests/phpunit/MediaWikiUnitTestCase.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup Testing
  20  */
  21
  22 use PHPUnit\Framework\TestCase;
  23
  24 /**
  25  * Base class for unit tests.
  26  *
  27  * Extend this class if you are testing classes which use dependency injection and do not access
  28  * global functions, variables, services or a storage backend.
  29  *
  30  * @since 1.34
  31  */
  32 abstract class MediaWikiUnitTestCase extends TestCase {
  33         use PHPUnit4And6Compat;
  34         use MediaWikiCoversValidator;
  35         use MediaWikiTestCaseTrait;
  36
  37         private static $originalGlobals;
  38         private static $unitGlobals;
  39
  40         /**
  41          * Whitelist of globals to allow in MediaWikiUnitTestCase.
  42          *
  43          * Please, keep this list to the bare minimum.
  44          *
  45          * @return string[]
  46          */
  47         private static function getGlobalsWhitelist() {
  48                 return [
  49                         // The autoloader may change between bootstrap and the first test,
  50                         // so (lazily) capture these here instead.
  51                         'wgAutoloadClasses',
  52                         'wgAutoloadLocalClasses',
  53                         // Need for LoggerFactory. Default is NullSpi.
  54                         'wgMWLoggerDefaultSpi',
  55                         'wgAutoloadAttemptLowercase'
  56                 ];
  57         }
  58
  59         public static function setUpBeforeClass() {
  60                 parent::setUpBeforeClass();
  61
  62                 $reflection = new ReflectionClass( static::class );
  63                 $dirSeparator = DIRECTORY_SEPARATOR;
  64                 if ( stripos( $reflection->getFilename(), "${dirSeparator}unit${dirSeparator}" ) === false ) {
  65                         self::fail( 'This unit test needs to be in "tests/phpunit/unit"!' );
  66                 }
  67
  68                 if ( defined( 'HHVM_VERSION' ) ) {
  69                         // There are a number of issues we encountered in trying to make this
  70                         // work on HHVM. Specifically, once an MediaWikiIntegrationTestCase executes
  71                         // before us, the original globals go missing. This might have to do with
  72                         // one of the non-unit tests passing GLOBALS somewhere and causing HHVM
  73                         // to get confused somehow.
  74                         return;
  75                 }
  76
  77                 self::$unitGlobals =& TestSetup::$bootstrapGlobals;
  78
  79                 foreach ( self::getGlobalsWhitelist() as $global ) {
  80                         self::$unitGlobals[ $global ] =& $GLOBALS[ $global ];
  81                 }
  82
  83                 // Would be nice if we coud simply replace $GLOBALS as a whole,
  84                 // but unsetting or re-assigning that breaks the reference of this magic
  85                 // variable. Thus we have to modify it in place.
  86                 self::$originalGlobals = [];
  87                 foreach ( $GLOBALS as $key => $_ ) {
  88                         // Stash current values
  89                         self::$originalGlobals[$key] =& $GLOBALS[$key];
  90
  91                         // Remove globals not part of the snapshot (see bootstrap.php, phpunit.php).
  92                         // Support: HHVM (avoid self-ref)
  93                         if ( $key !== 'GLOBALS' && !array_key_exists( $key, self::$unitGlobals ) ) {
  94                                 unset( $GLOBALS[$key] );
  95                         }
  96                 }
  97                 // Restore values from the early snapshot
  98                 // Not by ref because tests must not be able to modify the snapshot.
  99                 foreach ( self::$unitGlobals as $key => $value ) {
 100                         $GLOBALS[ $key ] = $value;
 101                 }
 102         }
 103
 104         protected function tearDown() {
 105                 if ( !defined( 'HHVM_VERSION' ) ) {
 106                         // Quick reset between tests
 107                         foreach ( $GLOBALS as $key => $_ ) {
 108                                 if ( $key !== 'GLOBALS' && !array_key_exists( $key, self::$unitGlobals ) ) {
 109                                         unset( $GLOBALS[$key] );
 110                                 }
 111                         }
 112                         foreach ( self::$unitGlobals as $key => $value ) {
 113                                 $GLOBALS[ $key ] = $value;
 114                         }
 115                 }
 116
 117                 parent::tearDown();
 118         }
 119
 120         public static function tearDownAfterClass() {
 121                 if ( !defined( 'HHVM_VERSION' ) ) {
 122                         // Remove globals created by the test
 123                         foreach ( $GLOBALS as $key => $_ ) {
 124                                 if ( $key !== 'GLOBALS' && !array_key_exists( $key, self::$originalGlobals ) ) {
 125                                         unset( $GLOBALS[$key] );
 126                                 }
 127                         }
 128                         // Restore values (including reference!)
 129                         foreach ( self::$originalGlobals as $key => &$value ) {
 130                                 $GLOBALS[ $key ] =& $value;
 131                         }
 132                 }
 133
 134                 parent::tearDownAfterClass();
 135         }
 136
 137         /**
 138          * Create a temporary hook handler which will be reset by tearDown.
 139          * This replaces other handlers for the same hook.
 140          * @param string $hookName Hook name
 141          * @param mixed $handler Value suitable for a hook handler
 142          * @since 1.34
 143          */
 144         protected function setTemporaryHook( $hookName, $handler ) {
 145                 // This will be reset by tearDown() when it restores globals. We don't want to use
 146                 // Hooks::register()/clear() because they won't replace other handlers for the same hook,
 147                 // which doesn't match behavior of MediaWikiIntegrationTestCase.
 148                 global $wgHooks;
 149                 $wgHooks[$hookName] = [ $handler ];
 150         }
 151
 152         protected function getMockMessage( $text, ...$params ) {
 153                 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
 154                         $params = $params[0];
 155                 }
 156
 157                 $msg = $this->getMockBuilder( Message::class )
 158                         ->disableOriginalConstructor()
 159                         ->setMethods( [] )
 160                         ->getMock();
 161
 162                 $msg->method( 'toString' )->willReturn( $text );
 163                 $msg->method( '__toString' )->willReturn( $text );
 164                 $msg->method( 'text' )->willReturn( $text );
 165                 $msg->method( 'parse' )->willReturn( $text );
 166                 $msg->method( 'plain' )->willReturn( $text );
 167                 $msg->method( 'parseAsBlock' )->willReturn( $text );
 168                 $msg->method( 'escaped' )->willReturn( $text );
 169
 170                 $msg->method( 'title' )->willReturn( $msg );
 171                 $msg->method( 'inLanguage' )->willReturn( $msg );
 172                 $msg->method( 'inContentLanguage' )->willReturn( $msg );
 173                 $msg->method( 'useDatabase' )->willReturn( $msg );
 174                 $msg->method( 'setContext' )->willReturn( $msg );
 175
 176                 $msg->method( 'exists' )->willReturn( true );
 177                 $msg->method( 'content' )->willReturn( new MessageContent( $msg ) );
 178
 179                 return $msg;
 180         }
 181 }