Add rule that enforces PHPUnit naming conventions

rules.neon

@@ -4,6 +4,7 @@ rules:
 	- PHPStan\Rules\PHPUnit\AssertSameWithCountRule
 	- PHPStan\Rules\PHPUnit\ClassCoversExistsRule
 	- PHPStan\Rules\PHPUnit\ClassMethodCoversExistsRule
+	- PHPStan\Rules\PHPUnit\ClassNamingRule
 	- PHPStan\Rules\PHPUnit\MockMethodCallRule
 	- PHPStan\Rules\PHPUnit\NoMissingSpaceInClassAnnotationRule
 	- PHPStan\Rules\PHPUnit\NoMissingSpaceInMethodAnnotationRule

src/Rules/PHPUnit/ClassNamingRule.php

@@ -0,0 +1,111 @@
+<?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 strlen;
+use function substr_compare;
+
+/**
+ * @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 [];
+		}
+
+		$class = $this->reflectionProvider->getClass($node->namespacedName->toString());
+
+		if (!$class->isSubclassOf(TestCase::class)) {
+			return [];
+		}
+
+		$errors = [];
+
+		if ($class->isAbstract()) {
+			$this->requireSuffix(
+				$errors,
+				$class->getName(),
+				'TestCase',
+				'Abstract test case class, \'%s\', should be named ending in \'%s\'.',
+			);
+
+			return $errors;
+		}
+
+		$this->requireSuffix(
+			$errors,
+			$class->getName(),
+			'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.',
+				$class->getName(),
+			))->identifier('phpunit.naming')->build();
+		}
+
+		return $errors;
+	}
+
+	/**
+	 * @param list<IdentifierRuleError> $errors
+	 * @param class-string $className
+	 * @param non-empty-string $suffix
+	 */
+	private function requireSuffix(array &$errors, string $className, string $suffix, string $messageFormat): void
+	{
+		if ($this->hasSuffix($className, $suffix)) {
+			return;
+		}
+
+		$errors[] = RuleErrorBuilder::message(sprintf(
+			$messageFormat,
+			$className,
+			$suffix,
+		))->identifier('phpunit.naming')->build();
+	}
+
+	/**
+	 * Checks if class name has the given suffix.
+	 *
+	 * Comparison is case insensitive.
+	 *
+	 * @param class-string $className
+	 * @param non-empty-string $suffix
+	 */
+	private function hasSuffix(string $className, string $suffix): bool
+	{
+		$classNameLen = strlen($className);
+		$suffixLen = strlen($suffix);
+
+		return $suffixLen < $classNameLen
+			&& substr_compare($className, $suffix, -$suffixLen, $suffixLen, true) === 0;
+	}
+
+}

tests/Rules/PHPUnit/AssertSameBooleanExpectedRuleTest.php

@@ -8,7 +8,7 @@
 /**
  * @extends RuleTestCase<AssertSameBooleanExpectedRule>
  */
-class AssertSameBooleanExpectedRuleTest extends RuleTestCase
+final class AssertSameBooleanExpectedRuleTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule

tests/Rules/PHPUnit/AssertSameMethodDifferentTypesRuleTest.php

@@ -9,7 +9,7 @@
 /**
  * @extends RuleTestCase<ImpossibleCheckTypeMethodCallRule>
  */
-class AssertSameMethodDifferentTypesRuleTest extends RuleTestCase
+final class AssertSameMethodDifferentTypesRuleTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule

tests/Rules/PHPUnit/AssertSameNullExpectedRuleTest.php

@@ -8,7 +8,7 @@
 /**
  * @extends RuleTestCase<AssertSameNullExpectedRule>
  */
-class AssertSameNullExpectedRuleTest extends RuleTestCase
+final class AssertSameNullExpectedRuleTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule

tests/Rules/PHPUnit/AssertSameStaticMethodDifferentTypesRuleTest.php

@@ -9,7 +9,7 @@
 /**
  * @extends RuleTestCase<ImpossibleCheckTypeStaticMethodCallRule>
  */
-class AssertSameStaticMethodDifferentTypesRuleTest extends RuleTestCase
+final class AssertSameStaticMethodDifferentTypesRuleTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule

tests/Rules/PHPUnit/AssertSameWithCountRuleTest.php

@@ -8,7 +8,7 @@
 /**
  * @extends RuleTestCase<AssertSameWithCountRule>
  */
-class AssertSameWithCountRuleTest extends RuleTestCase
+final class AssertSameWithCountRuleTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule

tests/Rules/PHPUnit/ClassCoversExistsRuleTest.php

@@ -8,7 +8,7 @@
 /**
  * @extends RuleTestCase<ClassCoversExistsRule>
  */
-class ClassCoversExistsRuleTest extends RuleTestCase
+final class ClassCoversExistsRuleTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule

tests/Rules/PHPUnit/ClassMethodCoversExistsRuleTest.php

@@ -9,7 +9,7 @@
 /**
  * @extends RuleTestCase<ClassMethodCoversExistsRule>
  */
-class ClassMethodCoversExistsRuleTest extends RuleTestCase
+final class ClassMethodCoversExistsRuleTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule

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>
+ */
+final 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/DataProviderDeclarationRuleTest.php

@@ -9,7 +9,7 @@
 /**
  * @extends RuleTestCase<DataProviderDeclarationRule>
  */
-class DataProviderDeclarationRuleTest extends RuleTestCase
+final class DataProviderDeclarationRuleTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule

tests/Rules/PHPUnit/ImpossibleCheckTypeMethodCallRuleTest.php

@@ -9,7 +9,7 @@
 /**
  * @extends RuleTestCase<ImpossibleCheckTypeMethodCallRule>
  */
-class ImpossibleCheckTypeMethodCallRuleTest extends RuleTestCase
+final class ImpossibleCheckTypeMethodCallRuleTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule

tests/Rules/PHPUnit/MockMethodCallRuleTest.php

@@ -9,7 +9,7 @@
 /**
  * @extends RuleTestCase<MockMethodCallRule>
  */
-class MockMethodCallRuleTest extends RuleTestCase
+final class MockMethodCallRuleTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule

tests/Rules/PHPUnit/NoMissingSpaceInClassAnnotationRuleTest.php

@@ -8,7 +8,7 @@
 /**
  * @extends RuleTestCase<NoMissingSpaceInClassAnnotationRule>
  */
-class NoMissingSpaceInClassAnnotationRuleTest extends RuleTestCase
+final class NoMissingSpaceInClassAnnotationRuleTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule

tests/Rules/PHPUnit/NoMissingSpaceInMethodAnnotationRuleTest.php

@@ -8,7 +8,7 @@
 /**
  * @extends RuleTestCase<NoMissingSpaceInMethodAnnotationRule>
  */
-class NoMissingSpaceInMethodAnnotationRuleTest extends RuleTestCase
+final class NoMissingSpaceInMethodAnnotationRuleTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule

tests/Rules/PHPUnit/ShouldCallParentMethodsRuleTest.php

@@ -8,7 +8,7 @@
 /**
  * @extends RuleTestCase<ShouldCallParentMethodsRule>
  */
-class ShouldCallParentMethodsRuleTest extends RuleTestCase
+final class ShouldCallParentMethodsRuleTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule

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
+{
+
+}

tests/Type/PHPUnit/AssertFunctionTypeSpecifyingExtensionTest.php

@@ -5,7 +5,7 @@
 use PHPStan\Testing\TypeInferenceTestCase;
 use function function_exists;
 
-class AssertFunctionTypeSpecifyingExtensionTest extends TypeInferenceTestCase
+final class AssertFunctionTypeSpecifyingExtensionTest extends TypeInferenceTestCase
 {
 
 	/** @return mixed[] */

tests/Type/PHPUnit/AssertMethodTypeSpecifyingExtensionTest.php

@@ -4,7 +4,7 @@
 
 use PHPStan\Testing\TypeInferenceTestCase;
 
-class AssertMethodTypeSpecifyingExtensionTest extends TypeInferenceTestCase
+final class AssertMethodTypeSpecifyingExtensionTest extends TypeInferenceTestCase
 {
 
 	/** @return mixed[] */