Inclusion of embedded nikic/php-parser is broken with PHPUnit 10

[bburnichon]

Bug Report

Subject	Details
Rector version	v2.2.3

I have some services in a symfony container that requires nikic/php-parser.
When invoking this service in an end-to-end test, the dumped service container adds several lines
to include include_once $root . '/vendor/nikic/php-parser/lib/PhpParser/Parser.php';

When running tests,
I encounter PHP Fatal error: Cannot declare interface PhpParser\Parser, because the name is already in use in ##redacted##/vendor/nikic/php-parser/lib/PhpParser/Parser.php on line 5

Minimal PHP Code Causing Issue

Not related with a code change. It does not work

Suppose this test file in tests directory

final class PhpParserBreakTest extends TestCase
{
    public function testItBreaksWhenIncludingLocalPhpParserInPHPUnitTest(): void
    {
        $this->expectNotToPerformAssertions();

        include_once \dirname(__DIR__, 4).'/vendor/nikic/php-parser/lib/PhpParser/Parser.php';
        include_once \dirname(__DIR__, 4).'/vendor/nikic/php-parser/lib/PhpParser/ParserFactory.php';
    }
}

Expected Behaviour

Test should be pass without issues

[TomasVotruba]

This could be tricky one. We'll need minimal reproducer repository.

[samsonasik]

@bburnichon I think you can verify with get_included_files() early in the test:

        $this->expectNotToPerformAssertions();
        
+       $rectorParser = \dirname(__DIR__, 4) . '/vendor/rector/rector/vendor/nikic/php-parser/lib/PhpParser/Parser.php';

+        if (in_array($rectorParser, get_included_files(), true)) {
+            // no need to include here, just do the test
+            return;
+        }

[bburnichon]

@bburnichon I think you can verify with get_included_files() early in the test:

Sorry, I think you misunderstood why the include_once are present. I do not control the inclusion, these are generated by symfony's DIC compilation passes. I put these in the test to simulate what is actually happening in my real test.

I will try to build a fully working reproduction repository (i am currently on my phone)

[bburnichon]

This could be tricky one. We'll need minimal reproducer repository.

Here you go bburnichon/rector-issue-9437 failing workflow

[samsonasik]

@bburnichon If the test case is auto generated by symfony DIC, it may needs to verify that some special path of symfony exists, could you show that?

[bburnichon]

No, symfony's DI generate a container file containing the include_once statements. For performance reasons, it does not rely on configured autoloader and generate a file like

/**
 * @internal This class has been auto-generated by the Symfony Dependency Injection Component.
 */
class getSwaggerDefinitionProviderService extends AppKernelDevDebugContainer
{
    /**
     * Gets the public 'XXX\Swagger\SwaggerDefinitionProvider' shared service.
     *
     * @return \XXX\Swagger\SwaggerDefinitionProvider
     */
    public static function do($container, $lazyLoad = true)
    {
        include_once \dirname(__DIR__, 4).'/src/Swagger/SwaggerDefinitionProvider.php';
        include_once \dirname(__DIR__, 4).'/vendor/nikic/php-parser/lib/PhpParser/Parser.php';
        include_once \dirname(__DIR__, 4).'/vendor/nikic/php-parser/lib/PhpParser/ParserFactory.php';

        $a = ($container->services['app.logger'] ?? $container->load('getApp_LoggerService'));

        return $container->services['XXX\\Swagger\\SwaggerDefinitionProvider'] = new \XXX\Swagger\SwaggerDefinitionProvider((new \PhpParser\ParserFactory())->createForHostVersion(), $a);
    }
}

I added only the include_once statements in the reproduction as this is what causes the issue.

[samsonasik]

This should be resolved in rector/rector:dev-main, see PR:

• Test rector/rector:dev-main bburnichon/rector-issue-9437#1

I tested locally, seems working OK

➜  rector-issue-9437 git:(patch-1) ✗ vendor/bin/phpunit 
PHPUnit 10.5.58 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.3.12
Configuration: /Users/samsonasik/www/rector-issue-9437/phpunit.xml

R                                                                   1 / 1 (100%)

Time: 00:00.001, Memory: 8.00 MB

There was 1 risky test:

1) BBurnichon\RectorIssue9437\Tests\ConflictingPhpParserLibraryTest::testItShouldNotConflictWhenIncludingPhpParserManually
This test does not define a code coverage target but is expected to do so

/Users/samsonasik/www/rector-issue-9437/tests/ConflictingPhpParserLibraryTest.php:9

OK, but there were issues!
Tests: 1, Assertions: 0, Risky: 1.

[samsonasik]

I created proper test for dev-main and phpunit 10 test

• Include PHPUnit 10 test with inclusion Parser.php rector-compat-tests#10