Merge pull request #94 from sabbelasichon/task/add-rule-test-for-RequestAttributeValidationRule

Author: sascha-egerer

src/Rule/RequestAttributeValidationRule.php

@@ -29,6 +29,9 @@ public function getNodeType(): string
 		return Node\Expr\MethodCall::class;
 	}
 
+	/**
+	 * @param Node\Expr\MethodCall $node
+	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if (!$node->name instanceof Node\Identifier) {

tests/Unit/Rule/RequestAttributeValidationRule/Fixture/UseDefinedRequestAttribute.php

@@ -0,0 +1,20 @@
+<?php declare(strict_types = 1);
+
+namespace SaschaEgerer\PhpstanTypo3\Tests\Unit\Rule\RequestAttributeValidationRule\Fixture;
+
+use Psr\Http\Message\ServerRequestInterface;
+
+final class UseDefinedRequestAttribute
+{
+
+	public function someMethod(): void
+	{
+		$this->getServerRequest()->getAttribute('backend.user');
+	}
+
+	public function getServerRequest(): ServerRequestInterface
+	{
+		return $GLOBALS['TYPO3_REQUEST'];
+	}
+
+}

tests/Unit/Rule/RequestAttributeValidationRule/Fixture/UseUndefinedRequestAttribute.php

@@ -0,0 +1,20 @@
+<?php declare(strict_types = 1);
+
+namespace SaschaEgerer\PhpstanTypo3\Tests\Unit\Rule\RequestAttributeValidationRule\Fixture;
+
+use Psr\Http\Message\ServerRequestInterface;
+
+final class UseUndefinedRequestAttribute
+{
+
+	public function someMethod(): void
+	{
+		$this->getServerRequest()->getAttribute('foo');
+	}
+
+	public function getServerRequest(): ServerRequestInterface
+	{
+		return $GLOBALS['TYPO3_REQUEST'];
+	}
+
+}

tests/Unit/Rule/RequestAttributeValidationRule/RequestAttributeValidationRuleTest.php

@@ -0,0 +1,47 @@
+<?php declare(strict_types = 1);
+
+namespace SaschaEgerer\PhpstanTypo3\Tests\Unit\Rule\RequestAttributeValidationRule;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use SaschaEgerer\PhpstanTypo3\Rule\RequestAttributeValidationRule;
+use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
+
+/**
+ * @extends RuleTestCase<RequestAttributeValidationRule>
+ */
+final class RequestAttributeValidationRuleTest extends RuleTestCase
+{
+
+	public function testRuleWithErrors(): void
+	{
+		$this->analyse(
+			[__DIR__ . '/Fixture/UseUndefinedRequestAttribute.php'],
+			[
+				[
+					'There is no request attribute "foo" configured so we can\'t figure out the exact type to return when calling Psr\Http\Message\ServerRequestInterface::getAttribute',
+					12,
+					'You should add custom request attribute to the typo3.requestGetAttributeMapping setting.',
+				],
+			]
+		);
+	}
+
+	public function testRuleWithoutErrors(): void
+	{
+		$this->analyse([__DIR__ . '/Fixture/UseDefinedRequestAttribute.php'], []);
+	}
+
+	protected function getRule(): Rule
+	{
+		return new RequestAttributeValidationRule([
+			'backend.user' => BackendUserAuthentication::class,
+		]);
+	}
+
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [__DIR__ . '/../../../../extension.neon'];
+	}
+
+}