Compat fix for phpunit 7

Author: gsherwood

package.xml

@@ -59,6 +59,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
     -- Thanks to Juliette Reinders Folmer for the patch
   - Improved auto-fixing of files with incomplete comment blocks for various commenting sniffs
     -- Thanks to Juliette Reinders Folmer for the patch
+  - Fixed test suite compatibility with PHPUnit 7
   - Fixed bug #1793 : PSR2 forcing exact indent for function call opening statements
   - Fixed bug #1803 : Squiz.WhiteSpace.ScopeKeywordSpacing removes member var name while fixing if no space after scope keyword
   - Fixed bug #1817 : Blank line not enforced after control structure if comment on same line as closing brace
@@ -124,6 +125,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
     <file baseinstalldir="" name="AllTests.php" role="test" />
     <file baseinstalldir="" name="bootstrap.php" role="test" />
     <file baseinstalldir="" name="TestSuite.php" role="test" />
+    <file baseinstalldir="" name="TestSuite7.php" role="test" />
    </dir>
    <dir name="src">
     <file baseinstalldir="PHP/CodeSniffer" name="Config.php" role="php">
@@ -1594,6 +1596,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
    <install as="phpunit.xml" name="phpunit.xml.dist" />
    <install as="AllTests.php" name="tests/AllTests.php" />
    <install as="TestSuite.php" name="tests/TestSuite.php" />
+   <install as="TestSuite7.php" name="tests/TestSuite7.php" />
    <install as="tests/bootstrap.php" name="tests/bootstrap.php" />
    <install as="CodeSniffer/Core/AllTests.php" name="tests/Core/AllTests.php" />
    <install as="CodeSniffer/Core/IsCamelCapsTest.php" name="tests/Core/IsCamelCapsTest.php" />
@@ -1621,6 +1624,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
    <install as="tests/AllTests.php" name="tests/AllTests.php" />
    <install as="tests/bootstrap.php" name="tests/bootstrap.php" />
    <install as="tests/TestSuite.php" name="tests/TestSuite.php" />
+   <install as="tests/TestSuite7.php" name="tests/TestSuite7.php" />
    <install as="CodeSniffer/Core/AllTests.php" name="tests/Core/AllTests.php" />
    <install as="CodeSniffer/Core/IsCamelCapsTest.php" name="tests/Core/IsCamelCapsTest.php" />
    <install as="CodeSniffer/Core/ErrorSuppressionTest.php" name="tests/Core/ErrorSuppressionTest.php" />

tests/AllTests.php

@@ -20,24 +20,27 @@
     include_once 'CodeSniffer/Standards/AllSniffs.php';
 }
 
-require_once 'TestSuite.php';
+// PHPUnit 7 made the TestSuite run() method incompatible with
+// older PHPUnit versions due to return type hints, so maintain
+// two different suite objects.
+$phpunit7 = false;
+if (class_exists('\PHPUnit\Runner\Version') === true) {
+    $version = \PHPUnit\Runner\Version::id();
+    if ($version[0] === '7') {
+        $phpunit7 = true;
+    }
+}
+
+if ($phpunit7 === true) {
+    include_once 'TestSuite7.php';
+} else {
+    include_once 'TestSuite.php';
+}
 
 class PHP_CodeSniffer_AllTests
 {
 
 
-    /**
-     * Prepare the test runner.
-     *
-     * @return void
-     */
-    public static function main()
-    {
-        TestRunner::run(self::suite());
-
-    }//end main()
-
-
     /**
      * Add all PHP_CodeSniffer test suites into a single test suite.
      *

tests/TestSuite.php

@@ -26,17 +26,7 @@ class TestSuite extends PHPUnit_TestSuite
     public function run(TestResult $result=null)
     {
         $result = parent::run($result);
-
-        $codes = count($GLOBALS['PHP_CODESNIFFER_SNIFF_CODES']);
-
-        echo PHP_EOL.PHP_EOL;
-        echo "Tests generated $codes unique error codes";
-        if ($codes > 0) {
-            $fixes   = count($GLOBALS['PHP_CODESNIFFER_FIXABLE_CODES']);
-            $percent = round(($fixes / $codes * 100), 2);
-            echo "; $fixes were fixable ($percent%)";
-        }
-
+        printPHPCodeSnifferTestOutput();
         return $result;
 
     }//end run()

tests/TestSuite7.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ * A PHP_CodeSniffer specific test suite for PHPUnit.
+ *
+ * @author    Greg Sherwood <[email protected]>
+ * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
+ * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
+ */
+
+namespace PHP_CodeSniffer\Tests;
+
+use PHPUnit\Framework\TestSuite as PHPUnit_TestSuite;
+use PHPUnit\Framework\TestResult;
+
+class TestSuite extends PHPUnit_TestSuite
+{
+
+
+    /**
+     * Runs the tests and collects their result in a TestResult.
+     *
+     * @param \PHPUnit\Framework\TestResult $result A test result.
+     *
+     * @return \PHPUnit\Framework\TestResult
+     */
+    public function run(TestResult $result=null): TestResult
+    {
+        $result = parent::run($result);
+        printPHPCodeSnifferTestOutput();
+        return $result;
+
+    }//end run()
+
+
+}//end class

tests/bootstrap.php

@@ -27,7 +27,6 @@
 
 $tokens = new \PHP_CodeSniffer\Util\Tokens();
 
-
 // Compatibility for PHPUnit < 6 and PHPUnit 6+.
 if (class_exists('PHPUnit_Framework_TestSuite') === true && class_exists('PHPUnit\Framework\TestSuite') === false) {
     class_alias('PHPUnit_Framework_TestSuite', 'PHPUnit'.'\Framework\TestSuite');
@@ -44,3 +43,23 @@ class_alias('PHPUnit_TextUI_TestRunner', 'PHPUnit'.'\TextUI\TestRunner');
 if (class_exists('PHPUnit_Framework_TestResult') === true && class_exists('PHPUnit\Framework\TestResult') === false) {
     class_alias('PHPUnit_Framework_TestResult', 'PHPUnit'.'\Framework\TestResult');
 }
+
+
+/**
+ * A global util function to help print unit test fixing data.
+ *
+ * @return void
+ */
+function printPHPCodeSnifferTestOutput()
+{
+    $codes = count($GLOBALS['PHP_CODESNIFFER_SNIFF_CODES']);
+
+    echo PHP_EOL.PHP_EOL;
+    echo "Tests generated $codes unique error codes";
+    if ($codes > 0) {
+        $fixes   = count($GLOBALS['PHP_CODESNIFFER_FIXABLE_CODES']);
+        $percent = round(($fixes / $codes * 100), 2);
+        echo "; $fixes were fixable ($percent%)";
+    }
+
+}//end printPHPCodeSnifferTestOutput()