Page MenuHomeWickedGov Phorge
Files F2750465

AutoLoaderStructureTest.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

AutoLoaderStructureTest.php
View Options

<?php
/**
* @coversNothing
*/
class AutoLoaderStructureTest extends MediaWikiIntegrationTestCase {
/**
* Assert that there were no classes loaded that are not registered with the AutoLoader.
*
* For example foo.php having class Foo and class Bar but only registering Foo.
* This is important because we should not be relying on Foo being used before Bar.
*/
public function testAutoLoadConfig() {
$results = self::checkAutoLoadConf();
$this->assertEquals(
$results['expected'],
$results['actual']
);
}
private static function parseFile( $contents ) {
// We could use token_get_all() here, but this is faster
// Note: Keep in sync with ClassCollector
$matches = [];
preg_match_all( '/
^ [\t ]* (?:
(?:final\s+)? (?:abstract\s+)? (?:class|interface|trait) \s+
(?P<class> \w+)
|
class_alias \s* \( \s*
([\'"]) (?P<original> [^\'"]+) \g{-2} \s* , \s*
([\'"]) (?P<alias> [^\'"]+ ) \g{-2} \s*
\) \s* ;
|
class_alias \s* \( \s*
(?P<originalStatic> [\w\\\\]+)::class \s* , \s*
([\'"]) (?P<aliasString> [^\'"]+ ) \g{-2} \s*
\) \s* ;
)
/imx', $contents, $matches, PREG_SET_ORDER );
$namespaceMatch = [];
preg_match( '/
^ [\t ]*
namespace \s+
(\w+(\\\\\w+)*)
\s* ;
/imx', $contents, $namespaceMatch );
$fileNamespace = $namespaceMatch ? $namespaceMatch[1] . '\\' : '';
$classesInFile = [];
$aliasesInFile = [];
foreach ( $matches as $match ) {
if ( !empty( $match['class'] ) ) {
// 'class Foo {}'
$class = $fileNamespace . $match['class'];
$classesInFile[$class] = true;
} elseif ( !empty( $match['original'] ) ) {
// 'class_alias( "Foo", "Bar" );'
$aliasesInFile[self::removeSlashes( $match['alias'] )] = $match['original'];
} else {
// 'class_alias( Foo::class, "Bar" );'
$aliasesInFile[self::removeSlashes( $match['aliasString'] )] =
$fileNamespace . $match['originalStatic'];
}
}
return [ $classesInFile, $aliasesInFile ];
}
private static function removeSlashes( $str ) {
return str_replace( '\\\\', '\\', $str );
}
private static function fixSlashes( $str ) {
return str_replace( '\\', '/', $str );
}
protected static function checkAutoLoadConf() {
$IP = MW_INSTALL_PATH;
// wgAutoloadLocalClasses has precedence, just like in includes/AutoLoader.php
$expected = AutoLoader::getClassFiles();
$actual = [];
foreach ( $expected as $class => $file ) {
// Only prefix $IP if it doesn't have it already.
// Generally local classes don't have it, and those from extensions and test suites do.
if ( $file[0] !== '/' && $file[1] !== ':' ) {
$filePath = self::fixSlashes( "$IP/$file" );
} else {
$filePath = self::fixSlashes( $file );
}
if ( !is_file( $filePath ) ) {
$actual[$class] = "[file '$filePath' does not exist]";
continue;
}
$contents = @file_get_contents( $filePath );
if ( $contents === false ) {
$actual[$class] = "[couldn't read file '$filePath']";
continue;
}
[ $classesInFile, $aliasesInFile ] = self::parseFile( $contents );
foreach ( $classesInFile as $className => $ignore ) {
$actual[$className] = $file;
}
// Only accept aliases for classes in the same file, because for correct
// behavior, all aliases for a class must be set up when the class is loaded
// (see <https://bugs.php.net/bug.php?id=61422>).
foreach ( $aliasesInFile as $alias => $class ) {
if ( isset( $classesInFile[$class] ) ) {
$actual[$alias] = $file;
} else {
$actual[$alias] = "[original class not in $file]";
}
}
}
return [
'expected' => $expected,
'actual' => $actual,
];
}
public function testAutoloadOrder() {
$path = __DIR__ . '/../../..';
$oldAutoload = file_get_contents( $path . '/autoload.php' );
$generator = new AutoloadGenerator( $path, 'local' );
$generator->setPsr4Namespaces( AutoLoader::CORE_NAMESPACES );
$generator->initMediaWikiDefault();
$newAutoload = $generator->getAutoload( 'maintenance/generateLocalAutoload.php' );
$this->assertEquals( $oldAutoload, $newAutoload, 'autoload.php does not match' .
' output of generateLocalAutoload.php script.' );
}
/**
* Verify that all the directories specified for PSR-4 autoloading
* actually exist, to prevent situations like T259448
*/
public function testAutoloadNamespaces() {
$missing = [];
$psr4Namespaces = AutoLoader::getNamespaceDirectories();
foreach ( $psr4Namespaces as $ns => $path ) {
if ( !is_dir( $path ) ) {
$missing[] = "Directory $path for namespace $ns does not exist";
}
}
$this->assertSame( [], $missing );
}
}

File Metadata

Mime Type
text/x-php
Expires
Fri, Jul 3, 16:31 (10 h, 3 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
e6/21/5e6961ea3896322de031938de4fe
Default Alt Text
AutoLoaderStructureTest.php (4 KB)

Event Timeline