CI/QA: prepare for adding additional tests

Update the test setup to allow for tests to be added for the Feature Complete tooling as well as the upcoming Docs XSD file.

**PHPUnit config**
* Rename the test suite to allow for adding additional test suites.
* Add a second test suite for the upcoming Docs XSD tests and future "Feature Complete" tooling tests, both of which will be non-PHPCS dependent tests.

**Composer**
* Tweak the supported PHPUnit version to ensure the namespaced `TestCase` class is always available.
* Add the PHPUnit Polyfills for use by those tests which need to use expectations/assertions which have changed over time.
* Add autoloading for test files.
* Add separate scripts to run the different test suites.
* Rename the `run-tests` script (to run all tests) to `test` to be in line with the names of similar scripts in other repos in this organisation.

**PHPUnit bootstrap**
* Load the autoloader for the PHPUnit Polyfills.

**GH Actions workflow**
* Adjust the existing test run to run only the sniff test testsuite.
* Add a second test run to run the tooling test suite which is only run once per PHP version.

**.gitattributes**
* Ignore the `Tests` directory for distribution archives.

**PHPCS config**
* Ignore long lines in test files as the "commands" to be passed can sometimes be quite long.

Author: jrfnl

.gitattributes

@@ -12,6 +12,7 @@
 /phpunit.xml.dist      export-ignore
 /phpunit-bootstrap.php export-ignore
 /PHPCSDebug/Tests      export-ignore
+/Tests                 export-ignore
 
 #
 # Auto detect text files and perform LF normalization

.github/workflows/quicktest.yml

@@ -83,5 +83,9 @@ jobs:
         if: ${{ matrix.phpcs_version == 'dev-master' }}
         run: composer check-complete
 
-      - name: Run the unit tests
-        run: composer run-tests
+      - name: Run the unit tests for the PHPCSDebug sniff
+        run: composer test-sniff
+
+      - name: Run the unit tests for the DevTools
+        if: ${{ matrix.phpcs_version == 'dev-master' }}
+        run: composer test-tools

.github/workflows/test.yml

@@ -124,5 +124,9 @@ jobs:
         if: matrix.phpcs_version == 'dev-master'
         run: composer check-complete
 
-      - name: Run the unit tests
-        run: composer run-tests
+      - name: Run the unit tests for the PHPCSDebug sniff
+        run: composer test-sniff
+
+      - name: Run the unit tests for the DevTools
+        if: ${{ matrix.phpcs_version == 'dev-master' }}
+        run: composer test-tools

composer.json

@@ -27,17 +27,23 @@
     },
     "require-dev" : {
         "roave/security-advisories" : "dev-master",
-        "phpunit/phpunit" : "^4.5 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0",
+        "phpunit/phpunit" : "^4.8.36 || ^5.7.21 || ^6.0 || ^7.0 || ^8.0 || ^9.0",
         "php-parallel-lint/php-parallel-lint": "^1.3.2",
         "php-parallel-lint/php-console-highlighter": "^1.0.0",
         "phpcsstandards/phpcsdevcs": "^1.1.3",
-        "phpcsstandards/phpcsutils" : "^1.0"
+        "phpcsstandards/phpcsutils" : "^1.0",
+        "yoast/phpunit-polyfills": "^1.0"
     },
     "config": {
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true
         }
     },
+    "autoload-dev" : {
+        "psr-4": {
+            "PHPCSDevTools\\Tests\\": "Tests/"
+        }
+    },
     "bin": [
         "bin/phpcs-check-feature-completeness"
     ],
@@ -56,9 +62,15 @@
         "fixcs": [
             "@php ./vendor/squizlabs/php_codesniffer/bin/phpcbf"
         ],
-        "run-tests": [
+        "test": [
             "@php ./vendor/phpunit/phpunit/phpunit"
         ],
+        "test-sniff": [
+            "@php ./vendor/phpunit/phpunit/phpunit --testsuite DebugSniff"
+        ],
+        "test-tools": [
+            "@php ./vendor/phpunit/phpunit/phpunit --testsuite DevTools"
+        ],
         "check-complete": [
             "@php ./bin/phpcs-check-feature-completeness ./PHPCSDebug"
         ]

phpcs.xml.dist

@@ -56,4 +56,8 @@
         <exclude-pattern>/phpunit-bootstrap\.php$</exclude-pattern>
     </rule>
 
+    <rule ref="Generic.Files.LineLength.TooLong">
+        <exclude-pattern>/Tests/*\.php$</exclude-pattern>
+    </rule>
+
 </ruleset>

phpunit-bootstrap.php

@@ -87,5 +87,8 @@
     die(1);
 }
 
+// Load test related autoloader.
+require_once __DIR__ . '/vendor/yoast/phpunit-polyfills/phpunitpolyfills-autoload.php';
+
 // Clean up.
 unset($ds, $phpcsDir, $phpcsUtilsDir, $vendorDir);

phpunit.xml.dist

@@ -13,8 +13,10 @@
     forceCoversAnnotation="true">
 
     <testsuites>
-        <testsuite name="PHPCSDevTools">
+        <testsuite name="DebugSniff">
             <directory suffix="Test.php">./PHPCSDebug/Tests/</directory>
         </testsuite>
+        <testsuite name="DevTools">
+        </testsuite>
     </testsuites>
 </phpunit>