TableBuilderTest.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);

namespace TYPO3\CMS\Core\Tests\Unit\Database\Schema\Parser;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use Doctrine\DBAL\Schema\ForeignKeyConstraint;
use Doctrine\DBAL\Schema\Index;
use Doctrine\DBAL\Schema\Table;
use Doctrine\DBAL\Types\IntegerType;
use Doctrine\DBAL\Types\SmallIntType;
use Doctrine\DBAL\Types\TextType;
use TYPO3\CMS\Core\Database\Schema\Parser\Parser;
use TYPO3\CMS\Core\Database\Schema\SqlReader;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class TableBuilderTest extends \TYPO3\TestingFramework\Core\Unit\UnitTestCase
{
    protected $table;

    protected function setUp()
    {
        parent::setUp();
        $sqlFile = file_get_contents(implode(DIRECTORY_SEPARATOR, [__DIR__, '..', 'Fixtures', 'tablebuilder.sql']));
        $sqlReader = GeneralUtility::makeInstance(SqlReader::class);
        $statements = $sqlReader->getCreateTableStatementArray($sqlFile);

        $parser = GeneralUtility::makeInstance(Parser::class, $statements[0]);
        $this->table = $parser->parse()[0];
    }

    public function hasExpectedTableName()
    {
        $this->assertSame('aTestTable', $this->table->getName());
    }

    public function hasExpectedTableEngine()
    {
        $this->assertTrue($this->table->hasOption('engine'));
        $this->assertSame('MyISAM', $this->table->getOption('engine'));
    }

    public function hasExpectedTableCollation()
    {
        $this->assertTrue($this->table->hasOption('charset'));
        $this->assertSame('latin1', $this->table->getOption('charset'));
    }

    public function hasExpectedTableCharacterSet()
    {
        $this->assertTrue($this->table->hasOption('collate'));
        $this->assertSame('latin1_german_cs', $this->table->getOption('collate'));
    }

    public function hasExpectedTableRowFormat()
    {
        $this->assertTrue($this->table->hasOption('row_format'));
        $this->assertSame('DYNAMIC', $this->table->getOption('row_format'));
    }

    public function hasExpectedTableAutoIncrementValue()
    {
        $this->assertTrue($this->table->hasOption('auto_increment'));
        $this->assertSame('1', $this->table->getOption('auto_increment'));
    }

    public function isExpectedUidColumn()
    {
        $subject = $this->table->getColumn('uid');
        $this->assertInstanceOf(IntegerType::class, $subject->getType());
        $this->assertSame(11, $subject->getLength());
        $this->assertFalse($subject->getUnsigned());
        $this->assertTrue($subject->getNotnull());
        $this->assertNull($subject->getDefault());
        $this->assertTrue($subject->getAutoincrement());
    }

    public function isExpectedPidColumn()
    {
        $subject = $this->table->getColumn('pid');
        $this->assertInstanceOf(IntegerType::class, $subject->getType());
        $this->assertSame(11, $subject->getLength());
        $this->assertFalse($subject->getUnsigned());
        $this->assertTrue($subject->getNotnull());
        $this->assertFalse($subject->getAutoincrement());
        $this->assertSame('0', $subject->getDefault());
    }

    public function isExpectedTstampColumn()
    {
        $subject = $this->table->getColumn('tstamp');
        $this->assertInstanceOf(IntegerType::class, $subject->getType());
        $this->assertSame(11, $subject->getLength());
        $this->assertTrue($subject->getUnsigned());
        $this->assertTrue($subject->getNotnull());
        $this->assertFalse($subject->getAutoincrement());
        $this->assertSame('0', $subject->getDefault());
    }

    public function isExpectedSortingColumn()
    {
        $subject = $this->table->getColumn('sorting');
        $this->assertInstanceOf(IntegerType::class, $subject->getType());
        $this->assertSame(11, $subject->getLength());
        $this->assertTrue($subject->getUnsigned());
        $this->assertTrue($subject->getNotnull());
        $this->assertFalse($subject->getAutoincrement());
        $this->assertSame(0, $subject->getDefault());
    }

    public function isExpectedDeletedColumn()
    {
        $subject = $this->table->getColumn('deleted');
        $this->assertInstanceOf(SmallIntType::class, $subject->getType());
        $this->assertSame(1, $subject->getLength());
        $this->assertTrue($subject->getUnsigned());
        $this->assertTrue($subject->getNotnull());
        $this->assertFalse($subject->getAutoincrement());
        $this->assertSame('0', $subject->getDefault());
    }

    public function isExpectedTSconfigColumn()
    {
        $subject = $this->table->getColumn('TSconfig');
        $this->assertInstanceOf(TextType::class, $subject->getType());
        $this->assertSame(65535, $subject->getLength());
        $this->assertFalse($subject->getNotnull());
        $this->assertNull($subject->getDefault());
    }

    public function isExpectedNoCacheColumn()
    {
        $subject = $this->table->getColumn('no_cache');
        $this->assertInstanceOf(IntegerType::class, $subject->getType());
        $this->assertSame(10, $subject->getLength());
        $this->assertTrue($subject->getUnsigned());
        $this->assertTrue($subject->getNotnull());
        $this->assertFalse($subject->getAutoincrement());
        $this->assertSame('0', $subject->getDefault());
    }

    public function isExpectedPrimaryKey()
    {
        $subject = $this->table->getPrimaryKey();
        $this->assertInstanceOf(Index::class, $subject);
        $this->assertTrue($subject->isPrimary());
        $this->assertSame(['`uid`'], $subject->getColumns());
    }

    public function isExpectedParentKey()
    {
        $subject = $this->table->getIndex('parent');
        $this->assertInstanceOf(Index::class, $subject);
        $this->assertTrue($subject->isUnique());
        $this->assertSame(['`pid`', '`deleted`', '`sorting`'], $subject->getColumns());
    }

    public function isExpectedNoCacheKey()
    {
        $subject = $this->table->getIndex('noCache');
        $this->assertInstanceOf(Index::class, $subject);
        $this->assertTrue($subject->isSimpleIndex());
        $this->assertSame(['`no_cache`'], $subject->getColumns());
    }

    public function isExpectedForeignKey()
    {
        $subject = $this->table->getForeignKey('fk_overlay');
        $this->assertInstanceOf(ForeignKeyConstraint::class, $subject);
        $this->assertSame(['`pid`'], $subject->getForeignColumns());
        $this->assertSame(['`uid`'], $subject->getLocalColumns());
        $this->assertSame('aTestTable', $subject->getLocalTableName());
        $this->assertSame('pages_language_overlay', $subject->getForeignTableName());
    }

    public function hasColumnLengthOnIndex()
    {
        $subject = $this->table->getIndex('substring');
        $this->assertSame(['`TSconfig`(80)'], $subject->getColumns());
    }
}