Merge pull request #46 from PHPCSStandards/feature/make-tests-stable

PHPCSDebug/Tests: change set up

Author: jrfnl

.travis.yml

@@ -24,7 +24,7 @@ env:
   # PHPCS `master`
   - PHPCS_VERSION="dev-master" LINT=1
   # Lowest supported PHPCS version.
-  - PHPCS_VERSION="3.0.2"
+  - PHPCS_VERSION="3.1.0"
 
 # Define the stages used.
 # For non-PRs, only the sniff and quicktest stages are run.
@@ -72,14 +72,14 @@ jobs:
       env: PHPCS_VERSION="dev-master" LINT=1
     - stage: quicktest
       php: 7.2
-      env: PHPCS_VERSION="3.0.2"
+      env: PHPCS_VERSION="3.1.0"
 
     - stage: quicktest
       php: 5.4
       env: PHPCS_VERSION="dev-master" LINT=1
     - stage: quicktest
       php: 5.4
-      env: PHPCS_VERSION="3.0.2"
+      env: PHPCS_VERSION="3.1.0"
 
     #### TEST STAGE ####
     # Additional builds to prevent issues with PHPCS versions incompatible with certain PHP versions.
@@ -135,12 +135,6 @@ before_install:
     if [[ "${TRAVIS_BUILD_STAGE_NAME^}" == "Sniff" ]]; then
       # The sniff stage doesn't run the unit tests, so no need for PHPUnit.
       composer remove --dev phpunit/phpunit --no-update --no-scripts
-    elif [[ "$PHPCS_VERSION" < "3.1.0" ]]; then
-      # PHPCS < 3.1.0 is not compatible with PHPUnit 6.x.
-      composer require --dev phpunit/phpunit:"^4.0||^5.0" --no-update --no-scripts
-    elif [[ "$PHPCS_VERSION" < "3.2.3" ]]; then
-      # PHPCS < 3.2.3 is not compatible with PHPUnit 7.x.
-      composer require --dev phpunit/phpunit:"^4.0||^5.0||^6.0" --no-update --no-scripts
     fi
 
   # --prefer-dist will allow for optimal use of the travis caching ability.
@@ -149,9 +143,6 @@ before_install:
     if [[ $TRAVIS_PHP_VERSION == "nightly" ]]; then
       # Not all dependencies allow for installing on nightly yet, so ignore platform requirements.
       composer install --prefer-dist --no-suggest --ignore-platform-reqs
-    elif [[ "$PHPCS_VERSION" == "4.0.x-dev" ]]; then
-      # PHPCS 4.x does not ship by default with the base test case, so source is needed.
-      composer install --prefer-source --no-suggest
     else
       composer install --prefer-dist --no-suggest
     fi

PHPCSDebug/Tests/Debug/TokenListUnitTest.php

@@ -10,7 +10,7 @@
 
 namespace PHPCSDebug\Tests\Debug;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHPCSUtils\TestUtils\UtilityMethodTestCase;
 
 /**
  * Unit test class for the TokenList sniff.
@@ -19,57 +19,39 @@
  *
  * @since 1.0.0
  */
-class TokenListUnitTest extends AbstractSniffUnitTest
+class TokenListUnitTest extends UtilityMethodTestCase
 {
 
     /**
-     * Cache any output generated during the test.
+     * Set the name of a sniff to pass to PHPCS to limit the run (and force it to record errors).
      *
-     * @var string
+     * @var array
      */
-    public static $output = '';
+    protected static $selectedSniff = ['PHPCSDebug.Debug.TokenList'];
 
     /**
-     * Sets up this unit test.
+     * Test the actual output of the TokenList sniff.
      *
      * @return void
      */
-    protected function setUp()
+    public function testOutput()
     {
-        parent::setUp();
-
         \ob_start();
-    }
+        self::$phpcsFile->process();
+        $output = \ob_get_flush();
 
-    /**
-     * Clean up.
-     *
-     * @return void
-     */
-    protected function tearDown()
-    {
-        self::$output = \ob_get_flush();
+        $output = \str_replace(["\r\n", "\r"], "\n", $output);
 
-        parent::tearDown();
-    }
+        $this->assertNotEmpty($output);
 
-    /**
-     * Returns the lines where errors should occur.
-     *
-     * @return array <int line number> => <int number of errors>
-     */
-    public function getErrorList()
-    {
-        return [];
-    }
+        $expected  = "\n";
+        $expected .= 'Ptr :: Ln :: Col  :: Cond :: Token Type                 :: [len]: Content' . "\n";
+        $expected .= '-------------------------------------------------------------------------' . "\n";
+        $expected .= '  0 :: L1 :: C  1 :: CC 0 :: T_OPEN_TAG                 :: [5]: <?php' . "\n\n";
+        $expected .= '  1 :: L2 :: C  1 :: CC 0 :: T_WHITESPACE               :: [0]: ' . "\n\n";
+        $expected .= '  2 :: L3 :: C  1 :: CC 0 :: T_FUNCTION                 :: [8]: function' . "\n";
+        $expected .= '  3 :: L3 :: C  9 :: CC 0 :: T_WHITESPACE               :: [0]: ' . "\n\n";
 
-    /**
-     * Returns the lines where warnings should occur.
-     *
-     * @return array <int line number> => <int number of warnings>
-     */
-    public function getWarningList()
-    {
-        return [];
+        $this->assertSame($expected, $output);
     }
 }

PHPCSDebug/Tests/Debug/TokenListZUnitTest.php

@@ -122,7 +122,7 @@ Once this project is installed, you will see a new `PHPCSDebug` ruleset in the l
 For now, this standard only contains one sniff: `PHPCSDebug.Debug.TokenList`.
 This sniff will display compact, but detailed information about the tokens found in a (test case) file.
 
-This sniff is compatible with PHPCS 3.0.2+.
+This sniff is compatible with PHPCS 3.1.0+.
 
 Typical usage:
 * Set up a test case file for a new sniff you intend to write.

README.md

@@ -21,19 +21,22 @@
     },
     "require" : {
         "php" : ">=5.4",
-        "squizlabs/php_codesniffer" : "^3.0.2",
+        "squizlabs/php_codesniffer" : "^3.1.0",
         "dealerdirect/phpcodesniffer-composer-installer" : "^0.4.1 || ^0.5 || ^0.6.2 || ^0.7"
     },
     "require-dev" : {
         "roave/security-advisories" : "dev-master",
-        "phpunit/phpunit" : "^4.5 || ^5.0 || ^6.0 || ^7.0",
+        "phpunit/phpunit" : "^4.5 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0",
         "php-parallel-lint/php-parallel-lint": "^1.0",
         "php-parallel-lint/php-console-highlighter": "^0.5",
-        "phpcsstandards/phpcsdevcs": "^1.1.1"
+        "phpcsstandards/phpcsdevcs": "^1.1.1",
+        "phpcsstandards/phpcsutils" : "^1.0"
     },
     "bin": [
         "bin/phpcs-check-feature-completeness"
     ],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
     "scripts" : {
         "lint": [
             "@php ./vendor/php-parallel-lint/php-parallel-lint/parallel-lint . -e php --exclude vendor --exclude .git"
@@ -45,7 +48,7 @@
             "@php ./vendor/squizlabs/php_codesniffer/bin/phpcbf"
         ],
         "run-tests": [
-            "@php ./vendor/phpunit/phpunit/phpunit --filter PHPCSDebug ./vendor/squizlabs/php_codesniffer/tests/AllTests.php"
+            "@php ./vendor/phpunit/phpunit/phpunit"
         ],
         "check-complete": [
             "@php ./bin/phpcs-check-feature-completeness ./PHPCSDebug"

composer.json

@@ -17,33 +17,51 @@
     \define('PHP_CODESNIFFER_IN_TESTS', true);
 }
 
+if (\defined('PHP_CODESNIFFER_CBF') === false) {
+    \define('PHP_CODESNIFFER_CBF', false);
+}
+
+if (\defined('PHP_CODESNIFFER_VERBOSITY') === false) {
+    \define('PHP_CODESNIFFER_VERBOSITY', 0);
+}
+
 $ds = \DIRECTORY_SEPARATOR;
 
 /*
  * Load the necessary PHPCS files.
  */
 // Get the PHPCS dir from an environment variable.
-$phpcsDir          = \getenv('PHPCS_DIR');
-$composerPHPCSPath = __DIR__ . $ds . 'vendor' . $ds . 'squizlabs' . $ds . 'php_codesniffer';
-
-if ($phpcsDir === false && \is_dir($composerPHPCSPath)) {
-    // PHPCS installed via Composer.
-    $phpcsDir = $composerPHPCSPath;
-} elseif ($phpcsDir !== false) {
-    /*
-     * PHPCS in a custom directory.
-     * For this to work, the `PHPCS_DIR` needs to be set in a custom `phpunit.xml` file.
-     */
+$phpcsDir = \getenv('PHPCS_DIR');
+
+// Get the PHPCSUtils dir from an environment variable.
+$phpcsUtilsDir = \getenv('PHPCSUTILS_DIR');
+
+// This may be a Composer install.
+if (\is_dir(__DIR__ . $ds . 'vendor')) {
+    $vendorDir = __DIR__ . $ds . 'vendor';
+    if ($phpcsDir === false && \is_dir($vendorDir . $ds . 'squizlabs' . $ds . 'php_codesniffer')) {
+        $phpcsDir = $vendorDir . $ds . 'squizlabs' . $ds . 'php_codesniffer';
+    }
+    if ($phpcsUtilsDir === false && \is_dir($vendorDir . $ds . 'phpcsstandards' . $ds . 'phpcsutils')) {
+        $phpcsUtilsDir = $vendorDir . $ds . 'phpcsstandards' . $ds . 'phpcsutils';
+    }
+}
+
+if ($phpcsDir !== false) {
     $phpcsDir = \realpath($phpcsDir);
 }
 
-// Try and load the PHPCS bootstrap which loads the autoloader and PHPUnit aliases.
-if ($phpcsDir !== false && \is_dir($phpcsDir)) {
-    if (\file_exists($phpcsDir . $ds . 'tests' . $ds . 'bootstrap.php')) {
-        require_once $phpcsDir . $ds . 'tests' . $ds . 'bootstrap.php'; // PHPUnit 6.x+ support as of PHPCS 3.1.0.
-    } elseif (\file_exists($phpcsDir . $ds . 'autoload.php')) {
-        require_once $phpcsDir . $ds . 'autoload.php'; // PHPCS < 3.1.0.
-    }
+if ($phpcsUtilsDir !== false) {
+    $phpcsUtilsDir = \realpath($phpcsUtilsDir);
+}
+
+// Try and load the PHPCS autoloader.
+if ($phpcsDir !== false && \file_exists($phpcsDir . $ds . 'autoload.php')) {
+    // PHPCS 3.x.
+    require_once $phpcsDir . $ds . 'autoload.php';
+
+    // Pre-load the token back-fills to prevent undefined constant notices.
+    require_once $phpcsDir . '/src/Util/Tokens.php';
 } else {
     echo 'Uh oh... can\'t find PHPCS.
 
@@ -55,28 +73,19 @@
     die(1);
 }
 
-/*
- * Set the PHPCS_IGNORE_TEST environment variable to ignore tests from other standards.
- * Ref: https://github.com/squizlabs/PHP_CodeSniffer/pull/1146
- */
-$phpcsDevtoolsStandards = [
-    'PHPCSDebug' => true,
-];
-
-$allStandards   = PHP_CodeSniffer\Util\Standards::getInstalledStandards();
-$allStandards[] = 'Generic';
+// Try and load the PHPCSUtils autoloader.
+if ($phpcsUtilsDir !== false && \file_exists($phpcsUtilsDir . $ds . 'phpcsutils-autoload.php')) {
+    require_once $phpcsUtilsDir . $ds . 'phpcsutils-autoload.php';
+} else {
+    echo 'Uh oh... can\'t find PHPCSUtils.
 
-$standardsToIgnore = [];
-foreach ($allStandards as $standard) {
-    if (isset($phpcsDevtoolsStandards[$standard]) === true) {
-        continue;
-    }
+If you use Composer, please run `composer install`.
+Otherwise, make sure you set a `PHPCSUTILS_DIR` environment variable in your phpunit.xml file
+pointing to the PHPCSUtils directory.
+';
 
-    $standardsToIgnore[] = $standard;
+    die(1);
 }
 
-$standardsToIgnoreString = \implode(',', $standardsToIgnore);
-\putenv("PHPCS_IGNORE_TESTS={$standardsToIgnoreString}");
-
 // Clean up.
-unset($ds, $phpcsDir, $composerPHPCSPath, $allStandards, $standardsToIgnore, $standard, $standardsToIgnoreString);
+unset($ds, $phpcsDir, $phpcsUtilsDir, $vendorDir);