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(
  44                                 1,
  45                                 $classes,
  46                                 "Only one class per file in PSR-4 autoloaded classes ($file)"
  47                         );
  48
  49                         // Check that the expected class name (based on the filename) is the
  50                         // same as the one we found.
  51                         // Strip directory prefix from front of filename, and .php extension
  52                         $abbrFileName = substr( substr( $file, strlen( $dir ) ), 0, -4 );
  53                         $expectedClassName = $prefix . str_replace( '/', '\\', $abbrFileName );
  54
  55                         $this->assertSame(
  56                                 $expectedClassName,
  57                                 $classes[0],
  58                                 "Class not autoloaded properly"
  59                         );
  60
  61                 } else {
  62                         // Dummy assertion so this test isn't marked in risky
  63                         // if the file has no classes nor aliases in it
  64                         $this->assertCount( 0, $classes );
  65                 }
  66
  67                 if ( $aliasesInFile ) {
  68                         $otherClasses = $wgAutoloadLocalClasses + $wgAutoloadClasses;
  69                         foreach ( $aliasesInFile as $alias => $class ) {
  70                                 $this->assertArrayHasKey( $alias, $otherClasses,
  71                                         'Alias must be in the classmap autoloader'
  72                                 );
  73                         }
  74                 }
  75         }
  76
  77         private static function parseFile( $contents ) {
  78                 // We could use token_get_all() here, but this is faster
  79                 // Note: Keep in sync with ClassCollector
  80                 $matches = [];
  81                 preg_match_all( '/
  82                                 ^ [\t ]* (?:
  83                                         (?:final\s+)? (?:abstract\s+)? (?:class|interface|trait) \s+
  84                                         (?P<class> \w+)
  85                                 |
  86                                         class_alias \s* \( \s*
  87                                                 ([\'"]) (?P<original> [^\'"]+) \g{-2} \s* , \s*
  88                                                 ([\'"]) (?P<alias> [^\'"]+ ) \g{-2} \s*
  89                                         \) \s* ;
  90                                 |
  91                                         class_alias \s* \( \s*
  92                                                 (?P<originalStatic> [\w\\\\]+)::class \s* , \s*
  93                                                 ([\'"]) (?P<aliasString> [^\'"]+ ) \g{-2} \s*
  94                                         \) \s* ;
  95                                 )
  96                         /imx', $contents, $matches, PREG_SET_ORDER );
  97
  98                 $namespaceMatch = [];
  99                 preg_match( '/
 100                                 ^ [\t ]*
 101                                         namespace \s+
 102                                                 (\w+(\\\\\w+)*)
 103                                         \s* ;
 104                         /imx', $contents, $namespaceMatch );
 105                 $fileNamespace = $namespaceMatch ? $namespaceMatch[1] . '\\' : '';
 106
 107                 $classesInFile = [];
 108                 $aliasesInFile = [];
 109
 110                 foreach ( $matches as $match ) {
 111                         if ( !empty( $match['class'] ) ) {
 112                                 // 'class Foo {}'
 113                                 $class = $fileNamespace . $match['class'];
 114                                 $classesInFile[$class] = true;
 115                         } else {
 116                                 if ( !empty( $match['original'] ) ) {
 117                                         // 'class_alias( "Foo", "Bar" );'
 118                                         $aliasesInFile[$match['alias']] = $match['original'];
 119                                 } else {
 120                                         // 'class_alias( Foo::class, "Bar" );'
 121                                         $aliasesInFile[$match['aliasString']] = $fileNamespace . $match['originalStatic'];
 122                                 }
 123                         }
 124                 }
 125
 126                 return [ $classesInFile, $aliasesInFile ];
 127         }
 128
 129         protected static function checkAutoLoadConf() {
 130                 global $wgAutoloadLocalClasses, $wgAutoloadClasses, $IP;
 131
 132                 // wgAutoloadLocalClasses has precedence, just like in includes/AutoLoader.php
 133                 $expected = $wgAutoloadLocalClasses + $wgAutoloadClasses;
 134                 $actual = [];
 135
 136                 $psr4Namespaces = [];
 137                 foreach ( AutoLoader::getAutoloadNamespaces() as $ns => $path ) {
 138                         $psr4Namespaces[rtrim( $ns, '\\' ) . '\\'] = rtrim( $path, '/' );
 139                 }
 140
 141                 foreach ( $expected as $class => $file ) {
 142                         // Only prefix $IP if it doesn't have it already.
 143                         // Generally local classes don't have it, and those from extensions and test suites do.
 144                         if ( substr( $file, 0, 1 ) != '/' && substr( $file, 1, 1 ) != ':' ) {
 145                                 $filePath = "$IP/$file";
 146                         } else {
 147                                 $filePath = $file;
 148                         }
 149
 150                         if ( !file_exists( $filePath ) ) {
 151                                 $actual[$class] = "[file '$filePath' does not exist]";
 152                                 continue;
 153                         }
 154
 155                         Wikimedia\suppressWarnings();
 156                         $contents = file_get_contents( $filePath );
 157                         Wikimedia\restoreWarnings();
 158
 159                         if ( $contents === false ) {
 160                                 $actual[$class] = "[couldn't read file '$filePath']";
 161                                 continue;
 162                         }
 163
 164                         list( $classesInFile, $aliasesInFile ) = self::parseFile( $contents );
 165
 166                         foreach ( $classesInFile as $className => $ignore ) {
 167                                 // Skip if it's a PSR4 class
 168                                 $parts = explode( '\\', $className );
 169                                 for ( $i = count( $parts ) - 1; $i > 0; $i-- ) {
 170                                         $ns = implode( '\\', array_slice( $parts, 0, $i ) ) . '\\';
 171                                         if ( isset( $psr4Namespaces[$ns] ) ) {
 172                                                 $expectedPath = $psr4Namespaces[$ns] . '/'
 173                                                         . implode( '/', array_slice( $parts, $i ) )
 174                                                         . '.php';
 175                                                 if ( $filePath === $expectedPath ) {
 176                                                         continue 2;
 177                                                 }
 178                                         }
 179                                 }
 180
 181                                 // Nope, add it.
 182                                 $actual[$className] = $file;
 183                         }
 184
 185                         // Only accept aliases for classes in the same file, because for correct
 186                         // behavior, all aliases for a class must be set up when the class is loaded
 187                         // (see <https://bugs.php.net/bug.php?id=61422>).
 188                         foreach ( $aliasesInFile as $alias => $class ) {
 189                                 if ( isset( $classesInFile[$class] ) ) {
 190                                         $actual[$alias] = $file;
 191                                 } else {
 192                                         $actual[$alias] = "[original class not in $file]";
 193                                 }
 194                         }
 195                 }
 196
 197                 return [
 198                         'expected' => $expected,
 199                         'actual' => $actual,
 200                 ];
 201         }
 202
 203         public function testAutoloadOrder() {
 204                 $path = realpath( __DIR__ . '/../../..' );
 205                 $oldAutoload = file_get_contents( $path . '/autoload.php' );
 206                 $generator = new AutoloadGenerator( $path, 'local' );
 207                 $generator->setPsr4Namespaces( AutoLoader::getAutoloadNamespaces() );
 208                 $generator->initMediaWikiDefault();
 209                 $newAutoload = $generator->getAutoload( 'maintenance/generateLocalAutoload.php' );
 210
 211                 $this->assertEquals( $oldAutoload, $newAutoload, 'autoload.php does not match' .
 212                         ' output of generateLocalAutoload.php script.' );
 213         }
 214 }