Tests: rename fixture methods and use annotations

As of PHPUnit 8.x, the method signature for the `setUpBeforeClass()`, `setUp()`, `tearDown()` and `tearDownAfterClass()` fixture methods has changed to require the `void` return type.

As the `void` return type isn't available until PHP 7.1, this cannot be implemented.

Annotations to the rescue.
By renaming the `setUpBeforeClass()`, `setUp()`, `tearDown()` and `tearDownAfterClass()` methods to another, descriptive name and using the `@beforeClass`, `@before`, `@after` and `@afterClass` annotations, the tests can be made cross-version compatible up to PHPUnit 9.x.

With this change, the unit tests can now be run on PHPUnit 4 - 9.

This constitutes a minor BC-break for external standards which a) extend the PHPCS native testsuite and b) overload the `AbstractSniffUnitTest::setUp()` method.
While quite a few external standards extends the PHPCS native testsuite, I very much doubt any of these overload the `setUp()` method, so IMO and taking into account that this is a test-only change, this is an acceptable change to include in the next PHPCS minor.

Ref: https://docs.phpunit.de/en/7.5/annotations.html#before

Author: jrfnl

src/Standards/Generic/Tests/Debug/ESLintUnitTest.php

@@ -36,31 +36,33 @@ class ESLintUnitTest extends AbstractSniffUnitTest
     /**
      * Sets up this unit test.
      *
+     * @before
+     *
      * @return void
      */
-    protected function setUp()
+    protected function setUpPrerequisites()
     {
-        parent::setUp();
+        parent::setUpPrerequisites();
 
         $cwd = getcwd();
         file_put_contents($cwd.'/.eslintrc.json', self::ESLINT_CONFIG);
 
-    }//end setUp()
+    }//end setUpPrerequisites()
 
 
     /**
      * Remove artifact.
      *
+     * @after
+     *
      * @return void
      */
-    protected function tearDown()
+    protected function resetProperties()
     {
-        parent::tearDown();
-
         $cwd = getcwd();
         unlink($cwd.'/.eslintrc.json');
 
-    }//end tearDown()
+    }//end resetProperties()
 
 
     /**

tests/Core/AbstractMethodUnitTest.php

@@ -41,9 +41,11 @@ 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 setUpBeforeClass()
+    public static function initializeFile()
     {
         $config            = new Config();
         $config->standards = ['PSR1'];
@@ -62,19 +64,21 @@ public static function setUpBeforeClass()
         self::$phpcsFile = new DummyFile($contents, $ruleset, $config);
         self::$phpcsFile->process();
 
-    }//end setUpBeforeClass()
+    }//end initializeFile()
 
 
     /**
      * Clean up after finished test.
      *
+     * @afterClass
+     *
      * @return void
      */
-    public static function tearDownAfterClass()
+    public static function resetFile()
     {
         self::$phpcsFile = null;
 
-    }//end tearDownAfterClass()
+    }//end resetFile()
 
 
     /**

tests/Core/Autoloader/DetermineLoadedClassTest.php

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

tests/Core/Filters/Filter/AcceptTest.php

@@ -36,9 +36,11 @@ class AcceptTest extends TestCase
     /**
      * Initialize the test.
      *
+     * @before
+     *
      * @return void
      */
-    public function setUp()
+    public function skipOnPEAR()
     {
         if ($GLOBALS['PHP_CODESNIFFER_PEAR'] === true) {
             // PEAR installs test and sniff files into different locations
@@ -47,15 +49,17 @@ public function setUp()
             $this->markTestSkipped('Test cannot run from a PEAR install');
         }
 
-    }//end setUp()
+    }//end skipOnPEAR()
 
 
     /**
      * Initialize the config and ruleset objects based on the `AcceptTest.xml` ruleset file.
      *
+     * @beforeClass
+     *
      * @return void
      */
-    public static function setUpBeforeClass()
+    public static function initializeConfigAndRuleset()
     {
         if ($GLOBALS['PHP_CODESNIFFER_PEAR'] === true) {
             // This test will be skipped.
@@ -66,7 +70,7 @@ public static function setUpBeforeClass()
         self::$config  = new Config(["--standard=$standard", "--ignore=*/somethingelse/*"]);
         self::$ruleset = new Ruleset(self::$config);
 
-    }//end setUpBeforeClass()
+    }//end initializeConfigAndRuleset()
 
 
     /**

tests/Core/Ruleset/RuleInclusionAbsoluteLinuxTest.php

@@ -41,9 +41,11 @@ class RuleInclusionAbsoluteLinuxTest extends TestCase
     /**
      * Initialize the config and ruleset objects.
      *
+     * @before
+     *
      * @return void
      */
-    public function setUp()
+    public function initializeConfigAndRuleset()
     {
         if ($GLOBALS['PHP_CODESNIFFER_PEAR'] === true) {
             // PEAR installs test and sniff files into different locations
@@ -74,19 +76,21 @@ public function setUp()
         $config        = new Config(["--standard={$this->standard}"]);
         $this->ruleset = new Ruleset($config);
 
-    }//end setUp()
+    }//end initializeConfigAndRuleset()
 
 
     /**
      * Reset ruleset file.
      *
+     * @after
+     *
      * @return void
      */
-    public function tearDown()
+    public function resetRuleset()
     {
         file_put_contents($this->standard, $this->contents);
 
-    }//end tearDown()
+    }//end resetRuleset()
 
 
     /**

tests/Core/Ruleset/RuleInclusionAbsoluteWindowsTest.php

@@ -41,9 +41,11 @@ class RuleInclusionAbsoluteWindowsTest extends TestCase
     /**
      * Initialize the config and ruleset objects.
      *
+     * @before
+     *
      * @return void
      */
-    public function setUp()
+    public function initializeConfigAndRuleset()
     {
         if (DIRECTORY_SEPARATOR === '/') {
             $this->markTestSkipped('Windows specific test');
@@ -73,21 +75,23 @@ public function setUp()
         $config        = new Config(["--standard={$this->standard}"]);
         $this->ruleset = new Ruleset($config);
 
-    }//end setUp()
+    }//end initializeConfigAndRuleset()
 
 
     /**
      * Reset ruleset file.
      *
+     * @after
+     *
      * @return void
      */
-    public function tearDown()
+    public function resetRuleset()
     {
         if (DIRECTORY_SEPARATOR !== '/') {
             file_put_contents($this->standard, $this->contents);
         }
 
-    }//end tearDown()
+    }//end resetRuleset()
 
 
     /**

tests/Core/Ruleset/RuleInclusionTest.php

@@ -42,9 +42,11 @@ class RuleInclusionTest extends TestCase
     /**
      * Initialize the test.
      *
+     * @before
+     *
      * @return void
      */
-    public function setUp()
+    public function skipOnPEAR()
     {
         if ($GLOBALS['PHP_CODESNIFFER_PEAR'] === true) {
             // PEAR installs test and sniff files into different locations
@@ -53,15 +55,17 @@ public function setUp()
             $this->markTestSkipped('Test cannot run from a PEAR install');
         }
 
-    }//end setUp()
+    }//end skipOnPEAR()
 
 
     /**
      * Initialize the config and ruleset objects based on the `RuleInclusionTest.xml` ruleset file.
      *
+     * @beforeClass
+     *
      * @return void
      */
-    public static function setUpBeforeClass()
+    public static function initializeConfigAndRuleset()
     {
         if ($GLOBALS['PHP_CODESNIFFER_PEAR'] === true) {
             // This test will be skipped.
@@ -92,19 +96,21 @@ public static function setUpBeforeClass()
         $config        = new Config(["--standard=$standard"]);
         self::$ruleset = new Ruleset($config);
 
-    }//end setUpBeforeClass()
+    }//end initializeConfigAndRuleset()
 
 
     /**
      * Reset ruleset file.
      *
+     * @after
+     *
      * @return void
      */
-    public function tearDown()
+    public function resetRuleset()
     {
         file_put_contents(self::$standard, self::$contents);
 
-    }//end tearDown()
+    }//end resetRuleset()
 
 
     /**

tests/Core/Sniffs/AbstractArraySniffTest.php

@@ -31,14 +31,16 @@ class AbstractArraySniffTest extends AbstractMethodUnitTest
      * 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 setUpBeforeClass()
+    public static function initializeFile()
     {
         self::$sniff = new AbstractArraySniffTestable();
-        parent::setUpBeforeClass();
+        parent::initializeFile();
 
-    }//end setUpBeforeClass()
+    }//end initializeFile()
 
 
     /**

tests/Core/Tokenizer/HeredocNowdocCloserTest.php

@@ -29,9 +29,11 @@ class HeredocNowdocCloserTest extends AbstractMethodUnitTest
      * {@internal This is a near duplicate of the original method. Only difference is that
      * tab replacement is enabled for this test.}
      *
+     * @beforeClass
+     *
      * @return void
      */
-    public static function setUpBeforeClass()
+    public static function initializeFile()
     {
         $config            = new Config();
         $config->standards = ['PSR1'];
@@ -51,7 +53,7 @@ public static function setUpBeforeClass()
         self::$phpcsFile = new DummyFile($contents, $ruleset, $config);
         self::$phpcsFile->process();
 
-    }//end setUpBeforeClass()
+    }//end initializeFile()
 
 
     /**

tests/Standards/AbstractSniffUnitTest.php

@@ -50,15 +50,17 @@ abstract class AbstractSniffUnitTest extends TestCase
     /**
      * Sets up this unit test.
      *
+     * @before
+     *
      * @return void
      */
-    protected function setUp()
+    protected function setUpPrerequisites()
     {
         $class = get_class($this);
         $this->standardsDir = $GLOBALS['PHP_CODESNIFFER_STANDARD_DIRS'][$class];
         $this->testsDir     = $GLOBALS['PHP_CODESNIFFER_TEST_DIRS'][$class];
 
-    }//end setUp()
+    }//end setUpPrerequisites()
 
 
     /**