Merge pull request #648 from haeber/master

alexislefebvre · web-flow · commit a36b57ece821 · 2025-10-22T20:12:01.000+02:00
add PHPUnit 12 compatibility; typos; PHP 8.4 compatibility; some cleanup; drop PHP 7.4
diff --git a/.github/workflows/qa.yml b/.github/workflows/qa.yml
@@ -14,7 +14,7 @@ jobs:
         run: rm -v composer.json
 
       - name: PHP-CS-Fixer
-        uses: docker://jakzal/phpqa:1.58.7-php7.4-alpine
+        uses: docker://jakzal/phpqa:1.58.7-php8.0-alpine
         with:
           args: php-cs-fixer --dry-run --diff --no-interaction --ansi fix
 
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -17,7 +17,7 @@ jobs:
         symfony-version: ['^6.4']
         phpunit-version: ['^9.6']
         include:
-          - php-version: 7.4
+          - php-version: 8.0
             symfony-version: "^5.4"
             phpunit-version: '^9.6'
             composer-flags: "--prefer-lowest"
@@ -48,6 +48,9 @@ jobs:
           - php-version: 8.4
             symfony-version: "^7.0"
             phpunit-version: "^11.0"
+          - php-version: 8.4
+            symfony-version: "^7.0"
+            phpunit-version: "^12.0"
 
     steps:
       - name: Checkout
@@ -88,12 +91,7 @@ jobs:
 
       # 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 to require for PHP 7
-        if: startsWith(matrix.php-version, '7.')
-        run: composer require --no-update "doctrine/annotations:^1.8.0"
-
       - name: Require Annotations v1/v2 to require for PHP 8+
-        if: startsWith(matrix.php-version, '7.') != true
         run: composer require --no-update "doctrine/annotations:^1.8.0|^2.0"
 
       - name: Install Composer dependencies
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,7 @@
 composer.lock
 vendor
 .php_cs.cache
+.idea
 
 # Ignore files created during tests
 /cov/
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,9 @@
 
 Removed features deprecated in [4.6](#46)
 
+## 4.14
+Drop support for PHP 7.4 (it does not support Attributes, which are obligatory for compatibility with PHPUnit 12)
+
 ## 4.10
 
 Drop support for php 7.2, 7.3
diff --git a/composer.json b/composer.json
@@ -7,16 +7,16 @@
     "authors": [
         {
             "name": "Liip AG",
-            "homepage": "http://www.liip.ch/"
+            "homepage": "https://www.liip.ch/"
         },
         {
             "name": "Community contributions",
             "homepage": "https://github.com/liip/LiipFunctionalTestBundle/contributors"
         }
     ],
     "require": {
-        "php": "^7.4 || ^8.0",
-        "phpunit/phpunit": "^9.6 || ^10.0 || ^11.0",
+        "php": "^8.0",
+        "phpunit/phpunit": "^9.6 || ^10.0 || ^11.0 || ^12.0",
         "symfony/browser-kit": "^5.4 || ^6.4 || ^7.0",
         "symfony/framework-bundle": "^5.4 || ^6.4 || ^7.0"
     },
diff --git a/doc/basic.md b/doc/basic.md
@@ -140,7 +140,7 @@ class MyControllerTest extends WebTestCase
 
 ##### fetchCrawler()
 
-Get a [Crawler](http://api.symfony.com/master/Symfony/Component/DomCrawler/Crawler.html) instance from an URL:
+Get a [Crawler](http://api.symfony.com/master/Symfony/Component/DomCrawler/Crawler.html) instance from a URL:
 
 ```php
 $crawler = $this->fetchCrawler('/contact');
@@ -176,7 +176,7 @@ class MyControllerTest extends WebTestCase
 
 ##### fetchContent()
 
-Get the content of an URL:
+Get the content of a URL:
 
 ```php
 $content = $this->fetchContent('/contact');
@@ -213,7 +213,7 @@ class MyControllerTest extends WebTestCase
 
 ##### getURL()
 
-Generate an URL from a route:
+Generate a URL from a route:
 
 ```php
 $path = $this->getUrl(
diff --git a/doc/caveats.md b/doc/caveats.md
@@ -45,11 +45,11 @@ AnnotationRegistry::registerLoader([$loader, 'loadClass']);
 AnnotationReader::addGlobalIgnoredName('group');
 ```
 
-Set path to this file in your PHPUnit configuration file (eg. `phpunit.xml.dist`):
+Set path to this file in your PHPUnit configuration file (e.g. `phpunit.xml.dist`):
 
 ```xml
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/6.5/phpunit.xsd"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.6/phpunit.xsd"
     bootstrap="tests/bootstrap.php"
     …
 >
diff --git a/doc/command.md b/doc/command.md
@@ -24,7 +24,7 @@ class MyTestCase extends WebTestCase {
 }
 ```
 
-Depending where your tests are running, you might want to disable the output
+Depending on where your tests are running, you might want to disable the output
 decorator:
 ```yaml
 # app/config/config_test.yml
diff --git a/doc/fastest.md b/doc/fastest.md
@@ -47,6 +47,6 @@ You can use the following command:
 find src/*/*/Tests/ -name "*Test.php" | vendor/bin/fastest "vendor/bin/phpunit -c app/phpunit.xml.dist {};"
 ```
 
-Otherwise you'll have to adapt the paths.
+Otherwise, you'll have to adapt the paths.
 
 ← [Caveats](./caveats.md)
diff --git a/doc/logged.md b/doc/logged.md
@@ -4,7 +4,7 @@ Create an already logged client
 > [!TIP]
 > Some methods provided by this bundle have been implemented in Symfony. Alternative ways will be shown below.
 
-The `WebTestCase` provides a conveniency method to create an already logged in client using the first parameter of
+The `WebTestCase` provides a convenience method to create an already logged in client using the first parameter of
 `WebTestCase::makeClient()`.
 
 You have three alternatives to create an already logged in client:
@@ -77,14 +77,14 @@ framework:
 ### Recommendations to use already logged in clients
 
 As [recommended by the Symfony Cookbook](http://symfony.com/doc/current/cookbook/testing/http_authentication.html) in
-the chapter about Testing, it is a good idea to to use HTTP Basic Auth for you tests. You can configure the
+the chapter about Testing, it is a good idea to use HTTP Basic Auth for you tests. You can configure the
 authentication method in your `config_test.yml`:
 
 ```yaml
 # The best practice in symfony is to put a HTTP basic auth
 # for the firewall in test env, so that not to have to
 # make a request to the login form every single time.
-# http://symfony.com/doc/current/cookbook/testing/http_authentication.html
+# https://symfony.com/doc/current/cookbook/testing/http_authentication.html
 security:
     firewalls:
         NAME_OF_YOUR_FIREWALL:
diff --git a/src/QueryCountClientTrait.php b/src/QueryCountClientTrait.php
@@ -28,7 +28,7 @@ public function request(
         array $parameters = [],
         array $files = [],
         array $server = [],
-        string $content = null,
+        ?string $content = null,
         bool $changeHistory = true
     ): Crawler {
         $crawler = parent::request($method, $uri, $parameters, $files, $server, $content, $changeHistory);
diff --git a/src/QueryCounter.php b/src/QueryCounter.php
@@ -45,11 +45,7 @@ private function getMaxQueryCount(): ?int
     {
         $maxQueryCount = $this->getMaxQueryAnnotation();
 
-        if (null !== $maxQueryCount) {
-            return $maxQueryCount;
-        }
-
-        return $this->defaultMaxCount;
+        return $maxQueryCount ?? $this->defaultMaxCount;
     }
 
     private function getMaxQueryAnnotation(): ?int
diff --git a/src/Resources/config/functional_test.xml b/src/Resources/config/functional_test.xml
@@ -2,7 +2,7 @@
 
 <container xmlns="http://symfony.com/schema/dic/services"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd">
 
     <services>
         <service id="liip_functional_test.exception_listener" class="Liip\FunctionalTestBundle\EventListener\ExceptionListener" public="true">
diff --git a/src/Resources/config/validator.xml b/src/Resources/config/validator.xml
@@ -2,7 +2,7 @@
 
 <container xmlns="http://symfony.com/schema/dic/services"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+           xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd">
 
     <services>
         <service id="liip_functional_test.validator"
diff --git a/src/Test/WebTestCase.php b/src/Test/WebTestCase.php
@@ -366,7 +366,7 @@ protected function makeClientWithCredentials(string $username, string $password,
      * Create User Token.
      *
      * Factory method for creating a User Token object for the firewall based on
-     * the user object provided. By default it will be a Username/Password
+     * the user object provided. By default, it will be a Username/Password
      * Token based on the user's credentials, but may be overridden for custom
      * tokens in your applications.
      *
@@ -464,8 +464,6 @@ public function fetchCrawler(string $path, string $method = 'GET', bool $authent
 
     /**
      * @deprecated
-     *
-     * @return WebTestCase
      */
     public function loginAs(UserInterface $user, string $firewallName): self
     {
@@ -631,7 +629,7 @@ private function getSession(KernelBrowser $client): SessionInterface
             // see https://github.com/symfony/symfony-docs/pull/14898/files#diff-29ab32502d95be802fed1001850b76c9624912cf4c299101d3ecaf17b0352562R37
             try {
                 $session = $requestStack->getSession();
-            } catch (SessionNotFoundException $e) {
+            } catch (SessionNotFoundException) {
                 $requestStack->push(new Request());
                 $session = new Session();
                 $session->start();
diff --git a/tests/App/AppKernel.php b/tests/App/AppKernel.php
@@ -14,13 +14,17 @@
 namespace Liip\Acme\Tests\App;
 
 use Symfony\Component\Config\Loader\LoaderInterface;
+use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\Component\HttpKernel\Kernel;
 
 class AppKernel extends Kernel
 {
+    /**
+     * @return Bundle[]
+     */
     public function registerBundles(): array
     {
-        $bundles = [
+        return [
             new \Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
             new \Symfony\Bundle\SecurityBundle\SecurityBundle(),
             new \Symfony\Bundle\TwigBundle\TwigBundle(),
@@ -29,8 +33,6 @@ public function registerBundles(): array
             new \Liip\FunctionalTestBundle\LiipFunctionalTestBundle(),
             new \Liip\Acme\Tests\App\AcmeBundle(),
         ];
-
-        return $bundles;
     }
 
     public function registerContainerConfiguration(LoaderInterface $loader): void
diff --git a/tests/Command/CommandConfigTest.php b/tests/Command/CommandConfigTest.php
@@ -29,6 +29,13 @@ class CommandConfigTest extends WebTestCase
 {
     private $commandTester;
 
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+
+        restore_exception_handler();
+    }
+
     protected static function getKernelClass(): string
     {
         return AppConfigKernel::class;
diff --git a/tests/Command/CommandTest.php b/tests/Command/CommandTest.php
@@ -14,6 +14,7 @@
 namespace Liip\Acme\Tests\Command;
 
 use Liip\FunctionalTestBundle\Test\WebTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Tester\CommandTester;
 
@@ -73,6 +74,7 @@ public function testRunCommandWithInputs(): void
     /**
      * @dataProvider useEnvProvider
      */
+    #[DataProvider('useEnvProvider')]
     public function testRunCommandWithoutOptionsAndNotReuseKernel(bool $useEnv): void
     {
         if ($useEnv) {
@@ -272,5 +274,6 @@ protected function tearDown(): void
         parent::tearDown();
 
         unset($this->commandTester);
+        restore_exception_handler();
     }
 }
diff --git a/tests/DependencyInjection/Compiler/SetTestClientPassMockTest.php b/tests/DependencyInjection/Compiler/SetTestClientPassMockTest.php
@@ -49,7 +49,7 @@ public function testSetTestClientPassElse(): void
             ->willReturn(false);
 
         try {
-            $setTestClientPass = new SetTestClientPass($container);
+            $setTestClientPass = new SetTestClientPass();
             $setTestClientPass->process($container);
         } catch (\Exception $e) {
             $this->assertSame(
diff --git a/tests/DependencyInjection/ConfigurationTest.php b/tests/DependencyInjection/ConfigurationTest.php
@@ -14,6 +14,7 @@
 namespace Liip\Acme\Tests\DependencyInjection;
 
 use Liip\FunctionalTestBundle\Test\WebTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
@@ -29,13 +30,21 @@ protected function setUp(): void
         $this->clientContainer = $client->getContainer();
     }
 
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+
+        restore_exception_handler();
+    }
+
     /**
      * @dataProvider parametersProvider
      *
      * @param string $node  Array key from parametersProvider
-     * @param string $value Array value from parametersProvider
+     * @param mixed  $value Array value from parametersProvider
      */
-    public function testParameter($node, $value): void
+    #[DataProvider('parametersProvider')]
+    public function testParameter(string $node, $value): void
     {
         $name = 'liip_functional_test.'.$node;
 
diff --git a/tests/Test/WebTestCaseConfigLeanFrameworkTest.php b/tests/Test/WebTestCaseConfigLeanFrameworkTest.php
@@ -28,6 +28,13 @@
  */
 class WebTestCaseConfigLeanFrameworkTest extends WebTestCase
 {
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+
+        restore_exception_handler();
+    }
+
     protected static function getKernelClass(): string
     {
         return AppConfigLeanFrameworkKernel::class;
diff --git a/tests/Test/WebTestCaseConfigTest.php b/tests/Test/WebTestCaseConfigTest.php
@@ -49,7 +49,7 @@ protected static function getKernelClass(): string
     }
 
     /**
-     * Log in as an user.
+     * Log in as a user.
      */
     public function testIndexClientWithCredentials(): void
     {
@@ -115,7 +115,7 @@ public function testIndexAuthenticatedClient(): void
     /**
      * Log in as the user defined in the Data Fixture.
      *
-     * loginAs() is deprecated but we test if for Backward Compatibility.
+     * loginAs() is deprecated, but we test if for Backward Compatibility.
      */
     public function testIndexAuthenticationLoginAs(): void
     {
diff --git a/tests/Test/WebTestCaseTest.php b/tests/Test/WebTestCaseTest.php

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class MyTestCase extends WebTestCase {`
`24`	`24`	`}`
`25`	`25`	```
`26`	`26`
`27`		`-Depending where your tests are running, you might want to disable the output`
	`27`	`+Depending on where your tests are running, you might want to disable the output`
`28`	`28`	`decorator:`
`29`	`29`	```yaml
`30`	`30`	`# app/config/config_test.yml`