Sanity check #[RequiresPhp] value and range

Author: staabm

composer.json

@@ -7,6 +7,7 @@
 	],
 	"require": {
 		"php": "^7.4 || ^8.0",
+		"composer/semver": "^3.4",
 		"phpstan/phpstan": "^2.1.32"
 	},
 	"conflict": {

src/Rules/PHPUnit/AttributeRequiresPhpVersionRule.php

@@ -2,12 +2,16 @@
 
 namespace PHPStan\Rules\PHPUnit;
 
+use Composer\Semver\Constraint\ConstraintInterface;
+use Composer\Semver\VersionParser;
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\InClassMethodNode;
+use PHPStan\Php\PhpVersion;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPUnit\Framework\TestCase;
+use UnexpectedValueException;
 use function count;
 use function is_numeric;
 use function method_exists;
@@ -19,6 +23,8 @@
 class AttributeRequiresPhpVersionRule implements Rule
 {
 
+	private ConstraintInterface $phpstanVersionConstraint;
+
 	private PHPUnitVersion $PHPUnitVersion;
 
 	private TestMethodsHelper $testMethodsHelper;
@@ -31,12 +37,16 @@ class AttributeRequiresPhpVersionRule implements Rule
 	public function __construct(
 		PHPUnitVersion $PHPUnitVersion,
 		TestMethodsHelper $testMethodsHelper,
-		bool $deprecationRulesInstalled
+		bool $deprecationRulesInstalled,
+		PhpVersion $phpVersion
 	)
 	{
 		$this->PHPUnitVersion = $PHPUnitVersion;
 		$this->testMethodsHelper = $testMethodsHelper;
 		$this->deprecationRulesInstalled = $deprecationRulesInstalled;
+
+		$parser = new VersionParser();
+		$this->phpstanVersionConstraint = $parser->parseConstraints($phpVersion->getVersionString());
 	}
 
 	public function getNodeType(): string
@@ -62,35 +72,57 @@ public function processNode(Node $node, Scope $scope): array
 		}
 
 		$errors = [];
+		$parser = new VersionParser();
 		foreach ($reflectionMethod->getAttributes('PHPUnit\Framework\Attributes\RequiresPhp') as $attr) {
 			$args = $attr->getArguments();
 			if (count($args) !== 1) {
 				continue;
 			}
 
 			if (
-				!is_numeric($args[0])
+				is_numeric($args[0])
 			) {
+				if ($this->PHPUnitVersion->requiresPhpversionAttributeWithOperator()->yes()) {
+					$errors[] = RuleErrorBuilder::message(
+						sprintf('Version requirement is missing operator.'),
+					)
+						->identifier('phpunit.attributeRequiresPhpVersion')
+						->build();
+				} elseif (
+					$this->deprecationRulesInstalled
+					&& $this->PHPUnitVersion->deprecatesPhpversionAttributeWithoutOperator()->yes()
+				) {
+					$errors[] = RuleErrorBuilder::message(
+						sprintf('Version requirement without operator is deprecated.'),
+					)
+						->identifier('phpunit.attributeRequiresPhpVersion')
+						->build();
+				}
+
 				continue;
 			}
 
-			if ($this->PHPUnitVersion->requiresPhpversionAttributeWithOperator()->yes()) {
+			try {
+				$testPhpVersionConstraint = $parser->parseConstraints($args[0]);
+			} catch (UnexpectedValueException $e) {
 				$errors[] = RuleErrorBuilder::message(
-					sprintf('Version requirement is missing operator.'),
-				)
-					->identifier('phpunit.attributeRequiresPhpVersion')
-					->build();
-			} elseif (
-				$this->deprecationRulesInstalled
-				&& $this->PHPUnitVersion->deprecatesPhpversionAttributeWithoutOperator()->yes()
-			) {
-				$errors[] = RuleErrorBuilder::message(
-					sprintf('Version requirement without operator is deprecated.'),
+					sprintf($e->getMessage()),
 				)
 					->identifier('phpunit.attributeRequiresPhpVersion')
 					->build();
+
+				continue;
+			}
+
+			if ($this->phpstanVersionConstraint->matches($testPhpVersionConstraint)) {
+				continue;
 			}
 
+			$errors[] = RuleErrorBuilder::message(
+				sprintf('Version requirement will always evaluate to false.'),
+			)
+				->identifier('phpunit.attributeRequiresPhpVersion')
+				->build();
 		}
 
 		return $errors;

tests/Rules/PHPUnit/AttributeRequiresPhpVersionRuleTest.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Rules\PHPUnit;
 
+use PHPStan\Php\PhpVersion;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
 use PHPStan\Type\FileTypeMapper;
@@ -12,6 +13,8 @@
 final class AttributeRequiresPhpVersionRuleTest extends RuleTestCase
 {
 
+	private int $phpVersion = 80500;
+
 	private ?int $phpunitMajorVersion;
 
 	private ?int $phpunitMinorVersion;
@@ -78,6 +81,34 @@ public function testRuleOnPHPUnit13(): void
 		]);
 	}
 
+	public function testPhpVersionMismatch(): void
+	{
+		$this->phpunitMajorVersion = 12;
+		$this->phpunitMinorVersion = 4;
+		$this->deprecationRulesInstalled = false;
+
+		$this->analyse([__DIR__ . '/data/requires-php-version-mismatch.php'], [
+			[
+				'Version requirement will always evaluate to false.',
+				12,
+			],
+		]);
+	}
+
+	public function testInvalidPhpVersion(): void
+	{
+		$this->phpunitMajorVersion = 12;
+		$this->phpunitMinorVersion = 4;
+		$this->deprecationRulesInstalled = false;
+
+		$this->analyse([__DIR__ . '/data/requires-php-version-invalid.php'], [
+			[
+				'Could not parse version constraint abc: Invalid version string "abc"',
+				12,
+			],
+		]);
+	}
+
 	protected function getRule(): Rule
 	{
 		$phpunitVersion = new PHPUnitVersion($this->phpunitMajorVersion, $this->phpunitMinorVersion);
@@ -89,6 +120,7 @@ protected function getRule(): Rule
 				$phpunitVersion,
 			),
 			$this->deprecationRulesInstalled,
+			new PhpVersion($this->phpVersion),
 		);
 	}
 

tests/Rules/PHPUnit/data/requires-php-version-invalid.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace RequiresPhpVersionMismatch;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\Attributes\RequiresPhp;
+
+class InvalidConstraint extends TestCase
+{
+	#[RequiresPhp('abc')]
+	public function testFoo(): void {
+
+	}
+}
+

tests/Rules/PHPUnit/data/requires-php-version-mismatch.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace RequiresPhpVersionMismatch;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\Attributes\RequiresPhp;
+
+class RequiresPhp5 extends TestCase
+{
+	#[RequiresPhp('< 7.0')]
+	public function testFoo(): void {
+
+	}
+}
+
+class RequiresPhp8 extends TestCase
+{
+	#[RequiresPhp('>=8.0')]
+	public function testFoo(): void {
+
+	}
+}