EntityViewsDataTest.php 40.5 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
   */
  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');

86 87 88 89 90 91
    $typed_data_manager = $this->getMockBuilder('Drupal\Core\TypedData\TypedDataManager')
      ->disableOriginalConstructor()
      ->getMock();
    $typed_data_manager->expects($this->any())
        ->method('createDataDefinition')
        ->willReturn($this->getMock('Drupal\Core\TypedData\DataDefinitionInterface'));
92 93 94 95
    $this->baseEntityType = new TestEntityType([
      'base_table' => 'entity_test',
      'id' => 'entity_test',
      'label' => 'Entity test',
96 97 98 99 100 101
      'entity_keys' => [
        'id' => 'id',
        'langcode' => 'langcode',
        'bundle' => 'type',
        'revision' => 'revision_id',
      ],
102
      'provider' => 'entity_test',
103
      'list_cache_contexts' => ['entity_test_list_cache_context'],
104 105 106 107 108 109 110 111 112 113 114
    ]);

    $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())
115
      ->method('getDefaultStorageSettings')
116 117
      ->willReturn([]);
    $field_type_manager->expects($this->any())
118
      ->method('getDefaultFieldSettings')
119 120 121 122 123
      ->willReturn([]);

    $container = new ContainerBuilder();
    $container->set('plugin.manager.field.field_type', $field_type_manager);
    $container->set('entity.manager', $this->entityManager);
124
    $container->set('typed_data_manager', $typed_data_manager);
125 126 127 128 129 130 131 132 133 134 135 136 137
    \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) {
138 139 140
    // 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')
141 142
      ->setLabel('Description')
      ->setDescription('A description of the term.')
143 144 145 146 147 148 149 150 151 152 153 154 155
      ->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);

156 157
    // Add a URL field; this example is from the Comment entity.
    $base_fields['homepage'] = BaseFieldDefinition::create('uri')
158 159
      ->setLabel('Homepage')
      ->setDescription("The comment author's home page address.")
160 161 162
      ->setTranslatable(TRUE)
      ->setSetting('max_length', 255);

163 164 165 166 167 168 169 170 171 172 173 174 175
    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']);
176
    $this->assertEquals(FALSE, $data['entity_test']['table']['entity revision']);
177
    $this->assertEquals('Entity test', $data['entity_test']['table']['group']);
178
    $this->assertEquals('entity_test', $data['entity_test']['table']['provider']);
179 180

    $this->assertEquals('id', $data['entity_test']['table']['base']['field']);
181
    $this->assertEquals(['entity_test_list_cache_context'], $data['entity_test']['table']['base']['cache_contexts']);
182 183 184 185 186 187 188 189 190 191 192 193 194
    $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() {
195 196
    $entity_type = $this->baseEntityType
      ->set('data_table', 'entity_test_mul_property_data')
197
      ->set('id', 'entity_test_mul')
198
      ->set('translatable', TRUE)
199 200 201 202 203 204
      ->setKey('label', 'label');

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

    // Tests the join definition between the base and the data table.
    $data = $this->viewsData->getViewsData();
205 206 207 208 209 210
    $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']));
211 212

    $this->assertEquals('entity_test_mul', $data['entity_test_mul_property_data']['table']['entity type']);
213
    $this->assertEquals(FALSE, $data['entity_test_mul_property_data']['table']['entity revision']);
214
    $this->assertEquals('Entity test', $data['entity_test_mul_property_data']['table']['group']);
215
    $this->assertEquals('entity_test', $data['entity_test']['table']['provider']);
216
    $this->assertEquals(['field' => 'label', 'table' => 'entity_test_mul_property_data'], $data['entity_test_mul_property_data']['table']['base']['defaults']);
217 218

    // Ensure the join information is set up properly.
219 220
    $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']);
221 222 223 224 225
    $this->assertFalse(isset($data['revision_table']));
    $this->assertFalse(isset($data['revision_data_table']));
  }

  /**
226
   * Tests revision table without data table support.
227
   */
228
  public function testRevisionTableWithoutDataTable() {
229 230
    $entity_type = $this->baseEntityType
      ->set('revision_table', 'entity_test_mulrev_revision')
231
      ->set('revision_data_table', NULL)
232 233 234 235 236 237 238
      ->set('id', 'entity_test_mulrev')
      ->setKey('revision', 'revision_id')
    ;
    $this->viewsData->setEntityType($entity_type);

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

239 240 241
    $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']);

242
    $this->assertEquals(FALSE, $data['entity_test']['table']['entity revision']);
243
    $this->assertEquals('entity_test_mulrev', $data['entity_test_mulrev_revision']['table']['entity type']);
244 245 246 247
    $this->assertEquals(TRUE, $data['entity_test_mulrev_revision']['table']['entity revision']);
    $this->assertEquals('entity_test_mulrev', $data['entity_test_mulrev_revision']['table']['entity type']);
    $this->assertEquals(TRUE, $data['entity_test_mulrev_revision']['table']['entity revision']);

248
    $this->assertEquals('Entity test revision', $data['entity_test_mulrev_revision']['table']['group']);
249
    $this->assertEquals('entity_test', $data['entity_test']['table']['provider']);
250 251 252 253 254 255

    // 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']);
256 257 258 259 260 261 262 263 264 265 266 267
    $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')
268
      ->set('translatable', TRUE)
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
      ->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.
285
    $revision_data = $data['entity_test_mulrev_property_revision'];
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
    $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')
307
      ->set('translatable', TRUE)
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
      ->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([
327
      'entity_test_mulrev_field_data' => ['left_field' => 'revision_id', 'field' => 'revision_id', 'type' => 'INNER'],
328 329
      'entity_test_mulrev_revision' => ['left_field' => 'revision_id', 'field' => 'revision_id', 'type' => 'INNER'],
    ], $revision_data['table']['join']);
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
    $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));
357 358 359 360
    $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));
361 362 363 364
    $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));
365 366 367 368 369 370 371 372 373 374 375 376 377

    // 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');
378 379 380
    $user_id_field_storage_definition->expects($this->any())
      ->method('getSettings')
      ->willReturn(['target_type' => 'user']);
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
    $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,
398
        'description' => $description_field_storage_definition,
399
        'homepage' => $homepage_field_storage_definition,
400 401 402 403 404 405 406 407 408 409
        '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));
410 411
    $user_base_field_definitions = [
      'uid' => BaseFieldDefinition::create('integer')
412 413
        ->setLabel('ID')
        ->setDescription('The ID of the user entity.')
414 415 416 417
        ->setReadOnly(TRUE)
        ->setSetting('unsigned', TRUE)
    ];
    $this->entityManager->expects($this->any())
418
      ->method('getBaseFieldDefinitions')
419 420 421 422
      ->will($this->returnValueMap([
        ['user', $user_base_field_definitions],
        ['entity_test', $base_field_definitions],
      ]));
423 424 425 426 427 428 429 430 431 432 433 434 435
    // 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']],
436
        ['description', ['value' => 'description__value', 'format' => 'description__format']],
437
        ['homepage', ['value' => 'homepage']],
438 439 440 441 442
        ['user_id', ['target_id' => 'user_id']],
      ]);
    $table_mapping->expects($this->any())
      ->method('getFieldNames')
      ->willReturnMap([
443
        ['entity_test', ['id', 'uuid', 'type', 'langcode', 'name', 'description', 'homepage', 'user_id']]
444 445 446 447 448 449 450 451 452 453 454
      ]);

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

    $this->setupFieldStorageDefinition();

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

    $this->assertNumericField($data['entity_test']['id']);
455
    $this->assertField($data['entity_test']['id'], 'id');
456
    $this->assertUuidField($data['entity_test']['uuid']);
457
    $this->assertField($data['entity_test']['uuid'], 'uuid');
458
    $this->assertStringField($data['entity_test']['type']);
459
    $this->assertEquals('type', $data['entity_test']['type']['entity field']);
460 461

    $this->assertLanguageField($data['entity_test']['langcode']);
462
    $this->assertField($data['entity_test']['langcode'], 'langcode');
463
    $this->assertEquals('Original language', $data['entity_test']['langcode']['title']);
464 465

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

468
    $this->assertLongTextField($data['entity_test'], 'description');
469 470
    $this->assertField($data['entity_test']['description__value'], 'description');
    $this->assertField($data['entity_test']['description__format'], 'description');
471

472
    $this->assertUriField($data['entity_test']['homepage']);
473
    $this->assertField($data['entity_test']['homepage'], 'homepage');
474

475
    $this->assertEntityReferenceField($data['entity_test']['user_id']);
476 477
    $this->assertField($data['entity_test']['user_id'], 'user_id');

478
    $relationship = $data['entity_test']['user_id']['relationship'];
479
    $this->assertEquals('users_field_data', $relationship['base']);
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
    $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')
496
      ->setSetting('target_type', 'entity_test_bundle')
497 498
      ->setTranslatable(TRUE);
    $base_field_definitions = $this->setupBaseFields($base_field_definitions);
499 500
    $user_base_field_definitions = [
      'uid' => BaseFieldDefinition::create('integer')
501 502
        ->setLabel('ID')
        ->setDescription('The ID of the user entity.')
503 504 505
        ->setReadOnly(TRUE)
        ->setSetting('unsigned', TRUE)
    ];
506 507
    $entity_test_type = new ConfigEntityType(['id' => 'entity_test_bundle']);

508
    $this->entityManager->expects($this->any())
509
      ->method('getBaseFieldDefinitions')
510 511 512 513
      ->will($this->returnValueMap([
        ['user', $user_base_field_definitions],
        ['entity_test_mul', $base_field_definitions],
      ]));
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529

    $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']],
530
        ['description', ['value' => 'description__value', 'format' => 'description__format']],
531
        ['homepage', ['value' => 'homepage']],
532 533 534 535 536
        ['user_id', ['target_id' => 'user_id']],
      ]);
    $table_mapping->expects($this->any())
      ->method('getFieldNames')
      ->willReturnMap([
537 538
        ['entity_test_mul', ['uuid']],
        ['entity_test_mul_property_data', ['id', 'type', 'langcode', 'name', 'description', 'homepage', 'user_id']],
539 540
      ]);

541 542 543 544 545 546 547 548 549
    $table_mapping->expects($this->any())
      ->method('getFieldTableName')
      ->willReturnCallback(function($field) {
        if ($field == 'uuid') {
          return 'entity_test_mul';
        }
        return 'entity_test_mul_property_data';
      });

550 551 552 553 554 555
    $this->entityStorage->expects($this->once())
      ->method('getTableMapping')
      ->willReturn($table_mapping);

    $this->setupFieldStorageDefinition();

556 557 558 559 560 561 562 563
    $user_entity_type = static::userEntityInfo();
    $this->entityManager->expects($this->any())
      ->method('getDefinition')
      ->will($this->returnValueMap([
        ['user', TRUE, $user_entity_type],
        ['entity_test_bundle', TRUE, $entity_test_type],
      ]));

564 565 566
    $data = $this->viewsData->getViewsData();

    // Check the base fields.
567 568
    $this->assertFalse(isset($data['entity_test_mul']['id']));
    $this->assertFalse(isset($data['entity_test_mul']['type']));
569
    $this->assertUuidField($data['entity_test_mul']['uuid']);
570
    $this->assertField($data['entity_test_mul']['uuid'], 'uuid');
571 572 573 574 575

    $this->assertFalse(isset($data['entity_test_mul']['type']['relationship']));

    // Also ensure that field_data only fields don't appear on the base table.
    $this->assertFalse(isset($data['entity_test_mul']['name']));
576 577 578
    $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']));
579
    $this->assertFalse(isset($data['entity_test_mul']['user_id']));
580
    $this->assertFalse(isset($data['entity_test_mul']['homepage']));
581 582 583

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

586 587 588
    $this->assertBundleField($data['entity_test_mul_property_data']['type']);
    $this->assertField($data['entity_test_mul_property_data']['type'], 'type');

589
    $this->assertLanguageField($data['entity_test_mul_property_data']['langcode']);
590
    $this->assertField($data['entity_test_mul_property_data']['langcode'], 'langcode');
591 592 593
    $this->assertEquals('Translation language', $data['entity_test_mul_property_data']['langcode']['title']);

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

596
    $this->assertLongTextField($data['entity_test_mul_property_data'], 'description');
597 598
    $this->assertField($data['entity_test_mul_property_data']['description__value'], 'description');
    $this->assertField($data['entity_test_mul_property_data']['description__format'], 'description');
599

600
    $this->assertUriField($data['entity_test_mul_property_data']['homepage']);
601
    $this->assertField($data['entity_test_mul_property_data']['homepage'], 'homepage');
602

603
    $this->assertEntityReferenceField($data['entity_test_mul_property_data']['user_id']);
604
    $this->assertField($data['entity_test_mul_property_data']['user_id'], 'user_id');
605
    $relationship = $data['entity_test_mul_property_data']['user_id']['relationship'];
606
    $this->assertEquals('users_field_data', $relationship['base']);
607 608 609 610 611 612 613 614 615 616 617 618
    $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')
619 620
      ->set('id', 'entity_test_mulrev')
      ->set('translatable', TRUE);
621
    $base_field_definitions = $this->setupBaseFields(EntityTestMulRev::baseFieldDefinitions($this->baseEntityType));
622 623
    $user_base_field_definitions = [
      'uid' => BaseFieldDefinition::create('integer')
624 625
        ->setLabel('ID')
        ->setDescription('The ID of the user entity.')
626 627 628 629
        ->setReadOnly(TRUE)
        ->setSetting('unsigned', TRUE)
    ];
    $this->entityManager->expects($this->any())
630
      ->method('getBaseFieldDefinitions')
631 632 633 634
      ->will($this->returnValueMap([
        ['user', $user_base_field_definitions],
        ['entity_test_mulrev', $base_field_definitions],
      ]));
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650

    $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']],
651
        ['description', ['value' => 'description__value', 'format' => 'description__format']],
652
        ['homepage', ['value' => 'homepage']],
653 654 655 656 657 658 659 660
        ['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']],
661 662
        ['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']],
663 664
      ]);

665 666 667 668 669 670 671 672 673
    $table_mapping->expects($this->any())
      ->method('getFieldTableName')
      ->willReturnCallback(function($field) {
        if ($field == 'uuid') {
          return 'entity_test_mulrev';
        }
        return 'entity_test_mulrev_property_data';
      });

674 675 676 677 678 679 680 681 682
    $this->entityStorage->expects($this->once())
      ->method('getTableMapping')
      ->willReturn($table_mapping);

    $this->setupFieldStorageDefinition();

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

    // Check the base fields.
683 684 685
    $this->assertFalse(isset($data['entity_test_mulrev']['id']));
    $this->assertFalse(isset($data['entity_test_mulrev']['type']));
    $this->assertFalse(isset($data['entity_test_mulrev']['revision_id']));
686
    $this->assertUuidField($data['entity_test_mulrev']['uuid']);
687
    $this->assertField($data['entity_test_mulrev']['uuid'], 'uuid');
688 689 690

    // Also ensure that field_data only fields don't appear on the base table.
    $this->assertFalse(isset($data['entity_test_mulrev']['name']));
691 692 693
    $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']));
694
    $this->assertFalse(isset($data['entity_test_mul']['homepage']));
695 696 697
    $this->assertFalse(isset($data['entity_test_mulrev']['langcode']));
    $this->assertFalse(isset($data['entity_test_mulrev']['user_id']));

698 699 700
    // Check the revision fields. The revision ID should only appear in the data
    // table.
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['revision_id']));
701 702

    // Also ensure that field_data only fields don't appear on the revision table.
703
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['id']));
704
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['name']));
705 706 707
    $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']));
708
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['homepage']));
709 710 711 712
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['user_id']));

    // Check the data fields.
    $this->assertNumericField($data['entity_test_mulrev_property_data']['id']);
713
    $this->assertField($data['entity_test_mulrev_property_data']['id'], 'id');
714 715
    $this->assertNumericField($data['entity_test_mulrev_property_data']['revision_id']);
    $this->assertField($data['entity_test_mulrev_property_data']['revision_id'], 'revision_id');
716
    $this->assertLanguageField($data['entity_test_mulrev_property_data']['langcode']);
717
    $this->assertField($data['entity_test_mulrev_property_data']['langcode'], 'langcode');
718
    $this->assertStringField($data['entity_test_mulrev_property_data']['name']);
719
    $this->assertField($data['entity_test_mulrev_property_data']['name'], 'name');
720

721
    $this->assertLongTextField($data['entity_test_mulrev_property_data'], 'description');
722 723
    $this->assertField($data['entity_test_mulrev_property_data']['description__value'], 'description');
    $this->assertField($data['entity_test_mulrev_property_data']['description__format'], 'description');
724
    $this->assertUriField($data['entity_test_mulrev_property_data']['homepage']);
725
    $this->assertField($data['entity_test_mulrev_property_data']['homepage'], 'homepage');
726

727
    $this->assertEntityReferenceField($data['entity_test_mulrev_property_data']['user_id']);
728
    $this->assertField($data['entity_test_mulrev_property_data']['user_id'], 'user_id');
729
    $relationship = $data['entity_test_mulrev_property_data']['user_id']['relationship'];
730
    $this->assertEquals('users_field_data', $relationship['base']);
731 732 733 734
    $this->assertEquals('uid', $relationship['base field']);

    // Check the property data fields.
    $this->assertNumericField($data['entity_test_mulrev_property_revision']['id']);
735
    $this->assertField($data['entity_test_mulrev_property_revision']['id'], 'id');
736 737

    $this->assertLanguageField($data['entity_test_mulrev_property_revision']['langcode']);
738
    $this->assertField($data['entity_test_mulrev_property_revision']['langcode'], 'langcode');
739
    $this->assertEquals('Translation language', $data['entity_test_mulrev_property_revision']['langcode']['title']);
740 741

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

744
    $this->assertLongTextField($data['entity_test_mulrev_property_revision'], 'description');
745 746
    $this->assertField($data['entity_test_mulrev_property_revision']['description__value'], 'description');
    $this->assertField($data['entity_test_mulrev_property_revision']['description__format'], 'description');
747

748
    $this->assertUriField($data['entity_test_mulrev_property_revision']['homepage']);
749
    $this->assertField($data['entity_test_mulrev_property_revision']['homepage'], 'homepage');
750

751
    $this->assertEntityReferenceField($data['entity_test_mulrev_property_revision']['user_id']);
752
    $this->assertField($data['entity_test_mulrev_property_revision']['user_id'], 'user_id');
753
    $relationship = $data['entity_test_mulrev_property_revision']['user_id']['relationship'];
754
    $this->assertEquals('users_field_data', $relationship['base']);
755 756 757
    $this->assertEquals('uid', $relationship['base field']);
  }

758 759 760 761 762 763 764 765 766 767 768 769
  /**
   * 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']);
  }

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
  /**
   * Tests add link types.
   */
  public function testEntityLinks() {
    $this->baseEntityType->setLinkTemplate('canonical', '/entity_test/{entity_test}');
    $this->baseEntityType->setLinkTemplate('edit-form', '/entity_test/{entity_test}/edit');
    $this->baseEntityType->setLinkTemplate('delete-form', '/entity_test/{entity_test}/delete');

    $data = $this->viewsData->getViewsData();
    $this->assertEquals('entity_link', $data['entity_test']['view_entity_test']['field']['id']);
    $this->assertEquals('entity_link_edit', $data['entity_test']['edit_entity_test']['field']['id']);
    $this->assertEquals('entity_link_delete', $data['entity_test']['delete_entity_test']['field']['id']);
  }

  /**
   * Tests additional edit links.
   */
  public function testEntityLinksJustEditForm() {
    $this->baseEntityType->setLinkTemplate('edit-form', '/entity_test/{entity_test}/edit');

    $data = $this->viewsData->getViewsData();
    $this->assertFalse(isset($data['entity_test']['view_entity_test']));
    $this->assertFalse(isset($data['entity_test']['delete_entity_test']));

    $this->assertEquals('entity_link_edit', $data['entity_test']['edit_entity_test']['field']['id']);
  }

797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
  /**
   * @covers ::getViewsData
   */
  public function testGetViewsDataWithoutEntityOperations() {
    // Make sure there is no list builder. The API does not document is
    // supports resetting entity handlers, so this might break in the future.
    $this->baseEntityType->setListBuilderClass(NULL);
    $data = $this->viewsData->getViewsData();
    $this->assertArrayNotHasKey('operations', $data[$this->baseEntityType->getBaseTable()]);
  }

  /**
   * @covers ::getViewsData
   */
  public function testGetViewsDataWithEntityOperations() {
    $this->baseEntityType->setListBuilderClass('\Drupal\Core\Entity\EntityListBuilder');
    $data = $this->viewsData->getViewsData();
    $this->assertSame('entity_operations', $data[$this->baseEntityType->getBaseTable()]['operations']['field']['id']);
  }

817 818 819 820 821 822 823
  /**
   * Tests views data for a string field.
   *
   * @param $data
   *   The views data to check.
   */
  protected function assertStringField($data) {
824
    $this->assertEquals('field', $data['field']['id']);
825 826 827 828 829
    $this->assertEquals('string', $data['filter']['id']);
    $this->assertEquals('string', $data['argument']['id']);
    $this->assertEquals('standard', $data['sort']['id']);
  }

830 831 832 833 834 835 836
  /**
   * Tests views data for a URI field.
   *
   * @param $data
   *   The views data to check.
   */
  protected function assertUriField($data) {
837 838
    $this->assertEquals('field', $data['field']['id']);
    $this->assertEquals('string', $data['field']['default_formatter']);
839 840 841 842 843
    $this->assertEquals('string', $data['filter']['id']);
    $this->assertEquals('string', $data['argument']['id']);
    $this->assertEquals('standard', $data['sort']['id']);
  }

844 845 846 847 848 849 850 851 852 853
  /**
   * 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'];
854
    $this->assertEquals('field', $value_field['field']['id']);
855 856 857 858 859 860 861 862
    $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']);
  }

863 864 865 866 867 868 869 870
  /**
   * 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?
871
    $this->assertEquals('field', $data['field']['id']);
872
    $this->assertFalse($data['field']['click sortable']);
873 874 875 876 877 878 879 880 881 882 883 884
    $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) {
885
    $this->assertEquals('field', $data['field']['id']);
886 887 888 889 890 891 892 893 894 895 896 897
    $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) {
898
    $this->assertEquals('field', $data['field']['id']);
899 900 901 902 903 904 905 906 907
    $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) {
908
    $this->assertEquals('field', $data['field']['id']);
909 910 911 912 913 914 915 916 917
    $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) {
918
    $this->assertEquals('field', $data['field']['id']);
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
    $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',
935
      'data_table' => 'users_field_data',
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972
      '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;
  }

}

}

973
namespace Drupal\entity_test\Entity {
974 975
  if (!function_exists('t')) {
    function t($string, array $args = []) {
976
      return strtr($string, $args);
977 978 979
    }
  }
}
980