RuleTestCase - fail when analysed symbols do not exist (misconfigured autoloading)

Author: ondrejmirtes

src/Testing/NonexistentAnalysedClassRule.php

@@ -0,0 +1,47 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Testing;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\InClassNode;
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use function sprintf;
+
+/**
+ * @implements Rule<InClassNode>
+ */
+final class NonexistentAnalysedClassRule implements Rule
+{
+
+	public function __construct(private ReflectionProvider $reflectionProvider)
+	{
+	}
+
+	public function getNodeType(): string
+	{
+		return InClassNode::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$className = $node->getClassReflection()->getName();
+		if ($this->reflectionProvider->hasClass($className)) {
+			return [];
+		}
+
+		return [
+			RuleErrorBuilder::message(sprintf(
+				'%s %s not found in ReflectionProvider. Configure "autoload-dev" section in composer.json to include your tests directory.',
+				$node->getClassReflection()->getClassTypeDescription(),
+				$node->getClassReflection()->getName(),
+			))
+				->identifier('phpstan.classNotFound')
+				->nonIgnorable()
+				->build(),
+		];
+	}
+
+}

src/Testing/NonexistentAnalysedTraitRule.php

@@ -0,0 +1,49 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Testing;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\ShouldNotHappenException;
+use function sprintf;
+
+/**
+ * @implements Rule<Node\Stmt\Trait_>
+ */
+final class NonexistentAnalysedTraitRule implements Rule
+{
+
+	public function __construct(private ReflectionProvider $reflectionProvider)
+	{
+	}
+
+	public function getNodeType(): string
+	{
+		return Node\Stmt\Trait_::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if ($node->namespacedName === null) {
+			throw new ShouldNotHappenException();
+		}
+		$traitName = $node->namespacedName->toString();
+		if ($this->reflectionProvider->hasClass($traitName)) {
+			return [];
+		}
+
+		return [
+			RuleErrorBuilder::message(sprintf(
+				'Trait %s not found in ReflectionProvider. Configure "autoload-dev" section in composer.json to include your tests directory.',
+				$traitName,
+			))
+				->identifier('phpstan.traitNotFound')
+				->nonIgnorable()
+				->build(),
+		];
+	}
+
+}

src/Testing/RuleTestCase.php

@@ -171,8 +171,11 @@ static function (Error $error) use ($strictlyTypedSprintf): string {
 	 */
 	public function gatherAnalyserErrors(array $files): array
 	{
+		$reflectionProvider = $this->createReflectionProvider();
 		$ruleRegistry = new DirectRuleRegistry([
 			$this->getRule(),
+			new NonexistentAnalysedClassRule($reflectionProvider),
+			new NonexistentAnalysedTraitRule($reflectionProvider),
 		]);
 		$files = array_map([$this->getFileHelper(), 'normalizePath'], $files);
 		$analyserResult = $this->getAnalyser($ruleRegistry)->analyse(
@@ -196,7 +199,7 @@ public function gatherAnalyserErrors(array $files): array
 			$ruleRegistry,
 			new IgnoreErrorExtensionProvider(self::getContainer()),
 			new RuleErrorTransformer(),
-			$this->createScopeFactory($this->createReflectionProvider(), $this->getTypeSpecifier()),
+			$this->createScopeFactory($reflectionProvider, $this->getTypeSpecifier()),
 			new LocalIgnoresProcessor(),
 			true,
 		);

tests/PHPStan/Testing/NonexistentAnalysedClassRuleTest.php

@@ -0,0 +1,47 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Testing;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\FuncCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+
+/**
+ * @extends RuleTestCase<Rule<FuncCall>>
+ */
+class NonexistentAnalysedClassRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new /** @implements Rule<FuncCall> */class implements Rule {
+
+			public function getNodeType(): string
+			{
+				return FuncCall::class;
+			}
+
+			public function processNode(Node $node, Scope $scope): array
+			{
+				return [];
+			}
+
+		};
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/../../notAutoloaded/nonexistentClasses.php'], [
+			[
+				'Class NamespaceForNonexistentClasses\Foo not found in ReflectionProvider. Configure "autoload-dev" section in composer.json to include your tests directory.',
+				7,
+			],
+			[
+				'Trait NamespaceForNonexistentClasses\FooTrait not found in ReflectionProvider. Configure "autoload-dev" section in composer.json to include your tests directory.',
+				17,
+			],
+		]);
+	}
+
+}

tests/notAutoloaded/nonexistentClasses.php

@@ -13,3 +13,8 @@ public function doFoo(): void
 	}
 
 }
+
+trait FooTrait
+{
+
+}