6 class AutoLoaderStructureTest
extends MediaWikiTestCase
{
8 * Assert that there were no classes loaded that are not registered with the AutoLoader.
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.
13 public function testAutoLoadConfig() {
14 $results = self
::checkAutoLoadConf();
22 public function providePSR4Completeness() {
23 foreach ( AutoLoader
::$psr4Namespaces as $prefix => $dir ) {
24 foreach ( $this->recurseFiles( $dir ) as $file ) {
25 yield
[ $prefix, $dir, $file ];
30 private function recurseFiles( $dir ) {
31 return ( new File_Iterator_Facade() )->getFilesAsArray( $dir, [ '.php' ] );
35 * @dataProvider providePSR4Completeness
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 );
46 "Only one class per file in PSR-4 autoloaded classes ($file)"
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 $dirNameLength = strlen( realpath( $dir ) ) +
1; // +1 for the trailing slash
53 $fileBaseName = substr( $file, $dirNameLength );
54 $abbrFileName = substr( $fileBaseName, 0, -4 );
55 $expectedClassName = $prefix . str_replace( '/', '\\', $abbrFileName );
60 "Class not autoloaded properly"
64 // Dummy assertion so this test isn't marked in risky
65 // if the file has no classes nor aliases in it
66 $this->assertCount( 0, $classes );
69 if ( $aliasesInFile ) {
70 $otherClasses = $wgAutoloadLocalClasses +
$wgAutoloadClasses;
71 foreach ( $aliasesInFile as $alias => $class ) {
72 $this->assertArrayHasKey( $alias, $otherClasses,
73 'Alias must be in the classmap autoloader'
79 private static function parseFile( $contents ) {
80 // We could use token_get_all() here, but this is faster
81 // Note: Keep in sync with ClassCollector
85 (?:final\s+)? (?:abstract\s+)? (?:class|interface|trait) \s+
88 class_alias \s* \( \s*
89 ([\'"]) (?P<original> [^\'"]+) \g{-2} \s* , \s*
90 ([\'"]) (?P<alias> [^\'"]+ ) \g{-2} \s*
93 class_alias \s* \( \s*
94 (?P<originalStatic> [\w\\\\]+)::class \s* , \s*
95 ([\'"]) (?P<aliasString> [^\'"]+ ) \g{-2} \s*
98 /imx', $contents, $matches, PREG_SET_ORDER
);
100 $namespaceMatch = [];
106 /imx', $contents, $namespaceMatch );
107 $fileNamespace = $namespaceMatch ?
$namespaceMatch[1] . '\\' : '';
112 foreach ( $matches as $match ) {
113 if ( !empty( $match['class'] ) ) {
115 $class = $fileNamespace . $match['class'];
116 $classesInFile[$class] = true;
117 } elseif ( !empty( $match['original'] ) ) {
118 // 'class_alias( "Foo", "Bar" );'
119 $aliasesInFile[$match['alias']] = $match['original'];
121 // 'class_alias( Foo::class, "Bar" );'
122 $aliasesInFile[$match['aliasString']] = $fileNamespace . $match['originalStatic'];
126 return [ $classesInFile, $aliasesInFile ];
129 protected static function checkAutoLoadConf() {
130 global $wgAutoloadLocalClasses, $wgAutoloadClasses, $IP;
132 // wgAutoloadLocalClasses has precedence, just like in includes/AutoLoader.php
133 $expected = $wgAutoloadLocalClasses +
$wgAutoloadClasses;
136 $psr4Namespaces = [];
137 foreach ( AutoLoader
::getAutoloadNamespaces() as $ns => $path ) {
138 $psr4Namespaces[rtrim( $ns, '\\' ) . '\\'] = rtrim( $path, '/' );
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";
150 if ( !file_exists( $filePath ) ) {
151 $actual[$class] = "[file '$filePath' does not exist]";
155 Wikimedia\
suppressWarnings();
156 $contents = file_get_contents( $filePath );
157 Wikimedia\restoreWarnings
();
159 if ( $contents === false ) {
160 $actual[$class] = "[couldn't read file '$filePath']";
164 list( $classesInFile, $aliasesInFile ) = self
::parseFile( $contents );
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 ) )
175 if ( $filePath === $expectedPath ) {
182 $actual[$className] = $file;
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;
192 $actual[$alias] = "[original class not in $file]";
198 'expected' => $expected,
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' );
211 $this->assertEquals( $oldAutoload, $newAutoload, 'autoload.php does not match' .
212 ' output of generateLocalAutoload.php script.' );