4 * @covers ApiModuleManager
10 class ApiModuleManagerTest
extends MediaWikiTestCase
{
12 private function getModuleManager() {
13 $request = new FauxRequest();
14 $main = new ApiMain( $request );
15 return new ApiModuleManager( $main );
18 public function newApiLogin( $main, $action ) {
19 return new ApiLogin( $main, $action );
22 public function addModuleProvider() {
24 'plain class' => array(
31 'with factory' => array(
35 array( $this, 'newApiLogin' ),
38 'with closure' => array(
42 function ( ApiMain
$main, $action ) {
43 return new ApiLogout( $main, $action );
50 * @dataProvider addModuleProvider
52 public function testAddModule( $name, $group, $class, $factory = null ) {
53 $moduleManager = $this->getModuleManager();
54 $moduleManager->addModule( $name, $group, $class, $factory );
56 $this->assertTrue( $moduleManager->isDefined( $name, $group ), 'isDefined' );
57 $this->assertNotNull( $moduleManager->getModule( $name, $group, true ), 'getModule' );
60 public function addModulesProvider() {
69 'login' => 'ApiLogin',
70 'logout' => 'ApiLogout',
75 'with factories' => array(
78 'class' => 'ApiLogin',
79 'factory' => array( $this, 'newApiLogin' ),
82 'class' => 'ApiLogout',
83 'factory' => function ( ApiMain
$main, $action ) {
84 return new ApiLogout( $main, $action );
94 * @dataProvider addModulesProvider
96 public function testAddModules( array $modules, $group ) {
97 $moduleManager = $this->getModuleManager();
98 $moduleManager->addModules( $modules, $group );
100 foreach ( array_keys( $modules ) as $name ) {
101 $this->assertTrue( $moduleManager->isDefined( $name, $group ), 'isDefined' );
102 $this->assertNotNull( $moduleManager->getModule( $name, $group, true ), 'getModule' );
106 public function getModuleProvider() {
108 'feedrecentchanges' => 'ApiFeedRecentChanges',
109 'feedcontributions' => array( 'class' => 'ApiFeedContributions' ),
111 'class' => 'ApiLogin',
112 'factory' => array( $this, 'newApiLogin' ),
115 'class' => 'ApiLogout',
116 'factory' => function ( ApiMain
$main, $action ) {
117 return new ApiLogout( $main, $action );
123 'legacy entry' => array(
126 'ApiFeedRecentChanges',
129 'just a class' => array(
132 'ApiFeedContributions',
135 'with factory' => array(
141 'with closure' => array(
150 * @dataProvider getModuleProvider
152 public function testGetModule( $modules, $name, $expectedClass ) {
153 $moduleManager = $this->getModuleManager();
154 $moduleManager->addModules( $modules, 'test' );
156 // should return the right module
157 $module1 = $moduleManager->getModule( $name, null, false );
158 $this->assertInstanceOf( $expectedClass, $module1 );
160 // should pass group check (with caching disabled)
161 $module2 = $moduleManager->getModule( $name, 'test', true );
162 $this->assertNotNull( $module2 );
164 // should use cached instance
165 $module3 = $moduleManager->getModule( $name, null, false );
166 $this->assertSame( $module1, $module3 );
168 // should not use cached instance if caching is disabled
169 $module4 = $moduleManager->getModule( $name, null, true );
170 $this->assertNotSame( $module1, $module4 );
173 public function testGetModule_null() {
175 'login' => 'ApiLogin',
176 'logout' => 'ApiLogout',
179 $moduleManager = $this->getModuleManager();
180 $moduleManager->addModules( $modules, 'test' );
182 $this->assertNull( $moduleManager->getModule( 'quux' ), 'unknown name' );
183 $this->assertNull( $moduleManager->getModule( 'login', 'bla' ), 'wrong group' );
186 public function testGetNames() {
188 'login' => 'ApiLogin',
189 'logout' => 'ApiLogout',
193 'feedcontributions' => array( 'class' => 'ApiFeedContributions' ),
194 'feedrecentchanges' => array( 'class' => 'ApiFeedRecentChanges' ),
197 $moduleManager = $this->getModuleManager();
198 $moduleManager->addModules( $fooModules, 'foo' );
199 $moduleManager->addModules( $barModules, 'bar' );
201 $fooNames = $moduleManager->getNames( 'foo' );
202 $this->assertArrayEquals( array_keys( $fooModules ), $fooNames );
204 $allNames = $moduleManager->getNames();
205 $allModules = array_merge( $fooModules, $barModules );
206 $this->assertArrayEquals( array_keys( $allModules ), $allNames );
209 public function testGetNamesWithClasses() {
211 'login' => 'ApiLogin',
212 'logout' => 'ApiLogout',
216 'feedcontributions' => array( 'class' => 'ApiFeedContributions' ),
217 'feedrecentchanges' => array( 'class' => 'ApiFeedRecentChanges' ),
220 $moduleManager = $this->getModuleManager();
221 $moduleManager->addModules( $fooModules, 'foo' );
222 $moduleManager->addModules( $barModules, 'bar' );
224 $fooNamesWithClasses = $moduleManager->getNamesWithClasses( 'foo' );
225 $this->assertArrayEquals( $fooModules, $fooNamesWithClasses );
227 $allNamesWithClasses = $moduleManager->getNamesWithClasses();
228 $allModules = array_merge( $fooModules, array(
229 'feedcontributions' => 'ApiFeedContributions',
230 'feedrecentchanges' => 'ApiFeedRecentChanges',
232 $this->assertArrayEquals( $allModules, $allNamesWithClasses );
235 public function testGetModuleGroup() {
237 'login' => 'ApiLogin',
238 'logout' => 'ApiLogout',
242 'feedcontributions' => array( 'class' => 'ApiFeedContributions' ),
243 'feedrecentchanges' => array( 'class' => 'ApiFeedRecentChanges' ),
246 $moduleManager = $this->getModuleManager();
247 $moduleManager->addModules( $fooModules, 'foo' );
248 $moduleManager->addModules( $barModules, 'bar' );
250 $this->assertEquals( 'foo', $moduleManager->getModuleGroup( 'login' ) );
251 $this->assertEquals( 'bar', $moduleManager->getModuleGroup( 'feedrecentchanges' ) );
252 $this->assertNull( $moduleManager->getModuleGroup( 'quux' ) );
255 public function testGetGroups() {
257 'login' => 'ApiLogin',
258 'logout' => 'ApiLogout',
262 'feedcontributions' => array( 'class' => 'ApiFeedContributions' ),
263 'feedrecentchanges' => array( 'class' => 'ApiFeedRecentChanges' ),
266 $moduleManager = $this->getModuleManager();
267 $moduleManager->addModules( $fooModules, 'foo' );
268 $moduleManager->addModules( $barModules, 'bar' );
270 $groups = $moduleManager->getGroups();
271 $this->assertArrayEquals( array( 'foo', 'bar' ), $groups );