Newer
Older
<?php
/**
* @file
* Contains \Drupal\system\Tests\Entity\FieldSqlStorageTest.
*/
namespace Drupal\system\Tests\Entity;
use Drupal\Core\Database\Database;
catch
committed
use Drupal\Core\Entity\ContentEntityDatabaseStorage;
use Drupal\Core\Entity\Exception\FieldStorageDefinitionUpdateForbiddenException;
use Drupal\field\Entity\FieldConfig;
/**
* Tests field storage.
*
* Field_sql_storage.module implements the default back-end storage plugin
* for the Field Storage API.
*/
class FieldSqlStorageTest extends EntityUnitTestBase {
/**
* Modules to enable.
*
* @var array
*/
public static $modules = array('field', 'field_test', 'text', 'entity_test');
/**
* The name of the created field.
*
* @var string
*/
protected $field_name;
/**
* A field to use in this class.
*
* @var \Drupal\field\Entity\FieldConfig
*/
protected $field;
/**
* A field instance to use in this test class.
*
* @var \Drupal\field\Entity\FieldInstanceConfig
*/
protected $instance;
/**
* Name of the revision table of the field.
*
* @var string
*/
protected $revision_table;
public static function getInfo() {
return array(
'name' => 'Field SQL storage tests',
'description' => "Test Field SQL Storage .",
'group' => 'Entity API'
);
}
function setUp() {
parent::setUp();
$this->installEntitySchema('entity_test_rev');
$entity_type = 'entity_test_rev';
$this->field_name = strtolower($this->randomName());
Alex Pott
committed
$this->field_cardinality = 4;
$this->field = entity_create('field_config', array(
'name' => $this->field_name,
'entity_type' => $entity_type,
'type' => 'test_field',
Alex Pott
committed
'cardinality' => $this->field_cardinality,
));
$this->field->save();
$this->instance = entity_create('field_instance_config', array(
'field' => $this->field,
'bundle' => $entity_type
));
$this->instance->save();
catch
committed
$this->table = ContentEntityDatabaseStorage::_fieldTableName($this->field);
$this->revision_table = ContentEntityDatabaseStorage::_fieldRevisionTableName($this->field);
}
/**
* Tests field loading works correctly by inserting directly in the tables.
*/
function testFieldLoad() {
$entity_type = $bundle = 'entity_test_rev';
catch
committed
$storage = $this->container->get('entity.manager')->getStorage($entity_type);
catch
committed
$columns = array('bundle', 'deleted', 'entity_id', 'revision_id', 'delta', 'langcode', ContentEntityDatabaseStorage::_fieldColumnName($this->field, 'value'));
// Create an entity with four revisions.
$revision_ids = array();
$entity = entity_create($entity_type);
$entity->save();
$revision_ids[] = $entity->getRevisionId();
for ($i = 0; $i < 4; $i++) {
$entity->setNewRevision();
$entity->save();
$revision_ids[] = $entity->getRevisionId();
}
// Generate values and insert them directly in the storage tables.
$values = array();
$query = db_insert($this->revision_table)->fields($columns);
foreach ($revision_ids as $revision_id) {
// Put one value too many.
Alex Pott
committed
for ($delta = 0; $delta <= $this->field_cardinality; $delta++) {
$value = mt_rand(1, 127);
$values[$revision_id][] = $value;
$query->values(array($bundle, 0, $entity->id(), $revision_id, $delta, $entity->language()->id, $value));
}
$query->execute();
}
$query = db_insert($this->table)->fields($columns);
foreach ($values[$revision_id] as $delta => $value) {
$query->values(array($bundle, 0, $entity->id(), $revision_id, $delta, $entity->language()->id, $value));
}
$query->execute();
// Load every revision and check the values.
foreach ($revision_ids as $revision_id) {
catch
committed
$entity = $storage->loadRevision($revision_id);
foreach ($values[$revision_id] as $delta => $value) {
Alex Pott
committed
if ($delta < $this->field_cardinality) {
$this->assertEqual($entity->{$this->field_name}[$delta]->value, $value);
}
else {
$this->assertFalse(array_key_exists($delta, $entity->{$this->field_name}));
}
}
}
// Load the "current revision" and check the values.
catch
committed
$entity = $storage->load($entity->id());
foreach ($values[$revision_id] as $delta => $value) {
Alex Pott
committed
if ($delta < $this->field_cardinality) {
$this->assertEqual($entity->{$this->field_name}[$delta]->value, $value);
}
else {
$this->assertFalse(array_key_exists($delta, $entity->{$this->field_name}));
}
}
// Add a translation in an unavailable language code and verify it is not
// loaded.
$unavailable_langcode = 'xx';
$values = array($bundle, 0, $entity->id(), $entity->getRevisionId(), 0, $unavailable_langcode, mt_rand(1, 127));
db_insert($this->table)->fields($columns)->values($values)->execute();
db_insert($this->revision_table)->fields($columns)->values($values)->execute();
catch
committed
$entity = $storage->load($entity->id());
$this->assertFalse(array_key_exists($unavailable_langcode, $entity->{$this->field_name}));
}
/**
* Tests field saving works correctly by reading directly from the tables.
*/
function testFieldWrite() {
$entity_type = $bundle = 'entity_test_rev';
$entity = entity_create($entity_type);
$revision_values = array();
// Check insert. Add one value too many.
$values = array();
Alex Pott
committed
for ($delta = 0; $delta <= $this->field_cardinality; $delta++) {
$values[$delta]['value'] = mt_rand(1, 127);
}
$entity->{$this->field_name} = $values;
$entity->save();
// Read the tables and check the correct values have been stored.
Angie Byron
committed
$rows = db_select($this->table, 't')->fields('t')->execute()->fetchAllAssoc('delta', \PDO::FETCH_ASSOC);
Alex Pott
committed
$this->assertEqual(count($rows), $this->field_cardinality);
foreach ($rows as $delta => $row) {
$expected = array(
'bundle' => $bundle,
'deleted' => 0,
'entity_id' => $entity->id(),
'revision_id' => $entity->getRevisionId(),
'langcode' => $entity->language()->id,
'delta' => $delta,
$this->field_name . '_value' => $values[$delta]['value'],
);
$this->assertEqual($row, $expected, "Row $delta was stored as expected.");
}
// Test update. Add less values and check that the previous values did not
// persist.
$values = array();
Alex Pott
committed
for ($delta = 0; $delta <= $this->field_cardinality - 2; $delta++) {
$values[$delta]['value'] = mt_rand(1, 127);
}
$entity->{$this->field_name} = $values;
$entity->save();
Angie Byron
committed
$rows = db_select($this->table, 't')->fields('t')->execute()->fetchAllAssoc('delta', \PDO::FETCH_ASSOC);
$this->assertEqual(count($rows), count($values));
foreach ($rows as $delta => $row) {
$expected = array(
'bundle' => $bundle,
'deleted' => 0,
'entity_id' => $entity->id(),
'revision_id' => $entity->getRevisionId(),
'langcode' => $entity->language()->id,
'delta' => $delta,
$this->field_name . '_value' => $values[$delta]['value'],
);
$this->assertEqual($row, $expected, "Row $delta was stored as expected.");
}
// Create a new revision.
$revision_values[$entity->getRevisionId()] = $values;
$values = array();
Alex Pott
committed
for ($delta = 0; $delta < $this->field_cardinality; $delta++) {
$values[$delta]['value'] = mt_rand(1, 127);
}
$entity->{$this->field_name} = $values;
$entity->setNewRevision();
$entity->save();
$revision_values[$entity->getRevisionId()] = $values;
// Check that data for both revisions are in the revision table.
foreach ($revision_values as $revision_id => $values) {
Angie Byron
committed
$rows = db_select($this->revision_table, 't')->fields('t')->condition('revision_id', $revision_id)->execute()->fetchAllAssoc('delta', \PDO::FETCH_ASSOC);
Alex Pott
committed
$this->assertEqual(count($rows), min(count($values), $this->field_cardinality));
foreach ($rows as $delta => $row) {
$expected = array(
'bundle' => $bundle,
'deleted' => 0,
'entity_id' => $entity->id(),
'revision_id' => $revision_id,
'langcode' => $entity->language()->id,
'delta' => $delta,
$this->field_name . '_value' => $values[$delta]['value'],
);
$this->assertEqual($row, $expected, "Row $delta was stored as expected.");
}
}
// Test emptying the field.
$entity->{$this->field_name} = NULL;
$entity->save();
Angie Byron
committed
$rows = db_select($this->table, 't')->fields('t')->execute()->fetchAllAssoc('delta', \PDO::FETCH_ASSOC);
$this->assertEqual(count($rows), 0);
}
/**
* Tests that long entity type and field names do not break.
*/
function testLongNames() {
// Use one of the longest entity_type names in core.
$entity_type = $bundle = 'entity_test_label_callback';
catch
committed
$storage = $this->container->get('entity.manager')->getStorage($entity_type);
// Create two fields with instances, and generate randome values.
$name_base = drupal_strtolower($this->randomName(FieldConfig::NAME_MAX_LENGTH - 1));
$field_names = array();
$values = array();
for ($i = 0; $i < 2; $i++) {
$field_names[$i] = $name_base . $i;
entity_create('field_config', array(
'name' => $field_names[$i],
'entity_type' => $entity_type,
'type' => 'test_field',
))->save();
entity_create('field_instance_config', array(
'field_name' => $field_names[$i],
'entity_type' => $entity_type,
'bundle' => $bundle,
))->save();
$values[$field_names[$i]] = mt_rand(1, 127);
}
// Save an entity with values.
$entity = entity_create($entity_type, $values);
$entity->save();
// Load the entity back and check the values.
catch
committed
$entity = $storage->load($entity->id());
foreach ($field_names as $field_name) {
$this->assertEqual($entity->get($field_name)->value, $values[$field_name]);
}
}
/**
* Test trying to update a field with data.
*/
function testUpdateFieldSchemaWithData() {
$entity_type = 'entity_test_rev';
// Create a decimal 5.2 field and add some data.
$field = entity_create('field_config', array(
'name' => 'decimal52',
'entity_type' => $entity_type,
'type' => 'decimal',
'settings' => array('precision' => 5, 'scale' => 2),
));
$field->save();
$instance = entity_create('field_instance_config', array(
'field' => $field,
'bundle' => $entity_type,
));
$instance->save();
$entity = entity_create($entity_type, array(
'id' => 0,
'revision_id' => 0,
));
$entity->decimal52->value = '1.235';
$entity->save();
// Attempt to update the field in a way that would work without data.
$field->settings['scale'] = 3;
try {
$field->save();
$this->fail(t('Cannot update field schema with data.'));
}
catch (FieldStorageDefinitionUpdateForbiddenException $e) {
$this->pass(t('Cannot update field schema with data.'));
}
}
/**
* Test that failure to create fields is handled gracefully.
*/
function testFieldUpdateFailure() {
// Create a text field.
$field = entity_create('field_config', array(
'name' => 'test_text',
'entity_type' => 'entity_test',
'type' => 'text',
'settings' => array('max_length' => 255),
));
$field->save();
// Attempt to update the field in a way that would break the storage.
$prior_field = $field;
$field->settings['max_length'] = -1;
try {
$field->save();
$this->fail(t('Update succeeded.'));
}
catch (\Exception $e) {
$this->pass(t('Update properly failed.'));
}
// Ensure that the field tables are still there.
catch
committed
foreach (ContentEntityDatabaseStorage::_fieldSqlSchema($prior_field) as $table_name => $table_info) {
$this->assertTrue(db_table_exists($table_name), t('Table %table exists.', array('%table' => $table_name)));
}
}
/**
* Test adding and removing indexes while data is present.
*/
function testFieldUpdateIndexesWithData() {
// Create a decimal field.
$field_name = 'testfield';
$entity_type = 'entity_test_rev';
$field = entity_create('field_config', array(
'name' => $field_name,
'entity_type' => $entity_type,
'type' => 'text',
));
$field->save();
$instance = entity_create('field_instance_config', array(
'field' => $field,
'bundle' => $entity_type,
));
$instance->save();
catch
committed
$tables = array(ContentEntityDatabaseStorage::_fieldTableName($field), ContentEntityDatabaseStorage::_fieldRevisionTableName($field));
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
// Verify the indexes we will create do not exist yet.
foreach ($tables as $table) {
$this->assertFalse(Database::getConnection()->schema()->indexExists($table, 'value'), t("No index named value exists in $table"));
$this->assertFalse(Database::getConnection()->schema()->indexExists($table, 'value_format'), t("No index named value_format exists in $table"));
}
// Add data so the table cannot be dropped.
$entity = entity_create($entity_type, array(
'id' => 1,
'revision_id' => 1,
));
$entity->$field_name->value = 'field data';
$entity->enforceIsNew();
$entity->save();
// Add an index.
$field->indexes = array('value' => array(array('value', 255)));
$field->save();
foreach ($tables as $table) {
$this->assertTrue(Database::getConnection()->schema()->indexExists($table, "{$field_name}_value"), t("Index on value created in $table"));
}
// Add a different index, removing the existing custom one.
$field->indexes = array('value_format' => array(array('value', 127), array('format', 127)));
$field->save();
foreach ($tables as $table) {
$this->assertTrue(Database::getConnection()->schema()->indexExists($table, "{$field_name}_value_format"), t("Index on value_format created in $table"));
$this->assertFalse(Database::getConnection()->schema()->indexExists($table, "{$field_name}_value"), t("Index on value removed in $table"));
}
// Verify that the tables were not dropped in the process.
catch
committed
$entity = $this->container->get('entity.manager')->getStorage($entity_type)->load(1);
$this->assertEqual($entity->$field_name->value, 'field data', t("Index changes performed without dropping the tables"));
}
/**
* Test foreign key support.
*/
function testFieldSqlStorageForeignKeys() {
// Create a 'shape' field, with a configurable foreign key (see
// field_test_field_schema()).
$field_name = 'testfield';
$foreign_key_name = 'shape';
$field = entity_create('field_config', array(
'name' => $field_name,
'entity_type' => 'entity_test',
'type' => 'shape',
'settings' => array('foreign_key_name' => $foreign_key_name),
));
$field->save();
// Get the field schema.
$schema = $field->getSchema();
// Retrieve the field definition and check that the foreign key is in place.
$this->assertEqual($schema['foreign keys'][$foreign_key_name]['table'], $foreign_key_name, 'Foreign key table name preserved through CRUD');
$this->assertEqual($schema['foreign keys'][$foreign_key_name]['columns'][$foreign_key_name], 'id', 'Foreign key column name preserved through CRUD');
// Update the field settings, it should update the foreign key definition too.
$foreign_key_name = 'color';
$field->settings['foreign_key_name'] = $foreign_key_name;
$field->save();
// Reload the field schema after the update.
$schema = $field->getSchema();
// Retrieve the field definition and check that the foreign key is in place.
Alex Pott
committed
$field = FieldConfig::loadByName('entity_test', $field_name);
$this->assertEqual($schema['foreign keys'][$foreign_key_name]['table'], $foreign_key_name, 'Foreign key table name modified after update');
$this->assertEqual($schema['foreign keys'][$foreign_key_name]['columns'][$foreign_key_name], 'id', 'Foreign key column name modified after update');
// Verify the SQL schema.
catch
committed
$schemas = ContentEntityDatabaseStorage::_fieldSqlSchema($field);
$schema = $schemas[ContentEntityDatabaseStorage::_fieldTableName($field)];
$this->assertEqual(count($schema['foreign keys']), 1, 'There is 1 foreign key in the schema');
$foreign_key = reset($schema['foreign keys']);
catch
committed
$foreign_key_column = ContentEntityDatabaseStorage::_fieldColumnName($field, $foreign_key_name);
$this->assertEqual($foreign_key['table'], $foreign_key_name, 'Foreign key table name preserved in the schema');
$this->assertEqual($foreign_key['columns'][$foreign_key_column], 'id', 'Foreign key column name preserved in the schema');
}
Alex Pott
committed
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
/**
* Tests reacting to a bundle being renamed.
*/
function testFieldSqlStorageBundleRename() {
$entity_type = $bundle = 'entity_test_rev';
// Create an entity.
$value = mt_rand(1, 127);
$entity = entity_create($entity_type, array(
'type' => $bundle,
$this->field->name => $value,
));
$entity->save();
// Rename the bundle.
$bundle_new = $bundle . '_renamed';
entity_test_rename_bundle($bundle, $bundle_new, $entity_type);
// Check that the 'bundle' column has been updated in storage.
$row = db_select($this->table, 't')
->fields('t', array('bundle', $this->field->name . '_value'))
->condition('entity_id', $entity->id())
->execute()
->fetch();
$this->assertEqual($row->bundle, $bundle_new);
$this->assertEqual($row->{$this->field->name . '_value'}, $value);
}
/**
* Tests table name generation.
*/
public function testTableNames() {
// Note: we need to test entity types with long names. We therefore use
// fields on imaginary entity types (works as long as we don't actually save
// them), and just check the generated table names.
// Short entity type and field name.
$entity_type = 'short_entity_type';
$field_name = 'short_field_name';
$field = entity_create('field_config', array(
'entity_type' => $entity_type,
'name' => $field_name,
'type' => 'test_field',
));
$expected = 'short_entity_type__short_field_name';
catch
committed
$this->assertEqual(ContentEntityDatabaseStorage::_fieldTableName($field), $expected);
$expected = 'short_entity_type_revision__short_field_name';
catch
committed
$this->assertEqual(ContentEntityDatabaseStorage::_fieldRevisionTableName($field), $expected);
// Short entity type, long field name
$entity_type = 'short_entity_type';
$field_name = 'long_field_name_abcdefghijklmnopqrstuvwxyz';
$field = entity_create('field_config', array(
'entity_type' => $entity_type,
'name' => $field_name,
'type' => 'test_field',
));
$expected = 'short_entity_type__' . substr(hash('sha256', $field->uuid()), 0, 10);
catch
committed
$this->assertEqual(ContentEntityDatabaseStorage::_fieldTableName($field), $expected);
$expected = 'short_entity_type_r__' . substr(hash('sha256', $field->uuid()), 0, 10);
catch
committed
$this->assertEqual(ContentEntityDatabaseStorage::_fieldRevisionTableName($field), $expected);
// Long entity type, short field name
$entity_type = 'long_entity_type_abcdefghijklmnopqrstuvwxyz';
$field_name = 'short_field_name';
$field = entity_create('field_config', array(
'entity_type' => $entity_type,
'name' => $field_name,
'type' => 'test_field',
));
$expected = 'long_entity_type_abcdefghijklmnopq__' . substr(hash('sha256', $field->uuid()), 0, 10);
catch
committed
$this->assertEqual(ContentEntityDatabaseStorage::_fieldTableName($field), $expected);
$expected = 'long_entity_type_abcdefghijklmnopq_r__' . substr(hash('sha256', $field->uuid()), 0, 10);
catch
committed
$this->assertEqual(ContentEntityDatabaseStorage::_fieldRevisionTableName($field), $expected);
// Long entity type and field name.
$entity_type = 'long_entity_type_abcdefghijklmnopqrstuvwxyz';
$field_name = 'long_field_name_abcdefghijklmnopqrstuvwxyz';
$field = entity_create('field_config', array(
'entity_type' => $entity_type,
'name' => $field_name,
'type' => 'test_field',
));
$expected = 'long_entity_type_abcdefghijklmnopq__' . substr(hash('sha256', $field->uuid()), 0, 10);
catch
committed
$this->assertEqual(ContentEntityDatabaseStorage::_fieldTableName($field), $expected);
$expected = 'long_entity_type_abcdefghijklmnopq_r__' . substr(hash('sha256', $field->uuid()), 0, 10);
catch
committed
$this->assertEqual(ContentEntityDatabaseStorage::_fieldRevisionTableName($field), $expected);
// Try creating a second field and check there are no clashes.
$field2 = entity_create('field_config', array(
'entity_type' => $entity_type,
'name' => $field_name . '2',
'type' => 'test_field',
));
catch
committed
$this->assertNotEqual(ContentEntityDatabaseStorage::_fieldTableName($field), ContentEntityDatabaseStorage::_fieldTableName($field2));
$this->assertNotEqual(ContentEntityDatabaseStorage::_fieldRevisionTableName($field), ContentEntityDatabaseStorage::_fieldRevisionTableName($field2));
// Deleted field.
$field = entity_create('field_config', array(
'entity_type' => 'some_entity_type',
'name' => 'some_field_name',
'type' => 'test_field',
'deleted' => TRUE,
));
$expected = 'field_deleted_data_' . substr(hash('sha256', $field->uuid()), 0, 10);
$this->assertEqual(ContentEntityDatabaseStorage::_fieldTableName($field, TRUE), $expected);
$expected = 'field_deleted_revision_' . substr(hash('sha256', $field->uuid()), 0, 10);
$this->assertEqual(ContentEntityDatabaseStorage::_fieldRevisionTableName($field, TRUE), $expected);