Tests: minor tweaks

The tests for PHPCS 4.x already run on PHPUnit 8.x and 9.x, these are just some small tweaks/simplifications which were not made before, but have now been made in the 3.x branch when enabling the test suite to run on PHPUnit 8.x and 9.x.

Author: jrfnl

.github/CONTRIBUTING.md

@@ -137,7 +137,6 @@ Note: There may be an issue or PR open already. If so, please join the discussio
 
 1. Fork/clone the repository.
 2. Run `composer install`.
-    When installing on PHP >= 8.0, use `composer install --ignore-platform-req=php+`.
 3. Create a new branch off the `master` branch to hold your patch.
     If there is an open issue associated with your patch, including the issue number in the branch name is good practice.
 
@@ -152,10 +151,8 @@ To help you with this, a number of convenience scripts are available:
 * `composer check-all` will run the `cs` + `test` checks in one go.
 * `composer cs` will check for code style violations.
 * `composer cbf` will run the autofixers for code style violations.
-* `composer test` will run the unit tests (only works when on PHP < 8.1).
-* `composer test-php8` will run the unit tests when you are working on PHP 8.1+.
-    Please note that using a `phpunit.xml` overload config file will not work with this script!
-* `composer coverage` will run the unit tests with code coverage (only works when on PHP < 8.1).
+* `composer test` will run the unit tests.
+* `composer coverage` will run the unit tests with code coverage.
     Note: you may want to use a custom `phpunit.xml` overload config file to tell PHPUnit where to place an HTML report.
     Alternative run it like so: `composer coverage -- --coverage-html /path/to/report-dir/` to specify the location for the HTML report on the command line.
 * `composer build` will build the phpcs.phar and phpcbf.phar files.

.github/workflows/test.yml

@@ -114,21 +114,12 @@ jobs:
 
       # Install dependencies and handle caching in one go.
       # @link https://github.com/marketplace/actions/install-php-dependencies-with-composer
-      - name: Install Composer dependencies - normal
-        if: ${{ matrix.php != '8.1' }}
+      - name: Install Composer dependencies
         uses: "ramsey/composer-install@v2"
         with:
           # Bust the cache at least once a month - output format: YYYY-MM.
           custom-cache-suffix: $(date -u "+%Y-%m")
 
-      # For PHP > 8.0, install with ignore platform reqs as not all PHPUnit allow for it yet.
-      - name: Install Composer dependencies - with ignore platform
-        if: ${{ matrix.php == '8.1' || matrix.php == '8.2' }}
-        uses: "ramsey/composer-install@v2"
-        with:
-          composer-options: --ignore-platform-req=php+
-          custom-cache-suffix: $(date -u "+%Y-%m")
-
       # Note: The code style check is run multiple times against every PHP version
       # as it also acts as an integration test.
       - name: 'PHPCS: set the path to PHP'

.gitignore

@@ -1,6 +1,7 @@
 /CodeSniffer.conf
 /phpcs.xml
 /phpunit.xml
+.phpunit.result.cache
 .idea/*
 /vendor/
 composer.lock

CHANGELOG.md

@@ -138,6 +138,9 @@ The file documents changes to the PHP_CodeSniffer project.
     - PSR2.Methods.FunctionCallSignature
     - PSR2.Methods.FunctionClosingBrace
     - Thanks to Atsushi Okui (@blue32a) for the patch
+- Support for PHPUnit 8 and 9 to the test suite.
+    - Test suites for external standards which run via the PHPCS native test suite can now run on PHPUnit 4-9 (was 4-7).
+    - If any of these tests use the PHPUnit `setUp()`/`tearDown()` methods or overload the `setUp()` in the `AbstractSniffUnitTest` test case, they will need to be adjusted. See the [PR details for further information](https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/59/commits/26384ebfcc0b1c1651b0e1e40c9b6c8c22881832).
 
 ### Changed
 - Changes have been made to the way PHPCS handles invalid sniff properties being set in a custom ruleset

composer.json

@@ -60,10 +60,6 @@
             "Composer\\Config::disableProcessTimeout",
             "@php ./vendor/phpunit/phpunit/phpunit tests/AllTests.php --no-coverage"
         ],
-        "test-php8": [
-            "Composer\\Config::disableProcessTimeout",
-            "@php ./vendor/phpunit/phpunit/phpunit tests/AllTests.php --no-configuration --bootstrap=tests/bootstrap.php --dont-report-useless-tests --no-coverage"
-        ],
         "coverage": [
             "Composer\\Config::disableProcessTimeout",
             "@php ./vendor/phpunit/phpunit/phpunit tests/AllTests.php -d max_execution_time=0"
@@ -81,7 +77,6 @@
         "cs": "Check for code style violations.",
         "cbf": "Fix code style violations.",
         "test": "Run the unit tests without code coverage.",
-        "test-php8": "Run the unit tests without code coverage on PHP 8.1 or higher.",
         "coverage": "Run the unit tests with code coverage.",
         "build": "Create PHAR files for PHPCS and PHPCBF.",
         "check-all": "Run all checks (phpcs, tests)."

phpunit.xml.dist

@@ -1,5 +1,15 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit backupGlobals="true" beStrictAboutTestsThatDoNotTestAnything="false" convertDeprecationsToExceptions="true" bootstrap="tests/bootstrap.php">
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.2/phpunit.xsd"
+    backupGlobals="true"
+    beStrictAboutTestsThatDoNotTestAnything="false"
+    bootstrap="tests/bootstrap.php"
+    convertErrorsToExceptions="true"
+    convertWarningsToExceptions="true"
+    convertNoticesToExceptions="true"
+    convertDeprecationsToExceptions="true"
+    >
     <testsuites>
         <testsuite name="PHP_CodeSniffer Test Suite">
             <file>tests/AllTests.php</file>