Tests: remove work-arounds for setup/teardown methods

As of PHPUnit 8, the `setUpBeforeClass()`, `setUp()`, `tearDown()` and `tearDownAfterClass()` method were required to have a `void` return type declaration.

This could previously not be applied as the test suite had to stay compatible with PHP < 7.2, so as a work-around, the `@beforeClass`, `@before`, `@after` and `@afterClass` annotations were used for these setup/teardown methods.

As support for PHPUnit < 8 has now been dropped, this work-around is no longer needed and the methods can use the more customary PHPUnit fixture method signature again.

Co-authored-by: Greg Sherwood <[email protected]>

Author: jrfnl

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()
 
 
     /**

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/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()
 
 
     /**

tests/Core/Filters/Filter/AcceptTest.php

@@ -28,17 +28,15 @@ final class AcceptTest extends AbstractFilterTestCase
     /**
      * Initialize the config and ruleset objects based on the `AcceptTest.xml` ruleset file.
      *
-     * @beforeClass
-     *
      * @return void
      */
-    public static function initializeConfigAndRuleset()
+    public static function setUpBeforeClass(): void
     {
         $standard      = __DIR__.'/'.basename(__FILE__, '.php').'.xml';
         self::$config  = new ConfigDouble(["--standard=$standard", '--ignore=*/somethingelse/*']);
         self::$ruleset = new Ruleset(self::$config);
 
-    }//end initializeConfigAndRuleset()
+    }//end setUpBeforeClass()
 
 
     /**

tests/Core/Fixer/GenerateDiffTest.php

@@ -46,11 +46,9 @@ final class GenerateDiffTest extends TestCase
      * prevent doing tab replacement when parsing the file. This is to allow for testing a
      * diff with tabs vs spaces (which wouldn't yield a diff if tabs had already been replaced).
      *
-     * @beforeClass
-     *
      * @return void
      */
-    public static function initializeFile()
+    public static function setUpBeforeClass(): void
     {
         $config  = new ConfigDouble();
         $ruleset = new Ruleset($config);
@@ -59,7 +57,7 @@ public static function initializeFile()
         self::$phpcsFile->parse();
         self::$phpcsFile->fixer->startFile(self::$phpcsFile);
 
-    }//end initializeFile()
+    }//end setUpBeforeClass()
 
 
     /**

tests/Core/Ruleset/ExpandRulesetReferenceHomePathTest.php

@@ -32,25 +32,21 @@ final class ExpandRulesetReferenceHomePathTest extends AbstractRulesetTestCase
     /**
      * Store the user's home path.
      *
-     * @beforeClass
-     *
      * @return void
      */
-    public static function storeHomePath()
+    public static function setUpBeforeClass(): void
     {
         self::$homepath = getenv('HOME');
 
-    }//end storeHomePath()
+    }//end setUpBeforeClass()
 
 
     /**
      * Restore the user's home path environment variable in case the test changed it or created it.
      *
-     * @afterClass
-     *
      * @return void
      */
-    public static function restoreHomePath()
+    public static function tearDownAfterClass(): void
     {
         if (is_string(self::$homepath) === true) {
             putenv('HOME='.self::$homepath);
@@ -59,22 +55,20 @@ public static function restoreHomePath()
             putenv('HOME');
         }
 
-    }//end restoreHomePath()
+    }//end tearDownAfterClass()
 
 
     /**
      * Set the home path to an alternative location.
      *
-     * @before
-     *
      * @return void
      */
-    protected function setHomePath()
+    protected function setUp(): void
     {
         $fakeHomePath = __DIR__.DIRECTORY_SEPARATOR.'Fixtures'.DIRECTORY_SEPARATOR.'FakeHomePath';
         putenv("HOME=$fakeHomePath");
 
-    }//end setHomePath()
+    }//end setUp()
 
 
     /**

tests/Core/Ruleset/GetIgnorePatternsTest.php

@@ -32,18 +32,16 @@ final class GetIgnorePatternsTest extends TestCase
     /**
      * Initialize the config and ruleset objects for this test.
      *
-     * @beforeClass
-     *
      * @return void
      */
-    public static function initializeConfigAndRuleset()
+    public static function setUpBeforeClass(): void
     {
         // Set up the ruleset.
         $standard      = __DIR__."/GetIgnorePatternsTest.xml";
         $config        = new ConfigDouble(["--standard=$standard"]);
         self::$ruleset = new Ruleset($config);
 
-    }//end initializeConfigAndRuleset()
+    }//end setUpBeforeClass()
 
 
     /**

tests/Core/Ruleset/GetIncludePatternsTest.php

@@ -32,18 +32,16 @@ final class GetIncludePatternsTest extends TestCase
     /**
      * Initialize the config and ruleset objects for this test.
      *
-     * @beforeClass
-     *
      * @return void
      */
-    public static function initializeConfigAndRuleset()
+    public static function setUpBeforeClass(): void
     {
         // Set up the ruleset.
         $standard      = __DIR__."/GetIncludePatternsTest.xml";
         $config        = new ConfigDouble(["--standard=$standard"]);
         self::$ruleset = new Ruleset($config);
 
-    }//end initializeConfigAndRuleset()
+    }//end setUpBeforeClass()
 
 
     /**