PhpUnit provider: support @dataProvider

Author: janedbal

src/Provider/PhpUnitEntrypointProvider.php

@@ -2,6 +2,9 @@
 
 namespace ShipMonk\PHPStan\DeadCode\Provider;
 
+use PHPStan\PhpDocParser\Lexer\Lexer;
+use PHPStan\PhpDocParser\Parser\PhpDocParser;
+use PHPStan\PhpDocParser\Parser\TokenIterator;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 use ReflectionMethod;
@@ -17,9 +20,15 @@ class PhpUnitEntrypointProvider implements EntrypointProvider
 
     private bool $enabled;
 
-    public function __construct(bool $enabled)
+    private PhpDocParser $phpDocParser;
+
+    private Lexer $lexer;
+
+    public function __construct(bool $enabled, PhpDocParser $phpDocParser, Lexer $lexer)
     {
         $this->enabled = $enabled;
+        $this->lexer = $lexer;
+        $this->phpDocParser = $phpDocParser;
     }
 
     public function isEntrypoint(ReflectionMethod $method): bool
@@ -28,6 +37,8 @@ public function isEntrypoint(ReflectionMethod $method): bool
             return false;
         }
 
+        $this->gatherDataProviders($method);
+
         return $this->isTestCaseMethod($method)
             || $this->isDataProviderMethod($method);
     }
@@ -40,21 +51,73 @@ private function isTestCaseMethod(ReflectionMethod $method): bool
 
     private function isDataProviderMethod(ReflectionMethod $originalMethod): bool
     {
+        if (!$originalMethod->getDeclaringClass()->isSubclassOf(TestCase::class)) {
+            return false;
+        }
+
+        $declaringClass = $originalMethod->getDeclaringClass();
+        $declaringClassName = $declaringClass->getName();
+
+        return $this->dataProviders[$declaringClassName][$originalMethod->getName()] ?? false;
+    }
+
+    private function gatherDataProviders(ReflectionMethod $originalMethod): void
+    {
+        if (!$originalMethod->getDeclaringClass()->isSubclassOf(TestCase::class)) {
+            return;
+        }
+
         $declaringClass = $originalMethod->getDeclaringClass();
         $declaringClassName = $declaringClass->getName();
 
-        if (!isset($this->dataProviders[$declaringClassName])) {
-            foreach ($declaringClass->getMethods() as $method) {
-                foreach ($method->getAttributes(DataProvider::class) as $providerAttributeReflection) {
-                    /** @var DataProvider $providerAttribute */
-                    $providerAttribute = $providerAttributeReflection->newInstance();
+        if (isset($this->dataProviders[$declaringClassName])) {
+            return;
+        }
+
+        foreach ($declaringClass->getMethods() as $method) {
+            if ($method->getDeclaringClass()->getName() !== $declaringClassName) {
+                continue; // dont iterate parents
+            }
+
+            foreach ($this->getDataProvidersFromAnnotations($method->getDocComment()) as $dataProvider) {
+                $this->dataProviders[$declaringClassName][$dataProvider] = true;
+            }
 
-                    $this->dataProviders[$declaringClassName][$providerAttribute->methodName()] = true;
-                }
+            foreach ($this->getDataProvidersFromAttributes($method) as $dataProvider) {
+                $this->dataProviders[$declaringClassName][$dataProvider] = true;
             }
         }
+    }
 
-        return $this->dataProviders[$declaringClassName][$originalMethod->getName()] ?? false;
+    /**
+     * @param false|string $rawPhpDoc
+     * @return iterable<string>
+     */
+    private function getDataProvidersFromAnnotations($rawPhpDoc): iterable
+    {
+        if ($rawPhpDoc === false) {
+            return;
+        }
+
+        $tokens = new TokenIterator($this->lexer->tokenize($rawPhpDoc));
+        $phpDoc = $this->phpDocParser->parse($tokens);
+
+        foreach ($phpDoc->getTagsByName('@dataProvider') as $tag) {
+            yield (string) $tag->value;
+        }
+    }
+
+    /**
+     * @return iterable<string>
+     */
+    private function getDataProvidersFromAttributes(ReflectionMethod $method): iterable
+    {
+        foreach ($method->getAttributes(DataProvider::class) as $providerAttributeReflection) {
+            /** @var DataProvider $providerAttribute */
+            $providerAttribute = $providerAttributeReflection->newInstance();
+
+            yield $providerAttribute->methodName();
+        }
     }
 
 }

tests/Rule/DeadMethodRuleTest.php

@@ -4,6 +4,8 @@
 
 use PhpParser\Node;
 use PHPStan\Collectors\Collector;
+use PHPStan\PhpDocParser\Lexer\Lexer;
+use PHPStan\PhpDocParser\Parser\PhpDocParser;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPUnit\Framework\Attributes\DataProvider;
 use ReflectionMethod;
@@ -45,7 +47,11 @@ public function isEntrypoint(ReflectionMethod $method): bool
                 self::getContainer()->getByType(ReflectionProvider::class),
                 enabled: true,
             ),
-            new PhpUnitEntrypointProvider(enabled: true),
+            new PhpUnitEntrypointProvider(
+                true,
+                self::getContainer()->getByType(PhpDocParser::class),
+                self::getContainer()->getByType(Lexer::class),
+            ),
             new SymfonyEntrypointProvider(enabled: true),
         ];
         return [

tests/Rule/data/DeadMethodRule/providers/phpunit.php

@@ -8,13 +8,24 @@
 class SomeTest extends TestCase
 {
 
-
-    #[DataProvider('provide')]
+    #[DataProvider('provideFromAttribute')]
     public function testFoo(string $arg): void
     {
     }
 
-    public static function provide(): array
+    /**
+     * @dataProvider provideFromPhpDoc
+     */
+    public function testBar(string $arg): void
+    {
+    }
+
+    public static function provideFromAttribute(): array
+    {
+        return [];
+    }
+
+    public static function provideFromPhpDoc(): array
     {
         return [];
     }