nextcloud/tests/lib/DB/MigratorTest.php

307 lines
9.7 KiB
PHP
Raw Normal View History

<?php
/**
* Copyright (c) 2014 Robin Appelman <icewind@owncloud.com>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
namespace Test\DB;
use Doctrine\DBAL\Exception;
use Doctrine\DBAL\ParameterType;
use Doctrine\DBAL\Platforms\MySQLPlatform;
use Doctrine\DBAL\Platforms\OraclePlatform;
use Doctrine\DBAL\Platforms\PostgreSQL94Platform;
use Doctrine\DBAL\Platforms\SqlitePlatform;
use Doctrine\DBAL\Schema\Schema;
use Doctrine\DBAL\Schema\SchemaConfig;
use OC\DB\Migrator;
use OC\DB\MySQLMigrator;
use OC\DB\OracleMigrator;
use OC\DB\PostgreSqlMigrator;
use OC\DB\SQLiteMigrator;
use OCP\DB\Types;
2015-07-29 19:19:31 +03:00
use OCP\IConfig;
2015-11-03 03:52:41 +03:00
/**
* Class MigratorTest
2015-11-03 03:52:41 +03:00
*
* @group DB
*
* @package Test\DB
*/
class MigratorTest extends \Test\TestCase {
/**
* @var \Doctrine\DBAL\Connection $connection
*/
private $connection;
/**
* @var IConfig
**/
private $config;
2015-07-29 19:19:31 +03:00
/** @var string */
private $tableName;
2017-10-02 13:32:21 +03:00
/** @var string */
private $tableNameTmp;
protected function setUp(): void {
parent::setUp();
$this->config = \OC::$server->getConfig();
$this->connection = \OC::$server->get(\OC\DB\Connection::class);
2017-10-02 13:32:21 +03:00
$this->tableName = $this->getUniqueTableName();
$this->tableNameTmp = $this->getUniqueTableName();
}
private function getMigrator(): Migrator {
$platform = $this->connection->getDatabasePlatform();
$random = \OC::$server->getSecureRandom();
$dispatcher = \OC::$server->getEventDispatcher();
if ($platform instanceof SqlitePlatform) {
return new SQLiteMigrator($this->connection, $this->config, $dispatcher);
} elseif ($platform instanceof OraclePlatform) {
return new OracleMigrator($this->connection, $this->config, $dispatcher);
} elseif ($platform instanceof MySQLPlatform) {
return new MySQLMigrator($this->connection, $this->config, $dispatcher);
} elseif ($platform instanceof PostgreSQL94Platform) {
return new PostgreSqlMigrator($this->connection, $this->config, $dispatcher);
}
return new Migrator($this->connection, $this->config, $dispatcher);
}
2017-10-02 13:32:21 +03:00
private function getUniqueTableName() {
return strtolower($this->getUniqueID($this->config->getSystemValue('dbtableprefix', 'oc_') . 'test_'));
}
protected function tearDown(): void {
2017-10-02 13:32:21 +03:00
// Try to delete if exists (IF EXISTS NOT SUPPORTED IN ORACLE)
try {
$this->connection->exec('DROP TABLE ' . $this->connection->quoteIdentifier($this->tableNameTmp));
} catch (Exception $e) {
}
2017-10-02 13:32:21 +03:00
try {
$this->connection->exec('DROP TABLE ' . $this->connection->quoteIdentifier($this->tableName));
} catch (Exception $e) {
}
parent::tearDown();
}
/**
* @return \Doctrine\DBAL\Schema\Schema[]
*/
private function getDuplicateKeySchemas() {
$startSchema = new Schema([], [], $this->getSchemaConfig());
$table = $startSchema->createTable($this->tableName);
$table->addColumn('id', 'integer');
$table->addColumn('name', 'string');
$table->addIndex(['id'], $this->tableName . '_id');
$endSchema = new Schema([], [], $this->getSchemaConfig());
$table = $endSchema->createTable($this->tableName);
$table->addColumn('id', 'integer');
$table->addColumn('name', 'string');
$table->addUniqueIndex(['id'], $this->tableName . '_id');
return [$startSchema, $endSchema];
}
/**
* @return \Doctrine\DBAL\Schema\Schema[]
*/
private function getChangedTypeSchema($from, $to) {
$startSchema = new Schema([], [], $this->getSchemaConfig());
$table = $startSchema->createTable($this->tableName);
$table->addColumn('id', $from);
$table->addColumn('name', 'string');
$table->addIndex(['id'], $this->tableName . '_id');
$endSchema = new Schema([], [], $this->getSchemaConfig());
$table = $endSchema->createTable($this->tableName);
$table->addColumn('id', $to);
$table->addColumn('name', 'string');
$table->addIndex(['id'], $this->tableName . '_id');
return [$startSchema, $endSchema];
}
private function getSchemaConfig() {
$config = new SchemaConfig();
$config->setName($this->connection->getDatabase());
return $config;
}
private function isSQLite() {
return $this->connection->getDatabasePlatform() instanceof SqlitePlatform;
}
private function isMySQL() {
return $this->connection->getDatabasePlatform() instanceof MySQLPlatform;
}
public function testUpgrade() {
[$startSchema, $endSchema] = $this->getDuplicateKeySchemas();
$migrator = $this->getMigrator();
$migrator->migrate($startSchema);
$this->connection->insert($this->tableName, ['id' => 1, 'name' => 'foo']);
$this->connection->insert($this->tableName, ['id' => 2, 'name' => 'bar']);
$this->connection->insert($this->tableName, ['id' => 3, 'name' => 'qwerty']);
$migrator->migrate($endSchema);
$this->addToAssertionCount(1);
}
public function testUpgradeDifferentPrefix() {
$oldTablePrefix = $this->config->getSystemValue('dbtableprefix', 'oc_');
$this->config->setSystemValue('dbtableprefix', 'ownc_');
$this->tableName = strtolower($this->getUniqueID($this->config->getSystemValue('dbtableprefix') . 'test_'));
[$startSchema, $endSchema] = $this->getDuplicateKeySchemas();
$migrator = $this->getMigrator();
$migrator->migrate($startSchema);
$this->connection->insert($this->tableName, ['id' => 1, 'name' => 'foo']);
$this->connection->insert($this->tableName, ['id' => 2, 'name' => 'bar']);
$this->connection->insert($this->tableName, ['id' => 3, 'name' => 'qwerty']);
$migrator->migrate($endSchema);
$this->addToAssertionCount(1);
$this->config->setSystemValue('dbtableprefix', $oldTablePrefix);
}
public function testInsertAfterUpgrade() {
[$startSchema, $endSchema] = $this->getDuplicateKeySchemas();
$migrator = $this->getMigrator();
$migrator->migrate($startSchema);
$migrator->migrate($endSchema);
$this->connection->insert($this->tableName, ['id' => 1, 'name' => 'foo']);
$this->connection->insert($this->tableName, ['id' => 2, 'name' => 'bar']);
try {
$this->connection->insert($this->tableName, ['id' => 2, 'name' => 'qwerty']);
$this->fail('Expected duplicate key insert to fail');
} catch (Exception $e) {
$this->addToAssertionCount(1);
}
}
public function testAddingPrimaryKeyWithAutoIncrement() {
$startSchema = new Schema([], [], $this->getSchemaConfig());
$table = $startSchema->createTable($this->tableName);
$table->addColumn('id', 'integer');
$table->addColumn('name', 'string');
$endSchema = new Schema([], [], $this->getSchemaConfig());
$table = $endSchema->createTable($this->tableName);
$table->addColumn('id', 'integer', ['autoincrement' => true]);
$table->addColumn('name', 'string');
$table->setPrimaryKey(['id']);
$migrator = $this->getMigrator();
$migrator->migrate($startSchema);
$migrator->migrate($endSchema);
$this->addToAssertionCount(1);
}
2014-07-01 14:55:36 +04:00
public function testReservedKeywords() {
$startSchema = new Schema([], [], $this->getSchemaConfig());
2014-07-01 14:55:36 +04:00
$table = $startSchema->createTable($this->tableName);
$table->addColumn('id', 'integer', ['autoincrement' => true]);
$table->addColumn('user', 'string', ['length' => 255]);
$table->setPrimaryKey(['id']);
2014-07-01 14:55:36 +04:00
$endSchema = new Schema([], [], $this->getSchemaConfig());
2014-07-01 14:55:36 +04:00
$table = $endSchema->createTable($this->tableName);
$table->addColumn('id', 'integer', ['autoincrement' => true]);
$table->addColumn('user', 'string', ['length' => 64]);
$table->setPrimaryKey(['id']);
2014-07-01 14:55:36 +04:00
$migrator = $this->getMigrator();
2014-07-01 14:55:36 +04:00
$migrator->migrate($startSchema);
$migrator->migrate($endSchema);
$this->addToAssertionCount(1);
2014-07-01 14:55:36 +04:00
}
2017-10-02 13:32:21 +03:00
public function testAddingForeignKey() {
$startSchema = new Schema([], [], $this->getSchemaConfig());
$table = $startSchema->createTable($this->tableName);
$table->addColumn('id', 'integer', ['autoincrement' => true]);
$table->addColumn('name', 'string');
$table->setPrimaryKey(['id']);
$fkName = "fkc";
$tableFk = $startSchema->createTable($this->tableNameTmp);
$tableFk->addColumn('fk_id', 'integer');
$tableFk->addColumn('name', 'string');
$tableFk->addForeignKeyConstraint($this->tableName, ['fk_id'], ['id'], [], $fkName);
2017-10-02 13:32:21 +03:00
$migrator = $this->getMigrator();
2017-10-02 13:32:21 +03:00
$migrator->migrate($startSchema);
$this->assertTrue($startSchema->getTable($this->tableNameTmp)->hasForeignKey($fkName));
}
public function dataNotNullEmptyValuesFailOracle(): array {
return [
[ParameterType::BOOLEAN, true, Types::BOOLEAN, false],
[ParameterType::BOOLEAN, false, Types::BOOLEAN, true],
[ParameterType::STRING, 'foo', Types::STRING, false],
[ParameterType::STRING, '', Types::STRING, true],
[ParameterType::INTEGER, 1234, Types::INTEGER, false],
[ParameterType::INTEGER, 0, Types::INTEGER, false], // Integer 0 is not stored as Null and therefor works
];
}
/**
* @dataProvider dataNotNullEmptyValuesFailOracle
*
* @param int $parameterType
* @param bool|int|string $value
* @param string $columnType
* @param bool $oracleThrows
*/
public function testNotNullEmptyValuesFailOracle(int $parameterType, $value, string $columnType, bool $oracleThrows): void {
$startSchema = new Schema([], [], $this->getSchemaConfig());
$table = $startSchema->createTable($this->tableName);
$table->addColumn('id', Types::BIGINT);
$table->addColumn('will_it_blend', $columnType, [
'notnull' => true,
]);
$table->addIndex(['id'], $this->tableName . '_id');
$migrator = $this->getMigrator();
$migrator->migrate($startSchema);
if ($oracleThrows && $this->connection->getDatabasePlatform() instanceof OraclePlatform) {
// Oracle can not store false|empty string in notnull columns
$this->expectException(\Doctrine\DBAL\Exception\NotNullConstraintViolationException::class);
}
$this->connection->insert(
$this->tableName,
['id' => 1, 'will_it_blend' => $value],
['id' => ParameterType::INTEGER, 'will_it_blend' => $parameterType],
);
$this->addToAssertionCount(1);
}
}