Merge pull request #994 from PHPCSStandards/phpcs-4.0/feature/tests-drop-support-phpunit-lt-8

Tests: drop support for PHPUnit < 8

Author: jrfnl

composer.json

@@ -36,7 +36,7 @@
         "ext-xmlwriter": "*"
     },
     "require-dev": {
-        "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.3.4"
+        "phpunit/phpunit": "^8.0 || ^9.3.4"
     },
     "bin": [
         "bin/phpcbf",

tests/AllTests.php

@@ -11,23 +11,7 @@
 
 require_once 'Core/AllTests.php';
 require_once 'Standards/AllSniffs.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_compare($version, '7.0', '>=') === true) {
-        $phpunit7 = true;
-    }
-}
-
-if ($phpunit7 === true) {
-    include_once 'TestSuite7.php';
-} else {
-    include_once 'TestSuite.php';
-}
+require_once 'TestSuite.php';
 
 class PHP_CodeSniffer_AllTests
 {

tests/Core/AbstractMethodUnitTest.php

@@ -42,11 +42,9 @@ abstract class AbstractMethodUnitTest extends TestCase
      * The test case file for a unit test class has to be in the same directory
      * directory and use the same file name as the test class, using the .inc extension.
      *
-     * @beforeClass
-     *
      * @return void
      */
-    public static function initializeFile()
+    public static function setUpBeforeClass(): void
     {
         $_SERVER['argv'] = [];
         $config          = new ConfigDouble();
@@ -67,20 +65,15 @@ public static function initializeFile()
         self::$phpcsFile = new DummyFile($contents, $ruleset, $config);
         self::$phpcsFile->parse();
 
-    }//end initializeFile()
+    }//end setUpBeforeClass()
 
 
     /**
      * Clean up after finished test by resetting all static properties on the class to their default values.
      *
-     * Note: This is a PHPUnit cross-version compatible {@see \PHPUnit\Framework\TestCase::tearDownAfterClass()}
-     * method.
-     *
-     * @afterClass
-     *
      * @return void
      */
-    public static function reset()
+    public static function tearDownAfterClass(): void
     {
         // Explicitly trigger __destruct() on the ConfigDouble to reset the Config statics.
         // The explicit method call prevents potential stray test-local references to the $config object
@@ -93,7 +86,7 @@ public static function reset()
         self::$tabWidth  = 4;
         self::$phpcsFile = null;
 
-    }//end reset()
+    }//end tearDownAfterClass()
 
 
     /**
@@ -246,16 +239,8 @@ public static function getTargetTokenFromFile(File $phpcsFile, $commentString, $
      */
     public function expectRunTimeException($message)
     {
-        $exception = 'PHP_CodeSniffer\Exceptions\RuntimeException';
-
-        if (method_exists($this, 'expectException') === true) {
-            // PHPUnit 5+.
-            $this->expectException($exception);
-            $this->expectExceptionMessage($message);
-        } else {
-            // PHPUnit 4.
-            $this->setExpectedException($exception, $message);
-        }
+        $this->expectException('PHP_CodeSniffer\Exceptions\RuntimeException');
+        $this->expectExceptionMessage($message);
 
     }//end expectRunTimeException()
 

tests/Core/Autoloader/DetermineLoadedClassTest.php

@@ -24,15 +24,13 @@ final class DetermineLoadedClassTest extends TestCase
     /**
      * Load the test files.
      *
-     * @beforeClass
-     *
      * @return void
      */
-    public static function includeFixture()
+    public static function setUpBeforeClass(): void
     {
         include __DIR__.'/TestFiles/Sub/C.inc';
 
-    }//end includeFixture()
+    }//end setUpBeforeClass()
 
 
     /**

tests/Core/Config/AbstractRealConfigTestCase.php

@@ -20,11 +20,9 @@ abstract class AbstractRealConfigTestCase extends TestCase
     /**
      * Set static properties in the Config class to prevent tests influencing each other.
      *
-     * @before
-     *
      * @return void
      */
-    protected function setConfigStatics()
+    protected function setUp(): void
     {
         // Set to the property's default value to clear out potentially set values from other tests.
         self::setStaticConfigProperty('overriddenDefaults', []);
@@ -35,40 +33,36 @@ protected function setConfigStatics()
         self::setStaticConfigProperty('configData', []);
         self::setStaticConfigProperty('configDataFile', '');
 
-    }//end setConfigStatics()
+    }//end setUp()
 
 
     /**
      * Clean up after each finished test.
      *
-     * @after
-     *
      * @return void
      */
-    protected function clearArgv()
+    protected function tearDown(): void
     {
         $_SERVER['argv'] = [];
 
-    }//end clearArgv()
+    }//end tearDown()
 
 
     /**
      * Reset the static properties in the Config class to their true defaults to prevent this class
      * from influencing other tests.
      *
-     * @afterClass
-     *
      * @return void
      */
-    public static function resetConfigToDefaults()
+    public static function tearDownAfterClass(): void
     {
         self::setStaticConfigProperty('overriddenDefaults', []);
         self::setStaticConfigProperty('executablePaths', []);
         self::setStaticConfigProperty('configData', null);
         self::setStaticConfigProperty('configDataFile', null);
         $_SERVER['argv'] = [];
 
-    }//end resetConfigToDefaults()
+    }//end tearDownAfterClass()
 
 
     /**

tests/Core/Config/GeneratorArgTest.php

@@ -112,14 +112,8 @@ public function testInvalidGenerator($generatorName)
         $exception = 'PHP_CodeSniffer\Exceptions\DeepExitException';
         $message   = 'ERROR: "'.$generatorName.'" is not a valid generator. The following generators are supported: Text, HTML and Markdown.';
 
-        if (method_exists($this, 'expectException') === true) {
-            // PHPUnit 5+.
-            $this->expectException($exception);
-            $this->expectExceptionMessage($message);
-        } else {
-            // PHPUnit 4.
-            $this->setExpectedException($exception, $message);
-        }
+        $this->expectException($exception);
+        $this->expectExceptionMessage($message);
 
         new ConfigDouble(["--generator={$generatorName}"]);
 

tests/Core/Config/ReportWidthTest.php

@@ -34,7 +34,7 @@ public function testReportWidthDefault()
         $config = new Config(['--standard=PSR1']);
 
         // Can't test the exact value as "auto" will resolve differently depending on the machine running the tests.
-        $this->assertTrue(is_int($config->reportWidth), 'Report width is not an integer');
+        $this->assertIsInt($config->reportWidth, 'Report width is not an integer');
         $this->assertGreaterThan(0, $config->reportWidth, 'Report width is not greater than 0');
 
     }//end testReportWidthDefault()
@@ -60,7 +60,7 @@ public function testReportWidthWillBeSetFromAutoWhenNotFoundInConfFile()
         $config = new Config(['--standard=PSR1']);
 
         // Can't test the exact value as "auto" will resolve differently depending on the machine running the tests.
-        $this->assertTrue(is_int($config->reportWidth), 'Report width is not an integer');
+        $this->assertIsInt($config->reportWidth, 'Report width is not an integer');
         $this->assertGreaterThan(0, $config->reportWidth, 'Report width is not greater than 0');
 
     }//end testReportWidthWillBeSetFromAutoWhenNotFoundInConfFile()
@@ -181,7 +181,7 @@ public function testReportWidthInputHandlingForAuto()
         $config->reportWidth = 'auto';
 
         // Can't test the exact value as "auto" will resolve differently depending on the machine running the tests.
-        $this->assertTrue(is_int($config->reportWidth), 'Report width is not an integer');
+        $this->assertIsInt($config->reportWidth, 'Report width is not an integer');
         $this->assertGreaterThan(0, $config->reportWidth, 'Report width is not greater than 0');
 
     }//end testReportWidthInputHandlingForAuto()

tests/Core/Config/SniffsExcludeArgsTest.php

@@ -50,14 +50,8 @@ public function testInvalid($argument, $value, $errors, $suggestion)
         $message .= 'Run "phpcs --help" for usage information'.PHP_EOL;
         $message .= PHP_EOL;
 
-        if (method_exists($this, 'expectException') === true) {
-            // PHPUnit 5+.
-            $this->expectException($exception);
-            $this->expectExceptionMessage($message);
-        } else {
-            // PHPUnit 4.
-            $this->setExpectedException($exception, $message);
-        }
+        $this->expectException($exception);
+        $this->expectExceptionMessage($message);
 
         new ConfigDouble(["--$argument=$value"]);
 

tests/Core/File/GetConditionTest.php

@@ -123,11 +123,9 @@ final class GetConditionTest extends AbstractMethodUnitTest
      * Retrieves the test tokens and marker token stack pointer positions
      * only once and caches them as they won't change between the tests anyway.
      *
-     * @before
-     *
      * @return void
      */
-    protected function setUpCaches()
+    protected function setUp(): void
     {
         if (empty(self::$testTokens) === true) {
             foreach (self::$testTargets as $targetToken => $marker) {
@@ -141,7 +139,7 @@ protected function setUpCaches()
             }
         }
 
-    }//end setUpCaches()
+    }//end setUp()
 
 
     /**

tests/Core/Filters/AbstractFilterTestCase.php

@@ -39,29 +39,22 @@ abstract class AbstractFilterTestCase extends TestCase
     /**
      * Initialize the config and ruleset objects.
      *
-     * @beforeClass
-     *
      * @return void
      */
-    public static function initializeConfigAndRuleset()
+    public static function setUpBeforeClass(): void
     {
         self::$config  = new ConfigDouble();
         self::$ruleset = new Ruleset(self::$config);
 
-    }//end initializeConfigAndRuleset()
+    }//end setUpBeforeClass()
 
 
     /**
      * Clean up after finished test by resetting all static properties on the Config class to their default values.
      *
-     * Note: This is a PHPUnit cross-version compatible {@see \PHPUnit\Framework\TestCase::tearDownAfterClass()}
-     * method.
-     *
-     * @afterClass
-     *
      * @return void
      */
-    public static function reset()
+    public static function tearDownAfterClass(): void
     {
         // Explicitly trigger __destruct() on the ConfigDouble to reset the Config statics.
         // The explicit method call prevents potential stray test-local references to the $config object
@@ -71,7 +64,7 @@ public static function reset()
             self::$config->__destruct();
         }
 
-    }//end reset()
+    }//end tearDownAfterClass()
 
 
     /**
@@ -96,24 +89,15 @@ protected function getMockedClass($className, array $constructorArgs=[], $method
     {
         $mockedObj = $this->getMockBuilder($className);
 
-        if (method_exists($mockedObj, 'onlyMethods') === true) {
-            // PHPUnit 8+.
-            if (is_array($methodsToMock) === true) {
-                return $mockedObj
-                    ->setConstructorArgs($constructorArgs)
-                    ->onlyMethods($methodsToMock)
-                    ->getMock();
-            }
-
-            return $mockedObj->getMock()
-                ->setConstructorArgs($constructorArgs);
+        if (is_array($methodsToMock) === true) {
+            return $mockedObj
+                ->setConstructorArgs($constructorArgs)
+                ->onlyMethods($methodsToMock)
+                ->getMock();
         }
 
-        // PHPUnit < 8.
-        return $mockedObj
-            ->setConstructorArgs($constructorArgs)
-            ->setMethods($methodsToMock)
-            ->getMock();
+        return $mockedObj->getMock()
+            ->setConstructorArgs($constructorArgs);
 
     }//end getMockedClass()