Add Recipe for PHPUnit 10 #1239

alexander-schranz · 2023-09-11T23:09:13Z

Q	A
License	MIT
Doc issue/PR	symfony/symfony-docs#...

This will add a recipe for PHPUnit 10:

Following changes:

listeners do not longer exists in PHPUnit 10 where replaced by extensions
the old extensions still exists but need to be written differently
- they require bootstrap tag now: https://docs.phpunit.de/en/10.3/configuration.html#the-extensions-element and use the new event system https://docs.phpunit.de/en/10.3/extending-phpunit.html#phpunit-s-event-system (this effects maybe phpunit-bridge and panther)
move from phpunit.xml.dist to phpunit.dist.xml for better IDE support (same already done for phpstan) see also: Support dist file name phpunit.dist.xml sebastianbergmann/phpunit#4650 / sebastianbergmann/phpunit@07a022a
from cache file .phpunit.result.cache to cache directory /.phpunit.cache/
move unrelated Panther ENV vars to Panther recipe

github-actions · 2023-09-11T23:09:33Z

Thanks for the PR 😍

How to test these changes in your application

Define the SYMFONY_ENDPOINT environment variable:

# On Unix-like (BSD, Linux and macOS)
export SYMFONY_ENDPOINT=https://raw.githubusercontent.com/symfony/recipes/flex/pull-1239/index.json
# On Windows
SET SYMFONY_ENDPOINT=https://raw.githubusercontent.com/symfony/recipes/flex/pull-1239/index.json

Install the package(s) related to this recipe:

composer req 'symfony/flex:^1.16'
composer req 'phpunit/phpunit:^10.0' 'symfony/panther:^1.0'

Don't forget to unset the SYMFONY_ENDPOINT environment variable when done:

# On Unix-like (BSD, Linux and macOS)
unset SYMFONY_ENDPOINT
# On Windows
SET SYMFONY_ENDPOINT=

Diff between recipe versions

In order to help with the review stage, I'm in charge of computing the diff between the various versions of patched recipes.
I'm going keep this comment up to date with any updates of the attached patch.

phpunit/phpunit

4.7 vs 9.3

diff --git a/phpunit/phpunit/4.7/phpunit.xml.dist b/phpunit/phpunit/9.3/phpunit.xml.dist
index db2b29d..23ea5cf 100644
--- a/phpunit/phpunit/4.7/phpunit.xml.dist
+++ b/phpunit/phpunit/9.3/phpunit.xml.dist
@@ -6,12 +6,15 @@
          backupGlobals="false"
          colors="true"
          bootstrap="tests/bootstrap.php"
+         convertDeprecationsToExceptions="false"
 >
     <php>
         <ini name="display_errors" value="1" />
         <ini name="error_reporting" value="-1" />
         <server name="APP_ENV" value="test" force="true" />
         <server name="SHELL_VERBOSITY" value="-1" />
+        <server name="SYMFONY_PHPUNIT_REMOVE" value="" />
+        <server name="SYMFONY_PHPUNIT_VERSION" value="9.5" />
     </php>
 
     <testsuites>
@@ -20,11 +23,11 @@
         </testsuite>
     </testsuites>
 
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
+    <coverage processUncoveredFiles="true">
+        <include>
             <directory suffix=".php">src</directory>
-        </whitelist>
-    </filter>
+        </include>
+    </coverage>
 
     <listeners>
         <listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener" />

9.3 vs 9.6

diff --git a/phpunit/phpunit/9.3/phpunit.xml.dist b/phpunit/phpunit/9.6/phpunit.xml.dist
index 23ea5cf..6c4bfed 100644
--- a/phpunit/phpunit/9.3/phpunit.xml.dist
+++ b/phpunit/phpunit/9.6/phpunit.xml.dist
@@ -33,8 +33,6 @@
         <listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener" />
     </listeners>
 
-    <!-- Uncomment when adding extensions
     <extensions>
     </extensions>
-    -->
 </phpunit>

9.6 vs 10.0

diff --git a/phpunit/phpunit/9.6/.env.test b/phpunit/phpunit/10.0/.env.test
index 9e7162f..24a43c0 100644
--- a/phpunit/phpunit/9.6/.env.test
+++ b/phpunit/phpunit/10.0/.env.test
@@ -2,5 +2,3 @@
 KERNEL_CLASS='App\Kernel'
 APP_SECRET='$ecretf0rt3st'
 SYMFONY_DEPRECATIONS_HELPER=999999
-PANTHER_APP_ENV=panther
-PANTHER_ERROR_SCREENSHOT_DIR=./var/error-screenshots
diff --git a/phpunit/phpunit/9.6/manifest.json b/phpunit/phpunit/10.0/manifest.json
index 8af7b3b..a35670a 100644
--- a/phpunit/phpunit/9.6/manifest.json
+++ b/phpunit/phpunit/10.0/manifest.json
@@ -1,11 +1,11 @@
 {
     "copy-from-recipe": {
         ".env.test": ".env.test",
-        "phpunit.xml.dist": "phpunit.xml.dist",
+        "phpunit.dist.xml": "phpunit.dist.xml",
         "tests/": "tests/"
     },
     "gitignore": [
         "/phpunit.xml",
-        ".phpunit.result.cache"
+        "/.phpunit.cache/"
     ]
 }
diff --git a/phpunit/phpunit/9.6/phpunit.xml.dist b/phpunit/phpunit/10.0/phpunit.dist.xml
similarity index 72%
rename from phpunit/phpunit/9.6/phpunit.xml.dist
rename to phpunit/phpunit/10.0/phpunit.dist.xml
index 6c4bfed..7ca7d74 100644
--- a/phpunit/phpunit/9.6/phpunit.xml.dist
+++ b/phpunit/phpunit/10.0/phpunit.dist.xml
@@ -6,7 +6,7 @@
          backupGlobals="false"
          colors="true"
          bootstrap="tests/bootstrap.php"
-         convertDeprecationsToExceptions="false"
+         cacheDirectory=".phpunit.cache"
 >
     <php>
         <ini name="display_errors" value="1" />
@@ -14,7 +14,7 @@
         <server name="APP_ENV" value="test" force="true" />
         <server name="SHELL_VERBOSITY" value="-1" />
         <server name="SYMFONY_PHPUNIT_REMOVE" value="" />
-        <server name="SYMFONY_PHPUNIT_VERSION" value="9.5" />
+        <server name="SYMFONY_PHPUNIT_VERSION" value="10" />
     </php>
 
     <testsuites>
@@ -23,15 +23,11 @@
         </testsuite>
     </testsuites>
 
-    <coverage processUncoveredFiles="true">
+    <source restrictDeprecations="true" restrictNotices="true" restrictWarnings="true">
         <include>
-            <directory suffix=".php">src</directory>
+            <directory>src</directory>
         </include>
-    </coverage>
-
-    <listeners>
-        <listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener" />
-    </listeners>
+    </source>
 
     <extensions>
     </extensions>

alexander-schranz · 2023-09-11T23:13:50Z

symfony/panther/1.0/manifest.json

@@ -19,6 +19,20 @@
            "content": "        <extension class=\"Symfony\\Component\\Panther\\ServerExtension\" />",
            "position": "after_target",
            "target": "<extensions>",
+            "warn_if_missing": false


by renaming the phpunit.xml.dist to phpunit.dist.xml we also have the advantages that this recipe is compatible so with phpunit 9 recipe and phpunit 10 recipe

alexander-schranz · 2023-09-11T23:14:15Z

symfony/panther/1.0/manifest.json

+        },
+        {
+            "file": "phpunit.dist.xml",
+            "content": "        <bootstrap class=\"Symfony\\Component\\Panther\\ServerExtension\" />",


Panther alreadys supports PHPUnit 10: symfony/panther#589

phpunit/phpunit/10.0/phpunit.dist.xml

alexander-schranz · 2023-12-14T21:15:26Z

Anything I need to tackle here?

symfony/panther/1.0/manifest.json

Co-authored-by: ToshY <31921460+ToshY@users.noreply.github.com>

a1812 · 2024-04-19T08:58:16Z

phpunit/phpunit/10.0/tests/bootstrap.php

+
+require dirname(__DIR__).'/vendor/autoload.php';
+
+if (file_exists(dirname(__DIR__).'/config/bootstrap.php')) {


I think this is an unnecessary check

@a1812 it is required to be compatible with Symfony 4.4 because also there people can update there recipes to latest version: https://github.com/symfony/recipes/blob/main/symfony/console/4.4/config/bootstrap.php

b-durand · 2024-04-27T11:08:04Z

Hello, what are the conditions for validating this request? New Symfony projects don't have a valid default configuration.

symfony-recipes-bot enabled auto-merge (squash) September 11, 2023 23:09

auto-merge was automatically disabled September 11, 2023 23:10
Head branch was pushed to by a user without write access

alexander-schranz force-pushed the feature/add-phpunit-10-support branch from 3a804c4 to e470d73 Compare September 11, 2023 23:10

symfony-recipes-bot enabled auto-merge (squash) September 11, 2023 23:10

Add Recipe for PHPUnit 10

8530d29

auto-merge was automatically disabled September 11, 2023 23:12
Head branch was pushed to by a user without write access

alexander-schranz force-pushed the feature/add-phpunit-10-support branch from e470d73 to 8530d29 Compare September 11, 2023 23:12

symfony-recipes-bot enabled auto-merge (squash) September 11, 2023 23:13

alexander-schranz commented Sep 11, 2023

View reviewed changes

OskarStark disabled auto-merge October 7, 2023 10:07

derrabus previously approved these changes Nov 5, 2023

View reviewed changes

OskarStark reviewed Nov 5, 2023

View reviewed changes

phpunit/phpunit/10.0/phpunit.dist.xml Outdated Show resolved Hide resolved

Update phpunit.dist.xml SYMFONY_PHPUNIT_VERSION to 10

7a4e09a

alexander-schranz dismissed derrabus’s stale review via 7a4e09a November 6, 2023 06:40

symfony-recipes-bot enabled auto-merge (squash) November 6, 2023 06:40

ToshY reviewed Dec 14, 2023

View reviewed changes

symfony/panther/1.0/manifest.json Outdated Show resolved Hide resolved

auto-merge was automatically disabled December 15, 2023 08:10
Head branch was pushed to by a user without write access

Update symfony/panther/1.0/manifest.json

8a8f244

Co-authored-by: ToshY <31921460+ToshY@users.noreply.github.com>

symfony-recipes-bot enabled auto-merge (squash) December 15, 2023 08:10

a1812 reviewed Apr 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Recipe for PHPUnit 10 #1239

Add Recipe for PHPUnit 10 #1239

alexander-schranz commented Sep 11, 2023 •

edited

github-actions bot commented Sep 11, 2023 •

edited

alexander-schranz Sep 11, 2023 •

edited

alexander-schranz Sep 11, 2023

alexander-schranz commented Dec 14, 2023

a1812 Apr 19, 2024

alexander-schranz Apr 19, 2024

b-durand commented Apr 27, 2024


		require dirname(__DIR__).'/vendor/autoload.php';

		if (file_exists(dirname(__DIR__).'/config/bootstrap.php')) {

Add Recipe for PHPUnit 10 #1239

Are you sure you want to change the base?

Add Recipe for PHPUnit 10 #1239

Conversation

alexander-schranz commented Sep 11, 2023 • edited

github-actions bot commented Sep 11, 2023 • edited

How to test these changes in your application

Diff between recipe versions

phpunit/phpunit

alexander-schranz Sep 11, 2023 • edited

Choose a reason for hiding this comment

alexander-schranz Sep 11, 2023

Choose a reason for hiding this comment

alexander-schranz commented Dec 14, 2023

a1812 Apr 19, 2024

Choose a reason for hiding this comment

alexander-schranz Apr 19, 2024

Choose a reason for hiding this comment

b-durand commented Apr 27, 2024

alexander-schranz commented Sep 11, 2023 •

edited

github-actions bot commented Sep 11, 2023 •

edited

alexander-schranz Sep 11, 2023 •

edited