tests/phpunit/includes/api/ApiModuleManagerTest.php

   1 <?php
   2
   3 /**
   4  * @covers ApiModuleManager
   5  *
   6  * @group API
   7  * @group Database
   8  * @group medium
   9  */
  10 class ApiModuleManagerTest extends MediaWikiTestCase {
  11
  12         private function getModuleManager() {
  13                 $request = new FauxRequest();
  14                 $main = new ApiMain( $request );
  15                 return new ApiModuleManager( $main );
  16         }
  17
  18         public function newApiLogin( $main, $action ) {
  19                 return new ApiLogin( $main, $action );
  20         }
  21
  22         public function addModuleProvider() {
  23                 return array(
  24                         'plain class' => array(
  25                                 'login',
  26                                 'action',
  27                                 'ApiLogin',
  28                                 null,
  29                         ),
  30
  31                         'with factory' => array(
  32                                 'login',
  33                                 'action',
  34                                 'ApiLogin',
  35                                 array( $this, 'newApiLogin' ),
  36                         ),
  37
  38                         'with closure' => array(
  39                                 'logout',
  40                                 'action',
  41                                 'ApiLogout',
  42                                 function( ApiMain $main, $action ) {
  43                                                 return new ApiLogout( $main, $action );
  44                                 },
  45                         ),
  46                 );
  47         }
  48
  49         /**
  50          * @dataProvider addModuleProvider
  51          */
  52         public function testAddModule( $name, $group, $class, $factory = null ) {
  53                 $moduleManager = $this->getModuleManager();
  54                 $moduleManager->addModule( $name, $group, $class, $factory );
  55
  56                 $this->assertTrue( $moduleManager->isDefined( $name, $group ), 'isDefined' );
  57                 $this->assertNotNull( $moduleManager->getModule( $name, $group, true ), 'getModule' );
  58         }
  59
  60         public function addModulesProvider() {
  61                 return array(
  62                         'empty' => array(
  63                                 array(),
  64                                 'action',
  65                         ),
  66
  67                         'simple' => array(
  68                                 array(
  69                                         'login' => 'ApiLogin',
  70                                         'logout' => 'ApiLogout',
  71                                 ),
  72                                 'action',
  73                         ),
  74
  75                         'with factories' => array(
  76                                 array(
  77                                         'login' => array(
  78                                                 'class' => 'ApiLogin',
  79                                                 'factory' => array( $this, 'newApiLogin' ),
  80                                         ),
  81                                         'logout' => array(
  82                                                 'class' => 'ApiLogout',
  83                                                 'factory' => function( ApiMain $main, $action ) {
  84                                                         return new ApiLogout( $main, $action );
  85                                                 },
  86                                         ),
  87                                 ),
  88                                 'action',
  89                         ),
  90                 );
  91         }
  92
  93         /**
  94          * @dataProvider addModulesProvider
  95          */
  96         public function testAddModules( array $modules, $group ) {
  97                 $moduleManager = $this->getModuleManager();
  98                 $moduleManager->addModules( $modules, $group );
  99
 100                 foreach ( array_keys( $modules ) as $name ) {
 101                         $this->assertTrue( $moduleManager->isDefined( $name, $group ), 'isDefined' );
 102                         $this->assertNotNull( $moduleManager->getModule( $name, $group, true ), 'getModule' );
 103                 }
 104         }
 105
 106         public function getModuleProvider() {
 107                 $modules = array(
 108                         'feedrecentchanges' => 'ApiFeedRecentChanges',
 109                         'feedcontributions' => array( 'class' => 'ApiFeedContributions' ),
 110                         'login' => array(
 111                                 'class' => 'ApiLogin',
 112                                 'factory' => array( $this, 'newApiLogin' ),
 113                         ),
 114                         'logout' => array(
 115                                 'class' => 'ApiLogout',
 116                                 'factory' => function( ApiMain $main, $action ) {
 117                                                 return new ApiLogout( $main, $action );
 118                                         },
 119                         ),
 120                 );
 121
 122                 return array(
 123                         'legacy entry' => array(
 124                                 $modules,
 125                                 'feedrecentchanges',
 126                                 'ApiFeedRecentChanges',
 127                         ),
 128
 129                         'just a class' => array(
 130                                 $modules,
 131                                 'feedcontributions',
 132                                 'ApiFeedContributions',
 133                         ),
 134
 135                         'with factory' => array(
 136                                 $modules,
 137                                 'login',
 138                                 'ApiLogin',
 139                         ),
 140
 141                         'with closure' => array(
 142                                 $modules,
 143                                 'logout',
 144                                 'ApiLogout',
 145                         ),
 146                 );
 147         }
 148
 149         /**
 150          * @dataProvider getModuleProvider
 151          */
 152         public function testGetModule( $modules, $name, $expectedClass ) {
 153                 $moduleManager = $this->getModuleManager();
 154                 $moduleManager->addModules( $modules, 'test' );
 155
 156                 // should return the right module
 157                 $module1 = $moduleManager->getModule( $name, null, false );
 158                 $this->assertInstanceOf( $expectedClass, $module1 );
 159
 160                 // should pass group check (with caching disabled)
 161                 $module2 = $moduleManager->getModule( $name, 'test', true );
 162                 $this->assertNotNull( $module2 );
 163
 164                 // should use cached instance
 165                 $module3 = $moduleManager->getModule( $name, null, false );
 166                 $this->assertSame( $module1, $module3 );
 167
 168                 // should not use cached instance if caching is disabled
 169                 $module4 = $moduleManager->getModule( $name, null, true );
 170                 $this->assertNotSame( $module1, $module4 );
 171         }
 172
 173         public function testGetModule_null() {
 174                 $modules = array(
 175                         'login' => 'ApiLogin',
 176                         'logout' => 'ApiLogout',
 177                 );
 178
 179                 $moduleManager = $this->getModuleManager();
 180                 $moduleManager->addModules( $modules, 'test' );
 181
 182                 $this->assertNull( $moduleManager->getModule( 'quux' ), 'unknown name' );
 183                 $this->assertNull( $moduleManager->getModule( 'login', 'bla' ), 'wrong group' );
 184         }
 185
 186         public function testGetNames() {
 187                 $fooModules = array(
 188                         'login' => 'ApiLogin',
 189                         'logout' => 'ApiLogout',
 190                 );
 191
 192                 $barModules = array(
 193                         'feedcontributions' => array( 'class' => 'ApiFeedContributions' ),
 194                         'feedrecentchanges' => array( 'class' => 'ApiFeedRecentChanges' ),
 195                 );
 196
 197                 $moduleManager = $this->getModuleManager();
 198                 $moduleManager->addModules( $fooModules, 'foo' );
 199                 $moduleManager->addModules( $barModules, 'bar' );
 200
 201                 $fooNames = $moduleManager->getNames( 'foo' );
 202                 $this->assertArrayEquals( array_keys( $fooModules ), $fooNames );
 203
 204                 $allNames = $moduleManager->getNames();
 205                 $allModules = array_merge( $fooModules, $barModules );
 206                 $this->assertArrayEquals( array_keys( $allModules ), $allNames );
 207         }
 208
 209         public function testGetNamesWithClasses() {
 210                 $fooModules = array(
 211                         'login' => 'ApiLogin',
 212                         'logout' => 'ApiLogout',
 213                 );
 214
 215                 $barModules = array(
 216                         'feedcontributions' => array( 'class' => 'ApiFeedContributions' ),
 217                         'feedrecentchanges' => array( 'class' => 'ApiFeedRecentChanges' ),
 218                 );
 219
 220                 $moduleManager = $this->getModuleManager();
 221                 $moduleManager->addModules( $fooModules, 'foo' );
 222                 $moduleManager->addModules( $barModules, 'bar' );
 223
 224                 $fooNamesWithClasses = $moduleManager->getNamesWithClasses( 'foo' );
 225                 $this->assertArrayEquals( $fooModules, $fooNamesWithClasses );
 226
 227                 $allNamesWithClasses = $moduleManager->getNamesWithClasses();
 228                 $allModules = array_merge( $fooModules, array(
 229                         'feedcontributions' => 'ApiFeedContributions',
 230                         'feedrecentchanges' => 'ApiFeedRecentChanges',
 231                 ) );
 232                 $this->assertArrayEquals( $allModules, $allNamesWithClasses );
 233         }
 234
 235         public function testGetModuleGroup() {
 236                 $fooModules = array(
 237                         'login' => 'ApiLogin',
 238                         'logout' => 'ApiLogout',
 239                 );
 240
 241                 $barModules = array(
 242                         'feedcontributions' => array( 'class' => 'ApiFeedContributions' ),
 243                         'feedrecentchanges' => array( 'class' => 'ApiFeedRecentChanges' ),
 244                 );
 245
 246                 $moduleManager = $this->getModuleManager();
 247                 $moduleManager->addModules( $fooModules, 'foo' );
 248                 $moduleManager->addModules( $barModules, 'bar' );
 249
 250                 $this->assertEquals( 'foo', $moduleManager->getModuleGroup( 'login' ) );
 251                 $this->assertEquals( 'bar', $moduleManager->getModuleGroup( 'feedrecentchanges' ) );
 252                 $this->assertNull( $moduleManager->getModuleGroup( 'quux' ) );
 253         }
 254
 255         public function testGetGroups() {
 256                 $fooModules = array(
 257                         'login' => 'ApiLogin',
 258                         'logout' => 'ApiLogout',
 259                 );
 260
 261                 $barModules = array(
 262                         'feedcontributions' => array( 'class' => 'ApiFeedContributions' ),
 263                         'feedrecentchanges' => array( 'class' => 'ApiFeedRecentChanges' ),
 264                 );
 265
 266                 $moduleManager = $this->getModuleManager();
 267                 $moduleManager->addModules( $fooModules, 'foo' );
 268                 $moduleManager->addModules( $barModules, 'bar' );
 269
 270                 $groups = $moduleManager->getGroups();
 271                 $this->assertArrayEquals( array( 'foo', 'bar' ), $groups );
 272         }
 273
 274 }