Skip to content

D
doctrine-dbal
Unverified Commit 64c18da1 authored by Sergei Morozov's avatar Sergei Morozov
Browse files
Options

Reworked the tests and fixed other platforms

parent 8515d7f0
Hide whitespace changes
Inline Side-by-side
Showing with 208 additions and 125 deletions
UPGRADE.md
View file @ 64c18da1
# Upgrade to 2.10 # Upgrade to 2.10
## MINOR BC BREAK: escaped default values ## MINOR BC BREAK: Default values are no longer handled as SQL expressions
Default values will be automatically escaped. So default values must now be specified non-escaped. They are converted to SQL literals (e.g. escaped). Clients must now specify default values in their initial form, not in the form of an SQL literal (e.g. escaped).
Before: Before:
......
lib/Doctrine/DBAL/Platforms/SQLServerPlatform.php
View file @ 64c18da1
...@@ -1629,7 +1629,7 @@ SQL ...@@ -1629,7 +1629,7 @@ SQL
return " DEFAULT '" . $this->convertBooleans($field['default']) . "'"; return " DEFAULT '" . $this->convertBooleans($field['default']) . "'";
} }
return " DEFAULT '" . $field['default'] . "'"; return ' DEFAULT ' . $this->quoteStringLiteral($field['default']);
} }
/** /**
......
lib/Doctrine/DBAL/Schema/DB2SchemaManager.php
View file @ 64c18da1
...@@ -6,10 +6,11 @@ use Doctrine\DBAL\Types\Type; ...@@ -6,10 +6,11 @@ use Doctrine\DBAL\Types\Type;
use const CASE_LOWER; use const CASE_LOWER;
use function array_change_key_case; use function array_change_key_case;
use function is_resource; use function is_resource;
use function preg_match;
use function str_replace;
use function strpos; use function strpos;
use function strtolower; use function strtolower;
use function substr; use function substr;
use function trim;
/** /**
* IBM Db2 Schema Manager. * IBM Db2 Schema Manager.
...@@ -47,7 +48,11 @@ class DB2SchemaManager extends AbstractSchemaManager ...@@ -47,7 +48,11 @@ class DB2SchemaManager extends AbstractSchemaManager
$default = null; $default = null;
if ($tableColumn['default'] !== null && $tableColumn['default'] !== 'NULL') { if ($tableColumn['default'] !== null && $tableColumn['default'] !== 'NULL') {
$default = trim($tableColumn['default'], "'"); $default = $tableColumn['default'];
if (preg_match('/^\'(.*)\'$/s', $default, $matches)) {
$default = str_replace("''", "'", $matches[1]);
}
} }
$type = $this->_platform->getDoctrineTypeMapping($tableColumn['typename']); $type = $this->_platform->getDoctrineTypeMapping($tableColumn['typename']);
......
lib/Doctrine/DBAL/Schema/MySqlSchemaManager.php
View file @ 64c18da1
...@@ -13,17 +13,36 @@ use function assert; ...@@ -13,17 +13,36 @@ use function assert;
use function explode; use function explode;
use function is_string; use function is_string;
use function preg_match; use function preg_match;
use function str_replace;
use function stripslashes;
use function strpos; use function strpos;
use function strtok; use function strtok;
use function strtolower; use function strtolower;
use function strtr;
/** /**
* Schema manager for the MySql RDBMS. * Schema manager for the MySql RDBMS.
*/ */
class MySqlSchemaManager extends AbstractSchemaManager class MySqlSchemaManager extends AbstractSchemaManager
{ {
/**
* @see https://mariadb.com/kb/en/library/string-literals/#escape-sequences
*/
private const MARIADB_ESCAPE_SEQUENCES = [
'\\0' => "\0",
"\\'" => "'",
'\\"' => '"',
'\\b' => "\b",
'\\n' => "\n",
'\\r' => "\r",
'\\t' => "\t",
'\\Z' => "\x1a",
'\\\\' => '\\',
'\\%' => '%',
'\\_' => '_',
// Internally, MariaDB escapes single quotes using the standard syntax
"''" => "'",
];
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
...@@ -219,7 +238,7 @@ class MySqlSchemaManager extends AbstractSchemaManager ...@@ -219,7 +238,7 @@ class MySqlSchemaManager extends AbstractSchemaManager
} }
if (preg_match('/^\'(.*)\'$/', $columnDefault, $matches)) { if (preg_match('/^\'(.*)\'$/', $columnDefault, $matches)) {
return stripslashes(str_replace("''", "'", $matches[1])); return strtr($matches[1], self::MARIADB_ESCAPE_SEQUENCES);
} }
switch ($columnDefault) { switch ($columnDefault) {
......
lib/Doctrine/DBAL/Schema/OracleSchemaManager.php
View file @ 64c18da1
...@@ -13,6 +13,7 @@ use function array_values; ...@@ -13,6 +13,7 @@ use function array_values;
use function assert; use function assert;
use function preg_match; use function preg_match;
use function sprintf; use function sprintf;
use function str_replace;
use function strpos; use function strpos;
use function strtolower; use function strtolower;
use function strtoupper; use function strtoupper;
...@@ -144,8 +145,10 @@ class OracleSchemaManager extends AbstractSchemaManager ...@@ -144,8 +145,10 @@ class OracleSchemaManager extends AbstractSchemaManager
} }
if ($tableColumn['data_default'] !== null) { if ($tableColumn['data_default'] !== null) {
// Default values returned from database are enclosed in single quotes. // Default values returned from database are represented as literal expressions
$tableColumn['data_default'] = trim($tableColumn['data_default'], "'"); if (preg_match('/^\'(.*)\'$/s', $tableColumn['data_default'], $matches)) {
$tableColumn['data_default'] = str_replace("''", "'", $matches[1]);
}
} }
if ($tableColumn['data_precision'] !== null) { if ($tableColumn['data_precision'] !== null) {
......
lib/Doctrine/DBAL/Schema/PostgreSqlSchemaManager.php
View file @ 64c18da1
...@@ -21,7 +21,6 @@ use function preg_match; ...@@ -21,7 +21,6 @@ use function preg_match;
use function preg_replace; use function preg_replace;
use function sprintf; use function sprintf;
use function str_replace; use function str_replace;
use function stripos;
use function strlen; use function strlen;
use function strpos; use function strpos;
use function strtolower; use function strtolower;
...@@ -330,11 +329,9 @@ class PostgreSqlSchemaManager extends AbstractSchemaManager ...@@ -330,11 +329,9 @@ class PostgreSqlSchemaManager extends AbstractSchemaManager
$autoincrement = true; $autoincrement = true;
} }
if (preg_match("/^['(](.*)[')]::.*$/", $tableColumn['default'], $matches)) { if (preg_match("/^['(](.*)[')]::/", $tableColumn['default'], $matches)) {
$tableColumn['default'] = $matches[1]; $tableColumn['default'] = $matches[1];
} } elseif (preg_match('/^NULL::/', $tableColumn['default'])) {
if (stripos($tableColumn['default'], 'NULL') === 0) {
$tableColumn['default'] = null; $tableColumn['default'] = null;
} }
......
lib/Doctrine/DBAL/Schema/SQLServerSchemaManager.php
View file @ 64c18da1
...@@ -16,7 +16,6 @@ use function sprintf; ...@@ -16,7 +16,6 @@ use function sprintf;
use function str_replace; use function str_replace;
use function strpos; use function strpos;
use function strtok; use function strtok;
use function trim;
/** /**
* SQL Server Schema Manager. * SQL Server Schema Manager.
...@@ -107,7 +106,7 @@ class SQLServerSchemaManager extends AbstractSchemaManager ...@@ -107,7 +106,7 @@ class SQLServerSchemaManager extends AbstractSchemaManager
'length' => $length === 0 || ! in_array($type, ['text', 'string']) ? null : $length, 'length' => $length === 0 || ! in_array($type, ['text', 'string']) ? null : $length,
'unsigned' => false, 'unsigned' => false,
'fixed' => (bool) $fixed, 'fixed' => (bool) $fixed,
'default' => $default !== 'NULL' ? $default : null, 'default' => $default,
'notnull' => (bool) $tableColumn['notnull'], 'notnull' => (bool) $tableColumn['notnull'],
'scale' => $tableColumn['scale'], 'scale' => $tableColumn['scale'],
'precision' => $tableColumn['precision'], 'precision' => $tableColumn['precision'],
...@@ -124,10 +123,18 @@ class SQLServerSchemaManager extends AbstractSchemaManager ...@@ -124,10 +123,18 @@ class SQLServerSchemaManager extends AbstractSchemaManager
return $column; return $column;
} }
private function parseDefaultExpression(string $value) : string private function parseDefaultExpression(string $value) : ?string
{ {
while (preg_match('/^\((.*)\)$/', $value, $matches)) { while (preg_match('/^\((.*)\)$/s', $value, $matches)) {
$value = trim($matches[1], "'"); $value = $matches[1];
}
if ($value === 'NULL') {
return null;
}
if (preg_match('/^\'(.*)\'$/s', $value, $matches)) {
$value = str_replace("''", "'", $matches[1]);
} }
if ($value === 'getdate()') { if ($value === 'getdate()') {
......
lib/Doctrine/DBAL/Schema/SqliteSchemaManager.php
View file @ 64c18da1
...@@ -324,11 +324,14 @@ class SqliteSchemaManager extends AbstractSchemaManager ...@@ -324,11 +324,14 @@ class SqliteSchemaManager extends AbstractSchemaManager
if ($default === 'NULL') { if ($default === 'NULL') {
$default = null; $default = null;
} }
if ($default !== null) { if ($default !== null) {
// SQLite returns strings wrapped in single quotes and escaped, so we need to strip them // SQLite returns the default value as a literal expression, so we need to parse it
$default = preg_replace("/^'(.*)'$/s", '\1', $default); if (preg_match('/^\'(.*)\'$/s', $default, $matches)) {
$default = str_replace("''", "'", $default); $default = str_replace("''", "'", $matches[1]);
}
} }
$notnull = (bool) $tableColumn['notnull']; $notnull = (bool) $tableColumn['notnull'];
if (! isset($tableColumn['name'])) { if (! isset($tableColumn['name'])) {
......
tests/Doctrine/Tests/DBAL/Functional/Schema/DefaultValueTest.php 0 → 100644
View file @ 64c18da1
<?php
declare(strict_types=1);
namespace Doctrine\Tests\DBAL\Functional\Schema;
use Doctrine\DBAL\Schema\Table;
use Doctrine\Tests\DbalFunctionalTestCase;
use function sprintf;
class DefaultValueTest extends DbalFunctionalTestCase
{
/** @var bool */
private static $initialized = false;
protected function setUp() : void
{
parent::setUp();
if (self::$initialized) {
return;
}
self::$initialized = true;
$table = new Table('default_value');
$table->addColumn('id', 'integer');
foreach (self::columnProvider() as [$name, $default]) {
$table->addColumn($name, 'string', [
'default' => $default,
'notnull' => false,
]);
}
$this->connection->getSchemaManager()
->dropAndCreateTable($table);
$this->connection->insert('default_value', ['id' => 1]);
}
/**
* @dataProvider columnProvider
*/
public function testEscapedDefaultValueCanBeIntrospected(string $name, $expectedDefault) : void
{
self::assertSame(
$expectedDefault,
$this->connection
->getSchemaManager()
->listTableDetails('default_value')
->getColumn($name)
->getDefault()
);
}
/**
* @dataProvider columnProvider
*/
public function testEscapedDefaultValueCanBeInserted(string $name, $expectedDefault) : void
{
$value = $this->connection->fetchColumn(
sprintf('SELECT %s FROM default_value', $name)
);
self::assertSame($expectedDefault, $value);
}
/**
* Returns potential escaped literals from all platforms combined.
*
* @see https://dev.mysql.com/doc/refman/5.7/en/string-literals.html
* @see http://www.sqlite.org/lang_expr.html
* @see https://www.postgresql.org/docs/9.6/static/sql-syntax-lexical.html#SQL-SYNTAX-STRINGS-ESCAPE
*
* @return mixed[][]
*/
public static function columnProvider() : iterable
{
return [
'Single quote' => [
'single_quote',
"foo'bar",
],
'Single quote, doubled' => [
'single_quote_doubled',
"foo''bar",
],
'Double quote' => [
'double_quote',
'foo"bar',
],
'Double quote, doubled' => [
'double_quote_doubled',
'foo""bar',
],
'Backspace' => [
'backspace',
"foo\x08bar",
],
'New line' => [
'new_line',
"foo\nbar",
],
'Carriage return' => [
'carriage_return',
"foo\rbar",
],
'Tab' => [
'tab',
"foo\tbar",
],
'Substitute' => [
'substitute',
"foo\x1abar",
],
'Backslash' => [
'backslash',
'foo\\bar',
],
'Backslash, doubled' => [
'backslash_doubled',
'foo\\\\bar',
],
'Percent' => [
'percent_sign',
'foo%bar',
],
'Underscore' => [
'underscore',
'foo_bar',
],
'NULL string' => [
'null_string',
'NULL',
],
'NULL value' => [
'null_value',
null,
],
'SQL expression' => [
'sql_expression',
"'; DROP DATABASE doctrine --",
],
'No double conversion' => [
'no_double_conversion',
"\\'",
],
];
}
}
tests/Doctrine/Tests/DBAL/Functional/Schema/MySqlSchemaManagerTest.php
View file @ 64c18da1
...@@ -11,8 +11,6 @@ use Doctrine\DBAL\Schema\Table; ...@@ -11,8 +11,6 @@ use Doctrine\DBAL\Schema\Table;
use Doctrine\DBAL\Types\Type; use Doctrine\DBAL\Types\Type;
use Doctrine\DBAL\Types\Types; use Doctrine\DBAL\Types\Types;
use Doctrine\Tests\Types\MySqlPointType; use Doctrine\Tests\Types\MySqlPointType;
use function implode;
use function sprintf;
class MySqlSchemaManagerTest extends SchemaManagerFunctionalTestCase class MySqlSchemaManagerTest extends SchemaManagerFunctionalTestCase
{ {
...@@ -517,45 +515,6 @@ class MySqlSchemaManagerTest extends SchemaManagerFunctionalTestCase ...@@ -517,45 +515,6 @@ class MySqlSchemaManagerTest extends SchemaManagerFunctionalTestCase
self::assertFalse($diff, 'Tables should be identical with column defauts time and date.'); self::assertFalse($diff, 'Tables should be identical with column defauts time and date.');
} }
/**
* Ensure default values (un-)escaping is properly done by mysql platforms.
* The test is voluntarily relying on schema introspection due to current
* doctrine limitations. Once #2850 is landed, this test can be removed.
*
* @see https://dev.mysql.com/doc/refman/5.7/en/string-literals.html
*/
public function testEnsureDefaultsAreUnescapedFromSchemaIntrospection() : void
{
$platform = $this->schemaManager->getDatabasePlatform();
$this->connection->query('DROP TABLE IF EXISTS test_column_defaults_with_create');
$escapeSequences = [
"\\0", // An ASCII NUL (X'00') character
"\\'",
"''", // Single quote
'\\"',
'""', // Double quote
'\\b', // A backspace character
'\\n', // A new-line character
'\\r', // A carriage return character
'\\t', // A tab character
'\\Z', // ASCII 26 (Control+Z)
'\\\\', // A backslash (\) character
'\\%', // A percent (%) character
'\\_', // An underscore (_) character
];
$default = implode('+', $escapeSequences);
$sql = sprintf(
'CREATE TABLE test_column_defaults_with_create(col1 VARCHAR(255) NULL DEFAULT %s)',
$platform->quoteStringLiteral($default)
);
$this->connection->query($sql);
$onlineTable = $this->schemaManager->listTableDetails('test_column_defaults_with_create');
self::assertSame($default, $onlineTable->getColumn('col1')->getDefault());
}
public function testEnsureTableOptionsAreReflectedInMetadata() : void public function testEnsureTableOptionsAreReflectedInMetadata() : void
{ {
$this->connection->query('DROP TABLE IF EXISTS test_table_metadata'); $this->connection->query('DROP TABLE IF EXISTS test_table_metadata');
......
tests/Doctrine/Tests/DBAL/Functional/Schema/SchemaManagerFunctionalTestCase.php
View file @ 64c18da1
...@@ -1495,67 +1495,6 @@ abstract class SchemaManagerFunctionalTestCase extends DbalFunctionalTestCase ...@@ -1495,67 +1495,6 @@ abstract class SchemaManagerFunctionalTestCase extends DbalFunctionalTestCase
self::assertEquals($sequence2InitialValue, $actualSequence2->getInitialValue()); self::assertEquals($sequence2InitialValue, $actualSequence2->getInitialValue());
} }
/**
* Returns potential escaped literals from all platforms combined.
*
* @see https://dev.mysql.com/doc/refman/5.7/en/string-literals.html
* @see http://www.sqlite.org/lang_expr.html
* @see https://www.postgresql.org/docs/9.6/static/sql-syntax-lexical.html#SQL-SYNTAX-STRINGS-ESCAPE
*
* @return mixed[][]
*/
private function getEscapedLiterals() : iterable
{
return [
['An ASCII NUL (X\'00\')', "foo\\0bar"],
['Single quote, C-style', "foo\\'bar"],
['Single quote, doubled-style', "foo''bar"],
['Double quote, C-style', 'foo\\"bar'],
['Double quote, double-style', 'foo""bar'],
['Backspace', 'foo\\bbar'],
['New-line', 'foo\\nbar'],
['Carriage return', 'foo\\rbar'],
['Tab', 'foo\\tbar'],
['ASCII 26 (Control+Z)', 'foo\\Zbar'],
['Backslash (\)', 'foo\\\\bar'],
['Percent (%)', 'foo\\%bar'],
['Underscore (_)', 'foo\\_bar'],
];
}
private function createTableForDefaultValues() : void
{
$table = new Table('string_escaped_default_value');
foreach ($this->getEscapedLiterals() as $i => $literal) {
$table->addColumn('field' . $i, 'string', ['default' => $literal[1]]);
}
$table->addColumn('def_foo', 'string');
$this->schemaManager->dropAndCreateTable($table);
}
public function testEscapedDefaultValueCanBeIntrospected() : void
{
$this->createTableForDefaultValues();
$onlineTable = $this->schemaManager->listTableDetails('string_escaped_default_value');
foreach ($this->getEscapedLiterals() as $i => $literal) {
self::assertSame($literal[1], $onlineTable->getColumn('field' . $i)->getDefault(), 'should be able introspect the value of default for: ' . $literal[0]);
}
}
public function testEscapedDefaultValueCanBeInserted() : void
{
$this->createTableForDefaultValues();
$this->connection->insert('string_escaped_default_value', ['def_foo' => 'foo']);
foreach ($this->getEscapedLiterals() as $i => $literal) {
$value = $this->connection->fetchColumn('SELECT field' . $i . ' FROM string_escaped_default_value');
self::assertSame($literal[1], $value, 'inserted default value should be the configured default value for: ' . $literal[0]);
}
}
/** /**
* @group #3086 * @group #3086
*/ */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment