MediaWiki  REL1_31
MediaWikiServicesTest.php
Go to the documentation of this file.
1 <?php
2 
3 use Mediawiki\Http\HttpRequestFactory;
17 
24 
28  private function newTestConfig() {
29  $globalConfig = new GlobalVarConfig();
30 
31  $testConfig = new HashConfig();
32  $testConfig->set( 'ServiceWiringFiles', $globalConfig->get( 'ServiceWiringFiles' ) );
33  $testConfig->set( 'ConfigRegistry', $globalConfig->get( 'ConfigRegistry' ) );
34 
35  return $testConfig;
36  }
37 
41  private function newMediaWikiServices( Config $config = null ) {
42  if ( $config === null ) {
43  $config = $this->newTestConfig();
44  }
45 
46  $instance = new MediaWikiServices( $config );
47 
48  // Load the default wiring from the specified files.
49  $wiringFiles = $config->get( 'ServiceWiringFiles' );
50  $instance->loadWiringFiles( $wiringFiles );
51 
52  return $instance;
53  }
54 
55  public function testGetInstance() {
56  $services = MediaWikiServices::getInstance();
57  $this->assertInstanceOf( MediaWikiServices::class, $services );
58  }
59 
60  public function testForceGlobalInstance() {
61  $newServices = $this->newMediaWikiServices();
62  $oldServices = MediaWikiServices::forceGlobalInstance( $newServices );
63 
64  $this->assertInstanceOf( MediaWikiServices::class, $oldServices );
65  $this->assertNotSame( $oldServices, $newServices );
66 
67  $theServices = MediaWikiServices::getInstance();
68  $this->assertSame( $theServices, $newServices );
69 
70  MediaWikiServices::forceGlobalInstance( $oldServices );
71 
72  $theServices = MediaWikiServices::getInstance();
73  $this->assertSame( $theServices, $oldServices );
74  }
75 
76  public function testResetGlobalInstance() {
77  $newServices = $this->newMediaWikiServices();
78  $oldServices = MediaWikiServices::forceGlobalInstance( $newServices );
79 
80  $service1 = $this->createMock( SalvageableService::class );
81  $service1->expects( $this->never() )
82  ->method( 'salvage' );
83 
84  $newServices->defineService(
85  'Test',
86  function () use ( $service1 ) {
87  return $service1;
88  }
89  );
90 
91  // force instantiation
92  $newServices->getService( 'Test' );
93 
94  MediaWikiServices::resetGlobalInstance( $this->newTestConfig() );
95  $theServices = MediaWikiServices::getInstance();
96 
97  $this->assertSame(
98  $service1,
99  $theServices->getService( 'Test' ),
100  'service definition should survive reset'
101  );
102 
103  $this->assertNotSame( $theServices, $newServices );
104  $this->assertNotSame( $theServices, $oldServices );
105 
106  MediaWikiServices::forceGlobalInstance( $oldServices );
107  }
108 
109  public function testResetGlobalInstance_quick() {
110  $newServices = $this->newMediaWikiServices();
111  $oldServices = MediaWikiServices::forceGlobalInstance( $newServices );
112 
113  $service1 = $this->createMock( SalvageableService::class );
114  $service1->expects( $this->never() )
115  ->method( 'salvage' );
116 
117  $service2 = $this->createMock( SalvageableService::class );
118  $service2->expects( $this->once() )
119  ->method( 'salvage' )
120  ->with( $service1 );
121 
122  // sequence of values the instantiator will return
123  $instantiatorReturnValues = [
124  $service1,
125  $service2,
126  ];
127 
128  $newServices->defineService(
129  'Test',
130  function () use ( &$instantiatorReturnValues ) {
131  return array_shift( $instantiatorReturnValues );
132  }
133  );
134 
135  // force instantiation
136  $newServices->getService( 'Test' );
137 
138  MediaWikiServices::resetGlobalInstance( $this->newTestConfig(), 'quick' );
139  $theServices = MediaWikiServices::getInstance();
140 
141  $this->assertSame( $service2, $theServices->getService( 'Test' ) );
142 
143  $this->assertNotSame( $theServices, $newServices );
144  $this->assertNotSame( $theServices, $oldServices );
145 
146  MediaWikiServices::forceGlobalInstance( $oldServices );
147  }
148 
149  public function testDisableStorageBackend() {
150  $newServices = $this->newMediaWikiServices();
151  $oldServices = MediaWikiServices::forceGlobalInstance( $newServices );
152 
153  $lbFactory = $this->getMockBuilder( \Wikimedia\Rdbms\LBFactorySimple::class )
154  ->disableOriginalConstructor()
155  ->getMock();
156 
157  $newServices->redefineService(
158  'DBLoadBalancerFactory',
159  function () use ( $lbFactory ) {
160  return $lbFactory;
161  }
162  );
163 
164  // force the service to become active, so we can check that it does get destroyed
165  $newServices->getService( 'DBLoadBalancerFactory' );
166 
167  MediaWikiServices::disableStorageBackend(); // should destroy DBLoadBalancerFactory
168 
169  try {
170  MediaWikiServices::getInstance()->getService( 'DBLoadBalancerFactory' );
171  $this->fail( 'DBLoadBalancerFactory should have been disabled' );
172  }
173  catch ( ServiceDisabledException $ex ) {
174  // ok, as expected
175  } catch ( Throwable $ex ) {
176  $this->fail( 'ServiceDisabledException expected, caught ' . get_class( $ex ) );
177  }
178 
179  MediaWikiServices::forceGlobalInstance( $oldServices );
180  $newServices->destroy();
181 
182  // No exception was thrown, avoid being risky
183  $this->assertTrue( true );
184  }
185 
186  public function testResetChildProcessServices() {
187  $newServices = $this->newMediaWikiServices();
188  $oldServices = MediaWikiServices::forceGlobalInstance( $newServices );
189 
190  $service1 = $this->createMock( DestructibleService::class );
191  $service1->expects( $this->once() )
192  ->method( 'destroy' );
193 
194  $service2 = $this->createMock( DestructibleService::class );
195  $service2->expects( $this->never() )
196  ->method( 'destroy' );
197 
198  // sequence of values the instantiator will return
199  $instantiatorReturnValues = [
200  $service1,
201  $service2,
202  ];
203 
204  $newServices->defineService(
205  'Test',
206  function () use ( &$instantiatorReturnValues ) {
207  return array_shift( $instantiatorReturnValues );
208  }
209  );
210 
211  // force the service to become active, so we can check that it does get destroyed
212  $oldTestService = $newServices->getService( 'Test' );
213 
214  MediaWikiServices::resetChildProcessServices();
215  $finalServices = MediaWikiServices::getInstance();
216 
217  $newTestService = $finalServices->getService( 'Test' );
218  $this->assertNotSame( $oldTestService, $newTestService );
219 
220  MediaWikiServices::forceGlobalInstance( $oldServices );
221  }
222 
223  public function testResetServiceForTesting() {
224  $services = $this->newMediaWikiServices();
225  $serviceCounter = 0;
226 
227  $services->defineService(
228  'Test',
229  function () use ( &$serviceCounter ) {
230  $serviceCounter++;
231  $service = $this->createMock( MediaWiki\Services\DestructibleService::class );
232  $service->expects( $this->once() )->method( 'destroy' );
233  return $service;
234  }
235  );
236 
237  // This should do nothing. In particular, it should not create a service instance.
238  $services->resetServiceForTesting( 'Test' );
239  $this->assertEquals( 0, $serviceCounter, 'No service instance should be created yet.' );
240 
241  $oldInstance = $services->getService( 'Test' );
242  $this->assertEquals( 1, $serviceCounter, 'A service instance should exit now.' );
243 
244  // The old instance should be detached, and destroy() called.
245  $services->resetServiceForTesting( 'Test' );
246  $newInstance = $services->getService( 'Test' );
247 
248  $this->assertNotSame( $oldInstance, $newInstance );
249 
250  // Satisfy the expectation that destroy() is called also for the second service instance.
251  $newInstance->destroy();
252  }
253 
255  $services = $this->newMediaWikiServices();
256 
257  $services->defineService(
258  'Test',
259  function () {
260  $service = $this->createMock( MediaWiki\Services\DestructibleService::class );
261  $service->expects( $this->never() )->method( 'destroy' );
262  return $service;
263  }
264  );
265 
266  $oldInstance = $services->getService( 'Test' );
267 
268  // The old instance should be detached, but destroy() not called.
269  $services->resetServiceForTesting( 'Test', false );
270  $newInstance = $services->getService( 'Test' );
271 
272  $this->assertNotSame( $oldInstance, $newInstance );
273  }
274 
275  public function provideGetters() {
276  $getServiceCases = $this->provideGetService();
277  $getterCases = [];
278 
279  // All getters should be named just like the service, with "get" added.
280  foreach ( $getServiceCases as $name => $case ) {
281  if ( $name[0] === '_' ) {
282  // Internal service, no getter
283  continue;
284  }
285  list( $service, $class ) = $case;
286  $getterCases[$name] = [
287  'get' . $service,
288  $class,
289  ];
290  }
291 
292  return $getterCases;
293  }
294 
298  public function testGetters( $getter, $type ) {
299  // Test against the default instance, since the dummy will not know the default services.
300  $services = MediaWikiServices::getInstance();
301  $service = $services->$getter();
302  $this->assertInstanceOf( $type, $service );
303  }
304 
305  public function provideGetService() {
306  // NOTE: This should list all service getters defined in ServiceWiring.php.
307  // NOTE: For every test case defined here there should be a corresponding
308  // test case defined in provideGetters().
309  return [
310  'BootstrapConfig' => [ 'BootstrapConfig', Config::class ],
311  'ConfigFactory' => [ 'ConfigFactory', ConfigFactory::class ],
312  'MainConfig' => [ 'MainConfig', Config::class ],
313  'SiteStore' => [ 'SiteStore', SiteStore::class ],
314  'SiteLookup' => [ 'SiteLookup', SiteLookup::class ],
315  'StatsdDataFactory' => [ 'StatsdDataFactory', IBufferingStatsdDataFactory::class ],
316  'InterwikiLookup' => [ 'InterwikiLookup', InterwikiLookup::class ],
317  'EventRelayerGroup' => [ 'EventRelayerGroup', EventRelayerGroup::class ],
318  'SearchEngineFactory' => [ 'SearchEngineFactory', SearchEngineFactory::class ],
319  'SearchEngineConfig' => [ 'SearchEngineConfig', SearchEngineConfig::class ],
320  'SkinFactory' => [ 'SkinFactory', SkinFactory::class ],
321  'DBLoadBalancerFactory' => [ 'DBLoadBalancerFactory', Wikimedia\Rdbms\LBFactory::class ],
322  'DBLoadBalancer' => [ 'DBLoadBalancer', Wikimedia\Rdbms\LoadBalancer::class ],
323  'WatchedItemStore' => [ 'WatchedItemStore', WatchedItemStore::class ],
324  'WatchedItemQueryService' => [ 'WatchedItemQueryService', WatchedItemQueryService::class ],
325  'CryptRand' => [ 'CryptRand', CryptRand::class ],
326  'CryptHKDF' => [ 'CryptHKDF', CryptHKDF::class ],
327  'MediaHandlerFactory' => [ 'MediaHandlerFactory', MediaHandlerFactory::class ],
328  'Parser' => [ 'Parser', Parser::class ],
329  'ParserCache' => [ 'ParserCache', ParserCache::class ],
330  'GenderCache' => [ 'GenderCache', GenderCache::class ],
331  'LinkCache' => [ 'LinkCache', LinkCache::class ],
332  'LinkRenderer' => [ 'LinkRenderer', LinkRenderer::class ],
333  'LinkRendererFactory' => [ 'LinkRendererFactory', LinkRendererFactory::class ],
334  '_MediaWikiTitleCodec' => [ '_MediaWikiTitleCodec', MediaWikiTitleCodec::class ],
335  'MimeAnalyzer' => [ 'MimeAnalyzer', MimeAnalyzer::class ],
336  'TitleFormatter' => [ 'TitleFormatter', TitleFormatter::class ],
337  'TitleParser' => [ 'TitleParser', TitleParser::class ],
338  'ProxyLookup' => [ 'ProxyLookup', ProxyLookup::class ],
339  'MainObjectStash' => [ 'MainObjectStash', BagOStuff::class ],
340  'MainWANObjectCache' => [ 'MainWANObjectCache', WANObjectCache::class ],
341  'LocalServerObjectCache' => [ 'LocalServerObjectCache', BagOStuff::class ],
342  'VirtualRESTServiceClient' => [ 'VirtualRESTServiceClient', VirtualRESTServiceClient::class ],
343  'ShellCommandFactory' => [ 'ShellCommandFactory', CommandFactory::class ],
344  'BlobStoreFactory' => [ 'BlobStoreFactory', BlobStoreFactory::class ],
345  'BlobStore' => [ 'BlobStore', BlobStore::class ],
346  '_SqlBlobStore' => [ '_SqlBlobStore', SqlBlobStore::class ],
347  'RevisionStore' => [ 'RevisionStore', RevisionStore::class ],
348  'RevisionLookup' => [ 'RevisionLookup', RevisionLookup::class ],
349  'HttpRequestFactory' => [ 'HttpRequestFactory', HttpRequestFactory::class ],
350  'CommentStore' => [ 'CommentStore', CommentStore::class ],
351  ];
352  }
353 
357  public function testGetService( $name, $type ) {
358  // Test against the default instance, since the dummy will not know the default services.
359  $services = MediaWikiServices::getInstance();
360 
361  $service = $services->getService( $name );
362  $this->assertInstanceOf( $type, $service );
363  }
364 
366  // Check all services in the default instance, not a dummy instance!
367  // Note that we instantiate all services here, including any that
368  // were registered by extensions.
369  $services = MediaWikiServices::getInstance();
370  $names = $services->getServiceNames();
371 
372  foreach ( $names as $name ) {
373  $this->assertTrue( $services->hasService( $name ) );
374  $service = $services->getService( $name );
375  $this->assertInternalType( 'object', $service );
376  }
377  }
378 
379 }
MediaWiki\Services\DestructibleService
DestructibleService defines a standard interface for shutting down a service instance.
Definition: DestructibleService.php:35
MediaWiki\Storage\RevisionStore
Service for looking up page revisions.
Definition: RevisionStore.php:69
MediaWiki\Storage\RevisionLookup
Service for looking up page revisions.
Definition: RevisionLookup.php:37
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
MediaWikiServicesTest\testForceGlobalInstance
testForceGlobalInstance()
Definition: MediaWikiServicesTest.php:60
MediaWikiServicesTest\testResetGlobalInstance
testResetGlobalInstance()
Definition: MediaWikiServicesTest.php:76
MediaWikiServicesTest\provideGetService
provideGetService()
Definition: MediaWikiServicesTest.php:305
HashConfig
A Config instance which stores all settings as a member variable.
Definition: HashConfig.php:28
MediaWikiServicesTest
MediaWiki\MediaWikiServices.
Definition: MediaWikiServicesTest.php:23
MediaWiki\Storage\SqlBlobStore
Service for storing and loading Content objects.
Definition: SqlBlobStore.php:50
MediaWiki\Linker\LinkRenderer
Class that generates HTML links for pages.
Definition: LinkRenderer.php:41
MediaWiki\Linker\LinkRendererFactory
Factory to create LinkRender objects.
Definition: LinkRendererFactory.php:31
MediaWikiServicesTest\testResetServiceForTesting
testResetServiceForTesting()
Definition: MediaWikiServicesTest.php:223
MediaWikiServicesTest\testGetters
testGetters( $getter, $type)
provideGetters
Definition: MediaWikiServicesTest.php:298
MediaWikiServicesTest\newMediaWikiServices
newMediaWikiServices(Config $config=null)
Definition: MediaWikiServicesTest.php:41
MediaWikiServicesTest\newTestConfig
newTestConfig()
Definition: MediaWikiServicesTest.php:28
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
Config
Interface for configuration instances.
Definition: Config.php:28
MediaWikiServicesTest\testResetServiceForTesting_noDestroy
testResetServiceForTesting_noDestroy()
Definition: MediaWikiServicesTest.php:254
MediaWikiServicesTest\provideGetters
provideGetters()
Definition: MediaWikiServicesTest.php:275
MediaWikiTestCase
Definition: MediaWikiTestCase.php:17
MediaWiki\Interwiki\InterwikiLookup
Service interface for looking up Interwiki records.
Definition: InterwikiLookup.php:31
MediaWiki
A helper class for throttling authentication attempts.
MediaWikiServicesTest\testDefaultServiceInstantiation
testDefaultServiceInstantiation()
Definition: MediaWikiServicesTest.php:365
MediaWiki\Storage\BlobStoreFactory
Service for instantiating BlobStores.
Definition: BlobStoreFactory.php:35
GlobalVarConfig
Accesses configuration settings from $GLOBALS.
Definition: GlobalVarConfig.php:28
$services
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition: hooks.txt:2273
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
MediaWikiServicesTest\testGetInstance
testGetInstance()
Definition: MediaWikiServicesTest.php:55
MediaWiki\Shell\CommandFactory
Factory facilitating dependency injection for Command.
Definition: CommandFactory.php:32
MediaWiki\Services\SalvageableService
SalvageableService defines an interface for services that are able to salvage state from a previous i...
Definition: SalvageableService.php:35
MediaWiki\Storage\BlobStore
Service for loading and storing data blobs.
Definition: BlobStore.php:33
MediaWikiServicesTest\testResetChildProcessServices
testResetChildProcessServices()
Definition: MediaWikiServicesTest.php:186
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
Wikimedia
MediaWikiServicesTest\testGetService
testGetService( $name, $type)
provideGetService
Definition: MediaWikiServicesTest.php:357
MediaWiki\Services\ServiceDisabledException
Exception thrown when trying to access a disabled service.
Definition: ServiceDisabledException.php:33
MediaWikiServicesTest\testDisableStorageBackend
testDisableStorageBackend()
Definition: MediaWikiServicesTest.php:149
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
MediaWikiServices
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:25
MediaWikiServicesTest\testResetGlobalInstance_quick
testResetGlobalInstance_quick()
Definition: MediaWikiServicesTest.php:109
$type
$type
Definition: testCompression.php:48