tests/phpunit/includes/api/Validator/SubmoduleDefTest.php

   1 <?php
   2
   3 namespace MediaWiki\Tests\Api\Validator;
   4
   5 use MediaWiki\Api\ApiMain;
   6 use MediaWiki\Api\ApiModuleManager;
   7 use MediaWiki\Api\Validator\SubmoduleDef;
   8 use MediaWiki\Tests\Api\MockApi;
   9 use Wikimedia\Message\DataMessageValue;
  10 use Wikimedia\ParamValidator\ParamValidator;
  11 use Wikimedia\ParamValidator\SimpleCallbacks;
  12 use Wikimedia\ParamValidator\TypeDef\EnumDef;
  13 use Wikimedia\ParamValidator\ValidationException;
  14 use Wikimedia\TestingAccessWrapper;
  15 use Wikimedia\Tests\ParamValidator\TypeDef\TypeDefTestCase;
  16
  17 /**
  18  * @covers \MediaWiki\Api\Validator\SubmoduleDef
  19  */
  20 class SubmoduleDefTest extends TypeDefTestCase {
  21
  22         protected function getInstance( SimpleCallbacks $callbacks, array $options ) {
  23                 return new SubmoduleDef( $callbacks, $options );
  24         }
  25
  26         private function mockApi() {
  27                 $api = $this->getMockBuilder( MockApi::class )
  28                         ->onlyMethods( [ 'getModuleManager' ] )
  29                         ->getMock();
  30                 $w = TestingAccessWrapper::newFromObject( $api );
  31                 $w->mModuleName = 'testmod';
  32                 $w->mMainModule = new ApiMain;
  33                 $w->mModulePrefix = 'tt';
  34
  35                 $w->mMainModule->getModuleManager()->addModule( 'testmod', 'action', [
  36                         'class' => MockApi::class,
  37                         'factory' => static function () use ( $api ) {
  38                                 return $api;
  39                         },
  40                 ] );
  41
  42                 $dep = $this->getMockBuilder( MockApi::class )
  43                         ->onlyMethods( [ 'isDeprecated' ] )
  44                         ->getMock();
  45                 $dep->method( 'isDeprecated' )->willReturn( true );
  46                 $int = $this->getMockBuilder( MockApi::class )
  47                         ->onlyMethods( [ 'isInternal' ] )
  48                         ->getMock();
  49                 $int->method( 'isInternal' )->willReturn( true );
  50                 $depint = $this->getMockBuilder( MockApi::class )
  51                         ->onlyMethods( [ 'isDeprecated', 'isInternal' ] )
  52                         ->getMock();
  53                 $depint->method( 'isDeprecated' )->willReturn( true );
  54                 $depint->method( 'isInternal' )->willReturn( true );
  55
  56                 $manager = new ApiModuleManager( $api );
  57                 $api->method( 'getModuleManager' )->willReturn( $manager );
  58                 $manager->addModule( 'mod1', 'test', MockApi::class );
  59                 $manager->addModule( 'mod2', 'test', MockApi::class );
  60                 $manager->addModule( 'dep', 'test', [
  61                         'class' => MockApi::class,
  62                         'factory' => static function () use ( $dep ) {
  63                                 return $dep;
  64                         },
  65                 ] );
  66                 $manager->addModule( 'depint', 'test', [
  67                         'class' => MockApi::class,
  68                         'factory' => static function () use ( $depint ) {
  69                                 return $depint;
  70                         },
  71                 ] );
  72                 $manager->addModule( 'int', 'test', [
  73                         'class' => MockApi::class,
  74                         'factory' => static function () use ( $int ) {
  75                                 return $int;
  76                         },
  77                 ] );
  78                 $manager->addModule( 'recurse', 'test', [
  79                         'class' => MockApi::class,
  80                         'factory' => static function () use ( $api ) {
  81                                 return $api;
  82                         },
  83                 ] );
  84                 $manager->addModule( 'mod3', 'xyz', MockApi::class );
  85
  86                 $this->assertSame( $api, $api->getModuleFromPath( 'testmod' ) );
  87                 $this->assertSame( $dep, $api->getModuleFromPath( 'testmod+dep' ) );
  88                 $this->assertSame( $int, $api->getModuleFromPath( 'testmod+int' ) );
  89                 $this->assertSame( $depint, $api->getModuleFromPath( 'testmod+depint' ) );
  90
  91                 return $api;
  92         }
  93
  94         public function provideValidate() {
  95                 $opts = [
  96                         'module' => $this->mockApi(),
  97                 ];
  98                 $map = [
  99                         SubmoduleDef::PARAM_SUBMODULE_MAP => [
 100                                 'mod2' => 'testmod+mod1',
 101                                 'mod3' => 'testmod+mod3',
 102                         ],
 103                 ];
 104
 105                 return [
 106                         'Basic' => [ 'mod1', 'mod1', [], $opts ],
 107                         'Nonexistent submodule' => [
 108                                 'mod3',
 109                                 new ValidationException(
 110                                         DataMessageValue::new( 'paramvalidator-badvalue', [], 'badvalue', [] ), 'test', 'mod3', []
 111                                 ),
 112                                 [],
 113                                 $opts,
 114                         ],
 115                         'Mapped' => [ 'mod3', 'mod3', $map, $opts ],
 116                         'Mapped, not in map' => [
 117                                 'mod1',
 118                                 new ValidationException(
 119                                         DataMessageValue::new( 'paramvalidator-badvalue', [], 'badvalue', [] ), 'test', 'mod1', $map
 120                                 ),
 121                                 $map,
 122                                 $opts,
 123                         ],
 124                 ];
 125         }
 126
 127         public function provideCheckSettings() {
 128                 $opts = [
 129                         'module' => $this->mockApi(),
 130                 ];
 131                 $keys = [
 132                         'Y', EnumDef::PARAM_DEPRECATED_VALUES,
 133                         SubmoduleDef::PARAM_SUBMODULE_MAP, SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX
 134                 ];
 135
 136                 return [
 137                         'Basic test' => [
 138                                 [],
 139                                 self::STDRET,
 140                                 [
 141                                         'issues' => [ 'X' ],
 142                                         'allowedKeys' => $keys,
 143                                         'messages' => [],
 144                                 ],
 145                                 $opts
 146                         ],
 147                         'Test with everything' => [
 148                                 [
 149                                         SubmoduleDef::PARAM_SUBMODULE_MAP => [
 150                                                 'foo' => 'testmod+mod1', 'bar' => 'testmod+mod2'
 151                                         ],
 152                                         SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX => 'g',
 153                                 ],
 154                                 self::STDRET,
 155                                 [
 156                                         'issues' => [ 'X' ],
 157                                         'allowedKeys' => $keys,
 158                                         'messages' => [],
 159                                 ],
 160                                 $opts
 161                         ],
 162                         'Bad types' => [
 163                                 [
 164                                         SubmoduleDef::PARAM_SUBMODULE_MAP => false,
 165                                         SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX => true,
 166                                 ],
 167                                 self::STDRET,
 168                                 [
 169                                         'issues' => [
 170                                                 'X',
 171                                                 SubmoduleDef::PARAM_SUBMODULE_MAP => 'PARAM_SUBMODULE_MAP must be an array, got boolean',
 172                                                 SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX
 173                                                         => 'PARAM_SUBMODULE_PARAM_PREFIX must be a string, got boolean',
 174                                         ],
 175                                         'allowedKeys' => $keys,
 176                                         'messages' => [],
 177                                 ],
 178                                 $opts
 179                         ],
 180                         'Bad values in map' => [
 181                                 [
 182                                         SubmoduleDef::PARAM_SUBMODULE_MAP => [
 183                                                 'a' => 'testmod+mod1',
 184                                                 'b' => false,
 185                                                 'c' => null,
 186                                                 'd' => 'testmod+mod7',
 187                                                 'r' => 'testmod+recurse+recurse',
 188                                         ],
 189                                 ],
 190                                 self::STDRET,
 191                                 [
 192                                         'issues' => [
 193                                                 'X',
 194                                                 'Values for PARAM_SUBMODULE_MAP must be strings, but value for "b" is boolean',
 195                                                 'Values for PARAM_SUBMODULE_MAP must be strings, but value for "c" is NULL',
 196                                                 'PARAM_SUBMODULE_MAP contains "testmod+mod7", which is not a valid module path',
 197                                         ],
 198                                         'allowedKeys' => $keys,
 199                                         'messages' => [],
 200                                 ],
 201                                 $opts
 202                         ],
 203                 ];
 204         }
 205
 206         public function provideGetEnumValues() {
 207                 $opts = [
 208                         'module' => $this->mockApi(),
 209                 ];
 210
 211                 return [
 212                         'Basic test' => [
 213                                 [ ParamValidator::PARAM_TYPE => 'submodule' ],
 214                                 [ 'mod1', 'mod2', 'dep', 'depint', 'int', 'recurse' ],
 215                                 $opts,
 216                         ],
 217                         'Mapped' => [
 218                                 [
 219                                         ParamValidator::PARAM_TYPE => 'submodule',
 220                                         SubmoduleDef::PARAM_SUBMODULE_MAP => [
 221                                                 'mod2' => 'test+mod1',
 222                                                 'mod3' => 'test+mod3',
 223                                         ]
 224                                 ],
 225                                 [ 'mod2', 'mod3' ],
 226                                 $opts,
 227                         ],
 228                 ];
 229         }
 230
 231         public function provideGetInfo() {
 232                 $opts = [
 233                         'module' => $this->mockApi(),
 234                 ];
 235
 236                 return [
 237                         'Basic' => [
 238                                 [],
 239                                 [
 240                                         'type' => [ 'mod1', 'mod2', 'recurse', 'dep', 'int', 'depint' ],
 241                                         'submodules' => [
 242                                                 'mod1' => 'testmod+mod1',
 243                                                 'mod2' => 'testmod+mod2',
 244                                                 'recurse' => 'testmod+recurse',
 245                                                 'dep' => 'testmod+dep',
 246                                                 'int' => 'testmod+int',
 247                                                 'depint' => 'testmod+depint',
 248                                         ],
 249                                         'deprecatedvalues' => [ 'dep', 'depint' ],
 250                                         'internalvalues' => [ 'depint', 'int' ],
 251                                 ],
 252                                 [
 253                                         ParamValidator::PARAM_TYPE => '<message key="paramvalidator-help-type-enum"><text>1</text><list listType="comma"><text>[[Special:ApiHelp/testmod+mod1|&lt;span dir=&quot;ltr&quot; lang=&quot;en&quot;&gt;mod1&lt;/span&gt;]]</text><text>[[Special:ApiHelp/testmod+mod2|&lt;span dir=&quot;ltr&quot; lang=&quot;en&quot;&gt;mod2&lt;/span&gt;]]</text><text>[[Special:ApiHelp/testmod+recurse|&lt;span dir=&quot;ltr&quot; lang=&quot;en&quot;&gt;recurse&lt;/span&gt;]]</text><text>[[Special:ApiHelp/testmod+dep|&lt;span dir=&quot;ltr&quot; lang=&quot;en&quot; class=&quot;apihelp-deprecated-value&quot;&gt;dep&lt;/span&gt;]]</text><text>[[Special:ApiHelp/testmod+int|&lt;span dir=&quot;ltr&quot; lang=&quot;en&quot; class=&quot;apihelp-internal-value&quot;&gt;int&lt;/span&gt;]]</text><text>[[Special:ApiHelp/testmod+depint|&lt;span dir=&quot;ltr&quot; lang=&quot;en&quot; class=&quot;apihelp-deprecated-value apihelp-internal-value&quot;&gt;depint&lt;/span&gt;]]</text></list><num>6</num></message>',
 254                                         ParamValidator::PARAM_ISMULTI => null,
 255                                 ],
 256                                 $opts,
 257                         ],
 258                         'Mapped' => [
 259                                 [
 260                                         ParamValidator::PARAM_DEFAULT => 'mod3|mod4',
 261                                         ParamValidator::PARAM_ISMULTI => true,
 262                                         SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX => 'g',
 263                                         SubmoduleDef::PARAM_SUBMODULE_MAP => [
 264                                                 'xyz' => 'testmod+dep',
 265                                                 'mod3' => 'testmod+mod3',
 266                                                 'mod4' => 'testmod+mod4', // doesn't exist
 267                                         ],
 268                                 ],
 269                                 [
 270                                         'type' => [ 'mod3', 'mod4', 'xyz' ],
 271                                         'submodules' => [
 272                                                 'mod3' => 'testmod+mod3',
 273                                                 'mod4' => 'testmod+mod4',
 274                                                 'xyz' => 'testmod+dep',
 275                                         ],
 276                                         'submoduleparamprefix' => 'g',
 277                                         'deprecatedvalues' => [ 'xyz' ],
 278                                 ],
 279                                 [
 280                                         ParamValidator::PARAM_TYPE => '<message key="paramvalidator-help-type-enum"><text>2</text><list listType="comma"><text>[[Special:ApiHelp/testmod+mod3|&lt;span dir=&quot;ltr&quot; lang=&quot;en&quot;&gt;mod3&lt;/span&gt;]]</text><text>[[Special:ApiHelp/testmod+mod4|&lt;span dir=&quot;ltr&quot; lang=&quot;en&quot;&gt;mod4&lt;/span&gt;]]</text><text>[[Special:ApiHelp/testmod+dep|&lt;span dir=&quot;ltr&quot; lang=&quot;en&quot; class=&quot;apihelp-deprecated-value&quot;&gt;xyz&lt;/span&gt;]]</text></list><num>3</num></message>',
 281                                         ParamValidator::PARAM_ISMULTI => null,
 282                                 ],
 283                                 $opts,
 284                         ],
 285                 ];
 286         }
 287
 288 }