Skip to content

Commit 5ca0b57

Browse files
soyukasoyuka
authored
test: phpunit exception not restored (api-platform#7949)
* test: phpunit exception not restored * test(symfony): track exception handler stack to fix risky tests | Q | A | ------------- | --- | Branch? | main | Tickets | ∅ | License | MIT | Doc PR | ∅ ApiTestCase now snapshots the exception handler stack via #[Before]/#[After] hooks (works even when subclasses override setUp without parent::setUp()). Bump symfony/http-kernel to ^6.4.13 to skip the ErrorListener handler leak and drop the AppKernel restore_exception_handler() workarounds.
1 parent a47e36c commit 5ca0b57

12 files changed

Lines changed: 106 additions & 29 deletions

File tree

‎composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@
114114
"psr/container": "^1.0 || ^2.0",
115115
"symfony/deprecation-contracts": "^3.1",
116116
"symfony/http-foundation": "^6.4.14 || ^7.0 || ^8.0",
117-
"symfony/http-kernel": "^6.4 || ^7.0 || ^8.0",
117+
"symfony/http-kernel": "^6.4.13 || ^7.0 || ^8.0",
118118
"symfony/property-access": "^6.4 || ^7.0 || ^8.0",
119119
"symfony/property-info": "^6.4 || ^7.1 || ^8.0",
120120
"symfony/serializer": "^6.4 || ^7.0 || ^8.0",

‎phpunit.xml.dist‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
backupGlobals="false"
44
bootstrap="tests/Fixtures/app/bootstrap.php"
55
colors="true"
6-
cacheDirectory=".phpunit.cache">
6+
cacheDirectory=".phpunit.cache"
7+
failOnRisky="true">
78
<php>
89
<ini name="error_reporting" value="-1"/>
910
<ini name="memory_limit" value="-1"/>

‎src/Doctrine/Odm/Tests/AppKernel.php‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
1919
use Symfony\Component\Config\Loader\LoaderInterface;
2020
use Symfony\Component\DependencyInjection\ContainerBuilder;
21-
use Symfony\Component\HttpKernel\Bundle\Bundle;
2221
use Symfony\Component\HttpKernel\Kernel;
2322

2423
/**
@@ -43,12 +42,6 @@ public function registerBundles(): array
4342
return [
4443
new FrameworkBundle(),
4544
new DoctrineMongoDBBundle(),
46-
new class extends Bundle {
47-
public function shutdown(): void
48-
{
49-
restore_exception_handler();
50-
}
51-
},
5245
];
5346
}
5447

‎src/Doctrine/Odm/Tests/DoctrineMongoDbOdmFilterTestCase.php‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,11 @@
1717
use Doctrine\ODM\MongoDB\DocumentManager;
1818
use Doctrine\ODM\MongoDB\Repository\DocumentRepository;
1919
use Doctrine\Persistence\ManagerRegistry;
20+
use PHPUnit\Framework\Attributes\After;
21+
use PHPUnit\Framework\Attributes\Before;
2022
use PHPUnit\Framework\Attributes\DataProvider;
2123
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
24+
use Symfony\Component\ErrorHandler\ErrorHandler;
2225

2326
/**
2427
* @internal
@@ -37,6 +40,8 @@ abstract class DoctrineMongoDbOdmFilterTestCase extends KernelTestCase
3740

3841
protected string $filterClass;
3942

43+
private bool $symfonyErrorHandlerWasRegistered = false;
44+
4045
protected function setUp(): void
4146
{
4247
self::bootKernel();
@@ -46,6 +51,34 @@ protected function setUp(): void
4651
$this->repository = $this->manager->getRepository($this->resourceClass);
4752
}
4853

54+
/**
55+
* Symfony\Bundle\FrameworkBundle\FrameworkBundle::boot() registers Symfony's ErrorHandler via
56+
* set_exception_handler() but never unregisters it: each kernel boot leaks one entry on the
57+
* exception handler stack, which PHPUnit flags as Risky. Track whether the handler was already
58+
* present before the test so we only pop the entry our own test introduced.
59+
*/
60+
#[Before]
61+
protected function captureExceptionHandlerStack(): void
62+
{
63+
$this->symfonyErrorHandlerWasRegistered = self::isSymfonyErrorHandlerRegistered();
64+
}
65+
66+
#[After]
67+
protected function restoreExceptionHandlerStack(): void
68+
{
69+
if (!$this->symfonyErrorHandlerWasRegistered && self::isSymfonyErrorHandlerRegistered()) {
70+
restore_exception_handler();
71+
}
72+
}
73+
74+
private static function isSymfonyErrorHandlerRegistered(): bool
75+
{
76+
$current = set_exception_handler(static fn () => null);
77+
restore_exception_handler();
78+
79+
return \is_array($current) && $current[0] instanceof ErrorHandler;
80+
}
81+
4982
#[DataProvider('provideApplyTestData')]
5083
public function testApply(?array $properties, array $filterParameters, array $expectedPipeline, ?callable $factory = null, ?string $resourceClass = null): void
5184
{

‎src/Doctrine/Orm/Tests/AppKernel.php‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
1919
use Symfony\Component\Config\Loader\LoaderInterface;
2020
use Symfony\Component\DependencyInjection\ContainerBuilder;
21-
use Symfony\Component\HttpKernel\Bundle\Bundle;
2221
use Symfony\Component\HttpKernel\Kernel;
2322

2423
/**
@@ -44,12 +43,6 @@ public function registerBundles(): array
4443
new FrameworkBundle(),
4544
new DoctrineBundle(),
4645
new TestBundle(),
47-
new class extends Bundle {
48-
public function shutdown(): void
49-
{
50-
restore_exception_handler();
51-
}
52-
},
5346
];
5447
}
5548

‎src/Doctrine/Orm/Tests/DoctrineOrmFilterTestCase.php‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,11 @@
1818
use ApiPlatform\Doctrine\Orm\Util\QueryNameGenerator;
1919
use Doctrine\ORM\EntityRepository;
2020
use Doctrine\Persistence\ManagerRegistry;
21+
use PHPUnit\Framework\Attributes\After;
22+
use PHPUnit\Framework\Attributes\Before;
2123
use PHPUnit\Framework\Attributes\DataProvider;
2224
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
25+
use Symfony\Component\ErrorHandler\ErrorHandler;
2326

2427
/**
2528
* @internal
@@ -38,6 +41,8 @@ abstract class DoctrineOrmFilterTestCase extends KernelTestCase
3841

3942
protected string $filterClass;
4043

44+
private bool $symfonyErrorHandlerWasRegistered = false;
45+
4146
protected function setUp(): void
4247
{
4348
self::bootKernel();
@@ -46,6 +51,34 @@ protected function setUp(): void
4651
$this->repository = $this->managerRegistry->getManagerForClass(Dummy::class)->getRepository(Dummy::class);
4752
}
4853

54+
/**
55+
* Symfony\Bundle\FrameworkBundle\FrameworkBundle::boot() registers Symfony's ErrorHandler via
56+
* set_exception_handler() but never unregisters it: each kernel boot leaks one entry on the
57+
* exception handler stack, which PHPUnit flags as Risky. Track whether the handler was already
58+
* present before the test so we only pop the entry our own test introduced.
59+
*/
60+
#[Before]
61+
protected function captureExceptionHandlerStack(): void
62+
{
63+
$this->symfonyErrorHandlerWasRegistered = self::isSymfonyErrorHandlerRegistered();
64+
}
65+
66+
#[After]
67+
protected function restoreExceptionHandlerStack(): void
68+
{
69+
if (!$this->symfonyErrorHandlerWasRegistered && self::isSymfonyErrorHandlerRegistered()) {
70+
restore_exception_handler();
71+
}
72+
}
73+
74+
private static function isSymfonyErrorHandlerRegistered(): bool
75+
{
76+
$current = set_exception_handler(static fn () => null);
77+
restore_exception_handler();
78+
79+
return \is_array($current) && $current[0] instanceof ErrorHandler;
80+
}
81+
4982
#[DataProvider('provideApplyTestData')]
5083
public function testApply(?array $properties, array $filterParameters, string $expectedDql, ?array $expectedParameters = null, ?callable $factory = null, ?string $resourceClass = null): void
5184
{

‎src/State/composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
"php": ">=8.2",
3131
"api-platform/metadata": "^4.3",
3232
"psr/container": "^1.0 || ^2.0",
33-
"symfony/http-kernel": "^6.4 || ^7.0 || ^8.0",
33+
"symfony/http-kernel": "^6.4.13 || ^7.0 || ^8.0",
3434
"symfony/serializer": "^6.4 || ^7.0 || ^8.0",
3535
"symfony/translation-contracts": "^3.0",
3636
"symfony/deprecation-contracts": "^3.1"

‎src/Symfony/Bundle/Test/ApiTestCase.php‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,12 @@
1414
namespace ApiPlatform\Symfony\Bundle\Test;
1515

1616
use ApiPlatform\Metadata\IriConverterInterface;
17+
use PHPUnit\Framework\Attributes\After;
18+
use PHPUnit\Framework\Attributes\Before;
1719
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
1820
use Symfony\Component\BrowserKit\AbstractBrowser;
1921
use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
22+
use Symfony\Component\ErrorHandler\ErrorHandler;
2023
use Symfony\Component\HttpClient\HttpClientTrait;
2124

2225
/**
@@ -38,6 +41,37 @@ abstract class ApiTestCase extends KernelTestCase
3841
*/
3942
protected static ?bool $alwaysBootKernel = null;
4043

44+
private bool $symfonyErrorHandlerWasRegistered = false;
45+
46+
/**
47+
* Symfony\Bundle\FrameworkBundle\FrameworkBundle::boot() registers Symfony's ErrorHandler via
48+
* set_exception_handler() but never unregisters it: each kernel boot leaks one entry on the
49+
* exception handler stack, which PHPUnit flags as Risky. Track whether the handler was already
50+
* present before the test (e.g. the kernel was booted from setUpBeforeClass) so we only pop
51+
* the entry our own test introduced.
52+
*/
53+
#[Before]
54+
protected function captureExceptionHandlerStack(): void
55+
{
56+
$this->symfonyErrorHandlerWasRegistered = self::isSymfonyErrorHandlerRegistered();
57+
}
58+
59+
#[After]
60+
protected function restoreExceptionHandlerStack(): void
61+
{
62+
if (!$this->symfonyErrorHandlerWasRegistered && self::isSymfonyErrorHandlerRegistered()) {
63+
restore_exception_handler();
64+
}
65+
}
66+
67+
private static function isSymfonyErrorHandlerRegistered(): bool
68+
{
69+
$current = set_exception_handler(static fn () => null);
70+
restore_exception_handler();
71+
72+
return \is_array($current) && $current[0] instanceof ErrorHandler;
73+
}
74+
4175
/**
4276
* Creates a Client.
4377
*

‎src/Symfony/Tests/EventListener/ErrorListenerTest.php‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,6 @@
3030

3131
class ErrorListenerTest extends TestCase
3232
{
33-
protected function tearDown(): void
34-
{
35-
restore_exception_handler();
36-
}
37-
3833
public function testDuplicateException(): void
3934
{
4035
$exception = new \Exception();

‎src/Symfony/composer.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
"api-platform/openapi": "^4.3",
4242
"symfony/asset": "^6.4 || ^7.0 || ^8.0",
4343
"symfony/finder": "^6.4 || ^7.0 || ^8.0",
44+
"symfony/http-kernel": "^6.4.13 || ^7.0 || ^8.0",
4445
"symfony/property-info": "^6.4 || ^7.0 || ^8.0",
4546
"symfony/property-access": "^6.4 || ^7.0 || ^8.0",
4647
"symfony/serializer": "^6.4 || ^7.0 || ^8.0",

0 commit comments

Comments
 (0)