[phpunit] Add NoAssertFuncCallInTestsRule (#175)

Author: TomasVotruba

README.md

@@ -1669,6 +1669,17 @@ final class SomeTest extends TestCase
 
 <br>
 
+### NoAssertFuncCallInTestsRule
+
+Avoid using assert*() functions in tests, as they can lead to false positives
+
+```yaml
+rules:
+    - Symplify\PHPStanRules\Rules\PHPUnit\NoAssertFuncCallInTestsRule
+```
+
+<br>
+
 ### NoMockOnlyTestRule
 
 Test should have at least one non-mocked property, to test something

config/phpunit-rules.neon

@@ -4,3 +4,5 @@ rules:
 
     - Symplify\PHPStanRules\Rules\Doctrine\NoDocumentMockingRule
     - Symplify\PHPStanRules\Rules\Doctrine\NoEntityMockingRule
+
+    - Symplify\PHPStanRules\Rules\PHPUnit\NoAssertFuncCallInTestsRule

phpunit.xml

@@ -11,5 +11,6 @@
         <directory>tests</directory>
         <exclude>tests/Rules/ClassNameRespectsParentSuffixRule/Fixture/</exclude>
         <exclude>tests/Rules/PHPUnit/PublicStaticDataProviderRule</exclude>
+        <exclude>tests/Rules/PHPUnit/NoAssertFuncCallInTestsRule/Fixture</exclude>
     </testsuite>
 </phpunit>

src/Enum/PHPUnitRuleIdentifier.php

@@ -13,4 +13,6 @@ final class PHPUnitRuleIdentifier
     public const PUBLIC_STATIC_DATA_PROVIDER = 'phpunit.publicStaticDataProvider';
 
     public const NO_MOCK_OBJECT_AND_REAL_OBJECT_PROPERTY = 'phpunit.noMockObjectAndRealObjectProperty';
+
+    public const NO_ASSERT_FUNC_CALL_IN_TESTS = 'phpunit.noAssertFuncCallInTests';
 }

src/Rules/PHPUnit/NoAssertFuncCallInTestsRule.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace Symplify\PHPStanRules\Rules\PHPUnit;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Name;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\IdentifierRuleError;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use Symplify\PHPStanRules\Enum\PHPUnitRuleIdentifier;
+
+/**
+ * @implements Rule<FuncCall>
+ */
+final class NoAssertFuncCallInTestsRule implements Rule
+{
+    /**
+     * @var string
+     */
+    public const ERROR_MESSAGE = 'Instead of assert() that can miss important checks, use native PHPUnit assert call';
+
+    private const TEST_FILE_SUFFIXES = [
+        'Test.php',
+        'TestCase.php',
+        'Context.php',
+    ];
+
+    public function getNodeType(): string
+    {
+        return FuncCall::class;
+    }
+
+    /**
+     * @param FuncCall $node
+     * @return IdentifierRuleError[]
+     */
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if (! $node->name instanceof Name) {
+            return [];
+        }
+
+        if ($node->name->toString() !== 'assert') {
+            return [];
+        }
+
+        if (! $this->isTestFile($scope)) {
+            return [];
+        }
+
+        $identifierRuleError = RuleErrorBuilder::message(self::ERROR_MESSAGE)
+            ->identifier(PHPUnitRuleIdentifier::NO_ASSERT_FUNC_CALL_IN_TESTS)
+            ->build();
+
+        return [$identifierRuleError];
+    }
+
+    private function isTestFile(Scope $scope): bool
+    {
+        foreach (self::TEST_FILE_SUFFIXES as $testFileSuffix) {
+            if (str_ends_with($scope->getFile(), $testFileSuffix)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

tests/Rules/PHPUnit/NoAssertFuncCallInTestsRule/Fixture/AssertFuncCallInsideTest.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Symplify\PHPStanRules\Tests\Rules\PHPUnit\NoAssertFuncCallInTestsRule\Fixture;
+
+final class AssertFuncCallInsideTest
+{
+    public function testMe(int $input)
+    {
+        assert($input === 100);
+    }
+}

tests/Rules/PHPUnit/NoAssertFuncCallInTestsRule/Fixture/SkipTestOutside.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Symplify\PHPStanRules\Tests\Rules\PHPUnit\NoAssertFuncCallInTestsRule\Fixture;
+
+final class SkipTestOutside
+{
+    public function process(int $input)
+    {
+        assert($input === 100);
+    }
+}

tests/Rules/PHPUnit/NoAssertFuncCallInTestsRule/NoAssertFuncCallInTestsRuleTest.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Symplify\PHPStanRules\Tests\Rules\PHPUnit\NoAssertFuncCallInTestsRule;
+
+use Iterator;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Symplify\PHPStanRules\Rules\PHPUnit\NoAssertFuncCallInTestsRule;
+
+final class NoAssertFuncCallInTestsRuleTest extends RuleTestCase
+{
+    #[DataProvider('provideData')]
+    public function testRule(string $filePath, array $expectedErrorsWithLines): void
+    {
+        $this->analyse([$filePath], $expectedErrorsWithLines);
+    }
+
+    public static function provideData(): Iterator
+    {
+        yield [__DIR__ . '/Fixture/AssertFuncCallInsideTest.php', [[NoAssertFuncCallInTestsRule::ERROR_MESSAGE, 9]]];
+
+        yield [__DIR__ . '/Fixture/SkipTestOutside.php', []];
+    }
+
+    protected function getRule(): Rule
+    {
+        return new NoAssertFuncCallInTestsRule();
+    }
+}