feat: allow ModelFactory::findOrCreate() in unit tests (#461)

Author: nikophil

src/Configuration.php

@@ -16,6 +16,7 @@
 use Doctrine\Persistence\ObjectManager;
 use Faker;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Zenstruck\Foundry\Exception\FoundryBootException;
 
 /**
  * @internal
@@ -241,10 +242,13 @@ public function getOdmObjectManagersToReset(): array
         return $this->odmObjectManagersToReset;
     }
 
+    /**
+     * @throws FoundryBootException
+     */
     private function managerRegistry(): ?ManagerRegistry
     {
         if (!$this->hasManagerRegistry()) {
-            throw new \RuntimeException('Foundry was booted without doctrine. Ensure your TestCase extends '.KernelTestCase::class);
+            throw FoundryBootException::notBootedWithDoctrine();
         }
 
         return $this->managerRegistry;

src/Exception/FoundryNotBootedException.php renamed to src/Exception/FoundryBootException.php

@@ -11,15 +11,29 @@
 
 namespace Zenstruck\Foundry\Exception;
 
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+
 /**
  * @internal
  */
-final class FoundryNotBootedException extends \RuntimeException
+final class FoundryBootException extends \RuntimeException
 {
-    public function __construct()
+    private function __construct(string $message)
+    {
+        parent::__construct($message);
+    }
+
+    public static function notBootedYet(): self
     {
-        parent::__construct(
+        return new self(
             'Foundry is not yet booted. Using in a test: is your Test case using the Factories trait? Using in a fixture: is ZenstruckFoundryBundle enabled for this environment?'
         );
     }
+
+    public static function notBootedWithDoctrine(): self
+    {
+        return new self(
+            'Foundry was booted without doctrine. Ensure your TestCase extends '.KernelTestCase::class
+        );
+    }
 }

src/Factory.php

@@ -15,7 +15,7 @@
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Mapping\ClassMetadata as ORMClassMetadata;
 use Faker;
-use Zenstruck\Foundry\Exception\FoundryNotBootedException;
+use Zenstruck\Foundry\Exception\FoundryBootException;
 use Zenstruck\Foundry\Persistence\InversedRelationshipCascadePersistCallback;
 use Zenstruck\Foundry\Persistence\PostPersistCallback;
 
@@ -291,13 +291,13 @@ final public static function shutdown(): void
     }
 
     /**
+     * @throws FoundryBootException
      * @internal
-     * @throws FoundryNotBootedException
      */
     final public static function configuration(): Configuration
     {
         if (!self::isBooted()) {
-            throw new FoundryNotBootedException();
+            throw FoundryBootException::notBootedYet();
         }
 
         return self::$configuration; // @phpstan-ignore-line
@@ -315,7 +315,7 @@ final public static function faker(): Faker\Generator
     {
         try {
             return self::configuration()->faker();
-        } catch (FoundryNotBootedException $exception) {
+        } catch (FoundryBootException $exception) {
             throw new \RuntimeException("Cannot get Foundry's configuration. If using faker in a data provider, consider passing attributes as a callable.");
         }
     }

src/ModelFactory.php

@@ -11,6 +11,8 @@
 
 namespace Zenstruck\Foundry;
 
+use Zenstruck\Foundry\Exception\FoundryBootException;
+
 /**
  * @template TModel of object
  * @template-extends Factory<TModel>
@@ -106,8 +108,11 @@ final public static function createSequence(iterable|callable $sequence): array
      */
     final public static function findOrCreate(array $attributes): Proxy
     {
-        if ($found = static::repository()->find($attributes)) {
-            return $found;
+        try {
+            if ($found = static::repository()->find($attributes)) {
+                return $found;
+            }
+        } catch (FoundryBootException) {
         }
 
         return static::new()->create($attributes);

tests/Unit/ModelFactoryTest.php

@@ -116,4 +116,16 @@ public function create_with_many_to_many_relation(): void
         $this->assertNull($post->getId());
         $this->assertCount(3, $post->getTags());
     }
+
+    /**
+     * @test
+     */
+    public function can_call_find_or_create(): void
+    {
+        $post = PostFactory::findOrCreate([
+            'title' => 'foo',
+        ]);
+
+        $this->assertSame('foo', $post->getTitle());
+    }
 }