9.5/_schema_migrator_test_8php_source.html

<?php

declare(strict_types = 1);


namespace ‪TYPO3\CMS\Core\Tests\Functional\Database\Schema;


/*

 * 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\AbstractSchemaManager;

use Doctrine\DBAL\Schema\Table;

use Doctrine\DBAL\Types\BigIntType;

use Doctrine\DBAL\Types\TextType;

use ‪TYPO3\CMS\Core\Database\ConnectionPool;

use ‪TYPO3\CMS\Core\Database\Schema\SchemaMigrator;

use ‪TYPO3\CMS\Core\Database\Schema\SqlReader;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;


class ‪SchemaMigratorTest extends FunctionalTestCase

{

    protected ‪$sqlReader;


    protected ‪$connectionPool;


    protected ‪$schemaManager;


    protected ‪$subject;


    protected ‪$tableName = 'a_test_table';


    protected function ‪setUp()

    {

        parent::setUp();

        $this->subject = GeneralUtility::makeInstance(SchemaMigrator::class);

        $this->sqlReader = GeneralUtility::makeInstance(SqlReader::class);

        $this->connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);

        $this->schemaManager = $this->connectionPool->getConnectionForTable($this->tableName)->getSchemaManager();

        $this->‪prepareTestTable();

    }


    protected function ‪tearDown()

    {

        parent::tearDown();


        if ($this->schemaManager->tablesExist([$this->tableName])) {

            $this->schemaManager->dropTable($this->tableName);

        }

        if ($this->schemaManager->tablesExist(['zzz_deleted_' . $this->tableName])) {

            $this->schemaManager->dropTable('zzz_deleted_' . $this->tableName);

        }

        if ($this->schemaManager->tablesExist(['another_test_table'])) {

            $this->schemaManager->dropTable('another_test_table');

        }

    }


    public function ‪createNewTable()

    {

        if ($this->schemaManager->tablesExist([$this->tableName])) {

            $this->schemaManager->dropTable($this->tableName);

        }


        $statements = $this->‪readFixtureFile('newTable');

        $updateSuggestions = $this->subject->getUpdateSuggestions($statements);


        $this->subject->migrate(

            $statements,

            $updateSuggestions[‪ConnectionPool::DEFAULT_CONNECTION_NAME]['create_table']

        );


        $this->assertCount(6, $this->‪getTableDetails()->getColumns());

    }


    public function ‪createNewTableIfNotExists()

    {

        $statements = $this->‪readFixtureFile('ifNotExists');

        $updateSuggestions = $this->subject->getUpdateSuggestions($statements);


        $this->subject->migrate(

            $statements,

            $updateSuggestions[‪ConnectionPool::DEFAULT_CONNECTION_NAME]['create_table']

        );


        $this->assertTrue($this->schemaManager->tablesExist(['another_test_table']));

    }


    public function ‪addNewColumns()

    {

        $statements = $this->‪readFixtureFile('addColumnsToTable');

        $updateSuggestions = $this->subject->getUpdateSuggestions($statements);


        $this->subject->migrate(

            $statements,

            $updateSuggestions[‪ConnectionPool::DEFAULT_CONNECTION_NAME]['add']

        );


        $this->assertCount(7, $this->‪getTableDetails()->getColumns());

        $this->assertTrue($this->‪getTableDetails()->hasColumn('title'));

        $this->assertTrue($this->‪getTableDetails()->hasColumn('description'));

    }


    public function ‪changeExistingColumn()

    {

        $statements = $this->‪readFixtureFile('changeExistingColumn');

        $updateSuggestions = $this->subject->getUpdateSuggestions($statements);


        $this->assertEquals(50, $this->‪getTableDetails()->getColumn('title')->getLength());

        $this->assertEmpty($this->‪getTableDetails()->getColumn('title')->getDefault());


        $this->subject->migrate(

            $statements,

            $updateSuggestions[‪ConnectionPool::DEFAULT_CONNECTION_NAME]['change']

        );


        $this->assertEquals(100, $this->‪getTableDetails()->getColumn('title')->getLength());

        $this->assertEquals('Title', $this->‪getTableDetails()->getColumn('title')->getDefault());

    }


    public function ‪notNullWithoutDefaultValue()

    {

        $statements = $this->‪readFixtureFile('notNullWithoutDefaultValue');

        $updateSuggestions = $this->subject->getUpdateSuggestions($statements);


        $this->subject->migrate(

            $statements,

            $updateSuggestions[‪ConnectionPool::DEFAULT_CONNECTION_NAME]['add']

        );


        $this->assertTrue($this->‪getTableDetails()->getColumn('aTestField')->getNotnull());

    }


    public function ‪defaultNullWithoutNotNull()

    {

        $statements = $this->‪readFixtureFile('defaultNullWithoutNotNull');

        $updateSuggestions = $this->subject->getUpdateSuggestions($statements);


        $this->subject->migrate(

            $statements,

            $updateSuggestions[‪ConnectionPool::DEFAULT_CONNECTION_NAME]['add']

        );


        $this->assertFalse($this->‪getTableDetails()->getColumn('aTestField')->getNotnull());

        $this->assertNull($this->‪getTableDetails()->getColumn('aTestField')->getDefault());

    }


    public function ‪renameUnusedField()

    {

        $statements = $this->‪readFixtureFile('unusedColumn');

        $updateSuggestions = $this->subject->getUpdateSuggestions($statements, true);


        $this->subject->migrate(

            $statements,

            $updateSuggestions[‪ConnectionPool::DEFAULT_CONNECTION_NAME]['change']

        );


        $this->assertFalse($this->‪getTableDetails()->hasColumn('hidden'));

        $this->assertTrue($this->‪getTableDetails()->hasColumn('zzz_deleted_hidden'));

    }


    public function ‪renameUnusedTable()

    {

        $statements = $this->‪readFixtureFile('unusedTable');

        $updateSuggestions = $this->subject->getUpdateSuggestions($statements, true);


        $this->subject->migrate(

            $statements,

            $updateSuggestions[‪ConnectionPool::DEFAULT_CONNECTION_NAME]['change_table']

        );


        $this->assertNotContains($this->tableName, $this->schemaManager->listTableNames());

        $this->assertContains('zzz_deleted_' . $this->tableName, $this->schemaManager->listTableNames());

    }


    public function ‪dropUnusedField()

    {

        $connection = $this->connectionPool->getConnectionForTable($this->tableName);

        $fromSchema = $this->schemaManager->createSchema();

        $toSchema = clone $fromSchema;

        $toSchema->getTable($this->tableName)->addColumn('zzz_deleted_testfield', 'integer', ['notnull' => false]);

        $statements = $fromSchema->getMigrateToSql(

            $toSchema,

            $connection->getDatabasePlatform()

        );

        $connection->executeUpdate($statements[0]);

        $this->assertTrue($this->‪getTableDetails()->hasColumn('zzz_deleted_testfield'));


        $statements = $this->‪readFixtureFile('newTable');

        $updateSuggestions = $this->subject->getUpdateSuggestions($statements, true);

        $this->subject->migrate(

            $statements,

            $updateSuggestions[‪ConnectionPool::DEFAULT_CONNECTION_NAME]['drop']

        );


        $this->assertFalse($this->‪getTableDetails()->hasColumn('zzz_deleted_testfield'));

    }


    public function ‪dropUnusedTable()

    {

        $this->schemaManager->renameTable($this->tableName, 'zzz_deleted_' . $this->tableName);

        $this->assertNotContains($this->tableName, $this->schemaManager->listTableNames());

        $this->assertContains('zzz_deleted_' . $this->tableName, $this->schemaManager->listTableNames());


        $statements = $this->‪readFixtureFile('newTable');

        $updateSuggestions = $this->subject->getUpdateSuggestions($statements, true);

        $this->subject->migrate(

            $statements,

            $updateSuggestions[‪ConnectionPool::DEFAULT_CONNECTION_NAME]['drop_table']

        );


        $this->assertNotContains($this->tableName, $this->schemaManager->listTableNames());

        $this->assertNotContains('zzz_deleted_' . $this->tableName, $this->schemaManager->listTableNames());

    }


    public function ‪installPerformsOnlyAddAndCreateOperations()

    {

        $statements = $this->‪readFixtureFile('addCreateChange');

        $this->subject->install($statements, true);


        $this->assertContains('another_test_table', $this->schemaManager->listTableNames());

        $this->assertTrue($this->‪getTableDetails()->hasColumn('title'));

        $this->assertTrue($this->‪getTableDetails()->hasIndex('title'));

        $this->assertTrue($this->‪getTableDetails()->getIndex('title')->isUnique());

        $this->assertNotInstanceOf(BigIntType::class, $this->‪getTableDetails()->getColumn('pid')->getType());

    }


    public function ‪installDoesNotAddIndexOnChangedColumn()

    {

        $statements = $this->‪readFixtureFile('addIndexOnChangedColumn');

        $this->subject->install($statements, true);


        $this->assertNotInstanceOf(TextType::class, $this->‪getTableDetails()->getColumn('title')->getType());

        $this->assertFalse($this->‪getTableDetails()->hasIndex('title'));

    }


    public function ‪changeExistingIndex()

    {

        // recreate the table with the indexes applied

        // this is needed for e.g. postgres

        if ($this->schemaManager->tablesExist([$this->tableName])) {

            $this->schemaManager->dropTable($this->tableName);

        }

        $this->‪prepareTestTable(false);


        $statements = $this->‪readFixtureFile('changeExistingIndex');

        $updateSuggestions = $this->subject->getUpdateSuggestions($statements);


        $this->subject->migrate(

            $statements,

            $updateSuggestions[‪ConnectionPool::DEFAULT_CONNECTION_NAME]['change']

        );


        $indexesAfterChange = $this->schemaManager->listTableIndexes($this->tableName);


        // indexes could be sorted differently thus we filter for index named "parent" only and

        // use that as index to retrieve the modified columns of that index

        $parentIndex = array_values(

            array_filter(

                array_keys($indexesAfterChange),

                function ($key) {

                    return strpos($key, 'parent') !== false;

                }

            )

        );


        $expectedColumnsOfChangedIndex = [

            'pid',

            'deleted'

        ];

        $this->assertEquals($expectedColumnsOfChangedIndex, $indexesAfterChange[$parentIndex[0]]->getColumns());

    }


    public function ‪installCanPerformChangeOperations()

    {

        $statements = $this->‪readFixtureFile('addCreateChange');

        $this->subject->install($statements);


        $this->assertContains('another_test_table', $this->schemaManager->listTableNames());

        $this->assertTrue($this->‪getTableDetails()->hasColumn('title'));

        $this->assertTrue($this->‪getTableDetails()->hasIndex('title'));

        $this->assertTrue($this->‪getTableDetails()->getIndex('title')->isUnique());

        $this->assertInstanceOf(BigIntType::class, $this->‪getTableDetails()->getColumn('pid')->getType());

    }


    public function ‪importStaticDataInsertsRecords()

    {

        $sqlCode = file_get_contents(implode(DIRECTORY_SEPARATOR, [__DIR__, '..', 'Fixtures', 'importStaticData.sql']));

        $connection = $this->connectionPool->getConnectionForTable($this->tableName);

        $statements = $this->sqlReader->getInsertStatementArray($sqlCode);

        $this->subject->importStaticData($statements);


        $this->assertEquals(2, $connection->count('*', $this->tableName, []));

    }


    public function ‪importStaticDataIgnoresTableDefinitions()

    {

        $sqlCode = file_get_contents(implode(DIRECTORY_SEPARATOR, [__DIR__, '..', 'Fixtures', 'importStaticData.sql']));

        $statements = $this->sqlReader->getStatementArray($sqlCode);

        $this->subject->importStaticData($statements);


        $this->assertNotContains('another_test_table', $this->schemaManager->listTableNames());

    }


    public function ‪changeTableEngine()

    {

        $statements = $this->‪readFixtureFile('alterTableEngine');

        $updateSuggestions = $this->subject->getUpdateSuggestions($statements);


        $index = array_keys($updateSuggestions[‪ConnectionPool::DEFAULT_CONNECTION_NAME]['change'])[0];

        $this->assertStringEndsWith(

            'ENGINE = MyISAM',

            $updateSuggestions[‪ConnectionPool::DEFAULT_CONNECTION_NAME]['change'][$index]

        );


        $this->subject->migrate(

            $statements,

            $updateSuggestions[‪ConnectionPool::DEFAULT_CONNECTION_NAME]['change']

        );


        $updateSuggestions = $this->subject->getUpdateSuggestions($statements);

        $this->assertEmpty($updateSuggestions[‪ConnectionPool::DEFAULT_CONNECTION_NAME]['change']);

        $this->assertEmpty($updateSuggestions[‪ConnectionPool::DEFAULT_CONNECTION_NAME]['change']);

    }


    protected function ‪prepareTestTable(bool $createOnly = true)

    {

        $statements = $this->‪readFixtureFile('newTable');

        $this->subject->install($statements, $createOnly);

    }


    protected function ‪getTableDetails(): Table

    {

        return $this->schemaManager->listTableDetails($this->tableName);

    }


    protected function ‪readFixtureFile(string $fixtureName): array

    {

        $sqlCode = file_get_contents(implode(DIRECTORY_SEPARATOR, [__DIR__, '..', 'Fixtures', $fixtureName]) . '.sql');


        return $this->sqlReader->getCreateTableStatementArray($sqlCode);

    }

}