3 use Mediawiki\Http\HttpRequestFactory
;
4 use MediaWiki\Interwiki\InterwikiLookup
;
5 use MediaWiki\Linker\LinkRenderer
;
6 use MediaWiki\Linker\LinkRendererFactory
;
7 use MediaWiki\MediaWikiServices
;
8 use MediaWiki\Preferences\PreferencesFactory
;
9 use MediaWiki\Services\DestructibleService
;
10 use MediaWiki\Services\SalvageableService
;
11 use MediaWiki\Services\ServiceDisabledException
;
12 use MediaWiki\Shell\CommandFactory
;
13 use MediaWiki\Storage\BlobStore
;
14 use MediaWiki\Storage\BlobStoreFactory
;
15 use MediaWiki\Storage\NameTableStore
;
16 use MediaWiki\Storage\RevisionFactory
;
17 use MediaWiki\Storage\RevisionLookup
;
18 use MediaWiki\Storage\RevisionStore
;
19 use MediaWiki\Storage\RevisionStoreFactory
;
20 use MediaWiki\Storage\SqlBlobStore
;
23 * @covers MediaWiki\MediaWikiServices
27 class MediaWikiServicesTest
extends MediaWikiTestCase
{
32 private function newTestConfig() {
33 $globalConfig = new GlobalVarConfig();
35 $testConfig = new HashConfig();
36 $testConfig->set( 'ServiceWiringFiles', $globalConfig->get( 'ServiceWiringFiles' ) );
37 $testConfig->set( 'ConfigRegistry', $globalConfig->get( 'ConfigRegistry' ) );
43 * @return MediaWikiServices
45 private function newMediaWikiServices( Config
$config = null ) {
46 if ( $config === null ) {
47 $config = $this->newTestConfig();
50 $instance = new MediaWikiServices( $config );
52 // Load the default wiring from the specified files.
53 $wiringFiles = $config->get( 'ServiceWiringFiles' );
54 $instance->loadWiringFiles( $wiringFiles );
59 public function testGetInstance() {
60 $services = MediaWikiServices
::getInstance();
61 $this->assertInstanceOf( MediaWikiServices
::class, $services );
64 public function testForceGlobalInstance() {
65 $newServices = $this->newMediaWikiServices();
66 $oldServices = MediaWikiServices
::forceGlobalInstance( $newServices );
68 $this->assertInstanceOf( MediaWikiServices
::class, $oldServices );
69 $this->assertNotSame( $oldServices, $newServices );
71 $theServices = MediaWikiServices
::getInstance();
72 $this->assertSame( $theServices, $newServices );
74 MediaWikiServices
::forceGlobalInstance( $oldServices );
76 $theServices = MediaWikiServices
::getInstance();
77 $this->assertSame( $theServices, $oldServices );
80 public function testResetGlobalInstance() {
81 $newServices = $this->newMediaWikiServices();
82 $oldServices = MediaWikiServices
::forceGlobalInstance( $newServices );
84 $service1 = $this->createMock( SalvageableService
::class );
85 $service1->expects( $this->never() )
86 ->method( 'salvage' );
88 $newServices->defineService(
90 function () use ( $service1 ) {
95 // force instantiation
96 $newServices->getService( 'Test' );
98 MediaWikiServices
::resetGlobalInstance( $this->newTestConfig() );
99 $theServices = MediaWikiServices
::getInstance();
103 $theServices->getService( 'Test' ),
104 'service definition should survive reset'
107 $this->assertNotSame( $theServices, $newServices );
108 $this->assertNotSame( $theServices, $oldServices );
110 MediaWikiServices
::forceGlobalInstance( $oldServices );
113 public function testResetGlobalInstance_quick() {
114 $newServices = $this->newMediaWikiServices();
115 $oldServices = MediaWikiServices
::forceGlobalInstance( $newServices );
117 $service1 = $this->createMock( SalvageableService
::class );
118 $service1->expects( $this->never() )
119 ->method( 'salvage' );
121 $service2 = $this->createMock( SalvageableService
::class );
122 $service2->expects( $this->once() )
123 ->method( 'salvage' )
126 // sequence of values the instantiator will return
127 $instantiatorReturnValues = [
132 $newServices->defineService(
134 function () use ( &$instantiatorReturnValues ) {
135 return array_shift( $instantiatorReturnValues );
139 // force instantiation
140 $newServices->getService( 'Test' );
142 MediaWikiServices
::resetGlobalInstance( $this->newTestConfig(), 'quick' );
143 $theServices = MediaWikiServices
::getInstance();
145 $this->assertSame( $service2, $theServices->getService( 'Test' ) );
147 $this->assertNotSame( $theServices, $newServices );
148 $this->assertNotSame( $theServices, $oldServices );
150 MediaWikiServices
::forceGlobalInstance( $oldServices );
153 public function testDisableStorageBackend() {
154 $newServices = $this->newMediaWikiServices();
155 $oldServices = MediaWikiServices
::forceGlobalInstance( $newServices );
157 $lbFactory = $this->getMockBuilder( \Wikimedia\Rdbms\LBFactorySimple
::class )
158 ->disableOriginalConstructor()
161 $newServices->redefineService(
162 'DBLoadBalancerFactory',
163 function () use ( $lbFactory ) {
168 // force the service to become active, so we can check that it does get destroyed
169 $newServices->getService( 'DBLoadBalancerFactory' );
171 MediaWikiServices
::disableStorageBackend(); // should destroy DBLoadBalancerFactory
174 MediaWikiServices
::getInstance()->getService( 'DBLoadBalancerFactory' );
175 $this->fail( 'DBLoadBalancerFactory should have been disabled' );
177 catch ( ServiceDisabledException
$ex ) {
179 } catch ( Throwable
$ex ) {
180 $this->fail( 'ServiceDisabledException expected, caught ' . get_class( $ex ) );
183 MediaWikiServices
::forceGlobalInstance( $oldServices );
184 $newServices->destroy();
186 // No exception was thrown, avoid being risky
187 $this->assertTrue( true );
190 public function testResetChildProcessServices() {
191 $newServices = $this->newMediaWikiServices();
192 $oldServices = MediaWikiServices
::forceGlobalInstance( $newServices );
194 $service1 = $this->createMock( DestructibleService
::class );
195 $service1->expects( $this->once() )
196 ->method( 'destroy' );
198 $service2 = $this->createMock( DestructibleService
::class );
199 $service2->expects( $this->never() )
200 ->method( 'destroy' );
202 // sequence of values the instantiator will return
203 $instantiatorReturnValues = [
208 $newServices->defineService(
210 function () use ( &$instantiatorReturnValues ) {
211 return array_shift( $instantiatorReturnValues );
215 // force the service to become active, so we can check that it does get destroyed
216 $oldTestService = $newServices->getService( 'Test' );
218 MediaWikiServices
::resetChildProcessServices();
219 $finalServices = MediaWikiServices
::getInstance();
221 $newTestService = $finalServices->getService( 'Test' );
222 $this->assertNotSame( $oldTestService, $newTestService );
224 MediaWikiServices
::forceGlobalInstance( $oldServices );
227 public function testResetServiceForTesting() {
228 $services = $this->newMediaWikiServices();
231 $services->defineService(
233 function () use ( &$serviceCounter ) {
235 $service = $this->createMock( MediaWiki\Services\DestructibleService
::class );
236 $service->expects( $this->once() )->method( 'destroy' );
241 // This should do nothing. In particular, it should not create a service instance.
242 $services->resetServiceForTesting( 'Test' );
243 $this->assertEquals( 0, $serviceCounter, 'No service instance should be created yet.' );
245 $oldInstance = $services->getService( 'Test' );
246 $this->assertEquals( 1, $serviceCounter, 'A service instance should exit now.' );
248 // The old instance should be detached, and destroy() called.
249 $services->resetServiceForTesting( 'Test' );
250 $newInstance = $services->getService( 'Test' );
252 $this->assertNotSame( $oldInstance, $newInstance );
254 // Satisfy the expectation that destroy() is called also for the second service instance.
255 $newInstance->destroy();
258 public function testResetServiceForTesting_noDestroy() {
259 $services = $this->newMediaWikiServices();
261 $services->defineService(
264 $service = $this->createMock( MediaWiki\Services\DestructibleService
::class );
265 $service->expects( $this->never() )->method( 'destroy' );
270 $oldInstance = $services->getService( 'Test' );
272 // The old instance should be detached, but destroy() not called.
273 $services->resetServiceForTesting( 'Test', false );
274 $newInstance = $services->getService( 'Test' );
276 $this->assertNotSame( $oldInstance, $newInstance );
279 public function provideGetters() {
280 $getServiceCases = $this->provideGetService();
283 // All getters should be named just like the service, with "get" added.
284 foreach ( $getServiceCases as $name => $case ) {
285 if ( $name[0] === '_' ) {
286 // Internal service, no getter
289 list( $service, $class ) = $case;
290 $getterCases[$name] = [
300 * @dataProvider provideGetters
302 public function testGetters( $getter, $type ) {
303 // Test against the default instance, since the dummy will not know the default services.
304 $services = MediaWikiServices
::getInstance();
305 $service = $services->$getter();
306 $this->assertInstanceOf( $type, $service );
309 public function provideGetService() {
310 // NOTE: This should list all service getters defined in ServiceWiring.php.
312 'BootstrapConfig' => [ 'BootstrapConfig', Config
::class ],
313 'ConfigFactory' => [ 'ConfigFactory', ConfigFactory
::class ],
314 'MainConfig' => [ 'MainConfig', Config
::class ],
315 'SiteStore' => [ 'SiteStore', SiteStore
::class ],
316 'SiteLookup' => [ 'SiteLookup', SiteLookup
::class ],
317 'StatsdDataFactory' => [ 'StatsdDataFactory', IBufferingStatsdDataFactory
::class ],
318 'InterwikiLookup' => [ 'InterwikiLookup', InterwikiLookup
::class ],
319 'EventRelayerGroup' => [ 'EventRelayerGroup', EventRelayerGroup
::class ],
320 'SearchEngineFactory' => [ 'SearchEngineFactory', SearchEngineFactory
::class ],
321 'SearchEngineConfig' => [ 'SearchEngineConfig', SearchEngineConfig
::class ],
322 'SkinFactory' => [ 'SkinFactory', SkinFactory
::class ],
323 'DBLoadBalancerFactory' => [ 'DBLoadBalancerFactory', Wikimedia\Rdbms\LBFactory
::class ],
324 'DBLoadBalancer' => [ 'DBLoadBalancer', Wikimedia\Rdbms\LoadBalancer
::class ],
325 'WatchedItemStore' => [ 'WatchedItemStore', WatchedItemStore
::class ],
326 'WatchedItemQueryService' => [ 'WatchedItemQueryService', WatchedItemQueryService
::class ],
327 'CryptRand' => [ 'CryptRand', CryptRand
::class ],
328 'CryptHKDF' => [ 'CryptHKDF', CryptHKDF
::class ],
329 'MediaHandlerFactory' => [ 'MediaHandlerFactory', MediaHandlerFactory
::class ],
330 'Parser' => [ 'Parser', Parser
::class ],
331 'ParserCache' => [ 'ParserCache', ParserCache
::class ],
332 'GenderCache' => [ 'GenderCache', GenderCache
::class ],
333 'LinkCache' => [ 'LinkCache', LinkCache
::class ],
334 'LinkRenderer' => [ 'LinkRenderer', LinkRenderer
::class ],
335 'LinkRendererFactory' => [ 'LinkRendererFactory', LinkRendererFactory
::class ],
336 '_MediaWikiTitleCodec' => [ '_MediaWikiTitleCodec', MediaWikiTitleCodec
::class ],
337 'MimeAnalyzer' => [ 'MimeAnalyzer', MimeAnalyzer
::class ],
338 'TitleFormatter' => [ 'TitleFormatter', TitleFormatter
::class ],
339 'TitleParser' => [ 'TitleParser', TitleParser
::class ],
340 'ProxyLookup' => [ 'ProxyLookup', ProxyLookup
::class ],
341 'MainObjectStash' => [ 'MainObjectStash', BagOStuff
::class ],
342 'MainWANObjectCache' => [ 'MainWANObjectCache', WANObjectCache
::class ],
343 'LocalServerObjectCache' => [ 'LocalServerObjectCache', BagOStuff
::class ],
344 'VirtualRESTServiceClient' => [ 'VirtualRESTServiceClient', VirtualRESTServiceClient
::class ],
345 'ShellCommandFactory' => [ 'ShellCommandFactory', CommandFactory
::class ],
346 'BlobStoreFactory' => [ 'BlobStoreFactory', BlobStoreFactory
::class ],
347 'BlobStore' => [ 'BlobStore', BlobStore
::class ],
348 '_SqlBlobStore' => [ '_SqlBlobStore', SqlBlobStore
::class ],
349 'RevisionStore' => [ 'RevisionStore', RevisionStore
::class ],
350 'RevisionStoreFactory' => [ 'RevisionStoreFactory', RevisionStoreFactory
::class ],
351 'RevisionLookup' => [ 'RevisionLookup', RevisionLookup
::class ],
352 'RevisionFactory' => [ 'RevisionFactory', RevisionFactory
::class ],
353 'ContentModelStore' => [ 'ContentModelStore', NameTableStore
::class ],
354 'SlotRoleStore' => [ 'SlotRoleStore', NameTableStore
::class ],
355 'HttpRequestFactory' => [ 'HttpRequestFactory', HttpRequestFactory
::class ],
356 'CommentStore' => [ 'CommentStore', CommentStore
::class ],
357 'ChangeTagDefStore' => [ 'ChangeTagDefStore', NameTableStore
::class ],
358 'ConfiguredReadOnlyMode' => [ 'ConfiguredReadOnlyMode', ConfiguredReadOnlyMode
::class ],
359 'ReadOnlyMode' => [ 'ReadOnlyMode', ReadOnlyMode
::class ],
360 'UploadRevisionImporter' => [ 'UploadRevisionImporter', UploadRevisionImporter
::class ],
361 'OldRevisionImporter' => [ 'OldRevisionImporter', OldRevisionImporter
::class ],
362 'WikiRevisionOldRevisionImporterNoUpdates' =>
363 [ 'WikiRevisionOldRevisionImporterNoUpdates', ImportableOldRevisionImporter
::class ],
364 'ExternalStoreFactory' => [ 'ExternalStoreFactory', ExternalStoreFactory
::class ],
365 'PreferencesFactory' => [ 'PreferencesFactory', PreferencesFactory
::class ],
366 'ActorMigration' => [ 'ActorMigration', ActorMigration
::class ],
371 * @dataProvider provideGetService
373 public function testGetService( $name, $type ) {
374 // Test against the default instance, since the dummy will not know the default services.
375 $services = MediaWikiServices
::getInstance();
377 $service = $services->getService( $name );
378 $this->assertInstanceOf( $type, $service );
381 public function testDefaultServiceInstantiation() {
382 // Check all services in the default instance, not a dummy instance!
383 // Note that we instantiate all services here, including any that
384 // were registered by extensions.
385 $services = MediaWikiServices
::getInstance();
386 $names = $services->getServiceNames();
388 foreach ( $names as $name ) {
389 $this->assertTrue( $services->hasService( $name ) );
390 $service = $services->getService( $name );
391 $this->assertInternalType( 'object', $service );
395 public function testDefaultServiceWiringServicesHaveTests() {
397 $testedServices = array_keys( $this->provideGetService() );
398 $allServices = array_keys( include $IP . '/includes/ServiceWiring.php' );
401 array_diff( $allServices, $testedServices ),
402 'The following services have not been added to MediaWikiServicesTest::provideGetService'