449 lines
18 KiB
PHP
449 lines
18 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Component\Debug\Tests;
|
|
|
|
use PHPUnit\Framework\TestCase;
|
|
use Symfony\Component\Debug\DebugClassLoader;
|
|
use Symfony\Component\Debug\ErrorHandler;
|
|
|
|
class DebugClassLoaderTest extends TestCase
|
|
{
|
|
/**
|
|
* @var int Error reporting level before running tests
|
|
*/
|
|
private $errorReporting;
|
|
|
|
private $loader;
|
|
|
|
protected function setUp()
|
|
{
|
|
$this->errorReporting = error_reporting(E_ALL);
|
|
$this->loader = new ClassLoader();
|
|
spl_autoload_register([$this->loader, 'loadClass'], true, true);
|
|
DebugClassLoader::enable();
|
|
}
|
|
|
|
protected function tearDown()
|
|
{
|
|
DebugClassLoader::disable();
|
|
spl_autoload_unregister([$this->loader, 'loadClass']);
|
|
error_reporting($this->errorReporting);
|
|
}
|
|
|
|
public function testIdempotence()
|
|
{
|
|
DebugClassLoader::enable();
|
|
|
|
$functions = spl_autoload_functions();
|
|
foreach ($functions as $function) {
|
|
if (\is_array($function) && $function[0] instanceof DebugClassLoader) {
|
|
$reflClass = new \ReflectionClass($function[0]);
|
|
$reflProp = $reflClass->getProperty('classLoader');
|
|
$reflProp->setAccessible(true);
|
|
|
|
$this->assertNotInstanceOf('Symfony\Component\Debug\DebugClassLoader', $reflProp->getValue($function[0]));
|
|
|
|
return;
|
|
}
|
|
}
|
|
|
|
$this->fail('DebugClassLoader did not register');
|
|
}
|
|
|
|
public function testThrowingClass()
|
|
{
|
|
$this->expectException('Exception');
|
|
$this->expectExceptionMessage('boo');
|
|
try {
|
|
class_exists(Fixtures\Throwing::class);
|
|
$this->fail('Exception expected');
|
|
} catch (\Exception $e) {
|
|
$this->assertSame('boo', $e->getMessage());
|
|
}
|
|
|
|
// the second call also should throw
|
|
class_exists(Fixtures\Throwing::class);
|
|
}
|
|
|
|
public function testUnsilencing()
|
|
{
|
|
if (\PHP_VERSION_ID >= 70000) {
|
|
$this->markTestSkipped('PHP7 throws exceptions, unsilencing is not required anymore.');
|
|
}
|
|
if (\defined('HHVM_VERSION')) {
|
|
$this->markTestSkipped('HHVM is not handled in this test case.');
|
|
}
|
|
|
|
ob_start();
|
|
|
|
$this->iniSet('log_errors', 0);
|
|
$this->iniSet('display_errors', 1);
|
|
|
|
// See below: this will fail with parse error
|
|
// but this should not be @-silenced.
|
|
@class_exists(TestingUnsilencing::class, true);
|
|
|
|
$output = ob_get_clean();
|
|
|
|
$this->assertStringMatchesFormat('%aParse error%a', $output);
|
|
}
|
|
|
|
/**
|
|
* @requires PHP < 8.0
|
|
*/
|
|
public function testStacking()
|
|
{
|
|
// the ContextErrorException must not be loaded to test the workaround
|
|
// for https://bugs.php.net/65322.
|
|
if (class_exists('Symfony\Component\Debug\Exception\ContextErrorException', false)) {
|
|
$this->markTestSkipped('The ContextErrorException class is already loaded.');
|
|
}
|
|
if (\defined('HHVM_VERSION')) {
|
|
$this->markTestSkipped('HHVM is not handled in this test case.');
|
|
}
|
|
|
|
ErrorHandler::register();
|
|
|
|
try {
|
|
// Trigger autoloading + E_STRICT at compile time
|
|
// which in turn triggers $errorHandler->handle()
|
|
// that again triggers autoloading for ContextErrorException.
|
|
// Error stacking works around the bug above and everything is fine.
|
|
|
|
eval('
|
|
namespace '.__NAMESPACE__.';
|
|
class ChildTestingStacking extends TestingStacking { function foo($bar) {} }
|
|
');
|
|
$this->fail('ContextErrorException expected');
|
|
} catch (\ErrorException $exception) {
|
|
// if an exception is thrown, the test passed
|
|
$this->assertStringStartsWith(__FILE__, $exception->getFile());
|
|
if (\PHP_VERSION_ID < 70000) {
|
|
$this->assertRegExp('/^Runtime Notice: Declaration/', $exception->getMessage());
|
|
$this->assertEquals(E_STRICT, $exception->getSeverity());
|
|
} else {
|
|
$this->assertRegExp('/^Warning: Declaration/', $exception->getMessage());
|
|
$this->assertEquals(E_WARNING, $exception->getSeverity());
|
|
}
|
|
} finally {
|
|
restore_error_handler();
|
|
restore_exception_handler();
|
|
}
|
|
}
|
|
|
|
public function testNameCaseMismatch()
|
|
{
|
|
$this->expectException('RuntimeException');
|
|
$this->expectExceptionMessage('Case mismatch between loaded and declared class names');
|
|
class_exists(TestingCaseMismatch::class, true);
|
|
}
|
|
|
|
public function testFileCaseMismatch()
|
|
{
|
|
$this->expectException('RuntimeException');
|
|
$this->expectExceptionMessage('Case mismatch between class and real file names');
|
|
if (!file_exists(__DIR__.'/Fixtures/CaseMismatch.php')) {
|
|
$this->markTestSkipped('Can only be run on case insensitive filesystems');
|
|
}
|
|
|
|
class_exists(Fixtures\CaseMismatch::class, true);
|
|
}
|
|
|
|
public function testPsr4CaseMismatch()
|
|
{
|
|
$this->expectException('RuntimeException');
|
|
$this->expectExceptionMessage('Case mismatch between loaded and declared class names');
|
|
class_exists(__NAMESPACE__.'\Fixtures\Psr4CaseMismatch', true);
|
|
}
|
|
|
|
public function testNotPsr0()
|
|
{
|
|
$this->assertTrue(class_exists(__NAMESPACE__.'\Fixtures\NotPSR0', true));
|
|
}
|
|
|
|
public function testNotPsr0Bis()
|
|
{
|
|
$this->assertTrue(class_exists(__NAMESPACE__.'\Fixtures\NotPSR0bis', true));
|
|
}
|
|
|
|
public function testClassAlias()
|
|
{
|
|
$this->assertTrue(class_exists(Fixtures\ClassAlias::class, true));
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideDeprecatedSuper
|
|
*/
|
|
public function testDeprecatedSuper($class, $super, $type)
|
|
{
|
|
set_error_handler(function () { return false; });
|
|
$e = error_reporting(0);
|
|
@trigger_error('', E_USER_DEPRECATED);
|
|
|
|
class_exists('Test\\'.__NAMESPACE__.'\\'.$class, true);
|
|
|
|
error_reporting($e);
|
|
restore_error_handler();
|
|
|
|
$lastError = error_get_last();
|
|
unset($lastError['file'], $lastError['line']);
|
|
|
|
$xError = [
|
|
'type' => E_USER_DEPRECATED,
|
|
'message' => 'The "Test\Symfony\Component\Debug\Tests\\'.$class.'" class '.$type.' "Symfony\Component\Debug\Tests\Fixtures\\'.$super.'" that is deprecated but this is a test deprecation notice.',
|
|
];
|
|
|
|
$this->assertSame($xError, $lastError);
|
|
}
|
|
|
|
public function provideDeprecatedSuper()
|
|
{
|
|
return [
|
|
['DeprecatedInterfaceClass', 'DeprecatedInterface', 'implements'],
|
|
['DeprecatedParentClass', 'DeprecatedClass', 'extends'],
|
|
];
|
|
}
|
|
|
|
public function testInterfaceExtendsDeprecatedInterface()
|
|
{
|
|
set_error_handler(function () { return false; });
|
|
$e = error_reporting(0);
|
|
trigger_error('', E_USER_NOTICE);
|
|
|
|
class_exists('Test\\'.NonDeprecatedInterfaceClass::class, true);
|
|
|
|
error_reporting($e);
|
|
restore_error_handler();
|
|
|
|
$lastError = error_get_last();
|
|
unset($lastError['file'], $lastError['line']);
|
|
|
|
$xError = [
|
|
'type' => E_USER_NOTICE,
|
|
'message' => '',
|
|
];
|
|
|
|
$this->assertSame($xError, $lastError);
|
|
}
|
|
|
|
public function testDeprecatedSuperInSameNamespace()
|
|
{
|
|
set_error_handler(function () { return false; });
|
|
$e = error_reporting(0);
|
|
trigger_error('', E_USER_NOTICE);
|
|
|
|
class_exists('Symfony\Bridge\Debug\Tests\Fixtures\ExtendsDeprecatedParent', true);
|
|
|
|
error_reporting($e);
|
|
restore_error_handler();
|
|
|
|
$lastError = error_get_last();
|
|
unset($lastError['file'], $lastError['line']);
|
|
|
|
$xError = [
|
|
'type' => E_USER_NOTICE,
|
|
'message' => '',
|
|
];
|
|
|
|
$this->assertSame($xError, $lastError);
|
|
}
|
|
|
|
public function testReservedForPhp7()
|
|
{
|
|
if (\PHP_VERSION_ID >= 70000) {
|
|
$this->markTestSkipped('PHP7 already prevents using reserved names.');
|
|
}
|
|
|
|
set_error_handler(function () { return false; });
|
|
$e = error_reporting(0);
|
|
trigger_error('', E_USER_NOTICE);
|
|
|
|
class_exists('Test\\'.Float::class, true);
|
|
|
|
error_reporting($e);
|
|
restore_error_handler();
|
|
|
|
$lastError = error_get_last();
|
|
unset($lastError['file'], $lastError['line']);
|
|
|
|
$xError = [
|
|
'type' => E_USER_DEPRECATED,
|
|
'message' => 'The "Test\Symfony\Component\Debug\Tests\Float" class uses the reserved name "Float", it will break on PHP 7 and higher',
|
|
];
|
|
|
|
$this->assertSame($xError, $lastError);
|
|
}
|
|
|
|
public function testExtendedFinalClass()
|
|
{
|
|
$deprecations = [];
|
|
set_error_handler(function ($type, $msg) use (&$deprecations) { $deprecations[] = $msg; });
|
|
$e = error_reporting(E_USER_DEPRECATED);
|
|
|
|
require __DIR__.'/Fixtures/FinalClasses.php';
|
|
|
|
$i = 1;
|
|
while (class_exists($finalClass = Fixtures\FinalClass::class.$i++, false)) {
|
|
spl_autoload_call($finalClass);
|
|
class_exists('Test\\'.__NAMESPACE__.'\\Extends'.substr($finalClass, strrpos($finalClass, '\\') + 1), true);
|
|
}
|
|
|
|
error_reporting($e);
|
|
restore_error_handler();
|
|
|
|
$this->assertSame([
|
|
'The "Symfony\Component\Debug\Tests\Fixtures\FinalClass1" class is considered final since version 3.3. It may change without further notice as of its next major version. You should not extend it from "Test\Symfony\Component\Debug\Tests\ExtendsFinalClass1".',
|
|
'The "Symfony\Component\Debug\Tests\Fixtures\FinalClass2" class is considered final. It may change without further notice as of its next major version. You should not extend it from "Test\Symfony\Component\Debug\Tests\ExtendsFinalClass2".',
|
|
'The "Symfony\Component\Debug\Tests\Fixtures\FinalClass3" class is considered final comment with @@@ and ***. It may change without further notice as of its next major version. You should not extend it from "Test\Symfony\Component\Debug\Tests\ExtendsFinalClass3".',
|
|
'The "Symfony\Component\Debug\Tests\Fixtures\FinalClass4" class is considered final. It may change without further notice as of its next major version. You should not extend it from "Test\Symfony\Component\Debug\Tests\ExtendsFinalClass4".',
|
|
'The "Symfony\Component\Debug\Tests\Fixtures\FinalClass5" class is considered final multiline comment. It may change without further notice as of its next major version. You should not extend it from "Test\Symfony\Component\Debug\Tests\ExtendsFinalClass5".',
|
|
'The "Symfony\Component\Debug\Tests\Fixtures\FinalClass6" class is considered final. It may change without further notice as of its next major version. You should not extend it from "Test\Symfony\Component\Debug\Tests\ExtendsFinalClass6".',
|
|
'The "Symfony\Component\Debug\Tests\Fixtures\FinalClass7" class is considered final another multiline comment... It may change without further notice as of its next major version. You should not extend it from "Test\Symfony\Component\Debug\Tests\ExtendsFinalClass7".',
|
|
'The "Symfony\Component\Debug\Tests\Fixtures\FinalClass8" class is considered final. It may change without further notice as of its next major version. You should not extend it from "Test\Symfony\Component\Debug\Tests\ExtendsFinalClass8".',
|
|
], $deprecations);
|
|
}
|
|
|
|
public function testExtendedFinalMethod()
|
|
{
|
|
$deprecations = [];
|
|
set_error_handler(function ($type, $msg) use (&$deprecations) { $deprecations[] = $msg; });
|
|
$e = error_reporting(E_USER_DEPRECATED);
|
|
|
|
class_exists(Fixtures\ExtendedFinalMethod::class, true);
|
|
|
|
error_reporting($e);
|
|
restore_error_handler();
|
|
|
|
$xError = [
|
|
'The "Symfony\Component\Debug\Tests\Fixtures\FinalMethod::finalMethod()" method is considered final since version 3.3. It may change without further notice as of its next major version. You should not extend it from "Symfony\Component\Debug\Tests\Fixtures\ExtendedFinalMethod".',
|
|
'The "Symfony\Component\Debug\Tests\Fixtures\FinalMethod::finalMethod2()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Symfony\Component\Debug\Tests\Fixtures\ExtendedFinalMethod".',
|
|
];
|
|
|
|
$this->assertSame($xError, $deprecations);
|
|
}
|
|
|
|
public function testExtendedDeprecatedMethodDoesntTriggerAnyNotice()
|
|
{
|
|
set_error_handler(function () { return false; });
|
|
$e = error_reporting(0);
|
|
trigger_error('', E_USER_NOTICE);
|
|
|
|
class_exists('Test\\'.ExtendsAnnotatedClass::class, true);
|
|
|
|
error_reporting($e);
|
|
restore_error_handler();
|
|
|
|
$lastError = error_get_last();
|
|
unset($lastError['file'], $lastError['line']);
|
|
|
|
$this->assertSame(['type' => E_USER_NOTICE, 'message' => ''], $lastError);
|
|
}
|
|
|
|
public function testInternalsUse()
|
|
{
|
|
$deprecations = [];
|
|
set_error_handler(function ($type, $msg) use (&$deprecations) { $deprecations[] = $msg; });
|
|
$e = error_reporting(E_USER_DEPRECATED);
|
|
|
|
class_exists('Test\\'.ExtendsInternals::class, true);
|
|
|
|
error_reporting($e);
|
|
restore_error_handler();
|
|
|
|
$this->assertSame($deprecations, [
|
|
'The "Symfony\Component\Debug\Tests\Fixtures\InternalInterface" interface is considered internal. It may change without further notice. You should not use it from "Test\Symfony\Component\Debug\Tests\ExtendsInternalsParent".',
|
|
'The "Symfony\Component\Debug\Tests\Fixtures\InternalClass" class is considered internal since version 3.4. It may change without further notice. You should not use it from "Test\Symfony\Component\Debug\Tests\ExtendsInternalsParent".',
|
|
'The "Symfony\Component\Debug\Tests\Fixtures\InternalTrait" trait is considered internal. It may change without further notice. You should not use it from "Test\Symfony\Component\Debug\Tests\ExtendsInternals".',
|
|
'The "Symfony\Component\Debug\Tests\Fixtures\InternalClass::internalMethod()" method is considered internal since version 3.4. It may change without further notice. You should not extend it from "Test\Symfony\Component\Debug\Tests\ExtendsInternals".',
|
|
]);
|
|
}
|
|
|
|
public function testUseTraitWithInternalMethod()
|
|
{
|
|
$deprecations = [];
|
|
set_error_handler(function ($type, $msg) use (&$deprecations) { $deprecations[] = $msg; });
|
|
$e = error_reporting(E_USER_DEPRECATED);
|
|
|
|
class_exists('Test\\'.UseTraitWithInternalMethod::class, true);
|
|
|
|
error_reporting($e);
|
|
restore_error_handler();
|
|
|
|
$this->assertSame([], $deprecations);
|
|
}
|
|
|
|
public function testEvaluatedCode()
|
|
{
|
|
$this->assertTrue(class_exists(Fixtures\DefinitionInEvaluatedCode::class, true));
|
|
}
|
|
}
|
|
|
|
class ClassLoader
|
|
{
|
|
public function loadClass($class)
|
|
{
|
|
}
|
|
|
|
public function getClassMap()
|
|
{
|
|
return [__NAMESPACE__.'\Fixtures\NotPSR0bis' => __DIR__.'/Fixtures/notPsr0Bis.php'];
|
|
}
|
|
|
|
public function findFile($class)
|
|
{
|
|
$fixtureDir = __DIR__.\DIRECTORY_SEPARATOR.'Fixtures'.\DIRECTORY_SEPARATOR;
|
|
|
|
if (TestingUnsilencing::class === $class) {
|
|
eval('-- parse error --');
|
|
} elseif (TestingStacking::class === $class) {
|
|
eval('namespace '.__NAMESPACE__.'; class TestingStacking { function foo() {} }');
|
|
} elseif (TestingCaseMismatch::class === $class) {
|
|
eval('namespace '.__NAMESPACE__.'; class TestingCaseMisMatch {}');
|
|
} elseif (__NAMESPACE__.'\Fixtures\Psr4CaseMismatch' === $class) {
|
|
return $fixtureDir.'psr4'.\DIRECTORY_SEPARATOR.'Psr4CaseMismatch.php';
|
|
} elseif (__NAMESPACE__.'\Fixtures\NotPSR0' === $class) {
|
|
return $fixtureDir.'reallyNotPsr0.php';
|
|
} elseif (__NAMESPACE__.'\Fixtures\NotPSR0bis' === $class) {
|
|
return $fixtureDir.'notPsr0Bis.php';
|
|
} elseif ('Symfony\Bridge\Debug\Tests\Fixtures\ExtendsDeprecatedParent' === $class) {
|
|
eval('namespace Symfony\Bridge\Debug\Tests\Fixtures; class ExtendsDeprecatedParent extends \\'.__NAMESPACE__.'\Fixtures\DeprecatedClass {}');
|
|
} elseif ('Test\\'.DeprecatedParentClass::class === $class) {
|
|
eval('namespace Test\\'.__NAMESPACE__.'; class DeprecatedParentClass extends \\'.__NAMESPACE__.'\Fixtures\DeprecatedClass {}');
|
|
} elseif ('Test\\'.DeprecatedInterfaceClass::class === $class) {
|
|
eval('namespace Test\\'.__NAMESPACE__.'; class DeprecatedInterfaceClass implements \\'.__NAMESPACE__.'\Fixtures\DeprecatedInterface {}');
|
|
} elseif ('Test\\'.NonDeprecatedInterfaceClass::class === $class) {
|
|
eval('namespace Test\\'.__NAMESPACE__.'; class NonDeprecatedInterfaceClass implements \\'.__NAMESPACE__.'\Fixtures\NonDeprecatedInterface {}');
|
|
} elseif ('Test\\'.Float::class === $class) {
|
|
eval('namespace Test\\'.__NAMESPACE__.'; class Float {}');
|
|
} elseif (0 === strpos($class, 'Test\\'.ExtendsFinalClass::class)) {
|
|
$classShortName = substr($class, strrpos($class, '\\') + 1);
|
|
eval('namespace Test\\'.__NAMESPACE__.'; class '.$classShortName.' extends \\'.__NAMESPACE__.'\Fixtures\\'.substr($classShortName, 7).' {}');
|
|
} elseif ('Test\\'.ExtendsAnnotatedClass::class === $class) {
|
|
eval('namespace Test\\'.__NAMESPACE__.'; class ExtendsAnnotatedClass extends \\'.__NAMESPACE__.'\Fixtures\AnnotatedClass {
|
|
public function deprecatedMethod() { }
|
|
}');
|
|
} elseif ('Test\\'.ExtendsInternals::class === $class) {
|
|
eval('namespace Test\\'.__NAMESPACE__.'; class ExtendsInternals extends ExtendsInternalsParent {
|
|
use \\'.__NAMESPACE__.'\Fixtures\InternalTrait;
|
|
|
|
public function internalMethod() { }
|
|
}');
|
|
} elseif ('Test\\'.ExtendsInternalsParent::class === $class) {
|
|
eval('namespace Test\\'.__NAMESPACE__.'; class ExtendsInternalsParent extends \\'.__NAMESPACE__.'\Fixtures\InternalClass implements \\'.__NAMESPACE__.'\Fixtures\InternalInterface { }');
|
|
} elseif ('Test\\'.UseTraitWithInternalMethod::class === $class) {
|
|
eval('namespace Test\\'.__NAMESPACE__.'; class UseTraitWithInternalMethod { use \\'.__NAMESPACE__.'\Fixtures\TraitWithInternalMethod; }');
|
|
}
|
|
|
|
return null;
|
|
}
|
|
}
|