special case for providers only containing static data, so we get more precise error lines

Author: staabm

src/Rules/PHPUnit/DataProviderDataRule.php

@@ -93,7 +93,7 @@ public function processNode(Node $node, Scope $scope): array
 		foreach ($testsWithProvider as $testMethod) {
 			$numberOfParameters = $testMethod->getNumberOfParameters();
 
-			foreach ($arraysTypes as $arraysType) {
+			foreach ($arraysTypes as [$startLine, $arraysType]) {
 				$args = $this->arrayItemsToArgs($arraysType, $numberOfParameters);
 				if ($args === null) {
 					continue;
@@ -107,7 +107,7 @@ public function processNode(Node $node, Scope $scope): array
 					new TypeExpr(new ObjectType($classReflection->getName())),
 					$testMethod->getName(),
 					$args,
-					['startLine' => $node->getStartLine()],
+					['startLine' => $startLine],
 				));
 			}
 		}
@@ -165,11 +165,38 @@ private function arrayItemsToArgs(Type $array, int $numberOfParameters): ?array
 
 	/**
 	 * @param Node\Stmt\Return_|Node\Expr\Yield_|Node\Expr\YieldFrom $node
-	 * @return array<Type>
+	 *
+	 * @return list<list{int, Type}>
 	 */
 	private function buildArrayTypesFromNode(Node $node, Scope $scope): array
 	{
 		$arraysTypes = [];
+
+		// special case for providers only containing static data, so we get more precise error lines
+		if ($node instanceof Node\Stmt\Return_ && $node->expr instanceof Node\Expr\Array_) {
+			foreach ($node->expr->items as $item) {
+				if (!$item->value instanceof Node\Expr\Array_) {
+					$arraysTypes = [];
+					break;
+				}
+
+				$constArrays = $scope->getType($item->value)->getConstantArrays();
+				if ($constArrays === []) {
+					$arraysTypes = [];
+					break;
+				}
+
+				foreach ($constArrays as $constArray) {
+					$arraysTypes[] = [$item->value->getStartLine(), $constArray];
+				}
+			}
+
+			if ($arraysTypes !== []) {
+				return $arraysTypes;
+			}
+		}
+
+		// general case with less precise error message lines
 		if ($node instanceof Node\Stmt\Return_ || $node instanceof Node\Expr\YieldFrom) {
 			if ($node->expr === null) {
 				return [];
@@ -180,21 +207,25 @@ private function buildArrayTypesFromNode(Node $node, Scope $scope): array
 			foreach ($exprConstArrays as $constArray) {
 				foreach ($constArray->getValueTypes() as $valueType) {
 					foreach ($valueType->getConstantArrays() as $constValueArray) {
-						$arraysTypes[] = $constValueArray;
+						$arraysTypes[] = [$node->getStartLine(), $constValueArray];
 					}
 				}
 			}
 
 			if ($arraysTypes === []) {
-				$arraysTypes = $exprType->getIterableValueType()->getArrays();
+				foreach ($exprType->getIterableValueType()->getArrays() as $arrayType) {
+					$arraysTypes[] = [$node->getStartLine(), $arrayType];
+				}
 			}
 		} elseif ($node instanceof Node\Expr\Yield_) {
 			if ($node->value === null) {
 				return [];
 			}
 
 			$exprType = $scope->getType($node->value);
-			$arraysTypes = $exprType->getConstantArrays();
+			foreach ($exprType->getConstantArrays() as $constValueArray) {
+				$arraysTypes[] = [$node->getStartLine(), $constValueArray];
+			}
 		}
 
 		return $arraysTypes;

tests/Rules/PHPUnit/DataProviderDataRuleTest.php

@@ -49,19 +49,19 @@ public function testRule(): void
 		$this->analyse([__DIR__ . '/data/data-provider-data.php'], [
 			[
 				'Parameter #2 $input of method DataProviderDataTest\FooTest::testWithAttribute() expects string, int given.',
-				19,
+				24,
 			],
 			[
 				'Parameter #2 $input of method DataProviderDataTest\FooTest::testWithAttribute() expects string, false given.',
-				19,
+				28,
 			],
 			[
 				'Parameter #2 $input of method DataProviderDataTest\BarTest::testWithAnnotation() expects string, int given.',
-				46,
+				51,
 			],
 			[
 				'Parameter #2 $input of method DataProviderDataTest\BarTest::testWithAnnotation() expects string, false given.',
-				46,
+				55,
 			],
 			[
 				'Parameter #2 $input of method DataProviderDataTest\YieldTest::myTestMethod() expects string, int given.',
@@ -117,27 +117,27 @@ public function testRule(): void
 			],
 			[
 				'Parameter #1 $si of method DataProviderDataTest\TestInvalidVariadic::testBar() expects int, string given.',
-				333,
+				334,
 			],
 			[
 				'Parameter #1 $s of method DataProviderDataTest\TestInvalidVariadic::testFoo() expects string, int given.',
-				333,
+				335,
 			],
 			[
 				'Parameter #1 $si of method DataProviderDataTest\TestInvalidVariadic2::testBar() expects int, string given.',
-				355,
+				356,
 			],
 			[
 				'Parameter #2 ...$moreS of method DataProviderDataTest\TestInvalidVariadic2::testFoo() expects int, string given.',
-				355,
+				356,
 			],
 			[
 				'Parameter #4 ...$moreS of method DataProviderDataTest\TestInvalidVariadic2::testFoo() expects int, string given.',
-				355,
+				356,
 			],
 			[
 				'Parameter #1 $s of method DataProviderDataTest\TestInvalidVariadic2::testFoo() expects string, int given.',
-				355,
+				357,
 			],
 			[
 				'Unknown parameter $foo in call to method DataProviderDataTest\TestArrayShapeIterable::testBar().',
@@ -165,11 +165,11 @@ public function testRule(): void
 			],
 			[
 				'Parameter #2 $input of method DataProviderDataTest\AbstractBaseTest::testWithAttribute() expects string, int given.',
-				461,
+				466,
 			],
 			[
 				'Parameter #2 $input of method DataProviderDataTest\AbstractBaseTest::testWithAttribute() expects string, false given.',
-				461,
+				470,
 			],
 			[
 				'Parameter #2 $input of method DataProviderDataTest\ConstantArrayUnionTypeReturnTest::testFoo() expects string, int given.',