SqlContentEntityStorageSchemaColumnTest.php

Same filename in other branches
  1. 9 core/modules/field/tests/src/Kernel/Entity/Update/SqlContentEntityStorageSchemaColumnTest.php
  2. 8.9.x core/modules/field/tests/src/Kernel/Entity/Update/SqlContentEntityStorageSchemaColumnTest.php
  3. 10 core/modules/field/tests/src/Kernel/Entity/Update/SqlContentEntityStorageSchemaColumnTest.php

Namespace

Drupal\Tests\field\Kernel\Entity\Update

File

core/modules/field/tests/src/Kernel/Entity/Update/SqlContentEntityStorageSchemaColumnTest.php

View source
<?php

declare (strict_types=1);
namespace Drupal\Tests\field\Kernel\Entity\Update;

use Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface;
use Drupal\Core\Entity\Exception\FieldStorageDefinitionUpdateForbiddenException;
use Drupal\Core\State\StateInterface;
use Drupal\entity_test\Entity\EntityTestRev;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\KernelTests\KernelTestBase;
use Drupal\Tests\system\Functional\Entity\Traits\EntityDefinitionTestTrait;

/**
 * Tests that schema changes in fields with data are detected during updates.
 *
 * @group Entity
 */
class SqlContentEntityStorageSchemaColumnTest extends KernelTestBase {
    use EntityDefinitionTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'entity_test',
        'field',
        'text',
        'user',
    ];
    
    /**
     * The created entity.
     *
     * @var \Drupal\Core\Entity\EntityInterface
     */
    protected $entity;
    
    /**
     * The field.
     *
     * @var \Drupal\field\FieldConfigInterface
     */
    protected $field;
    
    /**
     * The field storage.
     *
     * @var \Drupal\field\FieldStorageConfigInterface
     */
    protected $fieldStorage;
    
    /**
     * The entity definition update manager.
     *
     * @var \Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface
     */
    protected EntityDefinitionUpdateManagerInterface $entityDefinitionUpdateManager;
    
    /**
     * The state object.
     *
     * @var \Drupal\Core\State\StateInterface
     */
    protected StateInterface $state;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('entity_test_rev');
        $this->installEntitySchema('user');
        $field_name = 'test';
        $this->fieldStorage = FieldStorageConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test_rev',
            'type' => 'string',
            'cardinality' => 1,
        ]);
        $this->fieldStorage
            ->save();
        $this->field = FieldConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test_rev',
            'bundle' => 'entity_test_rev',
            'required' => TRUE,
        ]);
        $this->field
            ->save();
        // Create an entity with field data.
        $this->entity = EntityTestRev::create([
            'user_id' => 2,
            'name' => $this->randomMachineName(),
            $field_name => $this->randomString(),
        ]);
        $this->entity
            ->save();
    }
    
    /**
     * Tests that column-level schema changes are detected for fields with data.
     */
    public function testColumnUpdate() : void {
        // Change the field type in the stored schema.
        $schema = \Drupal::keyValue('entity.storage_schema.sql')->get('entity_test_rev.field_schema_data.test');
        $schema['entity_test_rev__test']['fields']['test_value']['type'] = 'varchar_ascii';
        \Drupal::keyValue('entity.storage_schema.sql')->set('entity_test_rev.field_schema_data.test', $schema);
        // Now attempt to run automatic updates. An exception should be thrown
        // since there is data in the table.
        $this->expectException(FieldStorageDefinitionUpdateForbiddenException::class);
        $entity_definition_update_manager = \Drupal::entityDefinitionUpdateManager();
        $field_storage_definition = $entity_definition_update_manager->getFieldStorageDefinition('test', 'entity_test_rev');
        $entity_definition_update_manager->updateFieldStorageDefinition($field_storage_definition);
    }
    
    /**
     * Tests that schema changes are updated for fields with data with the flag.
     */
    public function testColumnUpdateWithFlag() : void {
        // Change the field type in the stored schema.
        $schema = \Drupal::keyValue('entity.storage_schema.sql')->get('entity_test_rev.field_schema_data.test');
        $schema['entity_test_rev__test']['fields']['test_value']['type'] = 'varchar_ascii';
        \Drupal::keyValue('entity.storage_schema.sql')->set('entity_test_rev.field_schema_data.test', $schema);
        // Now attempt to run automatic updates. It should succeed if the
        // column_changes_handled flag is passed.
        $entity_definition_update_manager = \Drupal::entityDefinitionUpdateManager();
        $field_storage_definition = $entity_definition_update_manager->getFieldStorageDefinition('test', 'entity_test_rev');
        // Provide the flag to allow schema updates.
        $field_storage_definition->setSetting('column_changes_handled', TRUE);
        $entity_definition_update_manager->updateFieldStorageDefinition($field_storage_definition);
    }

}

Classes

Title Deprecated Summary
SqlContentEntityStorageSchemaColumnTest Tests that schema changes in fields with data are detected during updates.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.