PHPUnit: add separate configuration for PHPUnit 10

PHPUnit 10 makes significant changes to the configuration file.

Most notably:
* In PHPUnit 9.3, the manner of specifying the code coverage configuration has changed.
* In PHPUnit 10.0, a significant number of attributes of the `<phpunit>` element were removed or renamed.
* In PHPUnit 10.1, the manner of specifying code coverage has changed again.

While there is a `--migrate-configuration` option available in PHPUnit, that doesn't get us a well enough converted configuration file, so instead use a separate `phpunit10.xml.dist` file for running the tests on PHPUnit 10 with an optimal configuration.

Includes:
* Ignoring the new file for package archives.
* Adding separate scripts to the `composer.json` file to make how to run the tests on PHPUnit 10 more obvious for contributors.
* Updating the GH Actions workflows to take the new configuration file into account when appropriate.

Author: jrfnl

.gitattributes

@@ -9,3 +9,4 @@ tests/ export-ignore
 .phpcs.xml.dist export-ignore
 phpdoc.dist.xml export-ignore
 phpunit.xml.dist export-ignore
+phpunit10.xml.dist export-ignore

.github/workflows/quicktest.yml

@@ -90,12 +90,18 @@ jobs:
       - name: Access localhost on port 9002
         run: curl -i http://localhost:9002
 
-      - name: Show PHPUnit version
-        run: vendor/bin/phpunit --version
+      - name: Grab PHPUnit version
+        id: phpunit_version
+        run: echo "VERSION=$(vendor/bin/phpunit --version | grep --only-matching --max-count=1 --extended-regexp '\b[0-9]+\.[0-9]+')" >> $GITHUB_OUTPUT
 
-      - name: Run the unit tests
+      - name: Run the unit tests (PHPUnit < 10)
+        if: ${{ ! startsWith( steps.phpunit_version.outputs.VERSION, '10.' ) }}
         run: composer test
 
+      - name: Run the unit tests (PHPUnit 10+)
+        if: ${{ startsWith( steps.phpunit_version.outputs.VERSION, '10.' ) }}
+        run: composer test10
+
       - name: Stop proxy server
         continue-on-error: true
         run: |

.github/workflows/test.yml

@@ -114,16 +114,25 @@ jobs:
       - name: Access localhost on port 9002
         run: curl -i http://localhost:9002
 
-      - name: Show PHPUnit version
-        run: vendor/bin/phpunit --version
+      - name: Grab PHPUnit version
+        id: phpunit_version
+        run: echo "VERSION=$(vendor/bin/phpunit --version | grep --only-matching --max-count=1 --extended-regexp '\b[0-9]+\.[0-9]+')" >> $GITHUB_OUTPUT
 
-      - name: Run the unit tests, no code coverage
-        if: ${{ matrix.coverage == false }}
+      - name: Run the unit tests, no code coverage (PHPUnit < 10)
+        if: ${{  matrix.coverage == false && ! startsWith( steps.phpunit_version.outputs.VERSION, '10.' ) }}
         run: composer test
 
-      - name: Run the unit tests with code coverage
-        if: ${{ matrix.coverage == true }}
-        run: vendor/bin/phpunit --coverage-clover clover.xml
+      - name: Run the unit tests, no code coverage (PHPUnit 10+)
+        if: ${{  matrix.coverage == false && startsWith( steps.phpunit_version.outputs.VERSION, '10.' ) }}
+        run: composer test10
+
+      - name: Run the unit tests with code coverage (PHPUnit < 10)
+        if: ${{  matrix.coverage == true && ! startsWith( steps.phpunit_version.outputs.VERSION, '10.' ) }}
+        run: composer coverage -- --coverage-clover clover.xml
+
+      - name: Run the unit tests with code coverage (PHPUnit 10+)
+        if: ${{  matrix.coverage == true && startsWith( steps.phpunit_version.outputs.VERSION, '10.' ) }}
+        run: composer coverage10 -- --coverage-clover clover.xml
 
       - name: Stop proxy server
         continue-on-error: true

composer.json

@@ -84,8 +84,14 @@
     "test": [
       "@php ./vendor/phpunit/phpunit/phpunit --no-coverage"
     ],
+    "test10": [
+      "@php ./vendor/phpunit/phpunit/phpunit -c phpunit10.xml.dist --no-coverage"
+    ],
     "coverage": [
       "@php ./vendor/phpunit/phpunit/phpunit"
+    ],
+    "coverage10": [
+      "@php ./vendor/phpunit/phpunit/phpunit -c phpunit10.xml.dist"
     ]
   }
 }

phpunit.xml.dist

@@ -4,6 +4,7 @@
 	xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/7.5/phpunit.xsd"
 	backupGlobals="true"
 	bootstrap="tests/bootstrap.php"
+	beStrictAboutTestsThatDoNotTestAnything="true"
 	convertDeprecationsToExceptions="true"
 	colors="true"
 	verbose="true"

phpunit10.xml.dist

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/10.1/phpunit.xsd"
+	backupGlobals="true"
+	bootstrap="tests/bootstrap.php"
+	beStrictAboutTestsThatDoNotTestAnything="true"
+	colors="true"
+	displayDetailsOnTestsThatTriggerErrors="true"
+	displayDetailsOnTestsThatTriggerWarnings="true"
+	displayDetailsOnTestsThatTriggerNotices="true"
+	displayDetailsOnTestsThatTriggerDeprecations="true"
+	displayDetailsOnIncompleteTests="true"
+	displayDetailsOnSkippedTests="true"
+	failOnWarning="true"
+	failOnNotice="true"
+	failOnDeprecation="true"
+	>
+	<testsuites>
+		<testsuite name="RequestsTests">
+			<directory suffix="Test.php">tests</directory>
+		</testsuite>
+	</testsuites>
+
+	<source>
+		<include>
+			<directory suffix=".php">./src/</directory>
+		</include>
+	</source>
+
+	<coverage includeUncoveredFiles="true" ignoreDeprecatedCodeUnits="true">
+		<report>
+			<html outputDirectory="tests/coverage" lowUpperBound="35" highLowerBound="90"/>
+		</report>
+	</coverage>
+</phpunit>