Upgrade PHPUnit and add PHP 8.4 to CI (#391)

sulu · Jul 24, 2024 · 91b7157 · 91b7157
1 parent f5db9a5
commit 91b7157
Show file tree

Hide file tree

Showing 14 changed files with 101 additions and 30 deletions.
diff --git a/.github/workflows/test-application.yaml b/.github/workflows/test-application.yaml
@@ -20,6 +20,7 @@ jobs:
                       database: postgres
                       dependency-versions: 'lowest'
                       tools: 'composer:v2'
+                      phpunit-config: 'phpunit-9.xml.dist'
                       env:
                           SYMFONY_DEPRECATIONS_HELPER: disabled
                           DATABASE_URL: postgres://postgres:[email protected]/sulu_form_test?serverVersion=12.5
@@ -30,6 +31,7 @@ jobs:
                       database: mysql
                       dependency-versions: 'highest'
                       tools: 'composer:v2'
+                      phpunit-config: 'phpunit-9.xml.dist'
                       env:
                           SYMFONY_DEPRECATIONS_HELPER: weak
                           DATABASE_URL: mysql://root:[email protected]/sulu_form_test?serverVersion=5.7
@@ -57,6 +59,16 @@ jobs:
                           DATABASE_COLLATE: utf8mb4_unicode_ci
 
                     - php-version: '8.2'
+                      database: postgres
+                      dependency-versions: 'highest'
+                      tools: 'composer:v2'
+                      env:
+                          SYMFONY_DEPRECATIONS_HELPER: weak
+                          DATABASE_URL: postgres://postgres:[email protected]/sulu_form_test?serverVersion=12.5
+                          DATABASE_CHARSET: UTF8
+                          DATABASE_COLLATE:
+
+                    - php-version: '8.3'
                       database: mysql
                       dependency-versions: 'highest'
                       tools: 'composer:v2'
@@ -66,10 +78,11 @@ jobs:
                           DATABASE_CHARSET: utf8mb4
                           DATABASE_COLLATE: utf8mb4_unicode_ci
 
-                    - php-version: '8.3'
+                    - php-version: '8.4'
                       database: mysql
                       dependency-versions: 'highest'
                       tools: 'composer:v2'
+                      composer-options: '--ignore-platform-reqs'
                       env:
                           SYMFONY_DEPRECATIONS_HELPER: weak
                           DATABASE_URL: mysql://root:[email protected]/sulu_form_test?serverVersion=5.7
@@ -96,7 +109,7 @@ jobs:
 
         steps:
             - name: Checkout project
-              uses: actions/checkout@v2
+              uses: actions/checkout@v4
 
             - name: Install and configure PHP
               uses: shivammathur/setup-php@v2
@@ -106,11 +119,13 @@ jobs:
                   tools: ${{ matrix.tools }}
                   coverage: none
 
-            - name: Remove not required tooling for tests
-              run: composer remove php-cs-fixer/shim "*phpstan*" --dev --no-update
+            - name: Remove Lint Tools
+              # These tools are not required to run tests, so we are removing them to improve dependency resolving and
+              # testing lowest versions.
+              run: composer remove "*php-cs-fixer*" "*phpstan*" "*rector*" --dev --no-update
 
             - name: Install composer dependencies
-              uses: ramsey/composer-install@v1
+              uses: ramsey/composer-install@v2
               with:
                   dependency-versions: ${{matrix.dependency-versions}}
                   composer-options: ${{ matrix.composer-options }}
@@ -120,7 +135,7 @@ jobs:
               env: ${{ matrix.env }}
 
             - name: Execute test cases
-              run: time composer test
+              run: time composer test -- --config ${{ matrix.phpunit-config || 'phpunit.xml.dist' }}
               env: ${{ matrix.env }}
 
     lint:
@@ -131,18 +146,18 @@ jobs:
 
         steps:
             - name: Checkout project
-              uses: actions/checkout@v2
+              uses: actions/checkout@v4
 
             - name: Install and configure PHP
               uses: shivammathur/setup-php@v2
               with:
-                  php-version: 8.1
+                  php-version: 8.3
                   extensions: 'imagick'
                   tools: 'composer:v2'
                   coverage: none
 
             - name: Install composer dependencies
-              uses: ramsey/composer-install@v1
+              uses: ramsey/composer-install@v2
               with:
                   dependency-versions: ${{matrix.dependency-versions}}
                   composer-options: ${{ matrix.composer-options }}

diff --git a/Command/FormGeneratorCommand.php b/Command/FormGeneratorCommand.php
@@ -22,8 +22,6 @@
 
 class FormGeneratorCommand extends Command
 {
-    protected static $defaultName = 'sulu:form:generate-form';
-
     /**
      * @var EntityManagerInterface
      */
@@ -38,7 +36,7 @@ public function __construct(
         EntityManagerInterface $entityManager,
         WebspaceManagerInterface $webspaceManager
     ) {
-        parent::__construct(static::$defaultName);
+        parent::__construct('sulu:form:generate-form');
         $this->entityManager = $entityManager;
         $this->webspaceManager = $webspaceManager;
     }

diff --git a/Tests/Application/config/bootstrap.php b/Tests/Application/config/bootstrap.php
@@ -21,6 +21,10 @@
 
 require $file;
 
+if (!\trait_exists(Prophecy\PhpUnit\ProphecyTrait::class)) { // backwards compatibility layer for < PHP 7.3
+    require __DIR__ . '/../../prophecy-trait-bc-layer.php';
+}
+
 // Load cached env vars if the .env.local.php file exists
 // Run "composer dump-env prod" to create it (requires symfony/flex >=1.2)
 if (\is_array($env = @include \dirname(__DIR__) . '/.env.local.php')) {

diff --git a/Tests/Functional/Mail/HelperTestCase.php b/Tests/Functional/Mail/HelperTestCase.php
@@ -33,8 +33,6 @@ class HelperTestCase extends SuluTestCase
 
     protected function setUp(): void
     {
-        static::$kernel = null; // requires as Symfony 4.4 does not unset on tearDown
-
         $this->client = $this->createWebsiteClient();
         $this->purgeDatabase();
         $this->initPhpcr();

diff --git a/Tests/Functional/Metadata/DynamicFormMetadataLoaderTest.php b/Tests/Functional/Metadata/DynamicFormMetadataLoaderTest.php
@@ -238,8 +238,8 @@ public function testGetMetadataAttachmentEnglish(): void
         $this->assertEquals('number', $attachment->getItems()['options/max']->getType());
         $this->assertEquals(6, $attachment->getItems()['options/max']->getColspan());
 
-        $this->assertObjectHasAttribute('schema', $attachment);
-        $this->assertObjectHasAttribute('key', $attachment);
+        $this->assertTrue(\property_exists($attachment, 'schema'));
+        $this->assertTrue(\property_exists($attachment, 'key'));
     }
 
     public function testGetMetadataAttachmentGerman(): void

diff --git a/Tests/Unit/Configuration/FormConfigurationFactoryTest.php b/Tests/Unit/Configuration/FormConfigurationFactoryTest.php
@@ -12,6 +12,7 @@
 namespace Sulu\Bundle\FormBundle\Tests\Unit\Configuration;
 
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Sulu\Bundle\FormBundle\Configuration\FormConfigurationFactory;
 use Sulu\Bundle\FormBundle\Configuration\MailConfigurationInterface;
 use Sulu\Bundle\FormBundle\Entity\Dynamic;
@@ -26,6 +27,8 @@
  */
 class FormConfigurationFactoryTest extends TestCase
 {
+    use ProphecyTrait;
+
     public function testBuildByDynamic(): void
     {
         $dynamic = $this->createDynamic();

diff --git a/Tests/Unit/Event/ProtectedMediaSubscriberTest.php b/Tests/Unit/Event/ProtectedMediaSubscriberTest.php
@@ -15,6 +15,7 @@
 use Doctrine\ORM\QueryBuilder;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Sulu\Bundle\FormBundle\Event\ProtectedMediaSubscriber;
 use Sulu\Bundle\FormBundle\Tests\Application\Kernel;
@@ -29,6 +30,8 @@
 
 class ProtectedMediaSubscriberTest extends TestCase
 {
+    use ProphecyTrait;
+
     /**
      * @var EntityManagerInterface|ObjectProphecy
      */

diff --git a/Tests/Unit/Event/SendinblueListSubscriberTest.php b/Tests/Unit/Event/SendinblueListSubscriberTest.php
@@ -15,6 +15,7 @@
 use GuzzleHttp\Psr7\Response;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Http\Message\RequestInterface;
 use Sulu\Bundle\FormBundle\Configuration\FormConfiguration;
@@ -33,6 +34,8 @@
 
 class SendinblueListSubscriberTest extends TestCase
 {
+    use ProphecyTrait;
+
     /**
      * @var RequestStack
      */

diff --git a/Tests/Unit/Mail/MailerHelperTest.php b/Tests/Unit/Mail/MailerHelperTest.php
@@ -12,6 +12,7 @@
 namespace Sulu\Bundle\FormBundle\Tests\Unit\Mail;
 
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Log\LoggerInterface;
 use Sulu\Bundle\FormBundle\Mail\MailerHelper;
@@ -27,6 +28,8 @@
  */
 class MailerHelperTest extends TestCase
 {
+    use ProphecyTrait;
+
     /**
      * @var MailerHelper
      */

diff --git a/Tests/prophecy-trait-bc-layer.php b/Tests/prophecy-trait-bc-layer.php
@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of Sulu.
+ *
+ * (c) Sulu GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Prophecy\PhpUnit;
+
+/**
+ * @internal
+ */
+trait ProphecyTrait
+{
+}
diff --git a/composer.json b/composer.json
@@ -45,11 +45,12 @@
         "massive/search-bundle": "^2.0",
         "php-cs-fixer/shim": "^3.0",
         "phpspec/prophecy": "^1.14",
+        "phpspec/prophecy-phpunit": "^1.0 || ^2.0",
         "phpstan/phpstan": "^1.0",
         "phpstan/phpstan-doctrine": "^1.0",
         "phpstan/phpstan-phpunit": "^1.0",
         "phpstan/phpstan-symfony": "^1.0",
-        "phpunit/phpunit": "^8.0",
+        "phpunit/phpunit": "^8.5.39 || ^9.6.20 || ^10.0",
         "sendinblue/api-v3-sdk": "^8.0",
         "symfony/browser-kit": "^4.4 || ^5.0 || ^6.0 || ^7.0",
         "symfony/dotenv": "^4.4 || ^5.0 || ^6.0 || ^7.0",

diff --git a/phpstan.neon b/phpstan.neon
@@ -16,6 +16,7 @@ parameters:
         - %currentWorkingDirectory%/vendor/*
         - %currentWorkingDirectory%/Tests/*
         - %currentWorkingDirectory%/DependencyInjection/Configuration.php
+        - %currentWorkingDirectory%/Tests/prophecy-trait-bc-layer.php
     symfony:
         container_xml_path: %rootDir%/../../../Tests/Application/var/cache/admin/dev/Sulu_Bundle_FormBundle_Tests_Application_KernelDevDebugContainer.xml
         console_application_loader: Tests/phpstan/console-application.php

diff --git a/phpunit-9.xml.dist b/phpunit-9.xml.dist
@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit colors="true" bootstrap="Tests/test-bootstrap.php">
+   <testsuites>
+        <testsuite name="Sulu Form Bundle">
+            <directory>./Tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist addUncoveredFilesFromWhitelist="true">
+            <directory>.</directory>
+            <exclude>
+                <directory>Resources/</directory>
+                <directory>Tests/</directory>
+                <directory>vendor/</directory>
+            </exclude>
+        </whitelist>
+    </filter>
+
+    <php>
+        <env name="KERNEL_CLASS" value="Sulu\Bundle\FormBundle\Tests\Application\Kernel"/>
+        <env name="APP_ENV" value="test" force="true"/>
+    </php>
+</phpunit>
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,25 +1,24 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit colors="true" bootstrap="Tests/test-bootstrap.php">
-   <testsuites>
+    <testsuites>
         <testsuite name="Sulu Form Bundle">
             <directory>./Tests</directory>
         </testsuite>
     </testsuites>
 
-    <filter>
-        <whitelist addUncoveredFilesFromWhitelist="true">
-            <directory>.</directory>
-            <exclude>
-                <directory>Resources/</directory>
-                <directory>Tests/</directory>
-                <directory>vendor/</directory>
-            </exclude>
-        </whitelist>
-    </filter>
-
     <php>
         <env name="KERNEL_CLASS" value="Sulu\Bundle\FormBundle\Tests\Application\Kernel"/>
         <env name="APP_ENV" value="test" force="true"/>
-        <env name="SYMFONY_DEPRECATIONS_HELPER" value="weak"/>
     </php>
+
+    <source>
+        <include>
+            <directory>./</directory>
+        </include>
+        <exclude>
+            <directory>Resources/</directory>
+            <directory>Tests/</directory>
+            <directory>vendor/</directory>
+        </exclude>
+    </source>
 </phpunit>