3 class AutoLoaderTest
extends MediaWikiTestCase
{
4 protected function setUp() {
7 // Fancy dance to trigger a rebuild of AutoLoader::$autoloadLocalClassesLower
8 $this->mergeMwGlobalArrayValue( 'wgAutoloadLocalClasses', [
9 'TestAutoloadedLocalClass' =>
10 __DIR__
. '/../data/autoloader/TestAutoloadedLocalClass.php',
11 'TestAutoloadedCamlClass' =>
12 __DIR__
. '/../data/autoloader/TestAutoloadedCamlClass.php',
13 'TestAutoloadedSerializedClass' =>
14 __DIR__
. '/../data/autoloader/TestAutoloadedSerializedClass.php',
16 AutoLoader
::resetAutoloadLocalClassesLower();
18 $this->mergeMwGlobalArrayValue( 'wgAutoloadClasses', [
19 'TestAutoloadedClass' => __DIR__
. '/../data/autoloader/TestAutoloadedClass.php',
24 * Assert that there were no classes loaded that are not registered with the AutoLoader.
26 * For example foo.php having class Foo and class Bar but only registering Foo.
27 * This is important because we should not be relying on Foo being used before Bar.
29 public function testAutoLoadConfig() {
30 $results = self
::checkAutoLoadConf();
38 public function providePSR4Completeness() {
39 foreach ( AutoLoader
::$psr4Namespaces as $prefix => $dir ) {
40 foreach ( $this->recurseFiles( $dir ) as $file ) {
41 yield
[ $prefix, $file ];
46 private function recurseFiles( $dir ) {
47 return ( new File_Iterator_Facade() )->getFilesAsArray( $dir, [ '.php' ] );
52 * @dataProvider providePSR4Completeness
54 public function testPSR4Completeness( $prefix, $file ) {
55 global $wgAutoloadLocalClasses, $wgAutoloadClasses;
56 $contents = file_get_contents( $file );
57 list( $classesInFile, $aliasesInFile ) = self
::parseFile( $contents );
58 $classes = array_keys( $classesInFile );
59 $this->assertCount( 1, $classes,
60 "Only one class per file in PSR-4 autoloaded classes ($file)" );
62 $this->assertStringStartsWith( $prefix, $classes[0] );
64 class_exists( $classes[0] ) ||
interface_exists( $classes[0] ) ||
trait_exists( $classes[0] ),
65 "Class {$classes[0]} not autoloaded properly"
68 $otherClasses = $wgAutoloadLocalClasses +
$wgAutoloadClasses;
69 foreach ( $aliasesInFile as $alias => $class ) {
70 $this->assertArrayHasKey( $alias, $otherClasses,
71 '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+
83 (?P<class> [a-zA-Z0-9_]+)
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> [a-zA-Z0-9_]+)::class \s* , \s*
92 ([\'"]) (?P<aliasString> [^\'"]+ ) \g{-2} \s*
95 /imx', $contents, $matches, PREG_SET_ORDER
);
101 ([a-zA-Z0-9_]+(\\\\[a-zA-Z0-9_]+)*)
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;
115 if ( !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'];
125 return [ $classesInFile, $aliasesInFile ];
128 protected static function checkAutoLoadConf() {
129 global $wgAutoloadLocalClasses, $wgAutoloadClasses, $IP;
131 // wgAutoloadLocalClasses has precedence, just like in includes/AutoLoader.php
132 $expected = $wgAutoloadLocalClasses +
$wgAutoloadClasses;
135 $files = array_unique( $expected );
137 foreach ( $files as $class => $file ) {
138 // Only prefix $IP if it doesn't have it already.
139 // Generally local classes don't have it, and those from extensions and test suites do.
140 if ( substr( $file, 0, 1 ) != '/' && substr( $file, 1, 1 ) != ':' ) {
141 $filePath = "$IP/$file";
146 if ( !file_exists( $filePath ) ) {
147 $actual[$class] = "[file '$filePath' does not exist]";
151 Wikimedia\
suppressWarnings();
152 $contents = file_get_contents( $filePath );
153 Wikimedia\restoreWarnings
();
155 if ( $contents === false ) {
156 $actual[$class] = "[couldn't read file '$filePath']";
160 list( $classesInFile, $aliasesInFile ) = self
::parseFile( $contents );
162 foreach ( $classesInFile as $className => $ignore ) {
163 $actual[$className] = $file;
166 // Only accept aliases for classes in the same file, because for correct
167 // behavior, all aliases for a class must be set up when the class is loaded
168 // (see <https://bugs.php.net/bug.php?id=61422>).
169 foreach ( $aliasesInFile as $alias => $class ) {
170 if ( isset( $classesInFile[$class] ) ) {
171 $actual[$alias] = $file;
173 $actual[$alias] = "[original class not in $file]";
179 'expected' => $expected,
184 function testCoreClass() {
185 $this->assertTrue( class_exists( 'TestAutoloadedLocalClass' ) );
188 function testExtensionClass() {
189 $this->assertTrue( class_exists( 'TestAutoloadedClass' ) );
192 function testWrongCaseClass() {
193 $this->setMwGlobals( 'wgAutoloadAttemptLowercase', true );
195 $this->assertTrue( class_exists( 'testautoLoadedcamlCLASS' ) );
198 function testWrongCaseSerializedClass() {
199 $this->setMwGlobals( 'wgAutoloadAttemptLowercase', true );
201 $dummyCereal = 'O:29:"testautoloadedserializedclass":0:{}';
202 $uncerealized = unserialize( $dummyCereal );
203 $this->assertFalse( $uncerealized instanceof __PHP_Incomplete_Class
,
204 "unserialize() can load classes case-insensitively." );
207 function testAutoloadOrder() {
208 $path = realpath( __DIR__
. '/../../..' );
209 $oldAutoload = file_get_contents( $path . '/autoload.php' );
210 $generator = new AutoloadGenerator( $path, 'local' );
211 $generator->setExcludePaths( array_values( AutoLoader
::getAutoloadNamespaces() ) );
212 $generator->initMediaWikiDefault();
213 $newAutoload = $generator->getAutoload( 'maintenance/generateLocalAutoload.php' );
215 $this->assertEquals( $oldAutoload, $newAutoload, 'autoload.php does not match' .
216 ' output of generateLocalAutoload.php script.' );