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\Services\DestructibleService
;
9 use MediaWiki\Services\SalvageableService
;
10 use MediaWiki\Services\ServiceDisabledException
;
11 use MediaWiki\Shell\CommandFactory
;
12 use MediaWiki\Storage\BlobStore
;
13 use MediaWiki\Storage\BlobStoreFactory
;
14 use MediaWiki\Storage\RevisionStore
;
15 use MediaWiki\Storage\SqlBlobStore
;
18 * @covers MediaWiki\MediaWikiServices
22 class MediaWikiServicesTest
extends MediaWikiTestCase
{
27 private function newTestConfig() {
28 $globalConfig = new GlobalVarConfig();
30 $testConfig = new HashConfig();
31 $testConfig->set( 'ServiceWiringFiles', $globalConfig->get( 'ServiceWiringFiles' ) );
32 $testConfig->set( 'ConfigRegistry', $globalConfig->get( 'ConfigRegistry' ) );
38 * @return MediaWikiServices
40 private function newMediaWikiServices( Config
$config = null ) {
41 if ( $config === null ) {
42 $config = $this->newTestConfig();
45 $instance = new MediaWikiServices( $config );
47 // Load the default wiring from the specified files.
48 $wiringFiles = $config->get( 'ServiceWiringFiles' );
49 $instance->loadWiringFiles( $wiringFiles );
54 public function testGetInstance() {
55 $services = MediaWikiServices
::getInstance();
56 $this->assertInstanceOf( 'MediaWiki\\MediaWikiServices', $services );
59 public function testForceGlobalInstance() {
60 $newServices = $this->newMediaWikiServices();
61 $oldServices = MediaWikiServices
::forceGlobalInstance( $newServices );
63 $this->assertInstanceOf( 'MediaWiki\\MediaWikiServices', $oldServices );
64 $this->assertNotSame( $oldServices, $newServices );
66 $theServices = MediaWikiServices
::getInstance();
67 $this->assertSame( $theServices, $newServices );
69 MediaWikiServices
::forceGlobalInstance( $oldServices );
71 $theServices = MediaWikiServices
::getInstance();
72 $this->assertSame( $theServices, $oldServices );
75 public function testResetGlobalInstance() {
76 $newServices = $this->newMediaWikiServices();
77 $oldServices = MediaWikiServices
::forceGlobalInstance( $newServices );
79 $service1 = $this->createMock( SalvageableService
::class );
80 $service1->expects( $this->never() )
81 ->method( 'salvage' );
83 $newServices->defineService(
85 function () use ( $service1 ) {
90 // force instantiation
91 $newServices->getService( 'Test' );
93 MediaWikiServices
::resetGlobalInstance( $this->newTestConfig() );
94 $theServices = MediaWikiServices
::getInstance();
98 $theServices->getService( 'Test' ),
99 'service definition should survive reset'
102 $this->assertNotSame( $theServices, $newServices );
103 $this->assertNotSame( $theServices, $oldServices );
105 MediaWikiServices
::forceGlobalInstance( $oldServices );
108 public function testResetGlobalInstance_quick() {
109 $newServices = $this->newMediaWikiServices();
110 $oldServices = MediaWikiServices
::forceGlobalInstance( $newServices );
112 $service1 = $this->createMock( SalvageableService
::class );
113 $service1->expects( $this->never() )
114 ->method( 'salvage' );
116 $service2 = $this->createMock( SalvageableService
::class );
117 $service2->expects( $this->once() )
118 ->method( 'salvage' )
121 // sequence of values the instantiator will return
122 $instantiatorReturnValues = [
127 $newServices->defineService(
129 function () use ( &$instantiatorReturnValues ) {
130 return array_shift( $instantiatorReturnValues );
134 // force instantiation
135 $newServices->getService( 'Test' );
137 MediaWikiServices
::resetGlobalInstance( $this->newTestConfig(), 'quick' );
138 $theServices = MediaWikiServices
::getInstance();
140 $this->assertSame( $service2, $theServices->getService( 'Test' ) );
142 $this->assertNotSame( $theServices, $newServices );
143 $this->assertNotSame( $theServices, $oldServices );
145 MediaWikiServices
::forceGlobalInstance( $oldServices );
148 public function testDisableStorageBackend() {
149 $newServices = $this->newMediaWikiServices();
150 $oldServices = MediaWikiServices
::forceGlobalInstance( $newServices );
152 $lbFactory = $this->getMockBuilder( 'LBFactorySimple' )
153 ->disableOriginalConstructor()
156 $newServices->redefineService(
157 'DBLoadBalancerFactory',
158 function () use ( $lbFactory ) {
163 // force the service to become active, so we can check that it does get destroyed
164 $newServices->getService( 'DBLoadBalancerFactory' );
166 MediaWikiServices
::disableStorageBackend(); // should destroy DBLoadBalancerFactory
169 MediaWikiServices
::getInstance()->getService( 'DBLoadBalancerFactory' );
170 $this->fail( 'DBLoadBalancerFactory should have been disabled' );
172 catch ( ServiceDisabledException
$ex ) {
174 } catch ( Throwable
$ex ) {
175 $this->fail( 'ServiceDisabledException expected, caught ' . get_class( $ex ) );
178 MediaWikiServices
::forceGlobalInstance( $oldServices );
179 $newServices->destroy();
182 public function testResetChildProcessServices() {
183 $newServices = $this->newMediaWikiServices();
184 $oldServices = MediaWikiServices
::forceGlobalInstance( $newServices );
186 $service1 = $this->createMock( DestructibleService
::class );
187 $service1->expects( $this->once() )
188 ->method( 'destroy' );
190 $service2 = $this->createMock( DestructibleService
::class );
191 $service2->expects( $this->never() )
192 ->method( 'destroy' );
194 // sequence of values the instantiator will return
195 $instantiatorReturnValues = [
200 $newServices->defineService(
202 function () use ( &$instantiatorReturnValues ) {
203 return array_shift( $instantiatorReturnValues );
207 // force the service to become active, so we can check that it does get destroyed
208 $oldTestService = $newServices->getService( 'Test' );
210 MediaWikiServices
::resetChildProcessServices();
211 $finalServices = MediaWikiServices
::getInstance();
213 $newTestService = $finalServices->getService( 'Test' );
214 $this->assertNotSame( $oldTestService, $newTestService );
216 MediaWikiServices
::forceGlobalInstance( $oldServices );
219 public function testResetServiceForTesting() {
220 $services = $this->newMediaWikiServices();
223 $services->defineService(
225 function () use ( &$serviceCounter ) {
227 $service = $this->createMock( 'MediaWiki\Services\DestructibleService' );
228 $service->expects( $this->once() )->method( 'destroy' );
233 // This should do nothing. In particular, it should not create a service instance.
234 $services->resetServiceForTesting( 'Test' );
235 $this->assertEquals( 0, $serviceCounter, 'No service instance should be created yet.' );
237 $oldInstance = $services->getService( 'Test' );
238 $this->assertEquals( 1, $serviceCounter, 'A service instance should exit now.' );
240 // The old instance should be detached, and destroy() called.
241 $services->resetServiceForTesting( 'Test' );
242 $newInstance = $services->getService( 'Test' );
244 $this->assertNotSame( $oldInstance, $newInstance );
246 // Satisfy the expectation that destroy() is called also for the second service instance.
247 $newInstance->destroy();
250 public function testResetServiceForTesting_noDestroy() {
251 $services = $this->newMediaWikiServices();
253 $services->defineService(
256 $service = $this->createMock( 'MediaWiki\Services\DestructibleService' );
257 $service->expects( $this->never() )->method( 'destroy' );
262 $oldInstance = $services->getService( 'Test' );
264 // The old instance should be detached, but destroy() not called.
265 $services->resetServiceForTesting( 'Test', false );
266 $newInstance = $services->getService( 'Test' );
268 $this->assertNotSame( $oldInstance, $newInstance );
271 public function provideGetters() {
272 $getServiceCases = $this->provideGetService();
275 // All getters should be named just like the service, with "get" added.
276 foreach ( $getServiceCases as $name => $case ) {
277 if ( $name[0] === '_' ) {
278 // Internal service, no getter
281 list( $service, $class ) = $case;
282 $getterCases[$name] = [
292 * @dataProvider provideGetters
294 public function testGetters( $getter, $type ) {
295 // Test against the default instance, since the dummy will not know the default services.
296 $services = MediaWikiServices
::getInstance();
297 $service = $services->$getter();
298 $this->assertInstanceOf( $type, $service );
301 public function provideGetService() {
302 // NOTE: This should list all service getters defined in ServiceWiring.php.
303 // NOTE: For every test case defined here there should be a corresponding
304 // test case defined in provideGetters().
306 'BootstrapConfig' => [ 'BootstrapConfig', Config
::class ],
307 'ConfigFactory' => [ 'ConfigFactory', ConfigFactory
::class ],
308 'MainConfig' => [ 'MainConfig', Config
::class ],
309 'SiteStore' => [ 'SiteStore', SiteStore
::class ],
310 'SiteLookup' => [ 'SiteLookup', SiteLookup
::class ],
311 'StatsdDataFactory' => [ 'StatsdDataFactory', IBufferingStatsdDataFactory
::class ],
312 'InterwikiLookup' => [ 'InterwikiLookup', InterwikiLookup
::class ],
313 'EventRelayerGroup' => [ 'EventRelayerGroup', EventRelayerGroup
::class ],
314 'SearchEngineFactory' => [ 'SearchEngineFactory', SearchEngineFactory
::class ],
315 'SearchEngineConfig' => [ 'SearchEngineConfig', SearchEngineConfig
::class ],
316 'SkinFactory' => [ 'SkinFactory', SkinFactory
::class ],
317 'DBLoadBalancerFactory' => [ 'DBLoadBalancerFactory', Wikimedia\Rdbms\LBFactory
::class ],
318 'DBLoadBalancer' => [ 'DBLoadBalancer', 'LoadBalancer' ],
319 'WatchedItemStore' => [ 'WatchedItemStore', WatchedItemStore
::class ],
320 'WatchedItemQueryService' => [ 'WatchedItemQueryService', WatchedItemQueryService
::class ],
321 'CryptRand' => [ 'CryptRand', CryptRand
::class ],
322 'CryptHKDF' => [ 'CryptHKDF', CryptHKDF
::class ],
323 'MediaHandlerFactory' => [ 'MediaHandlerFactory', MediaHandlerFactory
::class ],
324 'Parser' => [ 'Parser', Parser
::class ],
325 'ParserCache' => [ 'ParserCache', ParserCache
::class ],
326 'GenderCache' => [ 'GenderCache', GenderCache
::class ],
327 'LinkCache' => [ 'LinkCache', LinkCache
::class ],
328 'LinkRenderer' => [ 'LinkRenderer', LinkRenderer
::class ],
329 'LinkRendererFactory' => [ 'LinkRendererFactory', LinkRendererFactory
::class ],
330 '_MediaWikiTitleCodec' => [ '_MediaWikiTitleCodec', MediaWikiTitleCodec
::class ],
331 'MimeAnalyzer' => [ 'MimeAnalyzer', MimeAnalyzer
::class ],
332 'TitleFormatter' => [ 'TitleFormatter', TitleFormatter
::class ],
333 'TitleParser' => [ 'TitleParser', TitleParser
::class ],
334 'ProxyLookup' => [ 'ProxyLookup', ProxyLookup
::class ],
335 'MainObjectStash' => [ 'MainObjectStash', BagOStuff
::class ],
336 'MainWANObjectCache' => [ 'MainWANObjectCache', WANObjectCache
::class ],
337 'LocalServerObjectCache' => [ 'LocalServerObjectCache', BagOStuff
::class ],
338 'VirtualRESTServiceClient' => [ 'VirtualRESTServiceClient', VirtualRESTServiceClient
::class ],
339 'ShellCommandFactory' => [ 'ShellCommandFactory', CommandFactory
::class ],
340 'BlobStoreFactory' => [ 'BlobStoreFactory', BlobStoreFactory
::class ],
341 'BlobStore' => [ 'BlobStore', BlobStore
::class ],
342 '_SqlBlobStore' => [ '_SqlBlobStore', SqlBlobStore
::class ],
343 'RevisionStore' => [ 'RevisionStore', RevisionStore
::class ],
344 'HttpRequestFactory' => [ 'HttpRequestFactory', HttpRequestFactory
::class ],
349 * @dataProvider provideGetService
351 public function testGetService( $name, $type ) {
352 // Test against the default instance, since the dummy will not know the default services.
353 $services = MediaWikiServices
::getInstance();
355 $service = $services->getService( $name );
356 $this->assertInstanceOf( $type, $service );
359 public function testDefaultServiceInstantiation() {
360 // Check all services in the default instance, not a dummy instance!
361 // Note that we instantiate all services here, including any that
362 // were registered by extensions.
363 $services = MediaWikiServices
::getInstance();
364 $names = $services->getServiceNames();
366 foreach ( $names as $name ) {
367 $this->assertTrue( $services->hasService( $name ) );
368 $service = $services->getService( $name );
369 $this->assertInternalType( 'object', $service );