tests/phpunit/structure/AutoLoaderStructureTest.php

   1 <?php
   2
   3 /**
   4  * @coversNothing
   5  */
   6 class AutoLoaderStructureTest extends MediaWikiTestCase {
   7         /**
   8          * Assert that there were no classes loaded that are not registered with the AutoLoader.
   9          *
  10          * For example foo.php having class Foo and class Bar but only registering Foo.
  11          * This is important because we should not be relying on Foo being used before Bar.
  12          */
  13         public function testAutoLoadConfig() {
  14                 $results = self::checkAutoLoadConf();
  15
  16                 $this->assertEquals(
  17                         $results['expected'],
  18                         $results['actual']
  19                 );
  20         }
  21
  22         public function providePSR4Completeness() {
  23                 foreach ( AutoLoader::$psr4Namespaces as $prefix => $dir ) {
  24                         foreach ( $this->recurseFiles( $dir ) as $file ) {
  25                                 yield [ $prefix, $dir, $file ];
  26                         }
  27                 }
  28         }
  29
  30         private function recurseFiles( $dir ) {
  31                 return ( new File_Iterator_Facade() )->getFilesAsArray( $dir, [ '.php' ] );
  32         }
  33
  34         /**
  35          * @dataProvider providePSR4Completeness
  36          */
  37         public function testPSR4Completeness( $prefix, $dir, $file ) {
  38                 global $wgAutoloadLocalClasses, $wgAutoloadClasses;
  39                 $contents = file_get_contents( $file );
  40                 list( $classesInFile, $aliasesInFile ) = self::parseFile( $contents );
  41                 $classes = array_keys( $classesInFile );
  42                 if ( $classes ) {
  43                         $this->assertCount( 1, $classes,
  44                                 "Only one class per file in PSR-4 autoloaded classes ($file)" );
  45
  46                         // Check that the expected class name (based on the filename) is the
  47                         // same as the one we found.
  48                         // Strip directory prefix from front of filename, and .php extension
  49                         $abbrFileName = substr( substr( $file, strlen( $dir ) ), 0, -4 );
  50                         $expectedClassName = $prefix . str_replace( '/', '\\', $abbrFileName );
  51
  52                         $this->assertSame(
  53                                 $expectedClassName,
  54                                 $classes[0],
  55                                 "Class not autoloaded properly"
  56                         );
  57
  58                 } else {
  59                         // Dummy assertion so this test isn't marked in risky
  60                         // if the file has no classes nor aliases in it
  61                         $this->assertCount( 0, $classes );
  62                 }
  63
  64                 if ( $aliasesInFile ) {
  65                         $otherClasses = $wgAutoloadLocalClasses + $wgAutoloadClasses;
  66                         foreach ( $aliasesInFile as $alias => $class ) {
  67                                 $this->assertArrayHasKey( $alias, $otherClasses,
  68                                         'Alias must be in the classmap autoloader'
  69                                 );
  70                         }
  71                 }
  72         }
  73
  74         private static function parseFile( $contents ) {
  75                 // We could use token_get_all() here, but this is faster
  76                 // Note: Keep in sync with ClassCollector
  77                 $matches = [];
  78                 preg_match_all( '/
  79                                 ^ [\t ]* (?:
  80                                         (?:final\s+)? (?:abstract\s+)? (?:class|interface|trait) \s+
  81                                         (?P<class> [a-zA-Z0-9_]+)
  82                                 |
  83                                         class_alias \s* \( \s*
  84                                                 ([\'"]) (?P<original> [^\'"]+) \g{-2} \s* , \s*
  85                                                 ([\'"]) (?P<alias> [^\'"]+ ) \g{-2} \s*
  86                                         \) \s* ;
  87                                 |
  88                                         class_alias \s* \( \s*
  89                                                 (?P<originalStatic> [a-zA-Z0-9_]+)::class \s* , \s*
  90                                                 ([\'"]) (?P<aliasString> [^\'"]+ ) \g{-2} \s*
  91                                         \) \s* ;
  92                                 )
  93                         /imx', $contents, $matches, PREG_SET_ORDER );
  94
  95                 $namespaceMatch = [];
  96                 preg_match( '/
  97                                 ^ [\t ]*
  98                                         namespace \s+
  99                                                 ([a-zA-Z0-9_]+(\\\\[a-zA-Z0-9_]+)*)
 100                                         \s* ;
 101                         /imx', $contents, $namespaceMatch );
 102                 $fileNamespace = $namespaceMatch ? $namespaceMatch[1] . '\\' : '';
 103
 104                 $classesInFile = [];
 105                 $aliasesInFile = [];
 106
 107                 foreach ( $matches as $match ) {
 108                         if ( !empty( $match['class'] ) ) {
 109                                 // 'class Foo {}'
 110                                 $class = $fileNamespace . $match['class'];
 111                                 $classesInFile[$class] = true;
 112                         } else {
 113                                 if ( !empty( $match['original'] ) ) {
 114                                         // 'class_alias( "Foo", "Bar" );'
 115                                         $aliasesInFile[$match['alias']] = $match['original'];
 116                                 } else {
 117                                         // 'class_alias( Foo::class, "Bar" );'
 118                                         $aliasesInFile[$match['aliasString']] = $fileNamespace . $match['originalStatic'];
 119                                 }
 120                         }
 121                 }
 122
 123                 return [ $classesInFile, $aliasesInFile ];
 124         }
 125
 126         protected static function checkAutoLoadConf() {
 127                 global $wgAutoloadLocalClasses, $wgAutoloadClasses, $IP;
 128
 129                 // wgAutoloadLocalClasses has precedence, just like in includes/AutoLoader.php
 130                 $expected = $wgAutoloadLocalClasses + $wgAutoloadClasses;
 131                 $actual = [];
 132
 133                 $files = array_unique( $expected );
 134
 135                 foreach ( $files as $class => $file ) {
 136                         // Only prefix $IP if it doesn't have it already.
 137                         // Generally local classes don't have it, and those from extensions and test suites do.
 138                         if ( substr( $file, 0, 1 ) != '/' && substr( $file, 1, 1 ) != ':' ) {
 139                                 $filePath = "$IP/$file";
 140                         } else {
 141                                 $filePath = $file;
 142                         }
 143
 144                         if ( !file_exists( $filePath ) ) {
 145                                 $actual[$class] = "[file '$filePath' does not exist]";
 146                                 continue;
 147                         }
 148
 149                         Wikimedia\suppressWarnings();
 150                         $contents = file_get_contents( $filePath );
 151                         Wikimedia\restoreWarnings();
 152
 153                         if ( $contents === false ) {
 154                                 $actual[$class] = "[couldn't read file '$filePath']";
 155                                 continue;
 156                         }
 157
 158                         list( $classesInFile, $aliasesInFile ) = self::parseFile( $contents );
 159
 160                         foreach ( $classesInFile as $className => $ignore ) {
 161                                 $actual[$className] = $file;
 162                         }
 163
 164                         // Only accept aliases for classes in the same file, because for correct
 165                         // behavior, all aliases for a class must be set up when the class is loaded
 166                         // (see <https://bugs.php.net/bug.php?id=61422>).
 167                         foreach ( $aliasesInFile as $alias => $class ) {
 168                                 if ( isset( $classesInFile[$class] ) ) {
 169                                         $actual[$alias] = $file;
 170                                 } else {
 171                                         $actual[$alias] = "[original class not in $file]";
 172                                 }
 173                         }
 174                 }
 175
 176                 return [
 177                         'expected' => $expected,
 178                         'actual' => $actual,
 179                 ];
 180         }
 181
 182         public function testAutoloadOrder() {
 183                 $path = realpath( __DIR__ . '/../../..' );
 184                 $oldAutoload = file_get_contents( $path . '/autoload.php' );
 185                 $generator = new AutoloadGenerator( $path, 'local' );
 186                 $generator->setExcludePaths( array_values( AutoLoader::getAutoloadNamespaces() ) );
 187                 $generator->initMediaWikiDefault();
 188                 $newAutoload = $generator->getAutoload( 'maintenance/generateLocalAutoload.php' );
 189
 190                 $this->assertEquals( $oldAutoload, $newAutoload, 'autoload.php does not match' .
 191                         ' output of generateLocalAutoload.php script.' );
 192         }
 193 }