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 $abbrFileName = substr( substr( $file, strlen( $dir ) ), 0, -4 );
53 $expectedClassName = $prefix . str_replace( '/', '\\', $abbrFileName );
58 "Class not autoloaded properly"
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 );
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'
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
83 (?:final\s+)? (?:abstract\s+)? (?:class|interface|trait) \s+
86 class_alias \s* \( \s*
87 ([\'"]) (?P<original> [^\'"]+) \g{-2} \s* , \s*
88 ([\'"]) (?P<alias> [^\'"]+ ) \g{-2} \s*
91 class_alias \s* \( \s*
92 (?P<originalStatic> [\w\\\\]+)::class \s* , \s*
93 ([\'"]) (?P<aliasString> [^\'"]+ ) \g{-2} \s*
96 /imx', $contents, $matches, PREG_SET_ORDER
);
104 /imx', $contents, $namespaceMatch );
105 $fileNamespace = $namespaceMatch ?
$namespaceMatch[1] . '\\' : '';
110 foreach ( $matches as $match ) {
111 if ( !empty( $match['class'] ) ) {
113 $class = $fileNamespace . $match['class'];
114 $classesInFile[$class] = true;
115 } elseif ( !empty( $match['original'] ) ) {
116 // 'class_alias( "Foo", "Bar" );'
117 $aliasesInFile[$match['alias']] = $match['original'];
119 // 'class_alias( Foo::class, "Bar" );'
120 $aliasesInFile[$match['aliasString']] = $fileNamespace . $match['originalStatic'];
124 return [ $classesInFile, $aliasesInFile ];
127 protected static function checkAutoLoadConf() {
128 global $wgAutoloadLocalClasses, $wgAutoloadClasses, $IP;
130 // wgAutoloadLocalClasses has precedence, just like in includes/AutoLoader.php
131 $expected = $wgAutoloadLocalClasses +
$wgAutoloadClasses;
134 $psr4Namespaces = [];
135 foreach ( AutoLoader
::getAutoloadNamespaces() as $ns => $path ) {
136 $psr4Namespaces[rtrim( $ns, '\\' ) . '\\'] = rtrim( $path, '/' );
139 foreach ( $expected as $class => $file ) {
140 // Only prefix $IP if it doesn't have it already.
141 // Generally local classes don't have it, and those from extensions and test suites do.
142 if ( substr( $file, 0, 1 ) != '/' && substr( $file, 1, 1 ) != ':' ) {
143 $filePath = "$IP/$file";
148 if ( !file_exists( $filePath ) ) {
149 $actual[$class] = "[file '$filePath' does not exist]";
153 Wikimedia\
suppressWarnings();
154 $contents = file_get_contents( $filePath );
155 Wikimedia\restoreWarnings
();
157 if ( $contents === false ) {
158 $actual[$class] = "[couldn't read file '$filePath']";
162 list( $classesInFile, $aliasesInFile ) = self
::parseFile( $contents );
164 foreach ( $classesInFile as $className => $ignore ) {
165 // Skip if it's a PSR4 class
166 $parts = explode( '\\', $className );
167 for ( $i = count( $parts ) - 1; $i > 0; $i-- ) {
168 $ns = implode( '\\', array_slice( $parts, 0, $i ) ) . '\\';
169 if ( isset( $psr4Namespaces[$ns] ) ) {
170 $expectedPath = $psr4Namespaces[$ns] . '/'
171 . implode( '/', array_slice( $parts, $i ) )
173 if ( $filePath === $expectedPath ) {
180 $actual[$className] = $file;
183 // Only accept aliases for classes in the same file, because for correct
184 // behavior, all aliases for a class must be set up when the class is loaded
185 // (see <https://bugs.php.net/bug.php?id=61422>).
186 foreach ( $aliasesInFile as $alias => $class ) {
187 if ( isset( $classesInFile[$class] ) ) {
188 $actual[$alias] = $file;
190 $actual[$alias] = "[original class not in $file]";
196 'expected' => $expected,
201 public function testAutoloadOrder() {
202 $path = realpath( __DIR__
. '/../../..' );
203 $oldAutoload = file_get_contents( $path . '/autoload.php' );
204 $generator = new AutoloadGenerator( $path, 'local' );
205 $generator->setPsr4Namespaces( AutoLoader
::getAutoloadNamespaces() );
206 $generator->initMediaWikiDefault();
207 $newAutoload = $generator->getAutoload( 'maintenance/generateLocalAutoload.php' );
209 $this->assertEquals( $oldAutoload, $newAutoload, 'autoload.php does not match' .
210 ' output of generateLocalAutoload.php script.' );