MediaWiki  master
ConfigFactoryTest.php
Go to the documentation of this file.
1 <?php
2 
4 
6 
10  public function testRegister() {
11  $factory = new ConfigFactory();
12  $factory->register( 'unittest', 'GlobalVarConfig::newInstance' );
13  $this->assertInstanceOf( GlobalVarConfig::class, $factory->makeConfig( 'unittest' ) );
14  }
15 
19  public function testRegisterInvalid() {
20  $factory = new ConfigFactory();
21  $this->setExpectedException( InvalidArgumentException::class );
22  $factory->register( 'invalid', 'Invalid callback' );
23  }
24 
28  public function testRegisterInvalidInstance() {
29  $factory = new ConfigFactory();
30  $this->setExpectedException( InvalidArgumentException::class );
31  $factory->register( 'invalidInstance', new stdClass );
32  }
33 
37  public function testRegisterInstance() {
38  $config = GlobalVarConfig::newInstance();
39  $factory = new ConfigFactory();
40  $factory->register( 'unittest', $config );
41  $this->assertSame( $config, $factory->makeConfig( 'unittest' ) );
42  }
43 
47  public function testRegisterAgain() {
48  $factory = new ConfigFactory();
49  $factory->register( 'unittest', 'GlobalVarConfig::newInstance' );
50  $config1 = $factory->makeConfig( 'unittest' );
51 
52  $factory->register( 'unittest', 'GlobalVarConfig::newInstance' );
53  $config2 = $factory->makeConfig( 'unittest' );
54 
55  $this->assertNotSame( $config1, $config2 );
56  }
57 
61  public function testSalvage() {
62  $oldFactory = new ConfigFactory();
63  $oldFactory->register( 'foo', 'GlobalVarConfig::newInstance' );
64  $oldFactory->register( 'bar', 'GlobalVarConfig::newInstance' );
65  $oldFactory->register( 'quux', 'GlobalVarConfig::newInstance' );
66 
67  // instantiate two of the three defined configurations
68  $foo = $oldFactory->makeConfig( 'foo' );
69  $bar = $oldFactory->makeConfig( 'bar' );
70  $quux = $oldFactory->makeConfig( 'quux' );
71 
72  // define new config instance
73  $newFactory = new ConfigFactory();
74  $newFactory->register( 'foo', 'GlobalVarConfig::newInstance' );
75  $newFactory->register( 'bar', function () {
76  return new HashConfig();
77  } );
78 
79  // "foo" and "quux" are defined in the old and the new factory.
80  // The old factory has instances for "foo" and "bar", but not "quux".
81  $newFactory->salvage( $oldFactory );
82 
83  $newFoo = $newFactory->makeConfig( 'foo' );
84  $this->assertSame( $foo, $newFoo, 'existing instance should be salvaged' );
85 
86  $newBar = $newFactory->makeConfig( 'bar' );
87  $this->assertNotSame( $bar, $newBar, 'don\'t salvage if callbacks differ' );
88 
89  // the new factory doesn't have quux defined, so the quux instance should not be salvaged
90  $this->setExpectedException( ConfigException::class );
91  $newFactory->makeConfig( 'quux' );
92  }
93 
97  public function testGetConfigNames() {
98  $factory = new ConfigFactory();
99  $factory->register( 'foo', 'GlobalVarConfig::newInstance' );
100  $factory->register( 'bar', new HashConfig() );
101 
102  $this->assertEquals( [ 'foo', 'bar' ], $factory->getConfigNames() );
103  }
104 
108  public function testMakeConfigWithCallback() {
109  $factory = new ConfigFactory();
110  $factory->register( 'unittest', 'GlobalVarConfig::newInstance' );
111 
112  $conf = $factory->makeConfig( 'unittest' );
113  $this->assertInstanceOf( Config::class, $conf );
114  $this->assertSame( $conf, $factory->makeConfig( 'unittest' ) );
115  }
116 
120  public function testMakeConfigWithObject() {
121  $factory = new ConfigFactory();
122  $conf = new HashConfig();
123  $factory->register( 'test', $conf );
124  $this->assertSame( $conf, $factory->makeConfig( 'test' ) );
125  }
126 
130  public function testMakeConfigFallback() {
131  $factory = new ConfigFactory();
132  $factory->register( '*', 'GlobalVarConfig::newInstance' );
133  $conf = $factory->makeConfig( 'unittest' );
134  $this->assertInstanceOf( Config::class, $conf );
135  }
136 
140  public function testMakeConfigWithNoBuilders() {
141  $factory = new ConfigFactory();
142  $this->setExpectedException( ConfigException::class );
143  $factory->makeConfig( 'nobuilderregistered' );
144  }
145 
150  $factory = new ConfigFactory();
151  $factory->register( 'unittest', function () {
152  return true; // Not a Config object
153  } );
154  $this->setExpectedException( UnexpectedValueException::class );
155  $factory->makeConfig( 'unittest' );
156  }
157 
161  public function testGetDefaultInstance() {
162  // NOTE: the global config factory returned here has been overwritten
163  // for operation in test mode. It may not reflect LocalSettings.
164  $factory = MediaWikiServices::getInstance()->getConfigFactory();
165  $this->assertInstanceOf( Config::class, $factory->makeConfig( 'main' ) );
166  }
167 
168 }
testMakeConfigWithNoBuilders()
ConfigFactory::makeConfig.
testGetConfigNames()
ConfigFactory::getConfigNames.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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:23
testMakeConfigFallback()
ConfigFactory::makeConfig.
testGetDefaultInstance()
ConfigFactory::getDefaultInstance.
testMakeConfigWithObject()
ConfigFactory::makeConfig.
testRegister()
ConfigFactory::register.
testMakeConfigWithInvalidCallback()
ConfigFactory::makeConfig.
testMakeConfigWithCallback()
ConfigFactory::makeConfig.
static newInstance()
Default builder function.
testSalvage()
ConfigFactory::salvage.
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:35
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:52
testRegisterAgain()
ConfigFactory::register.
testRegisterInvalidInstance()
ConfigFactory::register.
testRegisterInstance()
ConfigFactory::register.
A Config instance which stores all settings as a member variable.
Definition: HashConfig.php:28
testRegisterInvalid()
ConfigFactory::register.