Tests/Filters: new AbstractFilterTestCase

... to contain some basic utilities and logic for use in Filter related tests.

Includes switching the `Filter/AcceptTest` to use the new abstract and to use the available utilities.

Author: jrfnl

tests/Core/Filters/AbstractFilterTestCase.php

@@ -0,0 +1,104 @@
+<?php
+/**
+ * Tests for the \PHP_CodeSniffer\Filters\GitModified class.
+ *
+ * @author    Juliette Reinders Folmer <[email protected]>
+ * @copyright 2023 PHPCSStandards Contributors
+ * @license   https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
+ */
+
+namespace PHP_CodeSniffer\Tests\Core\Filters;
+
+use PHP_CodeSniffer\Config;
+use PHP_CodeSniffer\Filters\Filter;
+use PHP_CodeSniffer\Ruleset;
+use PHPUnit\Framework\TestCase;
+use RecursiveIteratorIterator;
+
+/**
+ * Base functionality and utilities for testing Filter classes.
+ */
+abstract class AbstractFilterTestCase extends TestCase
+{
+
+    /**
+     * The Config object.
+     *
+     * @var \PHP_CodeSniffer\Config
+     */
+    protected static $config;
+
+    /**
+     * The Ruleset object.
+     *
+     * @var \PHP_CodeSniffer\Ruleset
+     */
+    protected static $ruleset;
+
+
+    /**
+     * Initialize the config and ruleset objects.
+     *
+     * @beforeClass
+     *
+     * @return void
+     */
+    public static function initializeConfigAndRuleset()
+    {
+        self::$config  = new Config(['--standard=PSR1', '--report-width=80']);
+        self::$ruleset = new Ruleset(self::$config);
+
+    }//end initializeConfigAndRuleset()
+
+
+    /**
+     * Retrieve an array of files which were accepted by a filter.
+     *
+     * @param \PHP_CodeSniffer\Filters\Filter $filter The Filter object under test.
+     *
+     * @return array<string>
+     */
+    protected function getFilteredResultsAsArray(Filter $filter)
+    {
+        $iterator = new RecursiveIteratorIterator($filter);
+        $files    = [];
+        foreach ($iterator as $file) {
+            $files[] = $file;
+        }
+
+        return $files;
+
+    }//end getFilteredResultsAsArray()
+
+
+    /**
+     * Translate Linux paths to Windows paths, when necessary.
+     *
+     * These type of tests should be able to run and pass on both *nix as well as Windows
+     * based dev systems. This method is a helper to allow for this.
+     *
+     * @param array<string|array> $paths A single or multi-dimensional array containing
+     *                                   file paths.
+     *
+     * @return array<string|array>
+     */
+    protected static function mapPathsToRuntimeOs(array $paths)
+    {
+        if (DIRECTORY_SEPARATOR !== '\\') {
+            return $paths;
+        }
+
+        foreach ($paths as $key => $value) {
+            if (is_string($value) === true) {
+                $paths[$key] = strtr($value, '/', '\\\\');
+            } else if (is_array($value) === true) {
+                $paths[$key] = self::mapPathsToRuntimeOs($value);
+            }
+        }
+
+        return $paths;
+
+    }//end mapPathsToRuntimeOs()
+
+
+}//end class

tests/Core/Filters/Filter/AcceptTest.php

@@ -13,30 +13,16 @@
 use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Filters\Filter;
 use PHP_CodeSniffer\Ruleset;
-use PHPUnit\Framework\TestCase;
+use PHP_CodeSniffer\Tests\Core\Filters\AbstractFilterTestCase;
 
 /**
  * Tests for the \PHP_CodeSniffer\Filters\Filter::accept method.
  *
  * @covers \PHP_CodeSniffer\Filters\Filter
  */
-class AcceptTest extends TestCase
+class AcceptTest extends AbstractFilterTestCase
 {
 
-    /**
-     * The Config object.
-     *
-     * @var \PHP_CodeSniffer\Config
-     */
-    protected static $config;
-
-    /**
-     * The Ruleset object.
-     *
-     * @var \PHP_CodeSniffer\Ruleset
-     */
-    protected static $ruleset;
-
 
     /**
      * Initialize the config and ruleset objects based on the `AcceptTest.xml` ruleset file.
@@ -66,16 +52,10 @@ public static function initializeConfigAndRuleset()
      */
     public function testExcludePatterns($inputPaths, $expectedOutput)
     {
-        $fakeDI   = new \RecursiveArrayIterator($inputPaths);
-        $filter   = new Filter($fakeDI, '/', self::$config, self::$ruleset);
-        $iterator = new \RecursiveIteratorIterator($filter);
-        $files    = [];
-
-        foreach ($iterator as $file) {
-            $files[] = $file;
-        }
+        $fakeDI = new \RecursiveArrayIterator($inputPaths);
+        $filter = new Filter($fakeDI, '/', self::$config, self::$ruleset);
 
-        $this->assertEquals($expectedOutput, $files);
+        $this->assertEquals($expectedOutput, $this->getFilteredResultsAsArray($filter));
 
     }//end testExcludePatterns()
 
@@ -121,17 +101,7 @@ public function dataExcludePatterns()
         ];
 
         // Allow these tests to work on Windows as well.
-        if (DIRECTORY_SEPARATOR === '\\') {
-            foreach ($testCases as $key => $case) {
-                foreach ($case as $nr => $param) {
-                    foreach ($param as $file => $value) {
-                        $testCases[$key][$nr][$file] = strtr($value, '/', '\\');
-                    }
-                }
-            }
-        }
-
-        return $testCases;
+        return self::mapPathsToRuntimeOs($testCases);
 
     }//end dataExcludePatterns()