EntityViewsDataTest.php 36.2 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Contains \Drupal\Tests\views\Unit\EntityViewsDataTest.
6 7
 */

8
namespace Drupal\Tests\views\Unit {
9 10 11 12 13 14 15 16 17 18

use Drupal\Core\Config\Entity\ConfigEntityType;
use Drupal\Core\Entity\ContentEntityType;
use Drupal\Core\Entity\EntityType;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem;
use Drupal\Core\Field\Plugin\Field\FieldType\IntegerItem;
use Drupal\Core\Field\Plugin\Field\FieldType\LanguageItem;
use Drupal\Core\Field\Plugin\Field\FieldType\StringItem;
19
use Drupal\Core\Field\Plugin\Field\FieldType\UriItem;
20
use Drupal\Core\Field\Plugin\Field\FieldType\UuidItem;
21
use Drupal\text\Plugin\Field\FieldType\TextLongItem;
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
use Drupal\entity_test\Entity\EntityTest;
use Drupal\entity_test\Entity\EntityTestMul;
use Drupal\entity_test\Entity\EntityTestMulRev;
use Drupal\Tests\UnitTestCase;
use Drupal\views\EntityViewsData;
use Symfony\Component\DependencyInjection\ContainerBuilder;

/**
 * @coversDefaultClass \Drupal\views\EntityViewsData
 * @group Views
 */
class EntityViewsDataTest extends UnitTestCase {

  /**
   * Entity info to use in this test.
   *
38
   * @var \Drupal\Core\Entity\EntityTypeInterface|\Drupal\Tests\views\Unit\TestEntityType
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
   */
  protected $baseEntityType;

  /**
   * The mocked entity storage.
   *
   * @var \Drupal\Core\Entity\Sql\SqlContentEntityStorage|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $entityStorage;

  /**
   * The mocked entity manager.
   *
   * @var \Drupal\Core\Entity\EntityManagerInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $entityManager;

  /**
   * The mocked module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $moduleHandler;

  /**
   * The mocked translation manager.
   *
   * @var \Drupal\Core\StringTranslation\TranslationInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $translationManager;

  /**
   * The tested entity views controller.
   *
73
   * @var \Drupal\Tests\views\Unit\TestEntityViewsData
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
   */
  protected $viewsData;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    $this->entityStorage = $this->getMockBuilder('Drupal\Core\Entity\Sql\SqlContentEntityStorage')
      ->disableOriginalConstructor()
      ->getMock();
    $this->entityManager = $this->getMock('Drupal\Core\Entity\EntityManagerInterface');

    $this->baseEntityType = new TestEntityType([
      'base_table' => 'entity_test',
      'id' => 'entity_test',
      'label' => 'Entity test',
90
      'entity_keys' => ['id' => 'id', 'langcode' => 'langcode'],
91
      'provider' => 'entity_test',
92
      'list_cache_contexts' => ['entity_test_list_cache_context'],
93 94 95 96 97 98 99 100 101 102 103
    ]);

    $this->translationManager = $this->getStringTranslationStub();
    $this->moduleHandler = $this->getMock('Drupal\Core\Extension\ModuleHandlerInterface');

    $this->viewsData = new TestEntityViewsData($this->baseEntityType, $this->entityStorage, $this->entityManager, $this->moduleHandler, $this->translationManager);

    $field_type_manager = $this->getMockBuilder('Drupal\Core\Field\FieldTypePluginManager')
      ->disableOriginalConstructor()
      ->getMock();
    $field_type_manager->expects($this->any())
104
      ->method('getDefaultStorageSettings')
105 106
      ->willReturn([]);
    $field_type_manager->expects($this->any())
107
      ->method('getDefaultFieldSettings')
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
      ->willReturn([]);

    $container = new ContainerBuilder();
    $container->set('plugin.manager.field.field_type', $field_type_manager);
    $container->set('entity.manager', $this->entityManager);
    \Drupal::setContainer($container);
  }

  /**
   * Helper method to setup base fields.
   *
   * @param \Drupal\Core\Field\BaseFieldDefinition[] $base_fields
   *   The base fields which are adapted.
   *
   * @return \Drupal\Core\Field\BaseFieldDefinition[]
   *   The setup base fields.
   */
  protected function setupBaseFields(array $base_fields) {
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
    // Add a description field to the fields supplied by the EntityTest
    // classes. This example comes from the taxonomy Term entity.
    $base_fields['description'] = BaseFieldDefinition::create('text_long')
      ->setLabel(t('Description'))
      ->setDescription(t('A description of the term.'))
      ->setTranslatable(TRUE)
      ->setDisplayOptions('view', array(
          'label' => 'hidden',
          'type' => 'text_default',
          'weight' => 0,
        ))
      ->setDisplayConfigurable('view', TRUE)
      ->setDisplayOptions('form', array(
          'type' => 'text_textfield',
          'weight' => 0,
        ))
      ->setDisplayConfigurable('form', TRUE);

144 145 146 147 148 149 150
    // Add a URL field; this example is from the Comment entity.
    $base_fields['homepage'] = BaseFieldDefinition::create('uri')
      ->setLabel(t('Homepage'))
      ->setDescription(t("The comment author's home page address."))
      ->setTranslatable(TRUE)
      ->setSetting('max_length', 255);

151 152 153 154 155 156 157 158 159 160 161 162 163 164
    foreach ($base_fields as $name => $base_field) {
      $base_field->setName($name);
    }
    return $base_fields;
  }

  /**
   * Tests base tables.
   */
  public function testBaseTables() {
    $data = $this->viewsData->getViewsData();

    $this->assertEquals('entity_test', $data['entity_test']['table']['entity type']);
    $this->assertEquals('Entity test', $data['entity_test']['table']['group']);
165
    $this->assertEquals('entity_test', $data['entity_test']['table']['provider']);
166 167

    $this->assertEquals('id', $data['entity_test']['table']['base']['field']);
168
    $this->assertEquals(['entity_test_list_cache_context'], $data['entity_test']['table']['base']['cache_contexts']);
169 170 171 172 173 174 175 176 177 178 179 180 181
    $this->assertEquals('Entity test', $data['entity_test']['table']['base']['title']);

    $this->assertFalse(isset($data['entity_test']['table']['defaults']));

    $this->assertFalse(isset($data['entity_test_mul_property_data']));
    $this->assertFalse(isset($data['revision_table']));
    $this->assertFalse(isset($data['revision_data_table']));
  }

  /**
   * Tests data_table support.
   */
  public function testDataTable() {
182 183
    $entity_type = $this->baseEntityType
      ->set('data_table', 'entity_test_mul_property_data')
184 185 186 187 188 189 190
      ->set('id', 'entity_test_mul')
      ->setKey('label', 'label');

    $this->viewsData->setEntityType($entity_type);

    // Tests the join definition between the base and the data table.
    $data = $this->viewsData->getViewsData();
191 192 193 194 195 196
    $base_views_data = $data['entity_test'];

    // Ensure that the base table is set to the data table.
    $this->assertEquals('id', $data['entity_test_mul_property_data']['table']['base']['field']);
    $this->assertEquals('Entity test', $data['entity_test_mul_property_data']['table']['base']['title']);
    $this->assertFalse(isset($data['entity_test']['table']['base']));
197 198 199

    $this->assertEquals('entity_test_mul', $data['entity_test_mul_property_data']['table']['entity type']);
    $this->assertEquals('Entity test', $data['entity_test_mul_property_data']['table']['group']);
200
    $this->assertEquals('entity_test', $data['entity_test']['table']['provider']);
201
    $this->assertEquals(['field' => 'label', 'table' => 'entity_test_mul_property_data'], $data['entity_test_mul_property_data']['table']['base']['defaults']);
202 203

    // Ensure the join information is set up properly.
204 205
    $this->assertCount(1, $base_views_data['table']['join']);
    $this->assertEquals(['entity_test_mul_property_data' => ['left_field' => 'id', 'field' => 'id', 'type' => 'INNER']], $base_views_data['table']['join']);
206 207 208 209 210
    $this->assertFalse(isset($data['revision_table']));
    $this->assertFalse(isset($data['revision_data_table']));
  }

  /**
211
   * Tests revision table without data table support.
212
   */
213
  public function testRevisionTableWithoutDataTable() {
214 215
    $entity_type = $this->baseEntityType
      ->set('revision_table', 'entity_test_mulrev_revision')
216
      ->set('revision_data_table', NULL)
217 218 219 220 221 222 223
      ->set('id', 'entity_test_mulrev')
      ->setKey('revision', 'revision_id')
    ;
    $this->viewsData->setEntityType($entity_type);

    $data = $this->viewsData->getViewsData();

224 225 226
    $this->assertEquals('Entity test revisions', $data['entity_test_mulrev_revision']['table']['base']['title']);
    $this->assertEquals('revision_id', $data['entity_test_mulrev_revision']['table']['base']['field']);

227 228
    $this->assertEquals('entity_test_mulrev', $data['entity_test_mulrev_revision']['table']['entity type']);
    $this->assertEquals('Entity test revision', $data['entity_test_mulrev_revision']['table']['group']);
229
    $this->assertEquals('entity_test', $data['entity_test']['table']['provider']);
230 231 232 233 234 235

    // Ensure the join information is set up properly.
    // Tests the join definition between the base and the revision table.
    $revision_data = $data['entity_test_mulrev_revision'];
    $this->assertCount(1, $revision_data['table']['join']);
    $this->assertEquals(['entity_test' => ['left_field' => 'revision_id', 'field' => 'revision_id', 'type' => 'INNER']], $revision_data['table']['join']);
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
    $this->assertFalse(isset($data['data_table']));
  }

  /**
   * Tests revision table with data table support.
   */
  public function testRevisionTableWithRevisionDataTableAndDataTable() {
    $entity_type = $this->baseEntityType
      ->set('data_table', 'entity_test_mul_property_data')
      ->set('revision_table', 'entity_test_mulrev_revision')
      ->set('revision_data_table', 'entity_test_mulrev_property_revision')
      ->set('id', 'entity_test_mulrev')
      ->setKey('revision', 'revision_id')
    ;
    $this->viewsData->setEntityType($entity_type);

    $data = $this->viewsData->getViewsData();

    $this->assertEquals('Entity test revisions', $data['entity_test_mulrev_property_revision']['table']['base']['title']);
    $this->assertEquals('revision_id', $data['entity_test_mulrev_property_revision']['table']['base']['field']);
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['table']['base']));

    $this->assertEquals('entity_test_mulrev', $data['entity_test_mulrev_property_revision']['table']['entity type']);
    $this->assertEquals('Entity test revision', $data['entity_test_mulrev_revision']['table']['group']);
    $this->assertEquals('entity_test', $data['entity_test']['table']['provider']);

    // Ensure the join information is set up properly.
    // Tests the join definition between the base and the revision table.
264
    $revision_data = $data['entity_test_mulrev_property_revision'];
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
    $this->assertCount(2, $revision_data['table']['join']);
    $this->assertEquals([
      'entity_test_mul_property_data' => [
        'left_field' => 'revision_id', 'field' => 'revision_id', 'type' => 'INNER'
      ],
      'entity_test_mulrev_revision' => [
        'left_field' => 'revision_id', 'field' => 'revision_id', 'type' => 'INNER'
      ],
    ], $revision_data['table']['join']);

    $this->assertFalse(isset($data['data_table']));
  }

  /**
   * Tests revision table with data table support.
   */
  public function testRevisionTableWithRevisionDataTable() {
    $entity_type = $this->baseEntityType
      ->set('revision_table', 'entity_test_mulrev_revision')
      ->set('revision_data_table', 'entity_test_mulrev_property_revision')
      ->set('id', 'entity_test_mulrev')
      ->setKey('revision', 'revision_id')
    ;
    $this->viewsData->setEntityType($entity_type);

    $data = $this->viewsData->getViewsData();

    $this->assertEquals('Entity test revisions', $data['entity_test_mulrev_property_revision']['table']['base']['title']);
    $this->assertEquals('revision_id', $data['entity_test_mulrev_property_revision']['table']['base']['field']);
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['table']['base']));

    $this->assertEquals('entity_test_mulrev', $data['entity_test_mulrev_property_revision']['table']['entity type']);
    $this->assertEquals('Entity test revision', $data['entity_test_mulrev_revision']['table']['group']);
    $this->assertEquals('entity_test', $data['entity_test']['table']['provider']);

    // Ensure the join information is set up properly.
    // Tests the join definition between the base and the revision table.
    $revision_data = $data['entity_test_mulrev_property_revision'];
    $this->assertCount(2, $revision_data['table']['join']);
    $this->assertEquals([
      'entity_test' => ['left_field' => 'revision_id', 'field' => 'revision_id', 'type' => 'INNER'],
      'entity_test_mulrev_revision' => ['left_field' => 'revision_id', 'field' => 'revision_id', 'type' => 'INNER'],
    ], $revision_data['table']['join']);
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
    $this->assertFalse(isset($data['data_table']));
  }

  /**
   * Helper method to mock all store definitions.
   */
  protected function setupFieldStorageDefinition() {
    $id_field_storage_definition = $this->getMock('Drupal\Core\Field\FieldStorageDefinitionInterface');
    $id_field_storage_definition->expects($this->any())
      ->method('getSchema')
      ->willReturn(IntegerItem::schema($id_field_storage_definition));
    $uuid_field_storage_definition = $this->getMock('Drupal\Core\Field\FieldStorageDefinitionInterface');
    $uuid_field_storage_definition->expects($this->any())
      ->method('getSchema')
      ->willReturn(UuidItem::schema($uuid_field_storage_definition));
    $type_field_storage_definition = $this->getMock('Drupal\Core\Field\FieldStorageDefinitionInterface');
    $type_field_storage_definition->expects($this->any())
      ->method('getSchema')
      ->willReturn(StringItem::schema($type_field_storage_definition));
    $langcode_field_storage_definition = $this->getMock('Drupal\Core\Field\FieldStorageDefinitionInterface');
    $langcode_field_storage_definition->expects($this->any())
      ->method('getSchema')
      ->willReturn(LanguageItem::schema($langcode_field_storage_definition));
    $name_field_storage_definition = $this->getMock('Drupal\Core\Field\FieldStorageDefinitionInterface');
    $name_field_storage_definition->expects($this->any())
      ->method('getSchema')
      ->willReturn(StringItem::schema($name_field_storage_definition));
335 336 337 338
    $description_field_storage_definition = $this->getMock('Drupal\Core\Field\FieldStorageDefinitionInterface');
    $description_field_storage_definition->expects($this->any())
      ->method('getSchema')
      ->willReturn(TextLongItem::schema($description_field_storage_definition));
339 340 341 342
    $homepage_field_storage_definition = $this->getMock('Drupal\Core\Field\FieldStorageDefinitionInterface');
    $homepage_field_storage_definition->expects($this->any())
      ->method('getSchema')
      ->willReturn(UriItem::schema($homepage_field_storage_definition));
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372

    // Setup the user_id entity reference field.
    $this->entityManager->expects($this->any())
      ->method('getDefinition')
      ->willReturnMap([
          ['user', TRUE, static::userEntityInfo()],
        ]
      );
    $user_id_field_storage_definition = $this->getMock('Drupal\Core\Field\FieldStorageDefinitionInterface');
    $user_id_field_storage_definition->expects($this->any())
      ->method('getSetting')
      ->with('target_type')
      ->willReturn('user');
    $user_id_field_storage_definition->expects($this->any())
      ->method('getSchema')
      ->willReturn(EntityReferenceItem::schema($user_id_field_storage_definition));

    $revision_id_field_storage_definition = $this->getMock('Drupal\Core\Field\FieldStorageDefinitionInterface');
    $revision_id_field_storage_definition->expects($this->any())
      ->method('getSchema')
      ->willReturn(IntegerItem::schema($revision_id_field_storage_definition));

    $this->entityManager->expects($this->any())
      ->method('getFieldStorageDefinitions')
      ->willReturn([
        'id' => $id_field_storage_definition,
        'uuid' => $uuid_field_storage_definition,
        'type' => $type_field_storage_definition,
        'langcode' => $langcode_field_storage_definition,
        'name' => $name_field_storage_definition,
373
        'description' => $description_field_storage_definition,
374
        'homepage' => $homepage_field_storage_definition,
375 376 377 378 379 380 381 382 383 384
        'user_id' => $user_id_field_storage_definition,
        'revision_id' => $revision_id_field_storage_definition,
      ]);
  }

  /**
   * Tests fields on the base table.
   */
  public function testBaseTableFields() {
    $base_field_definitions = $this->setupBaseFields(EntityTest::baseFieldDefinitions($this->baseEntityType));
385

386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
    $this->entityManager->expects($this->once())
      ->method('getBaseFieldDefinitions')
      ->with('entity_test')
      ->willReturn($base_field_definitions);

    // Setup the table mapping.
    $table_mapping = $this->getMock('Drupal\Core\Entity\Sql\TableMappingInterface');
    $table_mapping->expects($this->any())
      ->method('getTableNames')
      ->willReturn(['entity_test']);
    $table_mapping->expects($this->any())
      ->method('getColumnNames')
      ->willReturnMap([
        ['id', ['value' => 'id']],
        ['uuid', ['value' => 'uuid']],
        ['type', ['value' => 'type']],
        ['langcode', ['value' => 'langcode']],
        ['name', ['value' => 'name']],
404
        ['description', ['value' => 'description__value', 'format' => 'description__format']],
405
        ['homepage', ['value' => 'homepage']],
406 407 408 409 410
        ['user_id', ['target_id' => 'user_id']],
      ]);
    $table_mapping->expects($this->any())
      ->method('getFieldNames')
      ->willReturnMap([
411
        ['entity_test', ['id', 'uuid', 'type', 'langcode', 'name', 'description', 'homepage', 'user_id']]
412 413 414 415 416 417 418 419 420 421 422
      ]);

    $this->entityStorage->expects($this->once())
      ->method('getTableMapping')
      ->willReturn($table_mapping);

    $this->setupFieldStorageDefinition();

    $data = $this->viewsData->getViewsData();

    $this->assertNumericField($data['entity_test']['id']);
423
    $this->assertField($data['entity_test']['id'], 'id');
424
    $this->assertUuidField($data['entity_test']['uuid']);
425
    $this->assertField($data['entity_test']['uuid'], 'uuid');
426
    $this->assertStringField($data['entity_test']['type']);
427
    $this->assertEquals('type', $data['entity_test']['type']['entity field']);
428 429

    $this->assertLanguageField($data['entity_test']['langcode']);
430
    $this->assertField($data['entity_test']['langcode'], 'langcode');
431
    $this->assertEquals('Original language', $data['entity_test']['langcode']['title']);
432 433

    $this->assertStringField($data['entity_test']['name']);
434
    $this->assertField($data['entity_test']['name'], 'name');
435

436
    $this->assertLongTextField($data['entity_test'], 'description');
437 438
    $this->assertField($data['entity_test']['description__value'], 'description');
    $this->assertField($data['entity_test']['description__format'], 'description');
439

440
    $this->assertUriField($data['entity_test']['homepage']);
441
    $this->assertField($data['entity_test']['homepage'], 'homepage');
442

443
    $this->assertEntityReferenceField($data['entity_test']['user_id']);
444 445
    $this->assertField($data['entity_test']['user_id'], 'user_id');

446
    $relationship = $data['entity_test']['user_id']['relationship'];
447
    $this->assertEquals('users_field_data', $relationship['base']);
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
    $this->assertEquals('uid', $relationship['base field']);
  }

  /**
   * Tests fields on the data table.
   */
  public function testDataTableFields() {
    $entity_type = $this->baseEntityType
      ->set('data_table', 'entity_test_mul_property_data')
      ->set('base_table', 'entity_test_mul')
      ->set('id', 'entity_test_mul')
      ->setKey('bundle', 'type')
    ;
    $base_field_definitions = $this->setupBaseFields(EntityTestMul::baseFieldDefinitions($this->baseEntityType));
    $base_field_definitions['type'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel('entity test type')
      ->setSettings(array('target_type' => 'entity_test_bundle'))
      ->setTranslatable(TRUE);
    $base_field_definitions = $this->setupBaseFields($base_field_definitions);
    $entity_test_type = new ConfigEntityType(['id' => 'entity_test_bundle']);
468
    $user_entity_type = static::userEntityInfo();
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
    $this->entityManager->expects($this->any())
      ->method('getDefinition')
      ->willReturnMap([
        ['entity_test_bundle', TRUE, $entity_test_type],
        ['user', TRUE, $user_entity_type],
      ]);

    $this->entityManager->expects($this->once())
      ->method('getBaseFieldDefinitions')
      ->with('entity_test_mul')
      ->willReturn($base_field_definitions);

    $this->viewsData->setEntityType($entity_type);

     // Setup the table mapping.
    $table_mapping = $this->getMock('Drupal\Core\Entity\Sql\TableMappingInterface');
    $table_mapping->expects($this->any())
      ->method('getTableNames')
      ->willReturn(['entity_test_mul', 'entity_test_mul_property_data']);
    $table_mapping->expects($this->any())
      ->method('getColumnNames')
      ->willReturnMap([
        ['id', ['value' => 'id']],
        ['uuid', ['value' => 'uuid']],
        ['type', ['value' => 'type']],
        ['langcode', ['value' => 'langcode']],
        ['name', ['value' => 'name']],
496
        ['description', ['value' => 'description__value', 'format' => 'description__format']],
497
        ['homepage', ['value' => 'homepage']],
498 499 500 501 502 503
        ['user_id', ['target_id' => 'user_id']],
      ]);
    $table_mapping->expects($this->any())
      ->method('getFieldNames')
      ->willReturnMap([
        ['entity_test_mul', ['id', 'uuid', 'type', 'langcode']],
504
        ['entity_test_mul_property_data', ['id', 'langcode', 'name', 'description', 'homepage', 'user_id']],
505 506 507 508 509 510 511 512 513 514 515 516
      ]);

    $this->entityStorage->expects($this->once())
      ->method('getTableMapping')
      ->willReturn($table_mapping);

    $this->setupFieldStorageDefinition();

    $data = $this->viewsData->getViewsData();

    // Check the base fields.
    $this->assertNumericField($data['entity_test_mul']['id']);
517
    $this->assertField($data['entity_test_mul']['id'], 'id');
518
    $this->assertUuidField($data['entity_test_mul']['uuid']);
519
    $this->assertField($data['entity_test_mul']['uuid'], 'uuid');
520 521

    $this->assertBundleField($data['entity_test_mul']['type']);
522
    $this->assertField($data['entity_test_mul']['type'], 'type');
523 524 525
    $this->assertFalse(isset($data['entity_test_mul']['type']['relationship']));

    $this->assertLanguageField($data['entity_test_mul']['langcode']);
526
    $this->assertField($data['entity_test_mul']['langcode'], 'langcode');
527 528
    // Also ensure that field_data only fields don't appear on the base table.
    $this->assertFalse(isset($data['entity_test_mul']['name']));
529 530 531
    $this->assertFalse(isset($data['entity_test_mul']['description']));
    $this->assertFalse(isset($data['entity_test_mul']['description__value']));
    $this->assertFalse(isset($data['entity_test_mul']['description__format']));
532
    $this->assertFalse(isset($data['entity_test_mul']['user_id']));
533
    $this->assertFalse(isset($data['entity_test_mul']['homepage']));
534 535 536

    // Check the data fields.
    $this->assertNumericField($data['entity_test_mul_property_data']['id']);
537
    $this->assertField($data['entity_test_mul_property_data']['id'], 'id');
538 539

    $this->assertLanguageField($data['entity_test_mul_property_data']['langcode']);
540
    $this->assertField($data['entity_test_mul_property_data']['langcode'], 'langcode');
541 542 543
    $this->assertEquals('Translation language', $data['entity_test_mul_property_data']['langcode']['title']);

    $this->assertStringField($data['entity_test_mul_property_data']['name']);
544
    $this->assertField($data['entity_test_mul_property_data']['name'], 'name');
545

546
    $this->assertLongTextField($data['entity_test_mul_property_data'], 'description');
547 548
    $this->assertField($data['entity_test_mul_property_data']['description__value'], 'description');
    $this->assertField($data['entity_test_mul_property_data']['description__format'], 'description');
549

550
    $this->assertUriField($data['entity_test_mul_property_data']['homepage']);
551
    $this->assertField($data['entity_test_mul_property_data']['homepage'], 'homepage');
552

553
    $this->assertEntityReferenceField($data['entity_test_mul_property_data']['user_id']);
554
    $this->assertField($data['entity_test_mul_property_data']['user_id'], 'user_id');
555
    $relationship = $data['entity_test_mul_property_data']['user_id']['relationship'];
556
    $this->assertEquals('users_field_data', $relationship['base']);
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
    $this->assertEquals('uid', $relationship['base field']);
  }

  /**
   * Tests fields on the revision table.
   */
  public function testRevisionTableFields() {
    $entity_type = $this->baseEntityType
      ->set('base_table', 'entity_test_mulrev')
      ->set('revision_table', 'entity_test_mulrev_revision')
      ->set('data_table', 'entity_test_mulrev_property_data')
      ->set('revision_data_table', 'entity_test_mulrev_property_revision')
      ->set('id', 'entity_test_mulrev');
    $base_field_definitions = $this->setupBaseFields(EntityTestMulRev::baseFieldDefinitions($this->baseEntityType));
    $this->entityManager->expects($this->once())
      ->method('getBaseFieldDefinitions')
      ->with('entity_test_mulrev')
      ->willReturn($base_field_definitions);

    $this->viewsData->setEntityType($entity_type);

     // Setup the table mapping.
    $table_mapping = $this->getMock('Drupal\Core\Entity\Sql\TableMappingInterface');
    $table_mapping->expects($this->any())
      ->method('getTableNames')
      ->willReturn(['entity_test_mulrev', 'entity_test_mulrev_revision', 'entity_test_mulrev_property_data', 'entity_test_mulrev_property_revision']);
    $table_mapping->expects($this->any())
      ->method('getColumnNames')
      ->willReturnMap([
        ['id', ['value' => 'id']],
        ['uuid', ['value' => 'uuid']],
        ['type', ['value' => 'type']],
        ['langcode', ['value' => 'langcode']],
        ['name', ['value' => 'name']],
591
        ['description', ['value' => 'description__value', 'format' => 'description__format']],
592
        ['homepage', ['value' => 'homepage']],
593 594 595 596 597 598 599 600
        ['user_id', ['target_id' => 'user_id']],
        ['revision_id', ['value' => 'id']],
      ]);
    $table_mapping->expects($this->any())
      ->method('getFieldNames')
      ->willReturnMap([
        ['entity_test_mulrev', ['id', 'revision_id', 'uuid', 'type']],
        ['entity_test_mulrev_revision', ['id', 'revision_id', 'langcode']],
601 602
        ['entity_test_mulrev_property_data', ['id', 'revision_id', 'langcode', 'name', 'description', 'homepage', 'user_id']],
        ['entity_test_mulrev_property_revision', ['id', 'revision_id', 'langcode', 'name', 'description', 'homepage', 'user_id']],
603 604 605 606 607 608 609 610 611 612 613 614
      ]);

    $this->entityStorage->expects($this->once())
      ->method('getTableMapping')
      ->willReturn($table_mapping);

    $this->setupFieldStorageDefinition();

    $data = $this->viewsData->getViewsData();

    // Check the base fields.
    $this->assertNumericField($data['entity_test_mulrev']['id']);
615
    $this->assertField($data['entity_test_mulrev']['id'], 'id');
616
    $this->assertNumericField($data['entity_test_mulrev']['revision_id']);
617
    $this->assertField($data['entity_test_mulrev']['revision_id'], 'revision_id');
618
    $this->assertUuidField($data['entity_test_mulrev']['uuid']);
619
    $this->assertField($data['entity_test_mulrev']['uuid'], 'uuid');
620
    $this->assertStringField($data['entity_test_mulrev']['type']);
621
    $this->assertField($data['entity_test_mulrev']['type'], 'type');
622 623 624

    // Also ensure that field_data only fields don't appear on the base table.
    $this->assertFalse(isset($data['entity_test_mulrev']['name']));
625 626 627
    $this->assertFalse(isset($data['entity_test_mul']['description']));
    $this->assertFalse(isset($data['entity_test_mul']['description__value']));
    $this->assertFalse(isset($data['entity_test_mul']['description__format']));
628
    $this->assertFalse(isset($data['entity_test_mul']['homepage']));
629 630 631 632 633
    $this->assertFalse(isset($data['entity_test_mulrev']['langcode']));
    $this->assertFalse(isset($data['entity_test_mulrev']['user_id']));

    // Check the revision fields.
    $this->assertNumericField($data['entity_test_mulrev_revision']['id']);
634
    $this->assertField($data['entity_test_mulrev_revision']['id'], 'id');
635
    $this->assertNumericField($data['entity_test_mulrev_revision']['revision_id']);
636
    $this->assertField($data['entity_test_mulrev_revision']['revision_id'], 'revision_id');
637 638

    $this->assertLanguageField($data['entity_test_mulrev_revision']['langcode']);
639
    $this->assertField($data['entity_test_mulrev_revision']['langcode'], 'langcode');
640 641 642 643
    $this->assertEquals('Original language', $data['entity_test_mulrev_revision']['langcode']['title']);

    // Also ensure that field_data only fields don't appear on the revision table.
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['name']));
644 645 646
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['description']));
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['description__value']));
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['description__format']));
647
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['homepage']));
648 649 650 651
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['user_id']));

    // Check the data fields.
    $this->assertNumericField($data['entity_test_mulrev_property_data']['id']);
652
    $this->assertField($data['entity_test_mulrev_property_data']['id'], 'id');
653
    $this->assertLanguageField($data['entity_test_mulrev_property_data']['langcode']);
654
    $this->assertField($data['entity_test_mulrev_property_data']['langcode'], 'langcode');
655
    $this->assertStringField($data['entity_test_mulrev_property_data']['name']);
656
    $this->assertField($data['entity_test_mulrev_property_data']['name'], 'name');
657

658
    $this->assertLongTextField($data['entity_test_mulrev_property_data'], 'description');
659 660
    $this->assertField($data['entity_test_mulrev_property_data']['description__value'], 'description');
    $this->assertField($data['entity_test_mulrev_property_data']['description__format'], 'description');
661
    $this->assertUriField($data['entity_test_mulrev_property_data']['homepage']);
662
    $this->assertField($data['entity_test_mulrev_property_data']['homepage'], 'homepage');
663

664
    $this->assertEntityReferenceField($data['entity_test_mulrev_property_data']['user_id']);
665
    $this->assertField($data['entity_test_mulrev_property_data']['user_id'], 'user_id');
666
    $relationship = $data['entity_test_mulrev_property_data']['user_id']['relationship'];
667
    $this->assertEquals('users_field_data', $relationship['base']);
668 669 670 671
    $this->assertEquals('uid', $relationship['base field']);

    // Check the property data fields.
    $this->assertNumericField($data['entity_test_mulrev_property_revision']['id']);
672
    $this->assertField($data['entity_test_mulrev_property_revision']['id'], 'id');
673 674

    $this->assertLanguageField($data['entity_test_mulrev_property_revision']['langcode']);
675
    $this->assertField($data['entity_test_mulrev_property_revision']['langcode'], 'langcode');
676
    $this->assertEquals('Translation language', $data['entity_test_mulrev_property_revision']['langcode']['title']);
677 678

    $this->assertStringField($data['entity_test_mulrev_property_revision']['name']);
679
    $this->assertField($data['entity_test_mulrev_property_revision']['name'], 'name');
680

681
    $this->assertLongTextField($data['entity_test_mulrev_property_revision'], 'description');
682 683
    $this->assertField($data['entity_test_mulrev_property_revision']['description__value'], 'description');
    $this->assertField($data['entity_test_mulrev_property_revision']['description__format'], 'description');
684

685
    $this->assertUriField($data['entity_test_mulrev_property_revision']['homepage']);
686
    $this->assertField($data['entity_test_mulrev_property_revision']['homepage'], 'homepage');
687

688
    $this->assertEntityReferenceField($data['entity_test_mulrev_property_revision']['user_id']);
689
    $this->assertField($data['entity_test_mulrev_property_revision']['user_id'], 'user_id');
690
    $relationship = $data['entity_test_mulrev_property_revision']['user_id']['relationship'];
691
    $this->assertEquals('users_field_data', $relationship['base']);
692 693 694
    $this->assertEquals('uid', $relationship['base field']);
  }

695 696 697 698 699 700 701 702 703 704 705 706
  /**
   * Tests generic stuff per field.
   *
   * @param array $data
   *   The views data to check.
   * @param string $field_name
   *   The entity field name.
   */
  protected function assertField($data, $field_name) {
    $this->assertEquals($field_name, $data['entity field']);
  }

707 708 709 710 711 712 713 714 715 716 717 718 719
  /**
   * Tests views data for a string field.
   *
   * @param $data
   *   The views data to check.
   */
  protected function assertStringField($data) {
    $this->assertEquals('standard', $data['field']['id']);
    $this->assertEquals('string', $data['filter']['id']);
    $this->assertEquals('string', $data['argument']['id']);
    $this->assertEquals('standard', $data['sort']['id']);
  }

720 721 722 723 724 725 726 727 728 729 730 731 732
  /**
   * Tests views data for a URI field.
   *
   * @param $data
   *   The views data to check.
   */
  protected function assertUriField($data) {
    $this->assertEquals('url', $data['field']['id']);
    $this->assertEquals('string', $data['filter']['id']);
    $this->assertEquals('string', $data['argument']['id']);
    $this->assertEquals('standard', $data['sort']['id']);
  }

733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
  /**
   * Tests views data for a long text field.
   *
   * @param $data
   *   The views data for the table this field is in.
   * @param $field_name
   *   The name of the field being checked.
   */
  protected function assertLongTextField($data, $field_name) {
    $value_field = $data[$field_name . '__value'];
    $this->assertEquals('markup', $value_field['field']['id']);
    $this->assertEquals($field_name . '__format', $value_field['field']['format']);
    $this->assertEquals('string', $value_field['filter']['id']);
    $this->assertEquals('string', $value_field['argument']['id']);
    $this->assertEquals('standard', $value_field['sort']['id']);

    $this->assertStringField($data[$field_name . '__format']);
  }

752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
  /**
   * Tests views data for a UUID field.
   *
   * @param array $data
   *   The views data to check.
   */
  protected function assertUuidField($data) {
    // @todo Can we provide additional support for UUIDs in views?
    $this->assertEquals('standard', $data['field']['id']);
    $this->assertEquals('string', $data['filter']['id']);
    $this->assertEquals('string', $data['argument']['id']);
    $this->assertEquals('standard', $data['sort']['id']);
  }

  /**
   * Tests views data for a numeric field.
   *
   * @param array $data
   *   The views data to check.
   */
  protected function assertNumericField($data) {
    $this->assertEquals('numeric', $data['field']['id']);
    $this->assertEquals('numeric', $data['filter']['id']);
    $this->assertEquals('numeric', $data['argument']['id']);
    $this->assertEquals('standard', $data['sort']['id']);
  }

  /**
   * Tests views data for a language field.
   *
   * @param array $data
   *   The views data to check.
   */
  protected function assertLanguageField($data) {
    $this->assertEquals('language', $data['field']['id']);
    $this->assertEquals('language', $data['filter']['id']);
    $this->assertEquals('language', $data['argument']['id']);
    $this->assertEquals('standard', $data['sort']['id']);
  }

  /**
   * Tests views data for a entity reference field.
   */
  protected function assertEntityReferenceField($data) {
    $this->assertEquals('numeric', $data['field']['id']);
    $this->assertEquals('numeric', $data['filter']['id']);
    $this->assertEquals('numeric', $data['argument']['id']);
    $this->assertEquals('standard', $data['sort']['id']);
  }

  /**
   * Tests views data for a bundle field.
   */
  protected function assertBundleField($data) {
    $this->assertEquals('standard', $data['field']['id']);
    $this->assertEquals('bundle', $data['filter']['id']);
    $this->assertEquals('string', $data['argument']['id']);
    $this->assertEquals('standard', $data['sort']['id']);
  }

  /**
   * Returns entity info for the user entity.
   *
   * @return array
   */
  protected static function userEntityInfo() {
    return new ContentEntityType([
      'id' => 'user',
      'class' => 'Drupal\user\Entity\User',
      'label' => 'User',
      'base_table' => 'users',
823
      'data_table' => 'users_field_data',
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
      'entity_keys' => [
        'id' => 'uid',
        'uuid' => 'uuid',
      ],
    ]);
  }

}

class TestEntityViewsData extends EntityViewsData {

  public function setEntityType(EntityTypeInterface $entity_type) {
    $this->entityType = $entity_type;
  }
}

class TestEntityType extends EntityType {

  /**
   * Sets a specific entity key.
   *
   * @param string $key
   *   The name of the entity key.
   * @param string $value
   *   The new value of the key.
   *
   * @return $this
   */
  public function setKey($key, $value) {
    $this->entity_keys[$key] = $value;
    return $this;
  }

}

}


namespace {
  use Drupal\Component\Utility\String;

  if (!function_exists('t')) {
    function t($string, array $args = []) {
      return String::format($string, $args);
    }
  }
}