Add functional regression test for EntityValueResolver on primary-key routes (#2230)

Author: ousamabenyounes

composer.json

@@ -59,6 +59,7 @@
         "symfony/http-kernel": "^6.4 || ^7.0",
         "symfony/messenger": "^6.4 || ^7.0",
         "symfony/property-info": "^6.4 || ^7.0",
+        "symfony/runtime": "^6.4 || ^7.0",
         "symfony/security-bundle": "^6.4 || ^7.0",
         "symfony/stopwatch": "^6.4 || ^7.0",
         "symfony/string": "^6.4 || ^7.0",
@@ -97,7 +98,8 @@
         "allow-plugins": {
             "composer/package-versions-deprecated": true,
             "dealerdirect/phpcodesniffer-composer-installer": true,
-            "symfony/flex": true
+            "symfony/flex": true,
+            "symfony/runtime": false
         },
         "sort-packages": true
     },

tests/ArgumentResolver/EntityValueResolverFunctionalTest.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Bundle\DoctrineBundle\Tests\ArgumentResolver;
+
+use Doctrine\Bundle\DoctrineBundle\Tests\ArgumentResolver\Fixtures\EntityValueResolverFunctionalKernel;
+use Doctrine\Bundle\DoctrineBundle\Tests\ArgumentResolver\Fixtures\Post;
+use Doctrine\ORM\EntityManagerInterface;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+
+use function assert;
+use function interface_exists;
+use function json_decode;
+
+/**
+ * Regression coverage for the /posts/{post} + Post $post happy path resolved by
+ * Symfony\Bridge\Doctrine\ArgumentResolver\EntityValueResolver. The tag priority
+ * configured in config/orm.php (and the priorities of FrameworkBundle's own
+ * value resolvers) must stay compatible so that the entity argument is still
+ * populated from the route placeholder.
+ */
+class EntityValueResolverFunctionalTest extends TestCase
+{
+    public function testEntityArgumentResolvedFromRoutePlaceholder(): void
+    {
+        if (! interface_exists(EntityManagerInterface::class)) {
+            self::markTestSkipped('This test requires ORM');
+        }
+
+        $kernel = new EntityValueResolverFunctionalKernel();
+        $kernel->boot();
+
+        try {
+            $container = $kernel->getContainer();
+            $em        = $container->get('doctrine.orm.default_entity_manager');
+            assert($em instanceof EntityManagerInterface);
+
+            // SchemaTool::createSchema triggers Schema::createTable, deprecated in
+            // DBAL 4 (https://github.com/doctrine/dbal/pull/7373); the DBAL 4 fluent
+            // replacement (Table::editor() / Column::editor()) is unavailable on
+            // DBAL 3 which this branch must still support, so a raw CREATE TABLE is
+            // emitted directly through the connection. The test kernel is SQLite-
+            // only, so a SQLite literal is safe here.
+            $em->getConnection()->executeStatement(
+                'CREATE TABLE posts (id INTEGER NOT NULL, title VARCHAR(255) NOT NULL, PRIMARY KEY(id))',
+            );
+
+            $post = new Post('Hello world');
+            $em->persist($post);
+            $em->flush();
+            $em->clear();
+
+            $response = $kernel->handle(Request::create('/posts/' . $post->id, 'GET'));
+
+            self::assertSame(200, $response->getStatusCode());
+            self::assertSame(
+                ['id' => $post->id, 'title' => 'Hello world'],
+                json_decode((string) $response->getContent(), true),
+            );
+        } finally {
+            $kernel->shutdown();
+        }
+    }
+}

tests/ArgumentResolver/Fixtures/EntityValueResolverFunctionalKernel.php

@@ -0,0 +1,95 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Bundle\DoctrineBundle\Tests\ArgumentResolver\Fixtures;
+
+use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
+use Doctrine\ORM\Configuration;
+use Psr\Log\NullLogger;
+use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
+use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Symfony\Component\HttpKernel\Bundle\BundleInterface;
+use Symfony\Component\HttpKernel\Kernel;
+use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
+
+use function md5;
+use function method_exists;
+use function mt_rand;
+use function sys_get_temp_dir;
+
+use const PHP_VERSION_ID;
+
+class EntityValueResolverFunctionalKernel extends Kernel
+{
+    use MicroKernelTrait;
+
+    private string|null $projectDir = null;
+
+    public function __construct()
+    {
+        parent::__construct('test', true);
+    }
+
+    /** @return iterable<BundleInterface> */
+    public function registerBundles(): iterable
+    {
+        return [
+            new FrameworkBundle(),
+            new DoctrineBundle(),
+        ];
+    }
+
+    protected function configureContainer(ContainerConfigurator $container): void
+    {
+        $container->extension('framework', [
+            'secret' => 'F00',
+            'http_method_override' => false,
+            'annotations' => false,
+            'php_errors' => ['log' => true],
+            'handle_all_throwables' => true,
+            'router' => ['utf8' => true],
+            'test' => true,
+        ]);
+
+        $container->extension('doctrine', [
+            'dbal' => [
+                'driver' => 'pdo_sqlite',
+                'memory' => true,
+                'schema_manager_factory' => 'doctrine.dbal.default_schema_manager_factory',
+            ],
+            'orm' => [
+                'controller_resolver' => ['auto_mapping' => false],
+                'enable_lazy_ghost_objects' => true,
+                /** @phpstan-ignore function.alreadyNarrowedType */
+                'enable_native_lazy_objects' => PHP_VERSION_ID >= 80400 && method_exists(Configuration::class, 'enableNativeLazyObjects'),
+                'mappings' => [
+                    'PostFixtures' => [
+                        'type' => 'attribute',
+                        'dir' => __DIR__,
+                        'prefix' => 'Doctrine\Bundle\DoctrineBundle\Tests\ArgumentResolver\Fixtures',
+                    ],
+                ],
+            ],
+        ]);
+
+        $services = $container->services();
+        $services->set('logger', NullLogger::class);
+        $services->set(PostController::class)
+            ->autowire()
+            ->autoconfigure()
+            ->public()
+            ->tag('controller.service_arguments');
+    }
+
+    protected function configureRoutes(RoutingConfigurator $routes): void
+    {
+        $routes->add('post_show', '/posts/{post}')->controller(PostController::class);
+    }
+
+    public function getProjectDir(): string
+    {
+        return $this->projectDir ??= sys_get_temp_dir() . '/sf_evr_kernel_' . md5((string) mt_rand());
+    }
+}

tests/ArgumentResolver/Fixtures/Post.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Bundle\DoctrineBundle\Tests\ArgumentResolver\Fixtures;
+
+use Doctrine\DBAL\Types\Types;
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity]
+#[ORM\Table(name: 'posts')]
+class Post
+{
+    #[ORM\Id]
+    #[ORM\GeneratedValue(strategy: 'AUTO')]
+    #[ORM\Column(type: Types::INTEGER)]
+    public int|null $id = null;
+
+    public function __construct(
+        #[ORM\Column(type: Types::STRING)]
+        public string $title,
+    ) {
+    }
+}

tests/ArgumentResolver/Fixtures/PostController.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Bundle\DoctrineBundle\Tests\ArgumentResolver\Fixtures;
+
+use Symfony\Component\HttpFoundation\JsonResponse;
+
+class PostController
+{
+    public function __invoke(Post $post): JsonResponse
+    {
+        return new JsonResponse(['id' => $post->id, 'title' => $post->title]);
+    }
+}