feat(story as fixture): if only one fixture, load it by default

Author: nikophil

config/persistence.php

@@ -24,7 +24,7 @@
             ->arg('$kernel', service('kernel'))
             ->tag('console.command', [
                 'command' => 'foundry:load-stories',
-                'aliases' => ['foundry:load-fixtures'],
+                'aliases' => ['foundry:load-fixtures', 'foundry:load-fixture', 'foundry:load-story'],
                 'description' => 'Load stories which are marked with #[AsFixture] attribute.',
             ])
     ;

docs/index.rst

@@ -1160,7 +1160,7 @@ once. To do this, wrap the operations in a ``flush_after()`` callback:
         TagFactory::createMany(200); // instantiated/persisted but not flushed
     }); // single flush
 
-The ``flush_after()`` function forwards the callback’s return, in case you need to use the objects in your tests:
+The ``flush_after()`` function forwards the callback's return, in case you need to use the objects in your tests:
 
 ::
 
@@ -2411,6 +2411,10 @@ Mark with the attribute ``#[AsFixture]`` the stories your want to be loaded by t
 
 ``bin/console foundry:load-stories category`` will now load the story ``CategoryStory`` in your database.
 
+.. note::
+
+    If only a single story exists, you can omit the argument and just call ``bin/console foundry:load-stories`` to load it.
+
 You can also load stories by group, by using the ``groups`` option:
 
 ::
@@ -2425,7 +2429,7 @@ You can also load stories by group, by using the ``groups`` option:
 
 ``bin/console foundry:load-stories all-stories`` will load both stories ``CategoryStory`` and ``PostStory``.
 
-.. note::
+.. tip::
 
     It is possible to call a story inside another story, by using `OtherStory::load();`. Because the stories are only
     loaded once, it will work regardless of the order of the stories.

src/Attribute/AsFixture.php

@@ -13,8 +13,6 @@
 
 namespace Zenstruck\Foundry\Attribute;
 
-use Zenstruck\Foundry\Story;
-
 /**
  * @author Nicolas PHILIPPE <[email protected]>
  */

src/Command/LoadStoryCommand.php

@@ -11,6 +11,7 @@
 
 namespace Zenstruck\Foundry\Command;
 
+use DAMA\DoctrineTestBundle\Doctrine\DBAL\StaticDriver;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Exception\LogicException;
@@ -19,14 +20,9 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
-use Symfony\Component\DependencyInjection\ServiceLocator;
 use Symfony\Component\HttpKernel\KernelInterface;
-use Zenstruck\Foundry\Configuration;
-use Zenstruck\Foundry\Exception\PersistenceNotAvailable;
 use Zenstruck\Foundry\Persistence\ResetDatabase\BeforeFirstTestResetter;
-use Zenstruck\Foundry\Persistence\ResetDatabase\ResetDatabaseManager;
 use Zenstruck\Foundry\Story;
-use Zenstruck\Foundry\Tests\Fixture\TestKernel;
 
 /**
  * @author Nicolas PHILIPPE <[email protected]>
@@ -41,8 +37,7 @@ public function __construct(
         /** @var iterable<BeforeFirstTestResetter> */
         private iterable $databaseResetters,
         private KernelInterface $kernel,
-    )
-    {
+    ) {
         parent::__construct();
     }
 
@@ -56,7 +51,7 @@ protected function configure(): void
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        if (count($this->stories) === 0) {
+        if (0 === \count($this->stories)) {
             throw new LogicException('No story as fixture available: add attribute #[AsFixture] to your story classes before running this command.');
         }
 
@@ -69,14 +64,18 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $stories = [];
 
         if (null === ($name = $input->getArgument('name'))) {
-            $storyNames = array_keys($this->stories);
-            if (count($this->groupedStories) > 0) {
-                $storyNames[] = '(choose a group of stories...)';
+            if (1 === \count($this->stories)) {
+                $name = \array_keys($this->stories)[0];
+            } else {
+                $storyNames = \array_keys($this->stories);
+                if (\count($this->groupedStories) > 0) {
+                    $storyNames[] = '(choose a group of stories...)';
+                }
+                $name = $io->choice('Choose a story to load:', $storyNames);
             }
-            $name = $io->choice('Choose a story to load:', $storyNames);
 
             if (!isset($this->stories[$name])) {
-                $groupsNames = array_keys($this->groupedStories);
+                $groupsNames = \array_keys($this->groupedStories);
                 $name = $io->choice('Choose a group of stories:', $groupsNames);
             }
         }
@@ -92,14 +91,14 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         if (!$stories) {
-            throw new InvalidArgumentException("Story with name \"$name\" does not exist.");
+            throw new InvalidArgumentException("Story with name \"{$name}\" does not exist.");
         }
 
         foreach ($stories as $name => $storyClass) {
             $storyClass::load();
 
             if ($io->isVerbose()) {
-                $io->info("Story \"$storyClass\" loaded (name: $name).");
+                $io->info("Story \"{$storyClass}\" loaded (name: {$name}).");
             }
         }
 
@@ -110,6 +109,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
     private function resetDatabase(): void
     {
+        // it is very not likely that we need dama when running this command
+        if (\class_exists(StaticDriver::class) && StaticDriver::isKeepStaticConnections()) {
+            StaticDriver::setKeepStaticConnections(false);
+        }
+
         foreach ($this->databaseResetters as $databaseResetter) {
             $databaseResetter->resetBeforeFirstTest($this->kernel);
         }

src/DependencyInjection/AsFixtureStoryCompilerPass.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Zenstruck\Foundry\DependencyInjection;
 
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
@@ -19,16 +28,14 @@ public function process(ContainerBuilder $container): void
         $fixtureStories = [];
         $groupedFixtureStories = [];
         foreach ($container->findTaggedServiceIds('foundry.story.fixture') as $id => $tags) {
-            if (count($tags) !== 1) {
+            if (1 !== \count($tags)) {
                 throw new LogicException('Tag "foundry.story.fixture" must be used only once per service.');
             }
 
             $name = $tags[0]['name'];
 
             if (isset($fixtureStories[$name])) {
-                throw new LogicException(
-                    "Cannot use #[AsFixture] name \"{$name}\" for service \"{$id}\". This name is already used by service \"{$fixtureStories[$name]}\"."
-                );
+                throw new LogicException("Cannot use #[AsFixture] name \"{$name}\" for service \"{$id}\". This name is already used by service \"{$fixtureStories[$name]}\".");
             }
 
             $storyClass = $container->findDefinition($id)->getClass();
@@ -46,11 +53,9 @@ public function process(ContainerBuilder $container): void
             }
         }
 
-        if ($collisionNames = array_intersect(array_keys($fixtureStories), array_keys($groupedFixtureStories))) {
-            $collisionNames = implode('", "', $collisionNames);
-            throw new LogicException(
-                "Cannot use #[AsFixture] group(s) \"{$collisionNames}\", they collide with fixture names."
-            );
+        if ($collisionNames = \array_intersect(\array_keys($fixtureStories), \array_keys($groupedFixtureStories))) {
+            $collisionNames = \implode('", "', $collisionNames);
+            throw new LogicException("Cannot use #[AsFixture] group(s) \"{$collisionNames}\", they collide with fixture names.");
         }
 
         $container->findDefinition('.zenstruck_foundry.story.load_story-command')

src/ZenstruckFoundryBundle.php

@@ -14,8 +14,8 @@
 use Symfony\Component\Config\Definition\Configurator\DefinitionConfigurator;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
-use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\LogicException;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\Bundle\AbstractBundle;
@@ -29,7 +29,6 @@
 use Zenstruck\Foundry\ORM\ResetDatabase\OrmResetter;
 use Zenstruck\Foundry\ORM\ResetDatabase\ResetDatabaseMode;
 use Zenstruck\Foundry\ORM\ResetDatabase\SchemaDatabaseResetter;
-use Symfony\Component\DependencyInjection\Exception\LogicException;
 
 /**
  * @author Kevin Bond <[email protected]>
@@ -437,10 +436,8 @@ private function configureFixturesStory(ContainerConfigurator $configurator, Con
             AsFixture::class,
             // @phpstan-ignore argument.type
             static function(ChildDefinition $definition, AsFixture $attribute, \ReflectionClass $reflector) {
-                if (false === $reflector->getParentClass() || $reflector->getParentClass()->getName() !== Story::class) {
-                    throw new LogicException(
-                        \sprintf("Only stories can be marked with \"%s\" attribute, class \"%s\" is not a story.", AsFixture::class, $reflector->getName())
-                    );
+                if (false === $reflector->getParentClass() || Story::class !== $reflector->getParentClass()->getName()) {
+                    throw new LogicException(\sprintf('Only stories can be marked with "%s" attribute, class "%s" is not a story.', AsFixture::class, $reflector->getName()));
                 }
 
                 $definition->addTag('foundry.story.fixture', ['name' => $attribute->name, 'groups' => $attribute->groups]);

tests/Fixture/Stories/Fixtures/FixtureInGroupStory.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Zenstruck\Foundry\Tests\Fixture\Stories\Fixtures;
 
 use Zenstruck\Foundry\Attribute\AsFixture;

tests/Fixture/Stories/Fixtures/FixtureStory.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Zenstruck\Foundry\Tests\Fixture\Stories\Fixtures;
 
 use Zenstruck\Foundry\Attribute\AsFixture;

tests/Fixture/Stories/Fixtures/FixtureStoryWithGroupNameCollision.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Zenstruck\Foundry\Tests\Fixture\Stories\Fixtures;
 
 use Zenstruck\Foundry\Attribute\AsFixture;

tests/Fixture/Stories/Fixtures/FixtureStoryWithNameCollision.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Zenstruck\Foundry\Tests\Fixture\Stories\Fixtures;
 
 use Zenstruck\Foundry\Attribute\AsFixture;

tests/Fixture/Stories/Fixtures/FixtureUsingAnotherFixtureStory.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Zenstruck\Foundry\Tests\Fixture\Stories\Fixtures;
 
 use Zenstruck\Foundry\Attribute\AsFixture;

tests/Fixture/config/stories_as_fixture_unique.yaml

@@ -0,0 +1,6 @@
+services:
+    _defaults:
+        autowire: true
+        autoconfigure: true
+
+    Zenstruck\Foundry\Tests\Fixture\Stories\Fixtures\FixtureStory: ~

tests/Integration/Command/LoadStoryTest.php renamed to tests/Integration/Command/LoadStoryCommandTest.php

@@ -1,15 +1,24 @@
 <?php
 
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Zenstruck\Foundry\Tests\Integration\Command;
 
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Test;
+use Symfony\Bundle\FrameworkBundle\Console\Application;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Exception\LogicException;
 use Symfony\Component\Console\Output\ConsoleOutput;
 use Symfony\Component\Console\Tester\CommandTester;
-use Symfony\Bundle\FrameworkBundle\Console\Application;
-use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Zenstruck\Foundry\Test\Factories;
 use Zenstruck\Foundry\Test\ResetDatabase;
 use Zenstruck\Foundry\Tests\Fixture\Factories\Entity\GenericEntityFactory;
@@ -18,9 +27,9 @@
 use Zenstruck\Foundry\Tests\Fixture\TestKernel;
 use Zenstruck\Foundry\Tests\Integration\RequiresORM;
 
-final class LoadStoryTest extends KernelTestCase
+final class LoadStoryCommandTest extends KernelTestCase
 {
-    use RequiresORM, ResetDatabase, Factories;
+    use Factories, RequiresORM, ResetDatabase;
 
     /**
      * @test
@@ -81,7 +90,7 @@ public function it_throws_if_name_collision_between_two_stories_name(): void
     {
         $this->expectException(\LogicException::class);
         $this->expectExceptionMessage(
-            sprintf(
+            \sprintf(
                 'Cannot use #[AsFixture] name "fixture-story" for service "%s". This name is already used by service "%s".',
                 FixtureStoryWithNameCollision::class,
                 FixtureStory::class,
@@ -145,8 +154,8 @@ public function it_can_load_fixture_which_loads_another_fixture(string $name): v
 
     public static function provideFixturesWhichLoadAnotherFixtureCases(): iterable
     {
-        yield 'by fixture name' =>  ['fixture-using-another-fixture'];
-        yield 'by group name' =>  ['fixture-using-another-fixture-group'];
+        yield 'by fixture name' => ['fixture-using-another-fixture'];
+        yield 'by group name' => ['fixture-using-another-fixture-group'];
     }
 
     /**
@@ -219,6 +228,21 @@ public function if_no_name_provided_it_asks_for_group_to_load(): void
         self::assertStringContainsString('Loading stories group "multiple-fixtures-in-group"', $commandTester->getDisplay());
     }
 
+    /**
+     * @test
+     */
+    #[Test]
+    public function if_no_name_provided_and_on_one_story_fixture_it_loads_it_automatically(): void
+    {
+        $commandTester = $this->commandTester(['environment' => 'stories_as_fixture_unique']);
+        $commandTester->execute(['--append' => true]);
+
+        GenericEntityFactory::assert()->count(1);
+        GenericEntityFactory::assert()->count(1, ['prop1' => 'fixture-story']);
+
+        self::assertStringContainsString('Loading story with name "fixture-story"', $commandTester->getDisplay());
+    }
+
     private function commandTester(array $options = []): CommandTester
     {
         return new CommandTester((new Application(self::bootKernel($options)))->find('foundry:load-stories'));