DefaultTableMappingIntegrationTest.php

Same filename in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Entity/DefaultTableMappingIntegrationTest.php
  2. 8.9.x core/tests/Drupal/KernelTests/Core/Entity/DefaultTableMappingIntegrationTest.php
  3. 11.x core/tests/Drupal/KernelTests/Core/Entity/DefaultTableMappingIntegrationTest.php

Namespace

Drupal\KernelTests\Core\Entity

File

core/tests/Drupal/KernelTests/Core/Entity/DefaultTableMappingIntegrationTest.php

View source
<?php

declare (strict_types=1);
namespace Drupal\KernelTests\Core\Entity;

use Drupal\Core\Entity\EntityFieldManagerInterface;
use Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\Tests\system\Functional\Entity\Traits\EntityDefinitionTestTrait;

/**
 * Tests the default table mapping class for content entities stored in SQL.
 *
 * @see \Drupal\Core\Entity\Sql\DefaultTableMapping
 * @see \Drupal\Core\Entity\Sql\TableMappingInterface
 *
 * @coversDefaultClass \Drupal\Core\Entity\Sql\DefaultTableMapping
 * @group Entity
 */
class DefaultTableMappingIntegrationTest extends EntityKernelTestBase {
    use EntityDefinitionTestTrait;
    
    /**
     * The table mapping for the tested entity type.
     *
     * @var \Drupal\Core\Entity\Sql\DefaultTableMapping
     */
    protected $tableMapping;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'entity_test_extra',
    ];
    
    /**
     * The entity field manager.
     *
     * @var \Drupal\Core\Entity\EntityFieldManagerInterface
     */
    protected EntityFieldManagerInterface $entityFieldManager;
    
    /**
     * The entity definition update manager.
     *
     * @var \Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface
     */
    protected EntityDefinitionUpdateManagerInterface $entityDefinitionUpdateManager;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Setup some fields for entity_test_extra to create.
        $definitions['multivalued_base_field'] = BaseFieldDefinition::create('string')->setName('multivalued_base_field')
            ->setTargetEntityTypeId('entity_test_mulrev')
            ->setTargetBundle('entity_test_mulrev')
            ->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED)
            ->setTranslatable(FALSE)
            ->setRevisionable(FALSE);
        $this->state
            ->set('entity_test_mulrev.additional_base_field_definitions', $definitions);
        $this->tableMapping = $this->entityTypeManager
            ->getStorage('entity_test_mulrev')
            ->getTableMapping();
        // Ensure that the tables for the new field are created.
        $this->applyEntityUpdates('entity_test_mulrev');
    }
    
    /**
     * Tests DefaultTableMapping::getFieldTableName().
     *
     * @covers ::getFieldTableName
     */
    public function testGetFieldTableName() : void {
        // Test the field table name for a single-valued base field, which is stored
        // in the entity's base table.
        $expected = 'entity_test_mulrev';
        $this->assertEquals($this->tableMapping
            ->getFieldTableName('uuid'), $expected);
        // Test the field table name for a translatable and revisionable base field,
        // which is stored in the entity's data table.
        $expected = 'entity_test_mulrev_property_data';
        $this->assertEquals($this->tableMapping
            ->getFieldTableName('name'), $expected);
        // Test the field table name for a multi-valued base field, which is stored
        // in a dedicated table.
        $expected = 'entity_test_mulrev__multivalued_base_field';
        $this->assertEquals($this->tableMapping
            ->getFieldTableName('multivalued_base_field'), $expected);
    }
    
    /**
     * @covers ::getAllFieldTableNames
     */
    public function testGetAllFieldTableNames() : void {
        // Check a field that is stored in all the shared tables.
        $expected = [
            'entity_test_mulrev',
            'entity_test_mulrev_property_data',
            'entity_test_mulrev_revision',
            'entity_test_mulrev_property_revision',
        ];
        $this->assertEquals($expected, $this->tableMapping
            ->getAllFieldTableNames('id'));
        // Check a field that is stored only in the base table.
        $expected = [
            'entity_test_mulrev',
        ];
        $this->assertEquals($expected, $this->tableMapping
            ->getAllFieldTableNames('uuid'));
        // Check a field that is stored only in the revision table.
        $expected = [
            'entity_test_mulrev_revision',
        ];
        $this->assertEquals($expected, $this->tableMapping
            ->getAllFieldTableNames('revision_default'));
        // Check a field that field that is stored in the data and revision data
        // tables.
        $expected = [
            'entity_test_mulrev_property_data',
            'entity_test_mulrev_property_revision',
        ];
        $this->assertEquals($expected, $this->tableMapping
            ->getAllFieldTableNames('name'));
        // Check a field that is stored in dedicated data and revision data tables.
        $expected = [
            'entity_test_mulrev__multivalued_base_field',
            'entity_test_mulrev_r__f86e511394',
        ];
        $this->assertEquals($expected, $this->tableMapping
            ->getAllFieldTableNames('multivalued_base_field'));
    }
    
    /**
     * Tests DefaultTableMapping::getTableNames().
     *
     * @covers ::getTableNames
     */
    public function testGetTableNames() : void {
        $storage_definitions = \Drupal::service('entity_field.manager')->getFieldStorageDefinitions('entity_test_mulrev');
        $dedicated_data_table = $this->tableMapping
            ->getDedicatedDataTableName($storage_definitions['multivalued_base_field']);
        $dedicated_revision_table = $this->tableMapping
            ->getDedicatedRevisionTableName($storage_definitions['multivalued_base_field']);
        // Check that both the data and the revision tables exist for a multi-valued
        // base field.
        $database_schema = \Drupal::database()->schema();
        $this->assertTrue($database_schema->tableExists($dedicated_data_table));
        $this->assertTrue($database_schema->tableExists($dedicated_revision_table));
        // Check that the table mapping contains both the data and the revision
        // tables exist for a multi-valued base field.
        $expected = [
            'entity_test_mulrev',
            'entity_test_mulrev_property_data',
            'entity_test_mulrev_revision',
            'entity_test_mulrev_property_revision',
            $dedicated_data_table,
            $dedicated_revision_table,
        ];
        $this->assertEquals($expected, $this->tableMapping
            ->getTableNames());
    }

}

Classes

Title Deprecated Summary
DefaultTableMappingIntegrationTest Tests the default table mapping class for content entities stored in SQL.

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