tests/phpunit/structure/ApiPrefixUniquenessTest.php

   1 <?php
   2
   3 /**
   4  * Checks that all API query modules, core and extensions, have unique prefixes.
   5  *
   6  * @group API
   7  */
   8 class ApiPrefixUniquenessTest extends MediaWikiTestCase {
   9
  10         public function testPrefixes() {
  11                 $main = new ApiMain( new FauxRequest() );
  12                 $query = new ApiQuery( $main, 'foo' );
  13                 $moduleManager = $query->getModuleManager();
  14
  15                 $modules = $moduleManager->getNames();
  16                 $prefixes = [];
  17
  18                 foreach ( $modules as $name ) {
  19                         $module = $moduleManager->getModule( $name );
  20                         $class = get_class( $module );
  21
  22                         $prefix = $module->getModulePrefix();
  23                         if ( $prefix === '' /* HACK: T196962 */ || $prefix === 'wbeu' ) {
  24                                 continue;
  25                         }
  26
  27                         if ( isset( $prefixes[$prefix] ) ) {
  28                                 $this->fail(
  29                                         "Module prefix '{$prefix}' is shared between {$class} and {$prefixes[$prefix]}"
  30                                 );
  31                         }
  32                         $prefixes[$module->getModulePrefix()] = $class;
  33
  34                         if ( $module instanceof ApiQueryGeneratorBase ) {
  35                                 // namespace with 'g', a generator can share a prefix with a module
  36                                 $prefix = 'g' . $prefix;
  37                                 if ( isset( $prefixes[$prefix] ) ) {
  38                                         $this->fail(
  39                                                 "Module prefix '{$prefix}' is shared between {$class} and {$prefixes[$prefix]}" .
  40                                                         " (as a generator)"
  41                                         );
  42                                 }
  43                                 $prefixes[$module->getModulePrefix()] = $class;
  44                         }
  45                 }
  46                 $this->assertTrue( true ); // dummy call to make this test non-incomplete
  47         }
  48 }