Merge pull request #611 from PHPCSStandards/feature/utilitymethodtestcase-improve-tests

TestUtils/UtilityMethodTestCase: improve setup/teardown tests

Author: jrfnl

Tests/TestUtils/UtilityMethodTestCase/GetTargetTokenTest.php

@@ -31,7 +31,7 @@ final class GetTargetTokenTest extends PolyfilledTestCase
      */
     public static function setUpTestFile()
     {
-        self::$caseFile = __DIR__ . '/UtilityMethodTestCaseTest.inc';
+        self::$caseFile = __DIR__ . '/SetUpTestFileTest.inc';
         parent::setUpTestFile();
     }
 

Tests/TestUtils/UtilityMethodTestCase/ResetTestFileTest.php

@@ -0,0 +1,69 @@
+<?php
+/**
+ * PHPCSUtils, utility functions and classes for PHP_CodeSniffer sniff developers.
+ *
+ * @package   PHPCSUtils
+ * @copyright 2019-2020 PHPCSUtils Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSUtils
+ */
+
+namespace PHPCSUtils\Tests\TestUtils\UtilityMethodTestCase;
+
+use PHPCSUtils\Tests\PolyfilledTestCase;
+
+/**
+ * Tests for the \PHPCSUtils\TestUtils\UtilityMethodTestCase class.
+ *
+ * @covers \PHPCSUtils\TestUtils\UtilityMethodTestCase::resetTestFile
+ *
+ * @since 1.0.0
+ */
+final class ResetTestFileTest extends PolyfilledTestCase
+{
+
+    /**
+     * Overload the "normal" set up as it needs to be run from within the actual test(s) to ensure we have a valid test.
+     *
+     * @beforeClass
+     *
+     * @return void
+     */
+    public static function setUpTestFile()
+    {
+        self::$caseFile = __DIR__ . '/SetUpTestFileTest.inc';
+        // Deliberately not running the actual setUpTestFile() method.
+    }
+
+    /**
+     * Test that the static class properties in the class are correctly reset.
+     *
+     * @return void
+     */
+    public function testTearDown()
+    {
+        // Initialize a test, which should change the values of most static properties.
+        self::$tabWidth      = 2;
+        self::$selectedSniff = ['Test.Test.Test'];
+        parent::setUpTestFile();
+
+        // Verify that (most) properties no longer have their original value.
+        $this->assertNotSame('0', self::$phpcsVersion, 'phpcsVersion was not updated');
+        $this->assertSame('inc', self::$fileExtension, 'fileExtension was (not) updated');
+        $this->assertNotSame('', self::$caseFile, 'caseFile was not updated');
+        $this->assertNotSame(4, self::$tabWidth, 'tabWidth was not updated');
+        $this->assertNotNull(self::$phpcsFile, 'phpcsFile was not updated');
+        $this->assertNotSame(['Dummy.Dummy.Dummy'], self::$selectedSniff, 'selectedSniff was not updated');
+
+        // Reset the file as per the "afterClass"/tear down method.
+        parent::resetTestFile();
+
+        // Verify the properties in the class have been cleaned up.
+        $this->assertSame('0', self::$phpcsVersion, 'phpcsVersion was not reset');
+        $this->assertSame('inc', self::$fileExtension, 'fileExtension was not reset');
+        $this->assertSame('', self::$caseFile, 'caseFile was not reset');
+        $this->assertSame(4, self::$tabWidth, 'tabWidth was not reset');
+        $this->assertNull(self::$phpcsFile, 'phpcsFile was not reset');
+        $this->assertSame(['Dummy.Dummy.Dummy'], self::$selectedSniff, 'selectedSniff was not reset');
+    }
+}

Tests/TestUtils/UtilityMethodTestCase/UtilityMethodTestCaseTest.inc renamed to Tests/TestUtils/UtilityMethodTestCase/SetUpTestFileTest.inc

@@ -15,11 +15,13 @@
 /**
  * Tests for the \PHPCSUtils\TestUtils\UtilityMethodTestCase class.
  *
- * @covers \PHPCSUtils\TestUtils\UtilityMethodTestCase
+ * @covers \PHPCSUtils\TestUtils\UtilityMethodTestCase::setUpTestFile
+ * @covers \PHPCSUtils\TestUtils\UtilityMethodTestCase::parseFile
+ * @covers \PHPCSUtils\TestUtils\UtilityMethodTestCase::skipJSCSSTestsOnPHPCS4
  *
  * @since 1.0.0
  */
-final class UtilityMethodTestCaseTest extends PolyfilledTestCase
+final class SetUpTestFileTest extends PolyfilledTestCase
 {
 
     /**
@@ -32,7 +34,7 @@ final class UtilityMethodTestCaseTest extends PolyfilledTestCase
      */
     public static function setUpTestFile()
     {
-        // Deliberately left empty.
+        // Deliberately not running the actual setUpTestFile() method.
     }
 
     /**
@@ -42,29 +44,24 @@ public static function setUpTestFile()
      */
     public function testSetUp()
     {
+        // Verify that the class was virgin to begin with.
+        $this->assertSame('0', self::$phpcsVersion, 'phpcsVersion was not correct to begin with');
+        $this->assertSame('inc', self::$fileExtension, 'fileExtension was not correct to begin with');
+        $this->assertSame('', self::$caseFile, 'caseFile was not correct to begin with');
+        $this->assertSame(4, self::$tabWidth, 'tabWidth was not correct to begin with');
+        $this->assertNull(self::$phpcsFile, 'phpcsFile was not correct to begin with');
+        $this->assertSame(['Dummy.Dummy.Dummy'], self::$selectedSniff, 'selectedSniff was not correct to begin with');
+
+        // Run the set up.
         parent::setUpTestFile();
+
+        // Verify select properties have been set correctly.
+        $this->assertNotSame('0', self::$phpcsVersion, 'phpcsVersion was not set');
+
         $this->assertInstanceOf('PHP_CodeSniffer\Files\File', self::$phpcsFile);
         $this->assertSame(57, self::$phpcsFile->numTokens);
 
         $tokens = self::$phpcsFile->getTokens();
         $this->assertIsArray($tokens);
     }
-
-    /**
-     * Test that the class is correct reset.
-     *
-     * @depends testSetUp
-     *
-     * @return void
-     */
-    public function testTearDown()
-    {
-        parent::resetTestFile();
-        $this->assertSame('0', self::$phpcsVersion, 'phpcsVersion was not reset');
-        $this->assertSame('inc', self::$fileExtension, 'fileExtension was not reset');
-        $this->assertSame('', self::$caseFile, 'caseFile was not reset');
-        $this->assertSame(4, self::$tabWidth, 'tabWidth was not reset');
-        $this->assertNull(self::$phpcsFile, 'phpcsFile was not reset');
-        $this->assertSame(['Dummy.Dummy.Dummy'], self::$selectedSniff, 'selectedSniff was not reset');
-    }
 }