EntityViewsDataTest.php 41 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
      'entity_keys' => [
97
        'uuid' => 'uuid',
98 99 100 101 102
        'id' => 'id',
        'langcode' => 'langcode',
        'bundle' => 'type',
        'revision' => 'revision_id',
      ],
103
      'provider' => 'entity_test',
104
      'list_cache_contexts' => ['entity_test_list_cache_context'],
105 106 107 108 109 110 111 112 113 114 115
    ]);

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

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

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

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

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

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

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

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

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

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

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

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

243
    $this->assertEquals(FALSE, $data['entity_test']['table']['entity revision']);
244
    $this->assertEquals('entity_test_mulrev', $data['entity_test_mulrev_revision']['table']['entity type']);
245 246 247 248
    $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']);

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

    // 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']);
257 258 259 260 261 262 263 264 265 266 267 268
    $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')
269
      ->set('translatable', TRUE)
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
      ->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.
286 287
    $revision_field_data = $data['entity_test_mulrev_property_revision'];
    $this->assertCount(1, $revision_field_data['table']['join']);
288 289 290 291
    $this->assertEquals([
      'entity_test_mul_property_data' => [
        'left_field' => 'revision_id', 'field' => 'revision_id', 'type' => 'INNER'
      ],
292 293 294 295 296 297
    ], $revision_field_data['table']['join']);

    $revision_base_data = $data['entity_test_mulrev_revision'];
    $this->assertCount(1, $revision_base_data['table']['join']);
    $this->assertEquals([
      'entity_test_mulrev_property_revision' => [
298 299
        'left_field' => 'revision_id', 'field' => 'revision_id', 'type' => 'INNER'
      ],
300
    ], $revision_base_data['table']['join']);
301 302 303 304 305 306 307 308 309 310 311 312

    $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')
313
      ->set('translatable', TRUE)
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
      ->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.
330 331 332 333 334 335 336 337 338 339
    $revision_field_data = $data['entity_test_mulrev_property_revision'];
    $this->assertCount(1, $revision_field_data['table']['join']);
    $this->assertEquals([
      'entity_test_mulrev_field_data' => [
        'left_field' => 'revision_id', 'field' => 'revision_id', 'type' => 'INNER'
      ],
    ], $revision_field_data['table']['join']);

    $revision_base_data = $data['entity_test_mulrev_revision'];
    $this->assertCount(1, $revision_base_data['table']['join']);
340
    $this->assertEquals([
341 342 343 344
      'entity_test_mulrev_property_revision' => [
        'left_field' => 'revision_id', 'field' => 'revision_id', 'type' => 'INNER'
      ],
    ], $revision_base_data['table']['join']);
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
    $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));
372 373 374 375
    $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));
376 377 378 379
    $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));
380 381 382 383 384 385 386 387 388 389 390 391 392

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

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

    $this->setupFieldStorageDefinition();

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

    $this->assertNumericField($data['entity_test']['id']);
470
    $this->assertField($data['entity_test']['id'], 'id');
471
    $this->assertUuidField($data['entity_test']['uuid']);
472
    $this->assertField($data['entity_test']['uuid'], 'uuid');
473
    $this->assertStringField($data['entity_test']['type']);
474
    $this->assertEquals('type', $data['entity_test']['type']['entity field']);
475 476

    $this->assertLanguageField($data['entity_test']['langcode']);
477
    $this->assertField($data['entity_test']['langcode'], 'langcode');
478
    $this->assertEquals('Original language', $data['entity_test']['langcode']['title']);
479 480

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

483
    $this->assertLongTextField($data['entity_test'], 'description');
484 485
    $this->assertField($data['entity_test']['description__value'], 'description');
    $this->assertField($data['entity_test']['description__format'], 'description');
486

487
    $this->assertUriField($data['entity_test']['homepage']);
488
    $this->assertField($data['entity_test']['homepage'], 'homepage');
489

490
    $this->assertEntityReferenceField($data['entity_test']['user_id']);
491 492
    $this->assertField($data['entity_test']['user_id'], 'user_id');

493
    $relationship = $data['entity_test']['user_id']['relationship'];
494
    $this->assertEquals('users_field_data', $relationship['base']);
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
    $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')
511
      ->setSetting('target_type', 'entity_test_bundle')
512 513
      ->setTranslatable(TRUE);
    $base_field_definitions = $this->setupBaseFields($base_field_definitions);
514 515
    $user_base_field_definitions = [
      'uid' => BaseFieldDefinition::create('integer')
516 517
        ->setLabel('ID')
        ->setDescription('The ID of the user entity.')
518 519 520
        ->setReadOnly(TRUE)
        ->setSetting('unsigned', TRUE)
    ];
521 522
    $entity_test_type = new ConfigEntityType(['id' => 'entity_test_bundle']);

523
    $this->entityManager->expects($this->any())
524
      ->method('getBaseFieldDefinitions')
525 526 527 528
      ->will($this->returnValueMap([
        ['user', $user_base_field_definitions],
        ['entity_test_mul', $base_field_definitions],
      ]));
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

    $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']],
545
        ['description', ['value' => 'description__value', 'format' => 'description__format']],
546
        ['homepage', ['value' => 'homepage']],
547 548 549 550 551
        ['user_id', ['target_id' => 'user_id']],
      ]);
    $table_mapping->expects($this->any())
      ->method('getFieldNames')
      ->willReturnMap([
552 553
        ['entity_test_mul', ['uuid']],
        ['entity_test_mul_property_data', ['id', 'type', 'langcode', 'name', 'description', 'homepage', 'user_id']],
554 555
      ]);

556 557 558 559 560 561 562 563 564
    $table_mapping->expects($this->any())
      ->method('getFieldTableName')
      ->willReturnCallback(function($field) {
        if ($field == 'uuid') {
          return 'entity_test_mul';
        }
        return 'entity_test_mul_property_data';
      });

565 566 567 568 569 570
    $this->entityStorage->expects($this->once())
      ->method('getTableMapping')
      ->willReturn($table_mapping);

    $this->setupFieldStorageDefinition();

571 572 573 574 575 576 577 578
    $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],
      ]));

579 580 581
    $data = $this->viewsData->getViewsData();

    // Check the base fields.
582 583
    $this->assertFalse(isset($data['entity_test_mul']['id']));
    $this->assertFalse(isset($data['entity_test_mul']['type']));
584
    $this->assertUuidField($data['entity_test_mul']['uuid']);
585
    $this->assertField($data['entity_test_mul']['uuid'], 'uuid');
586 587 588 589 590

    $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']));
591 592 593
    $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']));
594
    $this->assertFalse(isset($data['entity_test_mul']['user_id']));
595
    $this->assertFalse(isset($data['entity_test_mul']['homepage']));
596 597 598

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

601 602 603
    $this->assertBundleField($data['entity_test_mul_property_data']['type']);
    $this->assertField($data['entity_test_mul_property_data']['type'], 'type');

604
    $this->assertLanguageField($data['entity_test_mul_property_data']['langcode']);
605
    $this->assertField($data['entity_test_mul_property_data']['langcode'], 'langcode');
606 607 608
    $this->assertEquals('Translation language', $data['entity_test_mul_property_data']['langcode']['title']);

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

611
    $this->assertLongTextField($data['entity_test_mul_property_data'], 'description');
612 613
    $this->assertField($data['entity_test_mul_property_data']['description__value'], 'description');
    $this->assertField($data['entity_test_mul_property_data']['description__format'], 'description');
614

615
    $this->assertUriField($data['entity_test_mul_property_data']['homepage']);
616
    $this->assertField($data['entity_test_mul_property_data']['homepage'], 'homepage');
617

618
    $this->assertEntityReferenceField($data['entity_test_mul_property_data']['user_id']);
619
    $this->assertField($data['entity_test_mul_property_data']['user_id'], 'user_id');
620
    $relationship = $data['entity_test_mul_property_data']['user_id']['relationship'];
621
    $this->assertEquals('users_field_data', $relationship['base']);
622 623 624 625 626 627 628 629 630 631 632 633
    $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')
634 635
      ->set('id', 'entity_test_mulrev')
      ->set('translatable', TRUE);
636
    $base_field_definitions = $this->setupBaseFields(EntityTestMulRev::baseFieldDefinitions($this->baseEntityType));
637 638
    $user_base_field_definitions = [
      'uid' => BaseFieldDefinition::create('integer')
639 640
        ->setLabel('ID')
        ->setDescription('The ID of the user entity.')
641 642 643 644
        ->setReadOnly(TRUE)
        ->setSetting('unsigned', TRUE)
    ];
    $this->entityManager->expects($this->any())
645
      ->method('getBaseFieldDefinitions')
646 647 648 649
      ->will($this->returnValueMap([
        ['user', $user_base_field_definitions],
        ['entity_test_mulrev', $base_field_definitions],
      ]));
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665

    $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']],
666
        ['description', ['value' => 'description__value', 'format' => 'description__format']],
667
        ['homepage', ['value' => 'homepage']],
668 669 670 671 672 673 674 675
        ['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']],
676 677
        ['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']],
678 679
      ]);

680 681 682 683 684 685 686 687 688
    $table_mapping->expects($this->any())
      ->method('getFieldTableName')
      ->willReturnCallback(function($field) {
        if ($field == 'uuid') {
          return 'entity_test_mulrev';
        }
        return 'entity_test_mulrev_property_data';
      });

689 690 691 692 693 694 695 696 697
    $this->entityStorage->expects($this->once())
      ->method('getTableMapping')
      ->willReturn($table_mapping);

    $this->setupFieldStorageDefinition();

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

    // Check the base fields.
698 699 700
    $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']));
701
    $this->assertUuidField($data['entity_test_mulrev']['uuid']);
702
    $this->assertField($data['entity_test_mulrev']['uuid'], 'uuid');
703 704 705

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

713 714 715
    // Check the revision fields. The revision ID should only appear in the data
    // table.
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['revision_id']));
716 717

    // Also ensure that field_data only fields don't appear on the revision table.
718
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['id']));
719
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['name']));
720 721 722
    $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']));
723
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['homepage']));
724 725 726 727
    $this->assertFalse(isset($data['entity_test_mulrev_revision']['user_id']));

    // Check the data fields.
    $this->assertNumericField($data['entity_test_mulrev_property_data']['id']);
728
    $this->assertField($data['entity_test_mulrev_property_data']['id'], 'id');
729 730
    $this->assertNumericField($data['entity_test_mulrev_property_data']['revision_id']);
    $this->assertField($data['entity_test_mulrev_property_data']['revision_id'], 'revision_id');
731
    $this->assertLanguageField($data['entity_test_mulrev_property_data']['langcode']);
732
    $this->assertField($data['entity_test_mulrev_property_data']['langcode'], 'langcode');
733
    $this->assertStringField($data['entity_test_mulrev_property_data']['name']);
734
    $this->assertField($data['entity_test_mulrev_property_data']['name'], 'name');
735

736
    $this->assertLongTextField($data['entity_test_mulrev_property_data'], 'description');
737 738
    $this->assertField($data['entity_test_mulrev_property_data']['description__value'], 'description');
    $this->assertField($data['entity_test_mulrev_property_data']['description__format'], 'description');
739
    $this->assertUriField($data['entity_test_mulrev_property_data']['homepage']);
740
    $this->assertField($data['entity_test_mulrev_property_data']['homepage'], 'homepage');
741

742
    $this->assertEntityReferenceField($data['entity_test_mulrev_property_data']['user_id']);
743
    $this->assertField($data['entity_test_mulrev_property_data']['user_id'], 'user_id');
744
    $relationship = $data['entity_test_mulrev_property_data']['user_id']['relationship'];
745
    $this->assertEquals('users_field_data', $relationship['base']);
746 747 748 749
    $this->assertEquals('uid', $relationship['base field']);

    // Check the property data fields.
    $this->assertNumericField($data['entity_test_mulrev_property_revision']['id']);
750
    $this->assertField($data['entity_test_mulrev_property_revision']['id'], 'id');
751 752

    $this->assertLanguageField($data['entity_test_mulrev_property_revision']['langcode']);
753
    $this->assertField($data['entity_test_mulrev_property_revision']['langcode'], 'langcode');
754
    $this->assertEquals('Translation language', $data['entity_test_mulrev_property_revision']['langcode']['title']);
755 756

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

759
    $this->assertLongTextField($data['entity_test_mulrev_property_revision'], 'description');
760 761
    $this->assertField($data['entity_test_mulrev_property_revision']['description__value'], 'description');
    $this->assertField($data['entity_test_mulrev_property_revision']['description__format'], 'description');
762

763
    $this->assertUriField($data['entity_test_mulrev_property_revision']['homepage']);
764
    $this->assertField($data['entity_test_mulrev_property_revision']['homepage'], 'homepage');
765

766
    $this->assertEntityReferenceField($data['entity_test_mulrev_property_revision']['user_id']);
767
    $this->assertField($data['entity_test_mulrev_property_revision']['user_id'], 'user_id');
768
    $relationship = $data['entity_test_mulrev_property_revision']['user_id']['relationship'];
769
    $this->assertEquals('users_field_data', $relationship['base']);
770 771 772
    $this->assertEquals('uid', $relationship['base field']);
  }

773 774 775 776 777 778 779 780 781 782 783 784
  /**
   * 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']);
  }

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
  /**
   * 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']);
  }

812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
  /**
   * @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']);
  }

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

845 846 847 848 849 850 851
  /**
   * Tests views data for a URI field.
   *
   * @param $data
   *   The views data to check.
   */
  protected function assertUriField($data) {
852 853
    $this->assertEquals('field', $data['field']['id']);
    $this->assertEquals('string', $data['field']['default_formatter']);
854 855 856 857 858
    $this->assertEquals('string', $data['filter']['id']);
    $this->assertEquals('string', $data['argument']['id']);
    $this->assertEquals('standard', $data['sort']['id']);
  }

859 860 861 862 863 864 865 866 867 868
  /**
   * 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'];
869
    $this->assertEquals('field', $value_field['field']['id']);
870 871 872 873 874 875 876 877
    $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']);
  }

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

}

class TestEntityViewsData extends EntityViewsData {

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

966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988
}

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;
  }

}

}

989
namespace Drupal\entity_test\Entity {
990 991
  if (!function_exists('t')) {
    function t($string, array $args = []) {
992
      return strtr($string, $args);
993 994 995
    }
  }
}