class SqlContentEntityStorageSchemaColumnTest
Same name in other branches
- 9 core/modules/field/tests/src/Kernel/Entity/Update/SqlContentEntityStorageSchemaColumnTest.php \Drupal\Tests\field\Kernel\Entity\Update\SqlContentEntityStorageSchemaColumnTest
- 8.9.x core/modules/field/tests/src/Kernel/Entity/Update/SqlContentEntityStorageSchemaColumnTest.php \Drupal\Tests\field\Kernel\Entity\Update\SqlContentEntityStorageSchemaColumnTest
- 11.x core/modules/field/tests/src/Kernel/Entity/Update/SqlContentEntityStorageSchemaColumnTest.php \Drupal\Tests\field\Kernel\Entity\Update\SqlContentEntityStorageSchemaColumnTest
Tests that schema changes in fields with data are detected during updates.
@group Entity
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\ExtensionListTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait
- class \Drupal\Tests\field\Kernel\Entity\Update\SqlContentEntityStorageSchemaColumnTest extends \Drupal\KernelTests\KernelTestBase uses \Drupal\Tests\system\Functional\Entity\Traits\EntityDefinitionTestTrait
Expanded class hierarchy of SqlContentEntityStorageSchemaColumnTest
File
-
core/
modules/ field/ tests/ src/ Kernel/ Entity/ Update/ SqlContentEntityStorageSchemaColumnTest.php, line 21
Namespace
Drupal\Tests\field\Kernel\Entity\UpdateView source
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);
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
AssertContentTrait::$content | protected | property | The current raw content. | |||
AssertContentTrait::$drupalSettings | protected | property | The drupalSettings value from the current raw $content. | |||
AssertContentTrait::$elements | protected | property | The XML structure parsed from the current raw $content. | 1 | ||
AssertContentTrait::$plainTextContent | protected | property | The plain-text content of raw $content (text nodes). | |||
AssertContentTrait::assertEscaped | protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |||
AssertContentTrait::assertField | protected | function | Asserts that a field exists with the given name or ID. | |||
AssertContentTrait::assertFieldById | protected | function | Asserts that a field exists with the given ID and value. | |||
AssertContentTrait::assertFieldByName | protected | function | Asserts that a field exists with the given name and value. | |||
AssertContentTrait::assertFieldByXPath | protected | function | Asserts that a field exists in the current page by the given XPath. | |||
AssertContentTrait::assertFieldChecked | protected | function | Asserts that a checkbox field in the current page is checked. | |||
AssertContentTrait::assertFieldsByValue | protected | function | Asserts that a field exists in the current page with a given Xpath result. | |||
AssertContentTrait::assertLink | protected | function | Passes if a link with the specified label is found. | |||
AssertContentTrait::assertLinkByHref | protected | function | Passes if a link containing a given href (part) is found. | |||
AssertContentTrait::assertNoDuplicateIds | protected | function | Asserts that each HTML ID is used for just a single element. | |||
AssertContentTrait::assertNoEscaped | protected | function | Passes if raw text IS NOT found escaped on loaded page, fail otherwise. | |||
AssertContentTrait::assertNoField | protected | function | Asserts that a field does not exist with the given name or ID. | |||
AssertContentTrait::assertNoFieldById | protected | function | Asserts that a field does not exist with the given ID and value. | |||
AssertContentTrait::assertNoFieldByName | protected | function | Asserts that a field does not exist with the given name and value. | |||
AssertContentTrait::assertNoFieldByXPath | protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |||
AssertContentTrait::assertNoFieldChecked | protected | function | Asserts that a checkbox field in the current page is not checked. | |||
AssertContentTrait::assertNoLink | protected | function | Passes if a link with the specified label is not found. | |||
AssertContentTrait::assertNoLinkByHref | protected | function | Passes if a link containing a given href (part) is not found. | |||
AssertContentTrait::assertNoLinkByHrefInMainRegion | protected | function | Passes if a link containing a given href is not found in the main region. | |||
AssertContentTrait::assertNoOption | protected | function | Asserts that a select option in the current page does not exist. | |||
AssertContentTrait::assertNoOptionSelected | protected | function | Asserts that a select option in the current page is not checked. | |||
AssertContentTrait::assertNoPattern | protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |||
AssertContentTrait::assertNoRaw | protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |||
AssertContentTrait::assertNoText | protected | function | Passes if the page (with HTML stripped) does not contains the text. | |||
AssertContentTrait::assertNoTitle | protected | function | Pass if the page title is not the given string. | |||
AssertContentTrait::assertNoUniqueText | protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |||
AssertContentTrait::assertOption | protected | function | Asserts that a select option in the current page exists. | |||
AssertContentTrait::assertOptionByText | protected | function | Asserts that a select option with the visible text exists. | |||
AssertContentTrait::assertOptionSelected | protected | function | Asserts that a select option in the current page is checked. | |||
AssertContentTrait::assertOptionSelectedWithDrupalSelector | protected | function | Asserts that a select option in the current page is checked. | |||
AssertContentTrait::assertOptionWithDrupalSelector | protected | function | Asserts that a select option in the current page exists. | |||
AssertContentTrait::assertPattern | protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |||
AssertContentTrait::assertRaw | protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |||
AssertContentTrait::assertText | protected | function | Passes if the page (with HTML stripped) contains the text. | |||
AssertContentTrait::assertTextHelper | protected | function | Helper for assertText and assertNoText. | |||
AssertContentTrait::assertTextPattern | protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |||
AssertContentTrait::assertThemeOutput | protected | function | Asserts themed output. | |||
AssertContentTrait::assertTitle | protected | function | Pass if the page title is the given string. | |||
AssertContentTrait::assertUniqueText | protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |||
AssertContentTrait::assertUniqueTextHelper | protected | function | Helper for assertUniqueText and assertNoUniqueText. | |||
AssertContentTrait::buildXPathQuery | protected | function | Builds an XPath query. | |||
AssertContentTrait::constructFieldXpath | protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |||
AssertContentTrait::cssSelect | protected | function | Searches elements using a CSS selector in the raw content. | |||
AssertContentTrait::getAllOptions | protected | function | Get all option elements, including nested options, in a select. | |||
AssertContentTrait::getDrupalSettings | protected | function | Gets the value of drupalSettings for the currently-loaded page. | |||
AssertContentTrait::getRawContent | protected | function | Gets the current raw content. | |||
AssertContentTrait::getSelectedItem | protected | function | Get the selected value from a select field. | |||
AssertContentTrait::getTextContent | protected | function | Retrieves the plain-text content from the current raw content. | |||
AssertContentTrait::parse | protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |||
AssertContentTrait::removeWhiteSpace | protected | function | Removes all white-space between HTML tags from the raw content. | |||
AssertContentTrait::setDrupalSettings | protected | function | Sets the value of drupalSettings for the currently-loaded page. | |||
AssertContentTrait::setRawContent | protected | function | Sets the raw content (e.g. HTML). | |||
AssertContentTrait::xpath | protected | function | Performs an xpath search on the contents of the internal browser. | |||
ConfigTestTrait::configImporter | protected | function | Returns a ConfigImporter object to import test configuration. | |||
ConfigTestTrait::copyConfig | protected | function | Copies configuration objects from source storage to target storage. | |||
EntityDefinitionTestTrait::addBaseField | protected | function | Adds a new base field to the 'entity_test_update' entity type. | |||
EntityDefinitionTestTrait::addBaseFieldIndex | protected | function | Adds a single-field index to the base field. | |||
EntityDefinitionTestTrait::addBundleField | protected | function | Adds a new bundle field to the 'entity_test_update' entity type. | |||
EntityDefinitionTestTrait::addEntityIndex | protected | function | Adds an index to the 'entity_test_update' entity type's base table. | |||
EntityDefinitionTestTrait::addLongNameBaseField | protected | function | Adds a long-named base field to the 'entity_test_update' entity type. | |||
EntityDefinitionTestTrait::addRevisionableBaseField | protected | function | Adds a new revisionable base field to the 'entity_test_update' entity type. | |||
EntityDefinitionTestTrait::applyEntityUpdates | protected | function | Applies all the detected valid changes. | |||
EntityDefinitionTestTrait::deleteEntityType | protected | function | Removes the entity type. | |||
EntityDefinitionTestTrait::doEntityUpdate | protected | function | Performs an entity type definition update. | |||
EntityDefinitionTestTrait::doFieldUpdate | protected | function | Performs a field storage definition update. | |||
EntityDefinitionTestTrait::enableNewEntityType | protected | function | Enables a new entity type definition. | |||
EntityDefinitionTestTrait::getUpdatedEntityTypeDefinition | protected | function | Returns an entity type definition, possibly updated to be rev or mul. | |||
EntityDefinitionTestTrait::getUpdatedFieldStorageDefinitions | protected | function | Returns the required rev / mul field definitions for an entity type. | |||
EntityDefinitionTestTrait::makeBaseFieldEntityKey | protected | function | Promotes a field to an entity key. | |||
EntityDefinitionTestTrait::modifyBaseField | protected | function | Modifies the new base field from 'string' to 'text'. | |||
EntityDefinitionTestTrait::modifyBundleField | protected | function | Modifies the new bundle field from 'string' to 'text'. | |||
EntityDefinitionTestTrait::removeBaseField | protected | function | Removes the new base field from the 'entity_test_update' entity type. | |||
EntityDefinitionTestTrait::removeBaseFieldIndex | protected | function | Removes the index added in addBaseFieldIndex(). | |||
EntityDefinitionTestTrait::removeBundleField | protected | function | Removes the new bundle field from the 'entity_test_update' entity type. | |||
EntityDefinitionTestTrait::removeEntityIndex | protected | function | Removes the index added in addEntityIndex(). | |||
EntityDefinitionTestTrait::renameBaseTable | protected | function | Renames the base table to 'entity_test_update_new'. | |||
EntityDefinitionTestTrait::renameDataTable | protected | function | Renames the data table to 'entity_test_update_data_new'. | |||
EntityDefinitionTestTrait::renameRevisionBaseTable | protected | function | Renames the revision table to 'entity_test_update_revision_new'. | |||
EntityDefinitionTestTrait::renameRevisionDataTable | protected | function | Renames the revision data table to 'entity_test_update_revision_data_new'. | |||
EntityDefinitionTestTrait::resetEntityType | protected | function | Resets the entity type definition. | |||
EntityDefinitionTestTrait::updateEntityTypeToNotRevisionable | protected | function | Updates the 'entity_test_update' entity type not revisionable. | |||
EntityDefinitionTestTrait::updateEntityTypeToNotTranslatable | protected | function | Updates the 'entity_test_update' entity type to not translatable. | |||
EntityDefinitionTestTrait::updateEntityTypeToRevisionable | protected | function | Updates the 'entity_test_update' entity type to revisionable. | |||
EntityDefinitionTestTrait::updateEntityTypeToRevisionableAndTranslatable | protected | function | Updates the test entity type to be revisionable and translatable. | |||
EntityDefinitionTestTrait::updateEntityTypeToTranslatable | protected | function | Updates the 'entity_test_update' entity type to translatable. | |||
ExtensionListTestTrait::getModulePath | protected | function | Gets the path for the specified module. | |||
ExtensionListTestTrait::getThemePath | protected | function | Gets the path for the specified theme. | |||
KernelTestBase::$backupGlobals | protected | property | Back up and restore any global variables that may be changed by tests. | |||
KernelTestBase::$backupStaticAttributes | protected | property | Back up and restore static class properties that may be changed by tests. | |||
KernelTestBase::$backupStaticAttributesBlacklist | protected | property | Contains a few static class properties for performance. | |||
KernelTestBase::$classLoader | protected | property | ||||
KernelTestBase::$configImporter | protected | property | @todo Move into Config test base class. | 6 | ||
KernelTestBase::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | 3 | ||
KernelTestBase::$container | protected | property | ||||
KernelTestBase::$databasePrefix | protected | property | ||||
KernelTestBase::$keyValue | protected | property | The key_value service that must persist between container rebuilds. | |||
KernelTestBase::$preserveGlobalState | protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. |
|||
KernelTestBase::$root | protected | property | The app root. | |||
KernelTestBase::$runTestInSeparateProcess | protected | property | Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property. |
|||
KernelTestBase::$siteDirectory | protected | property | ||||
KernelTestBase::$strictConfigSchema | protected | property | Set to TRUE to strict check all configuration saved. | 9 | ||
KernelTestBase::$usesSuperUserAccessPolicy | protected | property | Set to TRUE to make user 1 a super user. | 7 | ||
KernelTestBase::$vfsRoot | protected | property | The virtual filesystem root directory. | |||
KernelTestBase::assertPostConditions | protected | function | 1 | |||
KernelTestBase::bootEnvironment | protected | function | Bootstraps a basic test environment. | |||
KernelTestBase::bootKernel | protected | function | Bootstraps a kernel for a test. | 1 | ||
KernelTestBase::config | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |||
KernelTestBase::disableModules | protected | function | Disables modules for this test. | |||
KernelTestBase::enableModules | protected | function | Enables modules for this test. | 1 | ||
KernelTestBase::getConfigSchemaExclusions | protected | function | Gets the config schema exclusions for this test. | |||
KernelTestBase::getDatabaseConnectionInfo | protected | function | Returns the Database connection info to be used for this test. | 2 | ||
KernelTestBase::getDatabasePrefix | public | function | ||||
KernelTestBase::getExtensionsForModules | private | function | Returns Extension objects for $modules to install. | |||
KernelTestBase::getModulesToEnable | private static | function | Returns the modules to install for this test. | |||
KernelTestBase::initFileCache | protected | function | Initializes the FileCache component. | |||
KernelTestBase::installConfig | protected | function | Installs default configuration for a given list of modules. | |||
KernelTestBase::installEntitySchema | protected | function | Installs the storage schema for a specific entity type. | |||
KernelTestBase::installSchema | protected | function | Installs database tables from a module schema definition. | |||
KernelTestBase::register | public | function | Registers test-specific services. | Overrides ServiceProviderInterface::register | 27 | |
KernelTestBase::render | protected | function | Renders a render array. | 1 | ||
KernelTestBase::setInstallProfile | protected | function | Sets the install profile and rebuilds the container to update it. | |||
KernelTestBase::setSetting | protected | function | Sets an in-memory Settings variable. | |||
KernelTestBase::setUpBeforeClass | public static | function | 1 | |||
KernelTestBase::setUpFilesystem | protected | function | Sets up the filesystem, so things like the file directory. | 2 | ||
KernelTestBase::stop | Deprecated | protected | function | Stops test execution. | ||
KernelTestBase::tearDown | protected | function | 6 | |||
KernelTestBase::tearDownCloseDatabaseConnection | public | function | @after | |||
KernelTestBase::vfsDump | protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |||
KernelTestBase::__get | public | function | ||||
KernelTestBase::__sleep | public | function | Prevents serializing any properties. | |||
PhpUnitWarnings::$deprecationWarnings | private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |||
PhpUnitWarnings::addWarning | public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |||
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | |||
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | |||
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | |||
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |||
RandomGeneratorTrait::randomStringValidate | Deprecated | public | function | Callback for random string validation. | ||
SqlContentEntityStorageSchemaColumnTest::$entity | protected | property | The created entity. | |||
SqlContentEntityStorageSchemaColumnTest::$entityDefinitionUpdateManager | protected | property | The entity definition update manager. | |||
SqlContentEntityStorageSchemaColumnTest::$field | protected | property | The field. | |||
SqlContentEntityStorageSchemaColumnTest::$fieldStorage | protected | property | The field storage. | |||
SqlContentEntityStorageSchemaColumnTest::$modules | protected static | property | Modules to install. | Overrides KernelTestBase::$modules | ||
SqlContentEntityStorageSchemaColumnTest::$state | protected | property | The state object. | |||
SqlContentEntityStorageSchemaColumnTest::setUp | protected | function | Overrides KernelTestBase::setUp | |||
SqlContentEntityStorageSchemaColumnTest::testColumnUpdate | public | function | Tests that column-level schema changes are detected for fields with data. | |||
SqlContentEntityStorageSchemaColumnTest::testColumnUpdateWithFlag | public | function | Tests that schema changes are updated for fields with data with the flag. | |||
StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | |||
TestRequirementsTrait::checkModuleRequirements | Deprecated | private | function | Checks missing module requirements. | ||
TestRequirementsTrait::checkRequirements | Deprecated | protected | function | Check module requirements for the Drupal use case. | ||
TestRequirementsTrait::getDrupalRoot | protected static | function | Returns the Drupal root directory. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.