function EntitySchemaTest::testCleanUpStorageDefinition

Tests fields from an uninstalled module are removed from the schema.

File

core/tests/Drupal/KernelTests/Core/Entity/EntitySchemaTest.php, line 322

Class

EntitySchemaTest

Tests the default entity storage schema handler.

Namespace

Code

public function testCleanUpStorageDefinition() : void {
    // Find all the entity types provided by the entity_test module and install
    // the schema for them.
    $entity_type_ids = [];
    $entities = \Drupal::entityTypeManager()->getDefinitions();
    foreach ($entities as $entity_type_id => $definition) {
        if ($definition instanceof ContentEntityTypeInterface && $definition->getProvider() == 'entity_test') {
            $this->installEntitySchema($entity_type_id);
            $entity_type_ids[] = $entity_type_id;
        }
    }
    // Get a list of all the entities in the schema.
    $key_value_store = \Drupal::keyValue('entity.storage_schema.sql');
    $schema = $key_value_store->getAll();
    // Count the storage definitions provided by the entity_test module, so that
    // after uninstall we can be sure there were some to be deleted.
    $entity_type_id_count = 0;
    foreach (array_keys($schema) as $storage_definition_name) {
        [
            $entity_type_id,
        ] = explode('.', $storage_definition_name);
        if (in_array($entity_type_id, $entity_type_ids)) {
            $entity_type_id_count++;
        }
    }
    // Ensure that there are storage definitions from the entity_test module.
    $this->assertNotEquals(0, $entity_type_id_count, 'There are storage definitions provided by the entity_test module in the schema.');
    // Uninstall the entity_test module.
    $this->container
        ->get('module_installer')
        ->uninstall([
        'entity_test',
    ]);
    // Get a list of all the entities in the schema.
    $key_value_store = \Drupal::keyValue('entity.storage_schema.sql');
    $schema = $key_value_store->getAll();
    // Count the storage definitions that come from entity types provided by
    // the entity_test module.
    $entity_type_id_count = 0;
    foreach (array_keys($schema) as $storage_definition_name) {
        [
            $entity_type_id,
        ] = explode('.', $storage_definition_name);
        if (in_array($entity_type_id, $entity_type_ids)) {
            $entity_type_id_count++;
        }
    }
    // Ensure that all storage definitions have been removed from the schema.
    $this->assertEquals(0, $entity_type_id_count, 'After uninstalling entity_test module the schema should not contains fields from entities provided by the module.');
}