Merge pull request #662 from alexislefebvre/chore-migrate-conf-files-to-PHP

chore: migrate configuration files to PHP and attributes

Author: alexislefebvre

.github/workflows/tests.yml

@@ -93,8 +93,8 @@ jobs:
           phpunit/phpunit=${{ matrix.phpunit-version }}
 
       # This is needed to fix builds where the `annotation_reader` service may not be set up if
-      # the Annotations package is not in the production dependencies
-      - name: Require Annotations v1/v2 to require for PHP 8+
+      # the doctrine/annotations package is not in the production dependencies
+      - name: Move doctrine/annotations v1/v2 to require (non-dev) for PHP 8+
         run: composer require --no-update "doctrine/annotations:^1.8.0|^2.0"
 
       - name: Install Composer dependencies

src/DependencyInjection/LiipFunctionalTestExtension.php

@@ -15,7 +15,7 @@
 
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
+use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 class LiipFunctionalTestExtension extends Extension
@@ -27,11 +27,11 @@ public function load(array $configs, ContainerBuilder $container): void
     {
         $config = $this->processConfiguration(new Configuration(), $configs);
 
-        $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
-        $loader->load('functional_test.xml');
+        $loader = new PhpFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $loader->load('functional_test.php');
 
         if (interface_exists('Symfony\Component\Validator\Validator\ValidatorInterface')) {
-            $loader->load('validator.xml');
+            $loader->load('validator.php');
         }
 
         foreach ($config as $key => $value) {

src/Resources/config/functional_test.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Liip/FunctionalTestBundle
+ *
+ * (c) Lukas Kahwe Smith <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+return static function (ContainerConfigurator $container) {
+    $services = $container->services();
+
+    $services->set('liip_functional_test.exception_listener', \Liip\FunctionalTestBundle\EventListener\ExceptionListener::class)
+        ->public()
+        ->tag('kernel.event_subscriber');
+
+    $services->set('liip_functional_test.query.count_client', \Liip\FunctionalTestBundle\QueryCountClient::class)
+        ->args([
+            service('kernel'),
+            '%test.client.parameters%',
+            service('test.client.history'),
+            service('test.client.cookiejar'),
+        ])
+        ->call('setQueryCounter', [service('liip_functional_test.query.counter')]);
+
+    $services->set('liip_functional_test.query.counter', \Liip\FunctionalTestBundle\QueryCounter::class)
+        ->args([
+            '%liip_functional_test.query.max_query_count%',
+            service('annotation_reader')->nullOnInvalid(),
+        ]);
+};

src/Resources/config/functional_test.xml

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Liip/FunctionalTestBundle
+ *
+ * (c) Lukas Kahwe Smith <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+return static function (ContainerConfigurator $container) {
+    $services = $container->services();
+
+    $services->set('liip_functional_test.validator', \Liip\FunctionalTestBundle\Validator\DataCollectingValidator::class)
+        ->public()
+        ->decorate('validator', 'validator.inner', 0, \Symfony\Component\DependencyInjection\ContainerInterface::IGNORE_ON_INVALID_REFERENCE)
+        ->args([service('validator.inner')->ignoreOnInvalid()])
+        ->tag('kernel.event_subscriber');
+};

src/Resources/config/validator.php

@@ -13,13 +13,26 @@
 
 namespace Liip\Acme\Tests\App\Entity;
 
+use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\Security\Core\User\UserInterface;
 
+#[
+    ORM\Entity,
+    ORM\Table(name: 'liip_user'),
+]
 class User implements UserInterface
 {
+    #[ORM\Id]
+    #[ORM\Column(type: 'integer')]
     private ?int $id = null;
+
+    #[ORM\Column(type: 'string', length: 255)]
     private string $name;
+
+    #[ORM\Column(type: 'string', length: 255)]
     private string $email;
+
+    #[ORM\Column(type: 'string', length: 255)]
     private string $salt;
 
     public function __construct()

src/Resources/config/validator.xml

@@ -36,8 +36,8 @@ doctrine:
                 connection: default
                 mappings:
                     LiipFunctionalTestBundle:
-                        type: "yml"
-                        dir: "%kernel.project_dir%/Resources/config/doctrine"
+                        type: "attribute"
+                        dir: "%kernel.project_dir%/Entity"
                         prefix: 'Liip\Acme\Tests\App\Entity'
                         is_bundle: false
 

tests/App/Entity/User.php

@@ -54,9 +54,11 @@ private function resetSchema(): void
         $commandTester = new CommandTester($command);
         $return = $commandTester->execute([
             '--force' => true,
+            '--complete' => true,
         ]);
 
         $this->assertSame(0, $return, $commandTester->getDisplay());
+        $this->assertStringNotContainsString('No Metadata Classes to process', $commandTester->getDisplay());
 
         $manager = $this->getContainer()->get('doctrine')->getManager();