Tests

pchapl · Sep 25, 2021 · e3acb74 · e3acb74
1 parent 2f84b85
commit e3acb74
Show file tree

Hide file tree

Showing 10 changed files with 183 additions and 36 deletions.
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -4,18 +4,19 @@
 
 namespace PChapl\DoctrineIdBundle\DependencyInjection;
 
+use PChapl\DoctrineIdBundle\DoctrineIdBundle;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 final class Configuration implements ConfigurationInterface
 {
     public function getConfigTreeBuilder(): TreeBuilder
     {
-        $treeBuilder = new TreeBuilder('doctrine_id');
+        $treeBuilder = new TreeBuilder(DoctrineIdBundle::BUNDLE_ID);
 
         $treeBuilder->getRootNode()
             ->children()
-                ->arrayNode('types')
+                ->arrayNode(DoctrineIdBundle::CONFIG_TYPES_KEY)
                     ->useAttributeAsKey('name')
                     ->scalarPrototype()->end()
                 ?->end()

diff --git a/src/DependencyInjection/DoctrineIdExtension.php b/src/DependencyInjection/DoctrineIdExtension.php
@@ -2,6 +2,7 @@
 
 namespace PChapl\DoctrineIdBundle\DependencyInjection;
 
+use PChapl\DoctrineIdBundle\DoctrineIdBundle;
 use PChapl\DoctrineIdBundle\Exception\InvalidConfigurationException;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
@@ -12,28 +13,28 @@ public function load(array $configs, ContainerBuilder $container): void
     {
         $config = $this->processConfiguration(new Configuration(), $configs);
 
-        $idTypes = $config['types'] ?? [];
+        $idTypes = $config[DoctrineIdBundle::CONFIG_TYPES_KEY] ?? [];
 
         $types = $container->hasParameter('doctrine.dbal.connection_factory.types')
             ? $container->getParameter('doctrine.dbal.connection_factory.types')
             : [];
 
         foreach ($idTypes as $typeName => $class) {
             if (!class_exists($class)) {
-                throw new InvalidConfigurationException("Can not load class $class");
+                throw new InvalidConfigurationException("Can not load class '$class'");
             }
             if (array_key_exists($typeName, $types)) {
                 throw new InvalidConfigurationException(
                     sprintf(
                         'Duplicate key "%s": type should be described either for %s or %s',
                         $typeName,
-                        'parameters.doctrine_id.types',
+                        'doctrine_id.types',
                         'doctrine.dbal.types',
                     )
                 );
             }
         }
 
-        $container->setParameter('pchapl.doctrine_id.types', $idTypes);
+        $container->setParameter(DoctrineIdBundle::TYPES_PARAMETER_NAME, $idTypes);
     }
 }
diff --git a/src/DoctrineIdBundle.php b/src/DoctrineIdBundle.php
@@ -12,12 +12,14 @@
 
 final class DoctrineIdBundle extends Bundle
 {
-    /**
-     * @throws Exception|InvalidArgumentException
-     */
+    public const TYPES_PARAMETER_NAME = 'pchapl.doctrine_id.types';
+    public const BUNDLE_ID = 'doctrine_id';
+    public const CONFIG_TYPES_KEY = 'types';
+
+    /** @throws Exception|InvalidArgumentException */
     public function boot(): void
     {
-        $types = $this->container->getParameter('pchapl.doctrine_id.types');
+        $types = $this->container->getParameter(self::TYPES_PARAMETER_NAME);
 
         foreach ($types as $typeName => $class) {
             if (!Type::hasType($typeName)) {

diff --git a/tests/DependencyInjection/ConfigurationTest.php b/tests/DependencyInjection/ConfigurationTest.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace PChapl\Tests\DependencyInjection;
+
+use PChapl\DoctrineIdBundle\DependencyInjection\Configuration;
+use PChapl\DoctrineIdBundle\DoctrineIdBundle;
+use PHPUnit\Framework\TestCase;
+
+class ConfigurationTest extends TestCase
+{
+    private const TYPES = [
+        DoctrineIdBundle::CONFIG_TYPES_KEY => [
+            'account_id' => 'App\Data\AccountId',
+            'user_id' => 'App\Data\UserId',
+        ],
+    ];
+
+    private Configuration $configuration;
+
+    protected function setUp(): void
+    {
+        $this->configuration = new Configuration();
+    }
+
+    public function testTree(): void
+    {
+        $tree = $this->configuration->getConfigTreeBuilder()->buildTree();
+
+        self::assertSame(DoctrineIdBundle::BUNDLE_ID, $tree->getName());
+        self::assertSame(self::TYPES, $tree->normalize(self::TYPES));
+    }
+}
diff --git a/tests/DependencyInjection/DoctrineIdExtensionTest.php b/tests/DependencyInjection/DoctrineIdExtensionTest.php
@@ -0,0 +1,92 @@
+<?php
+
+namespace PChapl\Tests\DependencyInjection;
+
+use PChapl\DoctrineIdBundle\DependencyInjection\DoctrineIdExtension;
+use PChapl\DoctrineIdBundle\DoctrineIdBundle;
+use PChapl\DoctrineIdBundle\Exception\InvalidConfigurationException;
+use PChapl\Tests\TestId;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+class DoctrineIdExtensionTest extends TestCase
+{
+    private const TEST_ID_TYPE_NAME = 'test_id_type_name';
+    private const CONFIGS = [
+        [
+            DoctrineIdBundle::CONFIG_TYPES_KEY => [
+                self::TEST_ID_TYPE_NAME => TestId::class,
+            ],
+        ],
+    ];
+
+    /** @var MockObject&ContainerBuilder */
+    private MockObject|ContainerBuilder $container;
+    private DoctrineIdExtension $extension;
+
+    protected function setUp(): void
+    {
+        $this->extension = new DoctrineIdExtension();
+
+        /** @var ContainerBuilder&MockObject $container */
+        $container = $this->createMock(ContainerBuilder::class);
+        $this->container = $container;
+    }
+
+    public function testLoad(): void
+    {
+        $this->container
+            ->expects($this->once())
+            ->method('setParameter')
+            ->willReturnCallback(
+                static function (string $name, mixed $value) {
+                    self::assertSame(DoctrineIdBundle::TYPES_PARAMETER_NAME, $name);
+                    self::assertIsArray($value);
+                    self::assertCount(1, $value);
+
+                    foreach ($value as $k => $v) {
+                        self::assertSame(self::TEST_ID_TYPE_NAME, $k);
+                        self::assertSame(TestId::class, $v);
+                    }
+                }
+            );
+
+        $this->extension->load(self::CONFIGS, $this->container);
+    }
+
+    public function testLoadFailsOnClass(): void
+    {
+        $this->expectException(InvalidConfigurationException::class);
+        $this->expectExceptionMessage("Can not load class 'fake-class'");
+
+        $this->extension->load(
+            [[DoctrineIdBundle::CONFIG_TYPES_KEY => [self::TEST_ID_TYPE_NAME => 'fake-class']]],
+            $this->container,
+        );
+    }
+
+    public function testLoadFailsOnDuplicate(): void
+    {
+        $duplicatedId = 'test_duplicated_id';
+
+        $this->container->method('hasParameter')->willReturnCallback(
+            static fn (string $name): bool => $name === 'doctrine.dbal.connection_factory.types',
+        );
+        $this->container->method('getParameter')->willReturnCallback(
+            static fn (string $name) => $name === 'doctrine.dbal.connection_factory.types'
+                ? [$duplicatedId => TestId::class]
+                : null,
+        );
+
+        $this->expectException(InvalidConfigurationException::class);
+        $this->expectExceptionMessage(
+            "Duplicate key \"$duplicatedId\": type should be described either for doctrine_id.types or doctrine.dbal.types"
+        );
+
+        $this->extension->load(
+            [[DoctrineIdBundle::CONFIG_TYPES_KEY => [$duplicatedId => TestId::class]]],
+            $this->container,
+        );
+    }
+}
diff --git a/tests/DoctrineIdBundleTest.php b/tests/DoctrineIdBundleTest.php
@@ -0,0 +1,39 @@
+<?php
+
+namespace PChapl\Tests;
+
+use PChapl\DoctrineIdBundle\DoctrineIdBundle;
+use PChapl\DoctrineIdBundle\Id\Type;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+class DoctrineIdBundleTest extends TestCase
+{
+    private const TEST_ID_TYPE_NAME = 'test_id_type_name';
+
+    private DoctrineIdBundle $bundle;
+
+    private array $parameters = [
+        DoctrineIdBundle::TYPES_PARAMETER_NAME => [
+            self::TEST_ID_TYPE_NAME => TestId::class,
+        ],
+    ];
+
+    protected function setUp(): void
+    {
+        $this->bundle = new DoctrineIdBundle();
+        /** @var ContainerInterface&MockObject $container */
+        $container = $this->createMock(ContainerInterface::class);
+        $this->bundle->setContainer($container);
+        $container->method('getParameter')->willReturnCallback(fn (string $name) => $this->parameters[$name] ?? null);
+    }
+
+    public function testBoot(): void
+    {
+        self::assertFalse(Type::hasType(self::TEST_ID_TYPE_NAME));
+        $this->bundle->boot();
+        self::assertTrue(Type::hasType(self::TEST_ID_TYPE_NAME));
+        self::assertInstanceOf(Type::class, Type::getType(self::TEST_ID_TYPE_NAME));
+    }
+}
diff --git a/tests/DoctrineIdExtensionTest.php b/tests/DoctrineIdExtensionTest.php
diff --git a/tests/BaseTest.php → tests/Id/BaseTest.php b/tests/BaseTest.php → tests/Id/BaseTest.php
@@ -1,9 +1,10 @@
 <?php
 
-namespace PChapl\Tests;
+namespace PChapl\Tests\Id;
 
 use PChapl\DoctrineIdBundle\Id\Base;
 use PChapl\DoctrineIdBundle\Id\Factory;
+use PChapl\Tests\TestId;
 use PHPUnit\Framework\TestCase;
 
 class BaseTest extends TestCase

diff --git a/tests/TypeFactoryTest.php → tests/Id/TypeFactoryTest.php b/tests/TypeFactoryTest.php → tests/Id/TypeFactoryTest.php
@@ -1,8 +1,9 @@
 <?php
 
-namespace PChapl\Tests;
+namespace PChapl\Tests\Id;
 
 use PChapl\DoctrineIdBundle\Id\TypeFactory;
+use PChapl\Tests\TestId;
 use PHPUnit\Framework\TestCase;
 
 class TypeFactoryTest extends TestCase

diff --git a/tests/TypeTest.php → tests/Id/TypeTest.php b/tests/TypeTest.php → tests/Id/TypeTest.php
@@ -1,12 +1,13 @@
 <?php
 
-namespace PChapl\Tests;
+namespace PChapl\Tests\Id;
 
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use PChapl\DoctrineIdBundle\Exception\ConversionException;
 use PChapl\DoctrineIdBundle\Id\Base;
 use PChapl\DoctrineIdBundle\Id\Type;
 use PChapl\DoctrineIdBundle\Id\TypeFactory;
+use PChapl\Tests\TestId;
 use PHPUnit\Framework\TestCase;
 use stdClass;