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, $file ];
30 private function recurseFiles( $dir ) {
31 return ( new File_Iterator_Facade() )->getFilesAsArray( $dir, [ '.php' ] );
35 * @dataProvider providePSR4Completeness
37 public function testPSR4Completeness( $prefix, $file ) {
38 global $wgAutoloadLocalClasses, $wgAutoloadClasses;
39 $contents = file_get_contents( $file );
40 list( $classesInFile, $aliasesInFile ) = self
::parseFile( $contents );
41 $classes = array_keys( $classesInFile );
43 $this->assertCount( 1, $classes,
44 "Only one class per file in PSR-4 autoloaded classes ($file)" );
46 $this->assertStringStartsWith( $prefix, $classes[0] );
48 class_exists( $classes[0] ) ||
interface_exists( $classes[0] ) ||
trait_exists( $classes[0] ),
49 "Class {$classes[0]} not autoloaded properly"
52 // Dummy assertion so this test isn't marked in risky
53 // if the file has no classes nor aliases in it
54 $this->assertCount( 0, $classes );
57 if ( $aliasesInFile ) {
58 $otherClasses = $wgAutoloadLocalClasses +
$wgAutoloadClasses;
59 foreach ( $aliasesInFile as $alias => $class ) {
60 $this->assertArrayHasKey( $alias, $otherClasses,
61 'Alias must be in the classmap autoloader'
67 private static function parseFile( $contents ) {
68 // We could use token_get_all() here, but this is faster
69 // Note: Keep in sync with ClassCollector
73 (?:final\s+)? (?:abstract\s+)? (?:class|interface|trait) \s+
74 (?P<class> [a-zA-Z0-9_]+)
76 class_alias \s* \( \s*
77 ([\'"]) (?P<original> [^\'"]+) \g{-2} \s* , \s*
78 ([\'"]) (?P<alias> [^\'"]+ ) \g{-2} \s*
81 class_alias \s* \( \s*
82 (?P<originalStatic> [a-zA-Z0-9_]+)::class \s* , \s*
83 ([\'"]) (?P<aliasString> [^\'"]+ ) \g{-2} \s*
86 /imx', $contents, $matches, PREG_SET_ORDER
);
92 ([a-zA-Z0-9_]+(\\\\[a-zA-Z0-9_]+)*)
94 /imx', $contents, $namespaceMatch );
95 $fileNamespace = $namespaceMatch ?
$namespaceMatch[1] . '\\' : '';
100 foreach ( $matches as $match ) {
101 if ( !empty( $match['class'] ) ) {
103 $class = $fileNamespace . $match['class'];
104 $classesInFile[$class] = true;
106 if ( !empty( $match['original'] ) ) {
107 // 'class_alias( "Foo", "Bar" );'
108 $aliasesInFile[$match['alias']] = $match['original'];
110 // 'class_alias( Foo::class, "Bar" );'
111 $aliasesInFile[$match['aliasString']] = $fileNamespace . $match['originalStatic'];
116 return [ $classesInFile, $aliasesInFile ];
119 protected static function checkAutoLoadConf() {
120 global $wgAutoloadLocalClasses, $wgAutoloadClasses, $IP;
122 // wgAutoloadLocalClasses has precedence, just like in includes/AutoLoader.php
123 $expected = $wgAutoloadLocalClasses +
$wgAutoloadClasses;
126 $files = array_unique( $expected );
128 foreach ( $files as $class => $file ) {
129 // Only prefix $IP if it doesn't have it already.
130 // Generally local classes don't have it, and those from extensions and test suites do.
131 if ( substr( $file, 0, 1 ) != '/' && substr( $file, 1, 1 ) != ':' ) {
132 $filePath = "$IP/$file";
137 if ( !file_exists( $filePath ) ) {
138 $actual[$class] = "[file '$filePath' does not exist]";
142 Wikimedia\
suppressWarnings();
143 $contents = file_get_contents( $filePath );
144 Wikimedia\restoreWarnings
();
146 if ( $contents === false ) {
147 $actual[$class] = "[couldn't read file '$filePath']";
151 list( $classesInFile, $aliasesInFile ) = self
::parseFile( $contents );
153 foreach ( $classesInFile as $className => $ignore ) {
154 $actual[$className] = $file;
157 // Only accept aliases for classes in the same file, because for correct
158 // behavior, all aliases for a class must be set up when the class is loaded
159 // (see <https://bugs.php.net/bug.php?id=61422>).
160 foreach ( $aliasesInFile as $alias => $class ) {
161 if ( isset( $classesInFile[$class] ) ) {
162 $actual[$alias] = $file;
164 $actual[$alias] = "[original class not in $file]";
170 'expected' => $expected,
175 public function testAutoloadOrder() {
176 $path = realpath( __DIR__
. '/../../..' );
177 $oldAutoload = file_get_contents( $path . '/autoload.php' );
178 $generator = new AutoloadGenerator( $path, 'local' );
179 $generator->setExcludePaths( array_values( AutoLoader
::getAutoloadNamespaces() ) );
180 $generator->initMediaWikiDefault();
181 $newAutoload = $generator->getAutoload( 'maintenance/generateLocalAutoload.php' );
183 $this->assertEquals( $oldAutoload, $newAutoload, 'autoload.php does not match' .
184 ' output of generateLocalAutoload.php script.' );