Doctrine\Tests\ORM\Tools\SchemaToolTest

Complexity

Total Complexity

11

Size/Duplication

Total Lines	271
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	testSchemaHasProperIndexesFromUniqueConstraintAnnotation()	0	17	1
A	testAddUniqueIndexForUniqueFieldAnnotation()	0	19	1
A	testDerivedCompositeKey()	0	46	2
A	testPostGenerateEvents()	0	25	1
A	testRemoveUniqueIndexOverruledByPrimaryKey()	0	17	1
A	testNullDefaultNotAddedToCustomSchemaOptions()	0	11	1
A	testSetDiscriminatorColumnWithoutLength()	0	24	1
A	testPassColumnOptionsToJoinColumn()	0	32	1
A	testPassColumnDefinitionToJoinColumn()	0	22	1
A	testAnnotationOptionsAttribute()	0	24	1

<?php

declare(strict_types=1);

namespace Doctrine\Tests\ORM\Tools;

use Doctrine\DBAL\Types\Type;
use Doctrine\ORM\Annotation as ORM;
use Doctrine\ORM\Mapping\DiscriminatorColumnMetadata;
use Doctrine\ORM\Mapping\InheritanceType;
use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
use Doctrine\ORM\Tools\Event\GenerateSchemaTableEventArgs;
use Doctrine\ORM\Tools\SchemaTool;
use Doctrine\ORM\Tools\ToolEvents;
use Doctrine\Tests\Models\CMS\CmsAddress;
use Doctrine\Tests\Models\CMS\CmsArticle;
use Doctrine\Tests\Models\CMS\CmsComment;
use Doctrine\Tests\Models\CMS\CmsEmployee;
use Doctrine\Tests\Models\CMS\CmsGroup;
use Doctrine\Tests\Models\CMS\CmsPhonenumber;
use Doctrine\Tests\Models\CMS\CmsUser;
use Doctrine\Tests\Models\CompositeKeyInheritance\JoinedDerivedChildClass;
use Doctrine\Tests\Models\CompositeKeyInheritance\JoinedDerivedIdentityClass;
use Doctrine\Tests\Models\CompositeKeyInheritance\JoinedDerivedRootClass;
use Doctrine\Tests\Models\Forum\ForumAvatar;
use Doctrine\Tests\Models\Forum\ForumUser;
use Doctrine\Tests\Models\NullDefault\NullDefaultColumn;
use Doctrine\Tests\OrmTestCase;
use function array_merge;
use function count;
use function current;

class SchemaToolTest extends OrmTestCase
{
    public function testAddUniqueIndexForUniqueFieldAnnotation() : void
    {
        $em         = $this->getTestEntityManager();
        $schemaTool = new SchemaTool($em);

        $classes = [
            $em->getClassMetadata(CmsAddress::class),
            $em->getClassMetadata(CmsArticle::class),
            $em->getClassMetadata(CmsComment::class),
            $em->getClassMetadata(CmsEmployee::class),
            $em->getClassMetadata(CmsGroup::class),
            $em->getClassMetadata(CmsPhonenumber::class),
            $em->getClassMetadata(CmsUser::class),
        ];

        $schema = $schemaTool->getSchemaFromMetadata($classes);

        self::assertTrue($schema->hasTable('cms_users'), 'Table cms_users should exist.');
        self::assertTrue($schema->getTable('cms_users')->columnsAreIndexed(['username']), 'username column should be indexed.');
    }

    public function testAnnotationOptionsAttribute() : void
    {
        $em         = $this->getTestEntityManager();
        $schemaTool = new SchemaTool($em);

        $classes = [
            $em->getClassMetadata(TestEntityWithAnnotationOptionsAttribute::class),
        ];

        $schema = $schemaTool->getSchemaFromMetadata($classes);

        $expected = ['foo' => 'bar', 'baz' => ['key' => 'val']];
        $table    = $schema->getTable('TestEntityWithAnnotationOptionsAttribute');

        self::assertEquals(
            array_merge($expected, ['create_options' => []]),
            $table->getOptions(),
            'options annotation are passed to the tables options'
        );

        self::assertEquals(
            $expected,
            $table->getColumn('test')->getCustomSchemaOptions(),
            'options annotation are passed to the columns customSchemaOptions'
        );
    }

    /**
     * @group DDC-200
     */
    public function testPassColumnDefinitionToJoinColumn() : void
    {
        $customColumnDef = 'MEDIUMINT(6) UNSIGNED NOT NULL';

        $em         = $this->getTestEntityManager();
        $schemaTool = new SchemaTool($em);

        $avatar     = $em->getClassMetadata(ForumAvatar::class);
        $idProperty = $avatar->getProperty('id');

The method getProperty() does not exist on Doctrine\Persistence\Mapping\ClassMetadata.

        $idProperty->setColumnDefinition($customColumnDef);

        $user    = $em->getClassMetadata(ForumUser::class);
        $classes = [$avatar, $user];
        $schema  = $schemaTool->getSchemaFromMetadata($classes);

        self::assertTrue($schema->hasTable('forum_users'));

        $table = $schema->getTable('forum_users');

        self::assertTrue($table->hasColumn('avatar_id'));
        self::assertEquals($customColumnDef, $table->getColumn('avatar_id')->getColumnDefinition());
    }

    /**
     * @group 6830
     */
    public function testPassColumnOptionsToJoinColumn() : void
    {
        $em       = $this->getTestEntityManager();
        $category = $em->getClassMetadata(GH6830Category::class);
        $board    = $em->getClassMetadata(GH6830Board::class);

        $schemaTool = new SchemaTool($em);
        $schema     = $schemaTool->getSchemaFromMetadata([$category, $board]);

        self::assertTrue($schema->hasTable('GH6830Category'));
        self::assertTrue($schema->hasTable('GH6830Board'));

        $tableCategory = $schema->getTable('GH6830Category');
        $tableBoard    = $schema->getTable('GH6830Board');

        self::assertTrue($tableBoard->hasColumn('category_id'));

        self::assertSame(
            $tableCategory->getColumn('id')->getFixed(),
            $tableBoard->getColumn('category_id')->getFixed(),
            'Foreign key/join column should have the same value of option `fixed` as the referenced column'
        );

        self::assertEquals(
            $tableCategory->getColumn('id')->getCustomSchemaOptions(),
            $tableBoard->getColumn('category_id')->getCustomSchemaOptions(),
            'Foreign key/join column should have the same custom options as the referenced column'
        );

        self::assertEquals(
            ['collation' => 'latin1_bin', 'foo' => 'bar'],
            $tableBoard->getColumn('category_id')->getCustomSchemaOptions()
        );
    }

    /**
     * @group DDC-283
     */
    public function testPostGenerateEvents() : void
    {
        $listener = new GenerateSchemaEventListener();

        $em = $this->getTestEntityManager();
        $em->getEventManager()->addEventListener(
            [ToolEvents::postGenerateSchemaTable, ToolEvents::postGenerateSchema],
            $listener
        );
        $schemaTool = new SchemaTool($em);

        $classes = [
            $em->getClassMetadata(CmsAddress::class),
            $em->getClassMetadata(CmsArticle::class),
            $em->getClassMetadata(CmsComment::class),
            $em->getClassMetadata(CmsEmployee::class),
            $em->getClassMetadata(CmsGroup::class),
            $em->getClassMetadata(CmsPhonenumber::class),
            $em->getClassMetadata(CmsUser::class),
        ];

        $schema = $schemaTool->getSchemaFromMetadata($classes);

The assignment to $schema is dead and can be removed.

        self::assertEquals(count($classes), $listener->tableCalls);
        self::assertTrue($listener->schemaCalled);
    }

    public function testNullDefaultNotAddedToCustomSchemaOptions() : void
    {
        $em         = $this->getTestEntityManager();
        $schemaTool = new SchemaTool($em);

        $customSchemaOptions = $schemaTool->getSchemaFromMetadata([$em->getClassMetadata(NullDefaultColumn::class)])
            ->getTable('NullDefaultColumn')
            ->getColumn('nullDefault')
            ->getCustomSchemaOptions();

        self::assertSame([], $customSchemaOptions);
    }

    /**
     * @group DDC-3671
     */
    public function testSchemaHasProperIndexesFromUniqueConstraintAnnotation() : void
    {
        $em         = $this->getTestEntityManager();
        $schemaTool = new SchemaTool($em);
        $classes    = [
            $em->getClassMetadata(UniqueConstraintAnnotationModel::class),
        ];

        $schema = $schemaTool->getSchemaFromMetadata($classes);

        self::assertTrue($schema->hasTable('unique_constraint_annotation_table'));
        $table = $schema->getTable('unique_constraint_annotation_table');

        self::assertCount(1, $table->getIndexes());
        self::assertCount(1, $table->getUniqueConstraints());
        self::assertTrue($table->hasIndex('primary'));
        self::assertTrue($table->hasUniqueConstraint('uniq_hash'));
    }

    public function testRemoveUniqueIndexOverruledByPrimaryKey() : void
    {
        $em         = $this->getTestEntityManager();
        $schemaTool = new SchemaTool($em);
        $classes    = [
            $em->getClassMetadata(FirstEntity::class),
            $em->getClassMetadata(SecondEntity::class),
        ];

        $schema = $schemaTool->getSchemaFromMetadata($classes);

        self::assertTrue($schema->hasTable('first_entity'), 'Table first_entity should exist.');

        $indexes = $schema->getTable('first_entity')->getIndexes();

        self::assertCount(1, $indexes, 'there should be only one index');
        self::assertTrue(current($indexes)->isPrimary(), 'index should be primary');
    }

    public function testSetDiscriminatorColumnWithoutLength() : void
    {
        $em         = $this->getTestEntityManager();
        $schemaTool = new SchemaTool($em);
        $metadata   = $em->getClassMetadata(FirstEntity::class);

        $metadata->setInheritanceType(InheritanceType::SINGLE_TABLE);

The method setInheritanceType() does not exist on Doctrine\Persistence\Mapping\ClassMetadata.

        $discriminatorColumn = new DiscriminatorColumnMetadata();

        $discriminatorColumn->setColumnName('discriminator');
        $discriminatorColumn->setType(Type::getType('string'));

        $metadata->setDiscriminatorColumn($discriminatorColumn);

The method setDiscriminatorColumn() does not exist on Doctrine\Persistence\Mapping\ClassMetadata.

        $schema = $schemaTool->getSchemaFromMetadata([$metadata]);

        self::assertTrue($schema->hasTable('first_entity'));
        $table = $schema->getTable('first_entity');

        self::assertTrue($table->hasColumn('discriminator'));
        $column = $table->getColumn('discriminator');

        self::assertEquals(255, $column->getLength());
    }

    public function testDerivedCompositeKey() : void
    {
        self::markTestIncomplete(
            '@guilhermeblanco, in #6767 this test was added and I got confused while rebasing SchemaTool... '
            . 'so this one does not work atm'
        );

        $em         = $this->getTestEntityManager();
        $schemaTool = new SchemaTool($em);

        $schema = $schemaTool->getSchemaFromMetadata(
            [
                $em->getClassMetadata(JoinedDerivedIdentityClass::class),
                $em->getClassMetadata(JoinedDerivedRootClass::class),
                $em->getClassMetadata(JoinedDerivedChildClass::class),
            ]
        );

        self::assertTrue($schema->hasTable('joined_derived_identity'));
        self::assertTrue($schema->hasTable('joined_derived_root'));
        self::assertTrue($schema->hasTable('joined_derived_child'));

        $rootTable = $schema->getTable('joined_derived_root');
        self::assertNotNull($rootTable->getPrimaryKey());
        self::assertSame(['keyPart1_id', 'keyPart2'], $rootTable->getPrimaryKey()->getColumns());

        $childTable = $schema->getTable('joined_derived_child');
        self::assertNotNull($childTable->getPrimaryKey());
        self::assertSame(['keyPart1_id', 'keyPart2'], $childTable->getPrimaryKey()->getColumns());

        $childTableForeignKeys = $childTable->getForeignKeys();

        self::assertCount(2, $childTableForeignKeys);

        $expectedColumns = [
            'joined_derived_identity' => [['keyPart1_id'], ['id']],
            'joined_derived_root'     => [['keyPart1_id', 'keyPart2'], ['keyPart1_id', 'keyPart2']],
        ];

        foreach ($childTableForeignKeys as $foreignKey) {
            self::assertArrayHasKey($foreignKey->getForeignTableName(), $expectedColumns);

            [$localColumns, $foreignColumns] = $expectedColumns[$foreignKey->getForeignTableName()];

            self::assertSame($localColumns, $foreignKey->getLocalColumns());
            self::assertSame($foreignColumns, $foreignKey->getForeignColumns());
        }
    }
}

/**
 * @ORM\Entity
 * @ORM\Table(options={"foo": "bar", "baz": {"key": "val"}})
 */
class TestEntityWithAnnotationOptionsAttribute
{
    /** @ORM\Id @ORM\Column */
    private $id;

The private property $id is not used, and could be removed.

    /** @ORM\Column(type="string", options={"foo": "bar", "baz": {"key": "val"}}) */
    private $test;

The private property $test is not used, and could be removed.

}

class GenerateSchemaEventListener
{
    public $tableCalls   = 0;
    public $schemaCalled = false;

    public function postGenerateSchemaTable(GenerateSchemaTableEventArgs $eventArgs)

The parameter $eventArgs is not used and could be removed.

    {
        $this->tableCalls++;
    }

    public function postGenerateSchema(GenerateSchemaEventArgs $eventArgs)

The parameter $eventArgs is not used and could be removed.

    {
        $this->schemaCalled = true;
    }
}

/**
 * @ORM\Entity
 * @ORM\Table(
 *     name="unique_constraint_annotation_table",
 *     uniqueConstraints={
 *         @ORM\UniqueConstraint(name="uniq_hash", columns={"hash"})
 *     }
 * )
 */
class UniqueConstraintAnnotationModel
{
    /** @ORM\Id @ORM\Column */
    private $id;

    /** @ORM\Column(name="hash", type="string", length=8, nullable=false, unique=true) */
    private $hash;

The private property $hash is not used, and could be removed.

}

/**
 * @ORM\Entity
 * @ORM\Table(name="first_entity")
 */
class FirstEntity
{
    /**
     * @ORM\Id
     * @ORM\Column(name="id")
     */
    public $id;

    /**
     * @ORM\OneToOne(targetEntity=SecondEntity::class)
     * @ORM\JoinColumn(name="id", referencedColumnName="first_entity_id")
     */
    public $secondEntity;

    /** @ORM\Column(name="name") */
    public $name;
}

/**
 * @ORM\Entity
 * @ORM\Table(name="second_entity")
 */
class SecondEntity
{
    /**
     * @ORM\Id
     * @ORM\Column(name="first_entity_id")
     */
    public $fist_entity_id;

    /** @ORM\Column(name="name") */
    public $name;
}

/**
 * @ORM\Entity
 */
class GH6830Board
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     */
    public $id;

    /**
     * @ORM\ManyToOne(targetEntity=GH6830Category::class, inversedBy="boards")
     * @ORM\JoinColumn(name="category_id", referencedColumnName="id")
     */
    public $category;
}

/**
 * @ORM\Entity
 */
class GH6830Category
{
    /**
     * @ORM\Id
     * @ORM\Column(type="string", length=8, options={"fixed":true, "collation":"latin1_bin", "foo":"bar"})
     *
     * @var string
     */
    public $id;

    /** @ORM\OneToMany(targetEntity=GH6830Board::class, mappedBy="category") */
    public $boards;
}