Add test for RequireQueryBuilderOnRepositoryRule (#221)

Author: TomasVotruba

src/Rules/Doctrine/RequireQueryBuilderOnRepositoryRule.php

@@ -22,7 +22,7 @@ final class RequireQueryBuilderOnRepositoryRule implements Rule
     /**
      * @var string
      */
-    private const ERROR_MESSAGE = 'Avoid calling ->createQueryBuilder() directly on EntityManager as it requires select() + from() calls with specific values. Use $repository->createQueryBuilder() to be safe instead';
+    public const ERROR_MESSAGE = 'Avoid calling ->createQueryBuilder() directly on EntityManager as it requires select() + from() calls with specific values. Use $repository->createQueryBuilder() to be safe instead';
 
     public function getNodeType(): string
     {

stubs/Doctrine/ORM/EntityManagerInterface.php

@@ -8,5 +8,11 @@
 
 interface EntityManagerInterface
 {
+    /**
+     * @param class-string $class
+     * @return EntityRepository
+     */
     public function getRepository(string $class): object;
+
+    public function createQueryBuilder();
 }

stubs/Doctrine/ORM/EntityRepository.php

@@ -8,4 +8,7 @@
 
 class EntityRepository
 {
+    public function createQueryBuilder()
+    {
+    }
 }

tests/Rules/Doctrine/RequireQueryBuilderOnRepositoryRule/Fixture/ReportOnEntityManager.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireQueryBuilderOnRepositoryRule\Fixture;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireQueryBuilderOnRepositoryRule\Source\RandomEntity;
+
+final class ReportOnEntityManager
+{
+    public function process(EntityManagerInterface $entityManager)
+    {
+        $someRepository = $entityManager->createQueryBuilder();
+    }
+}

tests/Rules/Doctrine/RequireQueryBuilderOnRepositoryRule/Fixture/SkipCreateQueryBuilderOnRepository.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireQueryBuilderOnRepositoryRule\Fixture;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireQueryBuilderOnRepositoryRule\Source\RandomEntity;
+
+final class SkipCreateQueryBuilderOnRepository
+{
+    public function process(EntityManagerInterface $entityManager)
+    {
+        $someRepository = $entityManager->getRepository(RandomEntity::class);
+
+        $queryBuilder = $someRepository
+            ->createQueryBuilder();
+    }
+
+    public function directlyOnCall(EntityManagerInterface $entityManager)
+    {
+        $queryBuilder = $entityManager->getRepository(RandomEntity::class)
+            ->createQueryBuilder();
+    }
+}

tests/Rules/Doctrine/RequireQueryBuilderOnRepositoryRule/RequireQueryBuilderOnRepositoryRuleTest.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireQueryBuilderOnRepositoryRule;
+
+use Iterator;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Symplify\PHPStanRules\Rules\Doctrine\RequireQueryBuilderOnRepositoryRule;
+
+final class RequireQueryBuilderOnRepositoryRuleTest extends RuleTestCase
+{
+    #[DataProvider('provideData')]
+    public function testRule(string $filePath, array $expectedErrorsWithLines): void
+    {
+        $this->analyse([$filePath], $expectedErrorsWithLines);
+    }
+
+    public static function provideData(): Iterator
+    {
+        yield [__DIR__ . '/Fixture/SkipCreateQueryBuilderOnRepository.php', []];
+
+        yield [__DIR__ . '/Fixture/ReportOnEntityManager.php', [
+            [RequireQueryBuilderOnRepositoryRule::ERROR_MESSAGE, 14],
+        ]];
+    }
+
+    protected function getRule(): Rule
+    {
+        return new RequireQueryBuilderOnRepositoryRule();
+    }
+}

tests/Rules/Doctrine/RequireQueryBuilderOnRepositoryRule/Source/RandomEntity.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireQueryBuilderOnRepositoryRule\Source;
+
+class RandomEntity
+{
+
+}

tests/Rules/Doctrine/RequireServiceRepositoryParentRuleTest/Fixture/SkipContractImplementingRepository.php renamed to tests/Rules/Doctrine/RequireServiceRepositoryParentRule/Fixture/SkipContractImplementingRepository.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireServiceRepositoryParentRuleTest\Fixture;
+namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireServiceRepositoryParentRule\Fixture;
 
 use Doctrine\Bundle\MongoDBBundle\Repository\ServiceDocumentRepositoryInterface;
 

tests/Rules/Doctrine/RequireServiceRepositoryParentRuleTest/Fixture/SkipServiceRepository.php renamed to tests/Rules/Doctrine/RequireServiceRepositoryParentRule/Fixture/SkipServiceRepository.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireServiceRepositoryParentRuleTest\Fixture;
+namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireServiceRepositoryParentRule\Fixture;
 
 use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
 

tests/Rules/Doctrine/RequireServiceRepositoryParentRuleTest/Fixture/SomeRepository.php renamed to tests/Rules/Doctrine/RequireServiceRepositoryParentRule/Fixture/SomeRepository.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireServiceRepositoryParentRuleTest\Fixture;
+namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireServiceRepositoryParentRule\Fixture;
 
 final class SomeRepository
 {