Refactored custom sniffer tests

Author: shudd3r

tests/Fixtures/SnifferTestRunner.php

@@ -24,7 +24,7 @@ class SnifferTestRunner
     private ?Config  $config;
     private array    $properties;
 
-    public function __construct(string $sniffClass)
+    public function __construct(string $sniffClass, array $options = [])
     {
         $runner = SnifferTokens::runner(__DIR__ . '/tests.phpcs.xml');
 
@@ -36,6 +36,7 @@ public function __construct(string $sniffClass)
         $code = Util\Common::getSniffCode($sniffClass);
         $this->ruleset->ruleset[$code]['properties'] = [];
         $this->properties = &$this->ruleset->ruleset[$code]['properties'];
+        $this->setProperties($options);
     }
 
     public function sniff(string $filename): Files\File
@@ -48,7 +49,7 @@ public function sniff(string $filename): Files\File
         return $testFile;
     }
 
-    public function setProperties(array $properties): void
+    private function setProperties(array $properties): void
     {
         $this->properties = array_map(fn ($value) => ['scope' => 'sniff', 'value' => $value], $properties);
     }

tests/Sniffer/Sniffs/Arrays/AmbiguousAssociativitySniffTest.php

@@ -19,10 +19,10 @@ class AmbiguousAssociativitySniffTest extends SnifferTest
 {
     public function test_AssocArray_WithNonAssocValues_GivesWarning()
     {
-        $this->assertWarningLines('./tests/Fixtures/code-samples/Sniffs/InvalidArrays.php', [5, 20, 22, 27]);
+        $this->assertWarningLines([5, 20, 22, 27], 'InvalidArrays.php');
     }
 
-    protected function sniffer(): string
+    protected function sniffClass(): string
     {
         return AmbiguousAssociativitySniff::class;
     }

tests/Sniffer/Sniffs/NamingConventions/ValidVariableNameSniffTest.php

@@ -17,19 +17,19 @@
 
 class ValidVariableNameSniffTest extends SnifferTest
 {
-    public function test_Number_InLocalVariableName_GivesWarning()
+    public function test_LocalVariableName_WithNumber_GivesWarning()
     {
-        $lines = [16, 17, 34, 36, 56, 68];
-        $this->assertWarningLines('./tests/Fixtures/code-samples/Sniffs/InvalidVariableNames.php', $lines);
+        $warningLines = [16, 17, 34, 36, 56, 68];
+        $this->assertWarningLines($warningLines, 'InvalidVariableNames.php');
     }
 
-    public function test_InvalidCamelCaseOrNumber_InClassVariable_GivesError(): void
+    public function test_ClassVariableName_WithNoCamelCaseOrNumber_GivesError()
     {
-        $lines = [13, 14, 15, 24, 25, 26, 27, 30, 31, 32, 34, 36, 43, 44, 53, 59, 60, 61, 69, 85];
-        $this->assertErrorLines('./tests/Fixtures/code-samples/Sniffs/InvalidVariableNames.php', $lines);
+        $errorLines = [13, 14, 15, 24, 25, 26, 27, 30, 31, 32, 34, 36, 43, 44, 53, 59, 60, 61, 69, 85];
+        $this->assertErrorLines($errorLines, 'InvalidVariableNames.php');
     }
 
-    protected function sniffer(): string
+    protected function sniffClass(): string
     {
         return ValidVariableNameSniff::class;
     }

tests/Sniffer/Sniffs/PhpDoc/CallableDefinitionSniffTest.php

@@ -17,26 +17,25 @@
 
 class CallableDefinitionSniffTest extends SnifferTest
 {
-    /** @dataProvider properties */
-    public function test_CallableParamDoc_WithoutDefinition_GivesWarning(array $properties, array $expectedWarningLines)
+    /** @dataProvider warningsForProperties */
+    public function test_CallableParamDoc_WithoutDefinition_GivesWarning(array $warningLines, array $properties)
     {
-        $this->setProperties($properties);
-        $this->assertWarningLines('./tests/Fixtures/code-samples/Sniffs/PhpDocCallableDefinitions.php', $expectedWarningLines);
+        $this->assertWarningLines($warningLines, 'PhpDocCallableDefinitions.php', $properties);
     }
 
-    public static function properties(): iterable
+    public static function warningsForProperties(): iterable
     {
         return [
-            [['syntax' => 'both', 'includeClosure' => false], range(15, 18)],
-            [['syntax' => 'both', 'includeClosure' => true], range(15, 22)],
-            [['syntax' => 'short', 'includeClosure' => false], array_merge(range(15, 18), [27, 28, 31])],
-            [['syntax' => 'long', 'includeClosure' => false], array_merge(range(15, 18), [23, 24], [33])],
-            [['syntax' => 'short', 'includeClosure' => true], array_merge(range(15, 22), range(27, 31))],
-            [['syntax' => 'long', 'includeClosure' => true], array_merge(range(15, 26), [32, 33, 34])]
+            'short+long closure(-)' => [range(15, 18), ['syntax' => 'both', 'includeClosure' => false]],
+            'short+long closure(+)' => [range(15, 22), ['syntax' => 'both', 'includeClosure' => true]],
+            'short closure (-)'     => [array_merge(range(15, 18), [27, 28, 31]), ['syntax' => 'short', 'includeClosure' => false]],
+            'long closure (-)'      => [array_merge(range(15, 18), [23, 24], [33]), ['syntax' => 'long', 'includeClosure' => false]],
+            'short closure (+)'     => [array_merge(range(15, 22), range(27, 31)), ['syntax' => 'short', 'includeClosure' => true]],
+            'long closure (+)'      => [array_merge(range(15, 26), [32, 33, 34]), ['syntax' => 'long', 'includeClosure' => true]]
         ];
     }
 
-    protected function sniffer(): string
+    protected function sniffClass(): string
     {
         return CallableDefinitionSniff::class;
     }

tests/Sniffer/Sniffs/PhpDoc/RequiredForPublicApiSniffTest.php

@@ -18,22 +18,22 @@
 class RequiredForPublicApiSniffTest extends SnifferTest
 {
     /** @dataProvider classFileWarnings */
-    public function test_Interface_Warnings(string $filename, array $warningLines)
+    public function test_Interface_Warnings(array $warningLines, string $filename)
     {
-        $this->assertWarningLines('./tests/Fixtures/code-samples/Sniffs/' . $filename, $warningLines);
+        $this->assertWarningLines($warningLines, $filename);
     }
 
     public static function classFileWarnings(): iterable
     {
         return [
-            'interface' => ['PhpDocRequiredForInterfaceApi.php', [12]],
-            'class'     => ['PhpDocRequiredForClassApi.php', [14]],
-            'parent'    => ['PhpDocRequiredForParentApi.php', [8]],
-            'invalid'   => ['PhpDocRequiredForInvalidClass.php', [8]]
+            'interface' => [[12], 'PhpDocRequiredForInterfaceApi.php'],
+            'class'     => [[14], 'PhpDocRequiredForClassApi.php'],
+            'parent'    => [[8], 'PhpDocRequiredForParentApi.php'],
+            'invalid'   => [[8], 'PhpDocRequiredForInvalidClass.php']
         ];
     }
 
-    protected function sniffer(): string
+    protected function sniffClass(): string
     {
         return RequiredForPublicApiSniff::class;
     }

tests/SnifferTest.php

@@ -12,34 +12,29 @@
 namespace Polymorphine\Dev\Tests;
 
 use PHPUnit\Framework\TestCase;
+use PHP_CodeSniffer\Files\File;
 use Polymorphine\Dev\Tests\Fixtures\SnifferTestRunner;
 
 
 abstract class SnifferTest extends TestCase
 {
-    private SnifferTestRunner $runner;
-
-    protected function setUp(): void
+    public function assertWarningLines(array $expectedWarningLines, string $filename, array $options = []): void
     {
-        $this->runner = new SnifferTestRunner($this->sniffer());
+        $file = $this->sniffedFile($filename, $options);
+        $this->assertEquals($expectedWarningLines, array_keys($file->getWarnings()));
     }
 
-    public function setProperties(array $properties): void
+    public function assertErrorLines(array $expectedErrorLines, string $filename, array $options = []): void
     {
-        $this->runner->setProperties($properties);
+        $file = $this->sniffedFile($filename, $options);
+        $this->assertEquals($expectedErrorLines, array_keys($file->getErrors()));
     }
 
-    public function assertWarningLines(string $filename, array $expectedWarningLines): void
-    {
-        $fileWarnings = $this->runner->sniff($filename)->getWarnings();
-        $this->assertEquals($expectedWarningLines, array_keys($fileWarnings));
-    }
+    abstract protected function sniffClass(): string;
 
-    public function assertErrorLines(string $filename, array $expectedErrorLines): void
+    private function sniffedFile(string $filename, array $options = []): File
     {
-        $fileErrors = $this->runner->sniff($filename)->getErrors();
-        $this->assertEquals($expectedErrorLines, array_keys($fileErrors));
+        $runner = new SnifferTestRunner($this->sniffClass(), $options);
+        return $runner->sniff('./tests/Fixtures/code-samples/Sniffs/' . $filename);
     }
-
-    abstract protected function sniffer(): string;
 }