Add rule that enforces PHPUnit naming conventions

Author: cs278

src/Rules/PHPUnit/ClassNamingRule.php

@@ -0,0 +1,93 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\PHPUnit;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Rules\IdentifierRuleError;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPUnit\Framework\TestCase;
+use function sprintf;
+use function str_ends_with;
+
+/**
+ * @implements Rule<Node\Stmt\Class_>
+ */
+class ClassNamingRule implements Rule
+{
+
+	private ReflectionProvider $reflectionProvider;
+
+	public function __construct(ReflectionProvider $reflectionProvider)
+	{
+		$this->reflectionProvider = $reflectionProvider;
+	}
+
+	public function getNodeType(): string
+	{
+		return Node\Stmt\Class_::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if (!isset($node->namespacedName)) {
+			return [];
+		}
+
+		$className = $node->namespacedName->name;
+		$class = $this->reflectionProvider->getClass($className);
+
+		if (!$class->isSubclassOf(TestCase::class)) {
+			return [];
+		}
+
+		$errors = [];
+
+		if ($class->isAbstract()) {
+			$this->requireSuffix(
+				$errors,
+				$className,
+				'TestCase',
+				'Abstract test case class, \'%s\', should be named ending in \'%s\'.',
+			);
+
+			return $errors;
+		}
+
+		$this->requireSuffix(
+			$errors,
+			$className,
+			'Test',
+			'Concrete test class, \'%s\', should be named ending in \'%s\'.',
+		);
+
+		if (!$class->isFinal()) {
+			$errors[] = RuleErrorBuilder::message(sprintf(
+				'Concrete test class, \'%s\', should be declared final.',
+				$className,
+			))->identifier('phpunit.naming')->build();
+		}
+
+		return $errors;
+	}
+
+	/**
+	 * @param list<IdentifierRuleError> $errors
+	 */
+	private function requireSuffix(array &$errors, string $className, string $suffix, string $messageFormat): void
+	{
+		if (str_ends_with($className, $suffix)) {
+			return;
+		}
+
+		// @todo Case sensitivity??
+		$errors[] = RuleErrorBuilder::message(sprintf(
+			$messageFormat,
+			$className,
+			$suffix,
+		))->identifier('phpunit.naming')->build();
+	}
+
+}

tests/Rules/PHPUnit/ClassNamingRuleTest.php

@@ -0,0 +1,41 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\PHPUnit;
+
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<ClassNamingRule>
+ */
+class ClassNamingRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new ClassNamingRule(self::getContainer()->getByType(ReflectionProvider::class));
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/class-naming.php'], [
+			['Concrete test class, \'ExampleTestCase\\IncorrectlyNamedTst\', should be named ending in \'Test\'.', 5],
+			['Abstract test case class, \'ExampleTestCase\\IncorrectlyNamedTestCse\', should be named ending in \'TestCase\'.', 10],
+			['Concrete test class, \'ExampleTestCase\\NotFinalTest\', should be declared final.', 15],
+			['Concrete test class, \'ExampleTestCase\\NotFinalOrNamedCorrectly\', should be named ending in \'Test\'.', 20],
+			['Concrete test class, \'ExampleTestCase\\NotFinalOrNamedCorrectly\', should be declared final.', 20],
+		]);
+	}
+
+	/**
+	 * @return string[]
+	 */
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [
+			__DIR__ . '/../../../extension.neon',
+		];
+	}
+
+}

tests/Rules/PHPUnit/data/class-naming.php

@@ -0,0 +1,37 @@
+<?php declare(strict_types = 1);
+
+namespace ExampleTestCase;
+
+final class IncorrectlyNamedTst extends \PHPUnit\Framework\TestCase
+{
+
+}
+
+abstract class IncorrectlyNamedTestCse extends \PHPUnit\Framework\TestCase
+{
+
+}
+
+class NotFinalTest extends \PHPUnit\Framework\TestCase
+{
+
+}
+
+class NotFinalOrNamedCorrectly extends \PHPUnit\Framework\TestCase
+{
+
+}
+
+new class() extends \PHPUnit\Framework\TestCase {
+
+};
+
+final class CorrectlyNamedAndFinalTest extends \PHPUnit\Framework\TestCase
+{
+
+}
+
+abstract class CorrectlyNamedTestCase extends \PHPUnit\Framework\TestCase
+{
+
+}