Add tests for external routing files (#1036)

| Q               | A
| --------------- | -----
| Bug fix?        | no
| New feature?    | no
| BC breaks?      | no
| Deprecations?   | no
| Related tickets | partially #1029
| License         | MIT

Author: loic425

tests/Application/config/packages/doctrine.yaml

@@ -19,6 +19,11 @@ doctrine:
                 type: attribute
                 dir: '%kernel.project_dir%/src/BoardGameBlog/Domain'
                 prefix: 'App\BoardGameBlog\Domain'
+            Conference:
+                is_bundle: false
+                type: attribute
+                dir: '%kernel.project_dir%/src/Conference/Entity'
+                prefix: 'App\Conference\Entity'
             Subscription:
                 is_bundle: false
                 type: attribute

tests/Application/config/services.yaml

@@ -95,6 +95,9 @@ services:
     App\BoardGameBlog\:
         resource: '../src/BoardGameBlog'
 
+    App\Conference\:
+        resource: '../src/Conference'
+
     App\Subscription\:
         resource: '../src/Subscription'
 

tests/Application/config/sylius/resources.yaml

@@ -1,5 +1,7 @@
 sylius_resource:
     mapping:
+        imports:
+            - '%kernel.project_dir%/config/sylius/resources/imports'
         paths:
             - '%kernel.project_dir%/src/BoardGameBlog/Infrastructure/Sylius/Resource'
             - '%kernel.project_dir%/src/Subscription/Entity'
@@ -52,6 +54,10 @@ sylius_resource:
                 model: App\Entity\PullRequest
                 form: App\Form\Type\PullRequestType
 
+        app.speaker:
+            classes:
+                model: App\Conference\Entity\Speaker
+
         app.zone:
             classes:
                 model: App\Entity\Zone\Zone

tests/Application/config/sylius/resources/imports/speaker.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+use App\Conference\Entity\Speaker;
+use App\Conference\Form\SpeakerType;
+use App\Conference\Grid\SpeakerGrid;
+use Sylius\Resource\Metadata\Create;
+use Sylius\Resource\Metadata\Delete;
+use Sylius\Resource\Metadata\Index;
+use Sylius\Resource\Metadata\Operations;
+use Sylius\Resource\Metadata\ResourceMetadata;
+use Sylius\Resource\Metadata\Update;
+
+return (new ResourceMetadata())
+    ->withRoutePrefix('/admin')
+    ->withClass(Speaker::class)
+    ->withSection('admin')
+    ->withTemplatesDir('crud')
+    ->withFormType(SpeakerType::class)
+    ->withOperations(new Operations([
+        new Create(),
+        new Update(),
+        new Delete(),
+        new Index(grid: SpeakerGrid::class),
+    ]))
+;

tests/Application/src/Conference/Entity/Speaker.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace App\Conference\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Sylius\Resource\Model\ResourceInterface;
+use Symfony\Component\Validator\Constraints\NotBlank;
+
+#[ORM\Entity]
+class Speaker implements ResourceInterface
+{
+    public function __construct(
+        #[ORM\Id]
+        #[ORM\Column(type: 'integer', unique: true)]
+        #[ORM\GeneratedValue(strategy: 'AUTO')]
+        public ?int $id = null,
+        #[NotBlank]
+        #[ORM\Column]
+        public ?string $firstName = null,
+        #[NotBlank]
+        #[ORM\Column]
+        public ?string $lastName = null,
+    ) {
+    }
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function getFullName(): ?string
+    {
+        return $this->firstName . ' ' . $this->lastName;
+    }
+}

tests/Application/src/Conference/Factory/SpeakerFactory.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace App\Conference\Factory;
+
+use App\Conference\Entity\Speaker;
+use Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory;
+
+/**
+ * @extends PersistentProxyObjectFactory<Speaker>
+ */
+final class SpeakerFactory extends PersistentProxyObjectFactory
+{
+    public static function class(): string
+    {
+        return Speaker::class;
+    }
+
+    public function withFirstName(string $firstName): self
+    {
+        return $this->with(['firstName' => $firstName]);
+    }
+
+    public function withLastName(string $lastName): self
+    {
+        return $this->with(['lastName' => $lastName]);
+    }
+
+    protected function defaults(): array
+    {
+        return [
+            'firstName' => self::faker()->firstName(),
+            'lastName' => self::faker()->lastName(),
+        ];
+    }
+}

tests/Application/src/Conference/Form/SpeakerType.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace App\Conference\Form;
+
+use App\Conference\Entity\Speaker;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+final class SpeakerType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $builder
+            ->add('firstName')
+            ->add('lastName')
+        ;
+    }
+
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setDefaults([
+            'data_class' => Speaker::class,
+        ]);
+    }
+}

tests/Application/src/Conference/Grid/SpeakerGrid.php

@@ -0,0 +1,62 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace App\Conference\Grid;
+
+use App\Conference\Entity\Speaker;
+use Sylius\Bundle\GridBundle\Builder\Action\CreateAction;
+use Sylius\Bundle\GridBundle\Builder\Action\DeleteAction;
+use Sylius\Bundle\GridBundle\Builder\Action\UpdateAction;
+use Sylius\Bundle\GridBundle\Builder\ActionGroup\ItemActionGroup;
+use Sylius\Bundle\GridBundle\Builder\ActionGroup\MainActionGroup;
+use Sylius\Bundle\GridBundle\Builder\Field\StringField;
+use Sylius\Bundle\GridBundle\Builder\GridBuilderInterface;
+use Sylius\Bundle\GridBundle\Grid\AbstractGrid;
+use Sylius\Bundle\GridBundle\Grid\ResourceAwareGridInterface;
+
+final class SpeakerGrid extends AbstractGrid implements ResourceAwareGridInterface
+{
+    public static function getName(): string
+    {
+        return 'app_speaker';
+    }
+
+    public function buildGrid(GridBuilderInterface $gridBuilder): void
+    {
+        $gridBuilder
+            ->orderBy('fullName', 'asc')
+            ->setLimits([10, 25, 50])
+            ->addField(
+                StringField::create('fullName')
+                    ->setLabel('Name')
+                    ->setSortable(true, 'firstName'),
+            )
+            ->addActionGroup(
+                MainActionGroup::create(
+                    CreateAction::create(),
+                ),
+            )
+            ->addActionGroup(
+                ItemActionGroup::create(
+                    UpdateAction::create(),
+                    DeleteAction::create(),
+                ),
+            )
+        ;
+    }
+
+    public function getResourceClass(): string
+    {
+        return Speaker::class;
+    }
+}

tests/Application/src/Tests/Controller/SpeakerUiTest.php

@@ -0,0 +1,119 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace App\Tests\Controller;
+
+use ApiTestCase\ApiTestCase;
+use App\Conference\Entity\Speaker;
+use App\Conference\Factory\SpeakerFactory;
+use Coduo\PHPMatcher\Backtrace\VoidBacktrace;
+use Coduo\PHPMatcher\Matcher;
+use Doctrine\ORM\EntityManagerInterface;
+use Symfony\Component\HttpFoundation\Response;
+use Zenstruck\Foundry\Test\Factories;
+use Zenstruck\Foundry\Test\ResetDatabase;
+
+final class SpeakerUiTest extends ApiTestCase
+{
+    use Factories;
+    use ResetDatabase;
+
+    /** @test */
+    public function it_allows_browsing_speakers(): void
+    {
+        SpeakerFactory::new()
+            ->withFirstName('Francis')
+            ->withLastName('Hilaire')
+            ->create()
+        ;
+
+        SpeakerFactory::new()
+            ->withFirstName('Gregor')
+            ->withLastName('Šink')
+            ->create()
+        ;
+
+        $this->client->request('GET', '/admin/speakers');
+        $response = $this->client->getResponse();
+
+        $this->assertResponseCode($response, Response::HTTP_OK);
+        $content = $response->getContent();
+
+        $this->assertStringContainsString('<td>Francis Hilaire</td>', $content);
+        $this->assertStringContainsString('<td>Gregor Šink</td>', $content);
+    }
+
+    /** @test */
+    public function it_allows_accessing_speaker_creation_page(): void
+    {
+        $this->client->request('GET', '/admin/speakers/new');
+
+        $this->assertResponseCode($this->client->getResponse(), Response::HTTP_OK);
+    }
+
+    /** @test */
+    public function it_allows_creating_a_speaker(): void
+    {
+        $this->client->request('GET', '/admin/speakers/new');
+        $this->client->submitForm('Create', [
+            'speaker[firstName]' => 'Francis',
+            'speaker[lastName]' => 'Hilaire',
+        ]);
+
+        $this->assertResponseRedirects(null, expectedCode: Response::HTTP_FOUND);
+
+        /** @var Speaker|null $speaker */
+        $speaker = static::getContainer()->get(EntityManagerInterface::class)->getRepository(Speaker::class)->findOneBy(['firstName' => 'Francis']);
+
+        $this->assertNotNull($speaker);
+        $this->assertSame('Francis Hilaire', $speaker->getFullName());
+    }
+
+    /** @test */
+    public function it_allows_updating_a_speaker(): void
+    {
+        $speaker = SpeakerFactory::createOne();
+
+        $this->client->request('GET', '/admin/speakers/' . $speaker->getId() . '/edit');
+        $this->client->submitForm('Save changes', [
+            'speaker[firstName]' => 'Francis',
+            'speaker[lastName]' => 'Hilaire',
+        ]);
+
+        $this->assertResponseRedirects(null, expectedCode: Response::HTTP_FOUND);
+
+        $speaker->_refresh();
+        $this->assertSame('Francis Hilaire', $speaker->getFullName());
+    }
+
+    /** @test */
+    public function it_allows_deleting_a_speaker(): void
+    {
+        SpeakerFactory::createOne();
+
+        $this->client->request('GET', '/admin/speakers');
+        $this->client->submitForm('Delete');
+
+        $this->assertResponseRedirects(null, expectedCode: Response::HTTP_FOUND);
+
+        /** @var Speaker[] $speakers */
+        $speakers = static::getContainer()->get(EntityManagerInterface::class)->getRepository(Speaker::class)->findAll();
+
+        $this->assertEmpty($speakers);
+    }
+
+    protected function buildMatcher(): Matcher
+    {
+        return $this->matcherFactory->createMatcher(new VoidBacktrace());
+    }
+}