tests/phpunit/includes/MediaWikiServicesTest.php

   1 <?php
   2 use Liuggio\StatsdClient\Factory\StatsdDataFactory;
   3 use MediaWiki\MediaWikiServices;
   4 use MediaWiki\Services\DestructibleService;
   5 use MediaWiki\Services\SalvageableService;
   6 use MediaWiki\Services\ServiceDisabledException;
   7
   8 /**
   9  * @covers MediaWiki\MediaWikiServices
  10  *
  11  * @group MediaWiki
  12  */
  13 class MediaWikiServicesTest extends MediaWikiTestCase {
  14
  15         /**
  16          * @return Config
  17          */
  18         private function newTestConfig() {
  19                 $globalConfig = new GlobalVarConfig();
  20
  21                 $testConfig = new HashConfig();
  22                 $testConfig->set( 'ServiceWiringFiles', $globalConfig->get( 'ServiceWiringFiles' ) );
  23                 $testConfig->set( 'ConfigRegistry', $globalConfig->get( 'ConfigRegistry' ) );
  24
  25                 return $testConfig;
  26         }
  27
  28         /**
  29          * @return MediaWikiServices
  30          */
  31         private function newMediaWikiServices( Config $config = null ) {
  32                 if ( $config === null ) {
  33                         $config = $this->newTestConfig();
  34                 }
  35
  36                 $instance = new MediaWikiServices( $config );
  37
  38                 // Load the default wiring from the specified files.
  39                 $wiringFiles = $config->get( 'ServiceWiringFiles' );
  40                 $instance->loadWiringFiles( $wiringFiles );
  41
  42                 return $instance;
  43         }
  44
  45         public function testGetInstance() {
  46                 $services = MediaWikiServices::getInstance();
  47                 $this->assertInstanceOf( 'MediaWiki\\MediaWikiServices', $services );
  48         }
  49
  50         public function testForceGlobalInstance() {
  51                 $newServices = $this->newMediaWikiServices();
  52                 $oldServices = MediaWikiServices::forceGlobalInstance( $newServices );
  53
  54                 $this->assertInstanceOf( 'MediaWiki\\MediaWikiServices', $oldServices );
  55                 $this->assertNotSame( $oldServices, $newServices );
  56
  57                 $theServices = MediaWikiServices::getInstance();
  58                 $this->assertSame( $theServices, $newServices );
  59
  60                 MediaWikiServices::forceGlobalInstance( $oldServices );
  61
  62                 $theServices = MediaWikiServices::getInstance();
  63                 $this->assertSame( $theServices, $oldServices );
  64         }
  65
  66         public function testResetGlobalInstance() {
  67                 $newServices = $this->newMediaWikiServices();
  68                 $oldServices = MediaWikiServices::forceGlobalInstance( $newServices );
  69
  70                 $service1 = $this->getMock( SalvageableService::class );
  71                 $service1->expects( $this->never() )
  72                         ->method( 'salvage' );
  73
  74                 $newServices->defineService(
  75                         'Test',
  76                         function() use ( $service1 ) {
  77                                 return $service1;
  78                         }
  79                 );
  80
  81                 // force instantiation
  82                 $newServices->getService( 'Test' );
  83
  84                 MediaWikiServices::resetGlobalInstance( $this->newTestConfig() );
  85                 $theServices = MediaWikiServices::getInstance();
  86
  87                 $this->assertSame(
  88                         $service1,
  89                         $theServices->getService( 'Test' ),
  90                         'service definition should survive reset'
  91                 );
  92
  93                 $this->assertNotSame( $theServices, $newServices );
  94                 $this->assertNotSame( $theServices, $oldServices );
  95
  96                 MediaWikiServices::forceGlobalInstance( $oldServices );
  97         }
  98
  99         public function testResetGlobalInstance_quick() {
 100                 $newServices = $this->newMediaWikiServices();
 101                 $oldServices = MediaWikiServices::forceGlobalInstance( $newServices );
 102
 103                 $service1 = $this->getMock( SalvageableService::class );
 104                 $service1->expects( $this->never() )
 105                         ->method( 'salvage' );
 106
 107                 $service2 = $this->getMock( SalvageableService::class );
 108                 $service2->expects( $this->once() )
 109                         ->method( 'salvage' )
 110                         ->with( $service1 );
 111
 112                 // sequence of values the instantiator will return
 113                 $instantiatorReturnValues = [
 114                         $service1,
 115                         $service2,
 116                 ];
 117
 118                 $newServices->defineService(
 119                         'Test',
 120                         function() use ( &$instantiatorReturnValues ) {
 121                                 return array_shift( $instantiatorReturnValues );
 122                         }
 123                 );
 124
 125                 // force instantiation
 126                 $newServices->getService( 'Test' );
 127
 128                 MediaWikiServices::resetGlobalInstance( $this->newTestConfig(), 'quick' );
 129                 $theServices = MediaWikiServices::getInstance();
 130
 131                 $this->assertSame( $service2, $theServices->getService( 'Test' ) );
 132
 133                 $this->assertNotSame( $theServices, $newServices );
 134                 $this->assertNotSame( $theServices, $oldServices );
 135
 136                 MediaWikiServices::forceGlobalInstance( $oldServices );
 137         }
 138
 139         public function testDisableStorageBackend() {
 140                 $newServices = $this->newMediaWikiServices();
 141                 $oldServices = MediaWikiServices::forceGlobalInstance( $newServices );
 142
 143                 $lbFactory = $this->getMockBuilder( 'LBFactorySimple' )
 144                         ->disableOriginalConstructor()
 145                         ->getMock();
 146
 147                 $lbFactory->expects( $this->once() )
 148                         ->method( 'destroy' );
 149
 150                 $newServices->redefineService(
 151                         'DBLoadBalancerFactory',
 152                         function() use ( $lbFactory ) {
 153                                 return $lbFactory;
 154                         }
 155                 );
 156
 157                 // force the service to become active, so we can check that it does get destroyed
 158                 $newServices->getService( 'DBLoadBalancerFactory' );
 159
 160                 MediaWikiServices::disableStorageBackend(); // should destroy DBLoadBalancerFactory
 161
 162                 try {
 163                         MediaWikiServices::getInstance()->getService( 'DBLoadBalancerFactory' );
 164                         $this->fail( 'DBLoadBalancerFactory shoudl have been disabled' );
 165                 }
 166                 catch ( ServiceDisabledException $ex ) {
 167                         // ok, as expected
 168                 }
 169                 catch ( Throwable $ex ) {
 170                         $this->fail( 'ServiceDisabledException expected, caught ' . get_class( $ex ) );
 171                 }
 172
 173                 MediaWikiServices::forceGlobalInstance( $oldServices );
 174                 $newServices->destroy();
 175         }
 176
 177         public function testResetChildProcessServices() {
 178                 $newServices = $this->newMediaWikiServices();
 179                 $oldServices = MediaWikiServices::forceGlobalInstance( $newServices );
 180
 181                 $service1 = $this->getMock( DestructibleService::class );
 182                 $service1->expects( $this->once() )
 183                         ->method( 'destroy' );
 184
 185                 $service2 = $this->getMock( DestructibleService::class );
 186                 $service2->expects( $this->never() )
 187                         ->method( 'destroy' );
 188
 189                 // sequence of values the instantiator will return
 190                 $instantiatorReturnValues = [
 191                         $service1,
 192                         $service2,
 193                 ];
 194
 195                 $newServices->defineService(
 196                         'Test',
 197                         function() use ( &$instantiatorReturnValues ) {
 198                                 return array_shift( $instantiatorReturnValues );
 199                         }
 200                 );
 201
 202                 // force the service to become active, so we can check that it does get destroyed
 203                 $oldTestService = $newServices->getService( 'Test' );
 204
 205                 MediaWikiServices::resetChildProcessServices();
 206                 $finalServices = MediaWikiServices::getInstance();
 207
 208                 $newTestService = $finalServices->getService( 'Test' );
 209                 $this->assertNotSame( $oldTestService, $newTestService );
 210
 211                 MediaWikiServices::forceGlobalInstance( $oldServices );
 212         }
 213
 214         public function testResetServiceForTesting() {
 215                 $services = $this->newMediaWikiServices();
 216                 $serviceCounter = 0;
 217
 218                 $services->defineService(
 219                         'Test',
 220                         function() use ( &$serviceCounter ) {
 221                                 $serviceCounter++;
 222                                 $service = $this->getMock( 'MediaWiki\Services\DestructibleService' );
 223                                 $service->expects( $this->once() )->method( 'destroy' );
 224                                 return $service;
 225                         }
 226                 );
 227
 228                 // This should do nothing. In particular, it should not create a service instance.
 229                 $services->resetServiceForTesting( 'Test' );
 230                 $this->assertEquals( 0, $serviceCounter, 'No service instance should be created yet.' );
 231
 232                 $oldInstance = $services->getService( 'Test' );
 233                 $this->assertEquals( 1, $serviceCounter, 'A service instance should exit now.' );
 234
 235                 // The old instance should be detached, and destroy() called.
 236                 $services->resetServiceForTesting( 'Test' );
 237                 $newInstance = $services->getService( 'Test' );
 238
 239                 $this->assertNotSame( $oldInstance, $newInstance );
 240
 241                 // Satisfy the expectation that destroy() is called also for the second service instance.
 242                 $newInstance->destroy();
 243         }
 244
 245         public function testResetServiceForTesting_noDestroy() {
 246                 $services = $this->newMediaWikiServices();
 247
 248                 $services->defineService(
 249                         'Test',
 250                         function() {
 251                                 $service = $this->getMock( 'MediaWiki\Services\DestructibleService' );
 252                                 $service->expects( $this->never() )->method( 'destroy' );
 253                                 return $service;
 254                         }
 255                 );
 256
 257                 $oldInstance = $services->getService( 'Test' );
 258
 259                 // The old instance should be detached, but destroy() not called.
 260                 $services->resetServiceForTesting( 'Test', false );
 261                 $newInstance = $services->getService( 'Test' );
 262
 263                 $this->assertNotSame( $oldInstance, $newInstance );
 264         }
 265
 266         public function provideGetters() {
 267                 $getServiceCases = $this->provideGetService();
 268                 $getterCases = [];
 269
 270                 // All getters should be named just like the service, with "get" added.
 271                 foreach ( $getServiceCases as $name => $case ) {
 272                         if ( $name[0] === '_' ) {
 273                                 // Internal service, no getter
 274                                 continue;
 275                         }
 276                         list( $service, $class ) = $case;
 277                         $getterCases[$name] = [
 278                                 'get' . $service,
 279                                 $class,
 280                         ];
 281                 }
 282
 283                 return $getterCases;
 284         }
 285
 286         /**
 287          * @dataProvider provideGetters
 288          */
 289         public function testGetters( $getter, $type ) {
 290                 // Test against the default instance, since the dummy will not know the default services.
 291                 $services = MediaWikiServices::getInstance();
 292                 $service = $services->$getter();
 293                 $this->assertInstanceOf( $type, $service );
 294         }
 295
 296         public function provideGetService() {
 297                 // NOTE: This should list all service getters defined in ServiceWiring.php.
 298                 // NOTE: For every test case defined here there should be a corresponding
 299                 // test case defined in provideGetters().
 300                 return [
 301                         'BootstrapConfig' => [ 'BootstrapConfig', Config::class ],
 302                         'ConfigFactory' => [ 'ConfigFactory', ConfigFactory::class ],
 303                         'MainConfig' => [ 'MainConfig', Config::class ],
 304                         'SiteStore' => [ 'SiteStore', SiteStore::class ],
 305                         'SiteLookup' => [ 'SiteLookup', SiteLookup::class ],
 306                         'StatsdDataFactory' => [ 'StatsdDataFactory', StatsdDataFactory::class ],
 307                         'EventRelayerGroup' => [ 'EventRelayerGroup', EventRelayerGroup::class ],
 308                         'SearchEngineFactory' => [ 'SearchEngineFactory', SearchEngineFactory::class ],
 309                         'SearchEngineConfig' => [ 'SearchEngineConfig', SearchEngineConfig::class ],
 310                         'SkinFactory' => [ 'SkinFactory', SkinFactory::class ],
 311                         'DBLoadBalancerFactory' => [ 'DBLoadBalancerFactory', 'LBFactory' ],
 312                         'DBLoadBalancer' => [ 'DBLoadBalancer', 'LoadBalancer' ],
 313                         'WatchedItemStore' => [ 'WatchedItemStore', WatchedItemStore::class ],
 314                         'GenderCache' => [ 'GenderCache', GenderCache::class ],
 315                         '_MediaWikiTitleCodec' => [ '_MediaWikiTitleCodec', MediaWikiTitleCodec::class ],
 316                         'TitleFormatter' => [ 'TitleFormatter', TitleFormatter::class ],
 317                         'TitleParser' => [ 'TitleParser', TitleParser::class ],
 318                 ];
 319         }
 320
 321         /**
 322          * @dataProvider provideGetService
 323          */
 324         public function testGetService( $name, $type ) {
 325                 // Test against the default instance, since the dummy will not know the default services.
 326                 $services = MediaWikiServices::getInstance();
 327
 328                 $service = $services->getService( $name );
 329                 $this->assertInstanceOf( $type, $service );
 330         }
 331
 332         public function testDefaultServiceInstantiation() {
 333                 // Check all services in the default instance, not a dummy instance!
 334                 // Note that we instantiate all services here, including any that
 335                 // were registered by extensions.
 336                 $services = MediaWikiServices::getInstance();
 337                 $names = $services->getServiceNames();
 338
 339                 foreach ( $names as $name ) {
 340                         $this->assertTrue( $services->hasService( $name ) );
 341                         $service = $services->getService( $name );
 342                         $this->assertInternalType( 'object', $service );
 343                 }
 344         }
 345
 346 }