3 class AutoLoaderStructureTest
extends MediaWikiTestCase
{
5 * Assert that there were no classes loaded that are not registered with the AutoLoader.
7 * For example foo.php having class Foo and class Bar but only registering Foo.
8 * This is important because we should not be relying on Foo being used before Bar.
10 public function testAutoLoadConfig() {
11 $results = self
::checkAutoLoadConf();
19 public function providePSR4Completeness() {
20 foreach ( AutoLoader
::$psr4Namespaces as $prefix => $dir ) {
21 foreach ( $this->recurseFiles( $dir ) as $file ) {
22 yield
[ $prefix, $dir, $file ];
27 private function recurseFiles( $dir ) {
28 return ( new File_Iterator_Facade() )->getFilesAsArray( $dir, [ '.php' ] );
32 * @dataProvider providePSR4Completeness
34 public function testPSR4Completeness( $prefix, $dir, $file ) {
35 global $wgAutoloadLocalClasses, $wgAutoloadClasses;
36 $contents = file_get_contents( $file );
37 list( $classesInFile, $aliasesInFile ) = self
::parseFile( $contents );
38 $classes = array_keys( $classesInFile );
43 "Only one class per file in PSR-4 autoloaded classes ($file)"
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 $dirNameLength = strlen( realpath( $dir ) ) +
1; // +1 for the trailing slash
50 $fileBaseName = substr( $file, $dirNameLength );
51 $abbrFileName = substr( $fileBaseName, 0, -4 );
52 $expectedClassName = $prefix . str_replace( '/', '\\', $abbrFileName );
57 "Class not autoloaded properly"
61 // Dummy assertion so this test isn't marked in risky
62 // if the file has no classes nor aliases in it
63 $this->assertCount( 0, $classes );
66 if ( $aliasesInFile ) {
67 $otherClasses = $wgAutoloadLocalClasses +
$wgAutoloadClasses;
68 foreach ( $aliasesInFile as $alias => $class ) {
69 $this->assertArrayHasKey( $alias, $otherClasses,
70 'Alias must be in the classmap autoloader'
76 private static function parseFile( $contents ) {
77 // We could use token_get_all() here, but this is faster
78 // Note: Keep in sync with ClassCollector
82 (?:final\s+)? (?:abstract\s+)? (?:class|interface|trait) \s+
85 class_alias \s* \( \s*
86 ([\'"]) (?P<original> [^\'"]+) \g{-2} \s* , \s*
87 ([\'"]) (?P<alias> [^\'"]+ ) \g{-2} \s*
90 class_alias \s* \( \s*
91 (?P<originalStatic> [\w\\\\]+)::class \s* , \s*
92 ([\'"]) (?P<aliasString> [^\'"]+ ) \g{-2} \s*
95 /imx', $contents, $matches, PREG_SET_ORDER
);
103 /imx', $contents, $namespaceMatch );
104 $fileNamespace = $namespaceMatch ?
$namespaceMatch[1] . '\\' : '';
109 foreach ( $matches as $match ) {
110 if ( !empty( $match['class'] ) ) {
112 $class = $fileNamespace . $match['class'];
113 $classesInFile[$class] = true;
114 } elseif ( !empty( $match['original'] ) ) {
115 // 'class_alias( "Foo", "Bar" );'
116 $aliasesInFile[$match['alias']] = $match['original'];
118 // 'class_alias( Foo::class, "Bar" );'
119 $aliasesInFile[$match['aliasString']] = $fileNamespace . $match['originalStatic'];
123 return [ $classesInFile, $aliasesInFile ];
126 protected static function checkAutoLoadConf() {
127 global $wgAutoloadLocalClasses, $wgAutoloadClasses, $IP;
129 // wgAutoloadLocalClasses has precedence, just like in includes/AutoLoader.php
130 $expected = $wgAutoloadLocalClasses +
$wgAutoloadClasses;
133 $psr4Namespaces = [];
134 foreach ( AutoLoader
::getAutoloadNamespaces() as $ns => $path ) {
135 $psr4Namespaces[rtrim( $ns, '\\' ) . '\\'] = rtrim( $path, '/' );
138 foreach ( $expected as $class => $file ) {
139 // Only prefix $IP if it doesn't have it already.
140 // Generally local classes don't have it, and those from extensions and test suites do.
141 if ( substr( $file, 0, 1 ) != '/' && substr( $file, 1, 1 ) != ':' ) {
142 $filePath = "$IP/$file";
147 if ( !file_exists( $filePath ) ) {
148 $actual[$class] = "[file '$filePath' does not exist]";
152 Wikimedia\
suppressWarnings();
153 $contents = file_get_contents( $filePath );
154 Wikimedia\restoreWarnings
();
156 if ( $contents === false ) {
157 $actual[$class] = "[couldn't read file '$filePath']";
161 list( $classesInFile, $aliasesInFile ) = self
::parseFile( $contents );
163 foreach ( $classesInFile as $className => $ignore ) {
164 // Skip if it's a PSR4 class
165 $parts = explode( '\\', $className );
166 for ( $i = count( $parts ) - 1; $i > 0; $i-- ) {
167 $ns = implode( '\\', array_slice( $parts, 0, $i ) ) . '\\';
168 if ( isset( $psr4Namespaces[$ns] ) ) {
169 $expectedPath = $psr4Namespaces[$ns] . '/'
170 . implode( '/', array_slice( $parts, $i ) )
172 if ( $filePath === $expectedPath ) {
179 $actual[$className] = $file;
182 // Only accept aliases for classes in the same file, because for correct
183 // behavior, all aliases for a class must be set up when the class is loaded
184 // (see <https://bugs.php.net/bug.php?id=61422>).
185 foreach ( $aliasesInFile as $alias => $class ) {
186 if ( isset( $classesInFile[$class] ) ) {
187 $actual[$alias] = $file;
189 $actual[$alias] = "[original class not in $file]";
195 'expected' => $expected,
200 public function testAutoloadOrder() {
201 $path = __DIR__
. '/../../..';
202 $oldAutoload = file_get_contents( $path . '/autoload.php' );
203 $generator = new AutoloadGenerator( $path, 'local' );
204 $generator->setPsr4Namespaces( AutoLoader
::getAutoloadNamespaces() );
205 $generator->initMediaWikiDefault();
206 $newAutoload = $generator->getAutoload( 'maintenance/generateLocalAutoload.php' );
208 $this->assertEquals( $oldAutoload, $newAutoload, 'autoload.php does not match' .
209 ' output of generateLocalAutoload.php script.' );