Test data providers for case duplications (#711)

Author: kubawerlos

README.md

@@ -3,7 +3,7 @@
 [![Latest stable version](https://img.shields.io/packagist/v/kubawerlos/php-cs-fixer-custom-fixers.svg?label=current%20version)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 [![PHP version](https://img.shields.io/packagist/php-v/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://php.net)
 [![License](https://img.shields.io/github/license/kubawerlos/php-cs-fixer-custom-fixers.svg)](LICENSE)
-![Tests](https://img.shields.io/badge/tests-3253-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-3312-brightgreen.svg)
 [![Downloads](https://img.shields.io/packagist/dt/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 
 [![CI Status](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/workflows/CI/badge.svg?branch=main&event=push)](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/actions)

tests/AutoReview/TestsCodeTest.php

@@ -15,6 +15,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Finder\SplFileInfo;
+use Tests\Fixer\AbstractFixerTestCase;
 
 /**
  * @internal
@@ -84,13 +85,9 @@ public function testDataProvidersKeys(string $className): void
 
         foreach ($dataProviders as $dataProvider) {
             $dataSet = $dataProvider->invoke(null);
-            \assert(\is_array($dataSet) || $dataSet instanceof \Generator);
+            \assert($dataSet instanceof \Iterator);
 
-            if ($dataSet instanceof \Generator) {
-                $dataSet = \iterator_to_array($dataSet);
-            }
-
-            foreach (\array_keys($dataSet) as $key) {
+            foreach (\array_keys(\iterator_to_array($dataSet)) as $key) {
                 if (!\is_string($key)) {
                     self::markTestIncomplete(\sprintf(
                         'Data provider "%s" in class "%s" has non-string keys.',
@@ -106,6 +103,48 @@ public function testDataProvidersKeys(string $className): void
         }
     }
 
+    /**
+     * @dataProvider provideTestClassCases
+     */
+    public function testDataProvidersValues(string $className): void
+    {
+        if (!\is_subclass_of($className, AbstractFixerTestCase::class)) {
+            $this->expectNotToPerformAssertions();
+
+            return;
+        }
+
+        $dataProviders = $this->getDataProviders($className);
+
+        foreach ($dataProviders as $dataProvider) {
+            $dataSet = $dataProvider->invoke(null);
+            \assert($dataSet instanceof \Iterator);
+            $dataSet = \iterator_to_array($dataSet);
+
+            $doNotChangeCases = [];
+            foreach ($dataSet as $value) {
+                if (\array_key_exists(1, $value) && $value[1] !== null) {
+                    continue;
+                }
+                $doNotChangeCases[] = $value[0];
+            }
+            foreach ($dataSet as $value) {
+                if (!\array_key_exists(1, $value) || $value[1] === null) {
+                    continue;
+                }
+                self::assertFalse(
+                    \in_array($value[0], $doNotChangeCases, true),
+                    \sprintf(
+                        "Expected value:\n%s\nis already tested if it is not changing, it does not need separate test case (%s::%s).",
+                        $value[0],
+                        $className,
+                        $dataProvider->getName()
+                    )
+                );
+            }
+        }
+    }
+
     /**
      * @return array<\ReflectionMethod>
      */
@@ -159,6 +198,8 @@ public static function provideTestClassCases(): iterable
                 $className .= '\\' . $file->getBasename('.php');
                 $tests[$className] = [$className];
             }
+
+            $tests = new \ArrayIterator($tests);
         }
 
         return $tests;

tests/Fixer/CommentSurroundedBySpacesFixerTest.php

@@ -39,10 +39,6 @@ public static function provideFixCases(): iterable
         yield ['<?php $a; //'];
         yield ['<?php $a; ////'];
         yield ['<?php $a; /**/'];
-        yield ['<?php $a; // foo'];
-        yield ['<?php $a; # foo'];
-        yield ['<?php $a; /* foo */'];
-        yield ['<?php $a; /** foo */'];
         yield ['<?php $a; /**  foo  */'];
         yield ["<?php AA; /**\tfoo\t*/"];
 

tests/Fixer/DataProviderNameFixerTest.php

@@ -52,17 +52,6 @@ public function testFix(string $expected, ?string $input = null, ?array $configu
      */
     public static function provideFixCases(): iterable
     {
-        yield 'data provider correctly named' => [
-            '<?php
-class FooTest extends TestCase {
-    /**
-     * @dataProvider provideFooCases
-     */
-    public function testFoo() {}
-    public function provideFooCases() {}
-}',
-        ];
-
         yield 'data provider named with different casing' => [
             '<?php
 class FooTest extends TestCase {

tests/Fixer/PhpdocParamTypeFixerTest.php

@@ -36,14 +36,6 @@ public function testFix(string $expected, ?string $input = null): void
      */
     public static function provideFixCases(): iterable
     {
-        yield [
-            '<?php
-            /**
-             * @param mixed $foo
-             */
-             ',
-        ];
-
         yield [
             '<?php
             /**

tests/Fixer/SingleSpaceBeforeStatementFixerTest.php

@@ -39,7 +39,6 @@ public static function provideFixCases(): iterable
         yield ['<?php $isNotFoo = !require "foo.php";'];
         yield ['<?php foo(new stdClass());'];
         yield ['<?php $content = @include "foo.php";'];
-        yield ['<?php $items = [new Item(), new Item()];'];
         yield ['<?php class Foo {public function bar() {}}'];
         yield ['<?php foo(
                           new Item()

tests/FixersTest.php

@@ -15,7 +15,6 @@
 use PhpCsFixerCustomFixers\Fixers;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Finder\Finder;
-use Symfony\Component\Finder\SplFileInfo;
 
 /**
  * @internal
@@ -47,22 +46,20 @@ public function testFixerIsInCollection(FixerInterface $fixer): void
      */
     public static function provideFixerIsInCollectionCases(): iterable
     {
-        return \array_map(
-            static function (SplFileInfo $fileInfo): array {
-                $className = 'PhpCsFixerCustomFixers\\Fixer\\' . $fileInfo->getBasename('.php');
+        $finder = Finder::create()
+            ->files()
+            ->in(__DIR__ . '/../src/Fixer/')
+            ->notName('AbstractFixer.php')
+            ->notName('DeprecatingFixerInterface.php');
 
-                $fixer = new $className();
-                \assert($fixer instanceof FixerInterface);
+        foreach ($finder as $file) {
+            $className = 'PhpCsFixerCustomFixers\\Fixer\\' . $file->getBasename('.php');
 
-                return [$fixer];
-            },
-            \iterator_to_array(Finder::create()
-                ->files()
-                ->in(__DIR__ . '/../src/Fixer/')
-                ->notName('AbstractFixer.php')
-                ->notName('DeprecatingFixerInterface.php')
-                ->getIterator())
-        );
+            $fixer = new $className();
+            \assert($fixer instanceof FixerInterface);
+
+            yield $className => [$fixer];
+        }
     }
 
     /**