Make phpunit.dataProviderStatic auto-fixable

Author: ondrejmirtes

composer.json

@@ -7,7 +7,7 @@
 	],
 	"require": {
 		"php": "^7.4 || ^8.0",
-		"phpstan/phpstan": "^2.0.4"
+		"phpstan/phpstan": "^2.1.18"
 	},
 	"conflict": {
 		"phpunit/phpunit": "<7.0"

extension.neon

@@ -54,6 +54,8 @@ services:
 		factory: @PHPStan\Rules\PHPUnit\DataProviderHelperFactory::create()
 	-
 		class: PHPStan\Rules\PHPUnit\DataProviderHelperFactory
+		arguments:
+			parser: @defaultAnalysisParser
 
 conditionalTags:
 	PHPStan\PhpDoc\PHPUnit\MockObjectTypeNodeResolverExtension:

src/Rules/PHPUnit/DataProviderHelper.php

@@ -2,12 +2,15 @@
 
 namespace PHPStan\Rules\PHPUnit;
 
+use PhpParser\Modifiers;
 use PhpParser\Node\Attribute;
 use PhpParser\Node\Expr\ClassConstFetch;
 use PhpParser\Node\Name;
 use PhpParser\Node\Scalar\String_;
 use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\NodeFinder;
 use PHPStan\Analyser\Scope;
+use PHPStan\Parser\Parser;
 use PHPStan\PhpDoc\ResolvedPhpDocBlock;
 use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
 use PHPStan\Reflection\ClassReflection;
@@ -37,16 +40,20 @@ class DataProviderHelper
 	 */
 	private FileTypeMapper $fileTypeMapper;
 
+	private Parser $parser;
+
 	private bool $phpunit10OrNewer;
 
 	public function __construct(
 		ReflectionProvider $reflectionProvider,
 		FileTypeMapper $fileTypeMapper,
+		Parser $parser,
 		bool $phpunit10OrNewer
 	)
 	{
 		$this->reflectionProvider = $reflectionProvider;
 		$this->fileTypeMapper = $fileTypeMapper;
+		$this->parser = $parser;
 		$this->phpunit10OrNewer = $phpunit10OrNewer;
 	}
 
@@ -188,13 +195,28 @@ public function processDataProvider(
 		}
 
 		if ($deprecationRulesInstalled && $this->phpunit10OrNewer && !$dataProviderMethodReflection->isStatic()) {
-			$errors[] = RuleErrorBuilder::message(sprintf(
+			$errorBuilder = RuleErrorBuilder::message(sprintf(
 				'@dataProvider %s related method must be static in PHPUnit 10 and newer.',
 				$dataProviderValue,
 			))
 				->line($lineNumber)
-				->identifier('phpunit.dataProviderStatic')
-				->build();
+				->identifier('phpunit.dataProviderStatic');
+
+			$dataProviderMethodReflectionDeclaringClass = $dataProviderMethodReflection->getDeclaringClass();
+			if ($dataProviderMethodReflectionDeclaringClass->getFileName() !== null) {
+				$stmts = $this->parser->parseFile($dataProviderMethodReflectionDeclaringClass->getFileName());
+				$nodeFinder = new NodeFinder();
+				/** @var ClassMethod|null $methodNode */
+				$methodNode = $nodeFinder->findFirst($stmts, static fn ($node) => $node instanceof ClassMethod && $node->name->toString() === $dataProviderMethodReflection->getName());
+				if ($methodNode !== null) {
+					$errorBuilder->fixNode($methodNode, static function (ClassMethod $methodNode) {
+						$methodNode->flags |= Modifiers::STATIC;
+
+						return $methodNode;
+					});
+				}
+			}
+			$errors[] = $errorBuilder->build();
 		}
 
 		return $errors;

src/Rules/PHPUnit/DataProviderHelperFactory.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Rules\PHPUnit;
 
+use PHPStan\Parser\Parser;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Type\FileTypeMapper;
 use PHPUnit\Framework\TestCase;
@@ -18,10 +19,17 @@ class DataProviderHelperFactory
 
 	private FileTypeMapper $fileTypeMapper;
 
-	public function __construct(ReflectionProvider $reflectionProvider, FileTypeMapper $fileTypeMapper)
+	private Parser $parser;
+
+	public function __construct(
+		ReflectionProvider $reflectionProvider,
+		FileTypeMapper $fileTypeMapper,
+		Parser $parser
+	)
 	{
 		$this->reflectionProvider = $reflectionProvider;
 		$this->fileTypeMapper = $fileTypeMapper;
+		$this->parser = $parser;
 	}
 
 	public function create(): DataProviderHelper
@@ -49,7 +57,7 @@ public function create(): DataProviderHelper
 			}
 		}
 
-		return new DataProviderHelper($this->reflectionProvider, $this->fileTypeMapper, $phpUnit10OrNewer);
+		return new DataProviderHelper($this->reflectionProvider, $this->fileTypeMapper, $this->parser, $phpUnit10OrNewer);
 	}
 
 }

tests/Rules/PHPUnit/DataProviderDeclarationRuleTest.php

@@ -17,7 +17,7 @@ protected function getRule(): Rule
 		$reflection = $this->createReflectionProvider();
 
 		return new DataProviderDeclarationRule(
-			new DataProviderHelper($reflection, self::getContainer()->getByType(FileTypeMapper::class),true),
+			new DataProviderHelper($reflection, self::getContainer()->getByType(FileTypeMapper::class), self::getContainer()->getService('defaultAnalysisParser'), true),
 			true,
 			true
 		);
@@ -65,6 +65,11 @@ public function testRule(): void
 		]);
 	}
 
+	public function testFixDataProviderStatic(): void
+	{
+		$this->fix(__DIR__ . '/data/data-provider-static-fix.php', __DIR__ . '/data/data-provider-static-fix.php.fixed');
+	}
+
 	/**
 	 * @return string[]
 	 */

tests/Rules/PHPUnit/data/data-provider-static-fix.php

@@ -0,0 +1,21 @@
+<?php declare(strict_types=1);
+
+namespace DataProviderStaticFix;
+
+class FixTestCase extends \PHPUnit\Framework\TestCase
+{
+
+	public function dataProvide(): iterable
+	{
+		yield [];
+	}
+
+	/**
+	 * @dataProvider dataProvide
+	 */
+	public function testFoo(): void
+	{
+
+	}
+
+}

tests/Rules/PHPUnit/data/data-provider-static-fix.php.fixed

@@ -0,0 +1,21 @@
+<?php declare(strict_types=1);
+
+namespace DataProviderStaticFix;
+
+class FixTestCase extends \PHPUnit\Framework\TestCase
+{
+
+	public static function dataProvide(): iterable
+	{
+		yield [];
+	}
+
+	/**
+	 * @dataProvider dataProvide
+	 */
+	public function testFoo(): void
+	{
+
+	}
+
+}