IN-1729 - Add TestRunner to separate class from side effects in runner.php

Author: vladimir-flyeralarm

composer.json

@@ -17,6 +17,11 @@
     "require": {
         "squizlabs/php_codesniffer": "^3.5"
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Flyeralarm\\Sniffer\\Tests\\": "tests/"
+        }
+    },
     "bin": [
         "bin/php-code-validator"
     ]

tests/TestRunner.php

@@ -0,0 +1,71 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flyeralarm\Sniffer\Tests;
+
+class TestRunner
+{
+    /**
+     * @param string $dirPath
+     */
+    public function processDir(string $dirPath)
+    {
+        $hasError = false;
+        $dir = opendir($dirPath);
+        while (($file = readdir($dir)) !== false) {
+            if (strpos($file, '.') === 0) {
+                continue;
+            }
+            if (is_dir($dirPath . $file)) {
+                processDir($dirPath . $file . '/');
+                continue;
+            }
+
+            $fileContent = file_get_contents($dirPath . $file);
+            $snifferOutput = shell_exec(
+                sprintf(
+                    "%s -w -p -s --report-width=120 --standard=%s %s",
+                    escapeshellcmd(__DIR__ . '/../vendor/bin/phpcs'),
+                    escapeshellarg(__DIR__ . '/ruleset.xml'),
+                    escapeshellarg($dirPath . $file)
+                )
+            );
+
+            // expectedPass
+            if (preg_match('|//\s@expectedPass$|m', $fileContent)) {
+                if (preg_match('|^FOUND.*AFFECTING.*LINE|m', $snifferOutput) === 0) {
+                    echo 'OK - [' . $dirPath . $file . ']' . PHP_EOL;
+                    continue;
+                }
+
+                $hasError = true;
+                echo "ERROR - [" . $dirPath . $file . "]:'
+                . ' Test was expected to fully pass. Result: " . PHP_EOL . $snifferOutput . PHP_EOL;
+                continue;
+            }
+
+            // expectedError
+            preg_match('|//\s@expectedError\s(.*)$|m', $fileContent, $expectedMatch);
+            if (count($expectedMatch) !== 2) {
+                echo 'WARNING - [' . $dirPath . $file . ']:'
+                    . ' File must contain exactly one "@expectedError <EXPECTATION MESSAGE>"'
+                    . ' or "@expectedPass" comment' . PHP_EOL;
+                continue;
+            }
+            $expected = $expectedMatch[1];
+            if (preg_match('/ERROR\s\|\s?[\[\]x\s]*\s' . preg_quote($expected, '/') . '/', $snifferOutput) === 0) {
+                $hasError = true;
+                echo 'ERROR - [' . $dirPath . $file . ']:'
+                    . ' Expectation <<' . $expected . '>>'
+                    . ' not found in result: ' . PHP_EOL . $snifferOutput . PHP_EOL;
+            } else {
+                echo 'OK - [' . $dirPath . $file . ']' . PHP_EOL;
+            }
+        }
+        if ($hasError) {
+            exit(1);
+        }
+        exit(0);
+    }
+}

tests/runner.php

@@ -1,59 +1,5 @@
 <?php
 
-$hasError = false;
-processDir(__DIR__ . '/rules/');
-if ($hasError) {
-    exit(1);
-}
-exit(0);
+require_once __DIR__ . '/TestRunner.php';
 
-function processDir($dirPath)
-{
-    global $hasError;
-    $dir = opendir($dirPath);
-    while (($file = readdir($dir)) !== false) {
-        if (strpos($file, '.') === 0) {
-            continue;
-        }
-        if (is_dir($dirPath . $file)) {
-            processDir($dirPath . $file . '/');
-            continue;
-        }
-
-        $fileContent = file_get_contents($dirPath . $file);
-        $snifferOutput = shell_exec(
-            sprintf(
-                "%s -w -p -s --report-width=120 --standard=%s %s",
-                escapeshellcmd(__DIR__ . '/../vendor/bin/phpcs'),
-                escapeshellarg(__DIR__ . '/ruleset.xml'),
-                escapeshellarg($dirPath . $file)
-            )
-        );
-
-        // expectedPass
-        if (preg_match('|//\s@expectedPass$|m', $fileContent)) {
-            if (preg_match('|^FOUND.*AFFECTING.*LINE|m', $snifferOutput) === 0) {
-                echo 'OK - [' . $dirPath . $file . ']' . PHP_EOL;
-                continue;
-            }
-
-            $hasError = true;
-            echo 'ERROR - [' . $dirPath . $file . ']: Test was expected to fully pass. Result: ' . PHP_EOL . $snifferOutput . PHP_EOL;
-            continue;
-        }
-
-        // expectedError
-        preg_match('|//\s@expectedError\s(.*)$|m', $fileContent, $expectedMatch);
-        if (count($expectedMatch) !== 2) {
-            echo 'WARNING - [' . $dirPath . $file . ']: File must contain exactly one "@expectedError <EXPECTATION MESSAGE>" or "@expectedPass" comment' . PHP_EOL;
-            continue;
-        }
-        $expected = $expectedMatch[1];
-        if (preg_match('/ERROR\s\|\s?[\[\]x\s]*\s' . preg_quote($expected, '/') . '/', $snifferOutput) === 0) {
-            $hasError = true;
-            echo 'ERROR - [' . $dirPath . $file . ']: Expectation <<' . $expected . '>> not found in result: ' . PHP_EOL . $snifferOutput . PHP_EOL;
-        } else {
-            echo 'OK - [' . $dirPath . $file . ']' . PHP_EOL;
-        }
-    }
-}
+(new \Flyeralarm\Sniffer\TestRunner())->processDir(__DIR__ . '/rules/');