Ignore missingType.iterableValue for data-providers

Author: staabm

data-provider-iterable-value.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace DataProviderIterableValueTest;
+
+use PHPUnit\Framework\TestCase;
+
+class Foo extends TestCase {
+	/**
+	 * @dataProvider dataProvider
+	 * @dataProvider dataProvider2
+	 */
+	public function testFoo() {
+
+	}
+
+	public function dataProvider(): iterable {
+		return [
+			[1, 2],
+			[3, 4],
+			[5, 6],
+		];
+	}
+
+	public function dataProvider2(): iterable {
+		$i = rand(0, 10);
+
+		return [
+			[$i, 2],
+		];
+	}
+
+	public function dataProvider3(): iterable {
+		$i = rand(0, 10);
+
+		return [
+			[$i, 2],
+		];
+	}
+
+	private function returnsMixed(): mixed {
+		return rand(0, 1) ? [[1, 2]] : "string";
+	}
+}

extension.neon

@@ -67,6 +67,11 @@ services:
 		arguments:
 			parser: @defaultAnalysisParser
 
+	-
+		class: PHPStan\Type\PHPUnit\DataProviderReturnTypeIgnoreExtension
+		tags:
+			- phpstan.ignoreErrorExtension
+
 conditionalTags:
 	PHPStan\PhpDoc\PHPUnit\MockObjectTypeNodeResolverExtension:
 		phpstan.phpDoc.typeNodeResolverExtension: %phpunit.convertUnionToIntersectionType%

src/Rules/PHPUnit/DataProviderHelper.php

@@ -53,23 +53,23 @@ public function __construct(
 	}
 
 	/**
-	 * @param ReflectionMethod|ClassMethod $node
+	 * @param ReflectionMethod|ClassMethod $testMethod
 	 *
 	 * @return iterable<array{ClassReflection|null, string, int}>
 	 */
 	public function getDataProviderMethods(
 		Scope $scope,
-		$node,
+		$testMethod,
 		ClassReflection $classReflection
 	): iterable
 	{
-		yield from $this->yieldDataProviderAnnotations($node, $scope, $classReflection);
+		yield from $this->yieldDataProviderAnnotations($testMethod, $scope, $classReflection);
 
 		if (!$this->phpunit10OrNewer) {
 			return;
 		}
 
-		yield from $this->yieldDataProviderAttributes($node, $classReflection);
+		yield from $this->yieldDataProviderAttributes($testMethod, $classReflection);
 	}
 
 	/**

src/Type/PHPUnit/DataProviderReturnTypeIgnoreExtension.php

@@ -0,0 +1,53 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\PHPUnit;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Error;
+use PHPStan\Analyser\IgnoreErrorExtension;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\InClassMethodNode;
+use PHPStan\Rules\PHPUnit\DataProviderHelper;
+use PHPStan\Rules\PHPUnit\TestMethodsHelper;
+
+final class DataProviderReturnTypeIgnoreExtension implements IgnoreErrorExtension
+{
+
+	private TestMethodsHelper $testMethodsHelper;
+
+	private DataProviderHelper $dataProviderHelper;
+
+	public function __construct(
+		TestMethodsHelper $testMethodsHelper,
+		DataProviderHelper $dataProviderHelper
+	)
+	{
+		$this->testMethodsHelper = $testMethodsHelper;
+		$this->dataProviderHelper = $dataProviderHelper;
+	}
+
+	public function shouldIgnore(Error $error, Node $node, Scope $scope): bool
+	{
+		if (! $node instanceof InClassMethodNode) { // @phpstan-ignore phpstanApi.instanceofAssumption
+			return false;
+		}
+
+		if ($error->getIdentifier() !== 'missingType.iterableValue') {
+			return false;
+		}
+
+		$classReflection = $node->getClassReflection();
+		$methodReflection = $node->getMethodReflection();
+		$testMethods = $this->testMethodsHelper->getTestMethods($classReflection, $scope);
+		foreach ($testMethods as $testMethod) {
+			foreach ($this->dataProviderHelper->getDataProviderMethods($scope, $testMethod, $classReflection) as [, $providerMethodName]) {
+				if ($providerMethodName === $methodReflection->getName()) {
+					return true;
+				}
+			}
+		}
+
+		return false;
+	}
+
+}

tests/Type/PHPUnit/DataProviderReturnTypeIgnoreExtensionTest.php

@@ -0,0 +1,30 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\PHPUnit;
+
+use PHPStan\Rules\Methods\MissingMethodReturnTypehintRule;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<MissingMethodReturnTypehintRule>
+ */
+class DataProviderReturnTypeIgnoreExtensionTest extends RuleTestCase {
+	protected function getRule(): Rule
+	{
+		/** @phpstan-ignore phpstanApi.classConstant */
+		$rule = self::getContainer()->getByType(MissingMethodReturnTypehintRule::class);
+		return $rule;
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/data-provider-iterable-value.php'], [
+		]);
+	}
+
+	static public function getAdditionalConfigFiles(): array
+	{
+		return [__DIR__ . '/../../../extension.neon'];
+	}
+}

tests/Type/PHPUnit/data/data-provider-iterable-value.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace DataProviderIterableValueTest;
+
+use PHPUnit\Framework\TestCase;
+
+class Foo extends TestCase {
+	/**
+	 * @dataProvider dataProvider
+	 * @dataProvider dataProvider2
+	 */
+	public function testFoo():void {
+
+	}
+
+	public function dataProvider(): iterable {
+		return [
+			[1, 2],
+			[3, 4],
+			[5, 6],
+		];
+	}
+
+	public function dataProvider2(): iterable {
+		$i = rand(0, 10);
+
+		return [
+			[$i, 2],
+		];
+	}
+}