Split entity manager methods of MockEntityFactoryTrait into separate trait

Author: codedmonkey

tests/FunctionalTests/Controller/ApiControllerPublicTest.php

@@ -6,6 +6,7 @@
 use CodedMonkey\Dirigent\Doctrine\Entity\Registry;
 use CodedMonkey\Dirigent\Doctrine\Entity\RegistryPackageMirroring;
 use CodedMonkey\Dirigent\Tests\FunctionalTests\PublicKernel;
+use CodedMonkey\Dirigent\Tests\Helper\EntityManagerTestTrait;
 use CodedMonkey\Dirigent\Tests\Helper\KernelTestCaseTrait;
 use CodedMonkey\Dirigent\Tests\Helper\MockEntityFactoryTrait;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
@@ -14,6 +15,7 @@
 
 class ApiControllerPublicTest extends KernelTestCase
 {
+    use EntityManagerTestTrait;
     use KernelTestCaseTrait;
     use MockEntityFactoryTrait;
 

tests/FunctionalTests/Controller/Dashboard/DashboardAccountControllerTest.php

@@ -4,6 +4,7 @@
 
 use CodedMonkey\Dirigent\Controller\Dashboard\DashboardAccountController;
 use CodedMonkey\Dirigent\Doctrine\Entity\User;
+use CodedMonkey\Dirigent\Tests\Helper\EntityManagerTestTrait;
 use CodedMonkey\Dirigent\Tests\Helper\MockEntityFactoryTrait;
 use CodedMonkey\Dirigent\Tests\Helper\WebTestCaseTrait;
 use Doctrine\ORM\EntityManagerInterface;
@@ -15,6 +16,7 @@
 #[CoversClass(DashboardAccountController::class)]
 class DashboardAccountControllerTest extends WebTestCase
 {
+    use EntityManagerTestTrait;
     use MockEntityFactoryTrait;
     use WebTestCaseTrait;
 

tests/FunctionalTests/Controller/Dashboard/DashboardCredentialsControllerTest.php

@@ -5,6 +5,7 @@
 use CodedMonkey\Dirigent\Controller\Dashboard\DashboardCredentialsController;
 use CodedMonkey\Dirigent\Doctrine\Entity\Credentials;
 use CodedMonkey\Dirigent\Doctrine\Entity\CredentialsType;
+use CodedMonkey\Dirigent\Tests\Helper\EntityManagerTestTrait;
 use CodedMonkey\Dirigent\Tests\Helper\MockEntityFactoryTrait;
 use CodedMonkey\Dirigent\Tests\Helper\WebTestCaseTrait;
 use PHPUnit\Framework\Attributes\CoversClass;
@@ -14,6 +15,7 @@
 #[CoversClass(DashboardCredentialsController::class)]
 class DashboardCredentialsControllerTest extends WebTestCase
 {
+    use EntityManagerTestTrait;
     use MockEntityFactoryTrait;
     use WebTestCaseTrait;
 

tests/FunctionalTests/Controller/Dashboard/DashboardPackagesControllerTest.php

@@ -5,13 +5,15 @@
 use CodedMonkey\Dirigent\Doctrine\Entity\Package;
 use CodedMonkey\Dirigent\Doctrine\Repository\PackageRepository;
 use CodedMonkey\Dirigent\Doctrine\Repository\RegistryRepository;
+use CodedMonkey\Dirigent\Tests\Helper\EntityManagerTestTrait;
 use CodedMonkey\Dirigent\Tests\Helper\MockEntityFactoryTrait;
 use CodedMonkey\Dirigent\Tests\Helper\WebTestCaseTrait;
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 use Symfony\Component\HttpFoundation\Response;
 
 class DashboardPackagesControllerTest extends WebTestCase
 {
+    use EntityManagerTestTrait;
     use MockEntityFactoryTrait;
     use WebTestCaseTrait;
 

tests/FunctionalTests/Controller/Dashboard/DashboardPackagesInfoControllerTest.php

@@ -3,13 +3,15 @@
 namespace CodedMonkey\Dirigent\Tests\FunctionalTests\Controller\Dashboard;
 
 use CodedMonkey\Dirigent\Doctrine\Repository\PackageRepository;
+use CodedMonkey\Dirigent\Tests\Helper\EntityManagerTestTrait;
 use CodedMonkey\Dirigent\Tests\Helper\MockEntityFactoryTrait;
 use CodedMonkey\Dirigent\Tests\Helper\WebTestCaseTrait;
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 use Symfony\Component\HttpFoundation\Response;
 
 class DashboardPackagesInfoControllerTest extends WebTestCase
 {
+    use EntityManagerTestTrait;
     use MockEntityFactoryTrait;
     use WebTestCaseTrait;
 

tests/Helper/EntityManagerTestTrait.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace CodedMonkey\Dirigent\Tests\Helper;
+
+use Doctrine\ORM\EntityManagerInterface;
+
+trait EntityManagerTestTrait
+{
+    /**
+     * Find a single entity by its ID or an array of criteria.
+     *
+     * @template T of object
+     *
+     * @param class-string<T> $className
+     *
+     * @return T|null
+     */
+    protected function findEntity(string $className, array|int $criteria): ?object
+    {
+        if (is_array($criteria)) {
+            return $this->getService(EntityManagerInterface::class)->getRepository($className)->findOneBy($criteria);
+        }
+
+        return $this->getService(EntityManagerInterface::class)->find($className, $criteria);
+    }
+
+    /**
+     * Persist and flush all given entities.
+     *
+     * @param object ...$entities
+     */
+    protected function persistEntities(...$entities): void
+    {
+        $entityManager = $this->getService(EntityManagerInterface::class);
+
+        foreach ($entities as $entity) {
+            $entityManager->persist($entity);
+        }
+
+        $entityManager->flush();
+    }
+
+    protected function clearEntities(): void
+    {
+        $this->getService(EntityManagerInterface::class)->clear();
+    }
+}

tests/Helper/MockEntityFactoryTrait.php

@@ -8,7 +8,6 @@
 use CodedMonkey\Dirigent\Doctrine\Entity\User;
 use CodedMonkey\Dirigent\Doctrine\Entity\Version;
 use Composer\Semver\VersionParser;
-use Doctrine\ORM\EntityManagerInterface;
 use Scheb\TwoFactorBundle\Security\TwoFactor\Provider\Totp\TotpAuthenticator;
 
 trait MockEntityFactoryTrait
@@ -57,7 +56,10 @@ protected function createMockUser(bool $mfaEnabled = false): User
         $user->setPlainPassword('PlainPassword99');
 
         if ($mfaEnabled) {
-            $totpAuthenticator = $this->getService(TotpAuthenticator::class);
+            /** @var TotpAuthenticator $totpAuthenticator */
+            $totpAuthenticator = $this->getMockBuilder(TotpAuthenticator::class)
+                ->disableOriginalConstructor()
+                ->getMock();
 
             $user->setTotpSecret($totpAuthenticator->generateSecret());
         }
@@ -74,43 +76,4 @@ protected function createMockVersion(Package $package, string $versionName = '1.
 
         return $version;
     }
-
-    /**
-     * Find a single entity by its ID or an array of criteria.
-     *
-     * @template T of object
-     *
-     * @param class-string<T> $className
-     *
-     * @return T|null
-     */
-    protected function findEntity(string $className, array|int $criteria): ?object
-    {
-        if (is_array($criteria)) {
-            return $this->getService(EntityManagerInterface::class)->getRepository($className)->findOneBy($criteria);
-        }
-
-        return $this->getService(EntityManagerInterface::class)->find($className, $criteria);
-    }
-
-    /**
-     * Persist and flush all given entities.
-     *
-     * @param object ...$entities
-     */
-    protected function persistEntities(...$entities): void
-    {
-        $entityManager = $this->getService(EntityManagerInterface::class);
-
-        foreach ($entities as $entity) {
-            $entityManager->persist($entity);
-        }
-
-        $entityManager->flush();
-    }
-
-    protected function clearEntities(): void
-    {
-        $this->getService(EntityManagerInterface::class)->clear();
-    }
 }