Version 1
[yaffs-website] / web / core / modules / field / tests / src / Kernel / EntityReference / Views / EntityReferenceRelationshipTest.php
diff --git a/web/core/modules/field/tests/src/Kernel/EntityReference/Views/EntityReferenceRelationshipTest.php b/web/core/modules/field/tests/src/Kernel/EntityReference/Views/EntityReferenceRelationshipTest.php
new file mode 100644 (file)
index 0000000..31d6503
--- /dev/null
@@ -0,0 +1,336 @@
+<?php
+
+namespace Drupal\Tests\field\Kernel\EntityReference\Views;
+
+use Drupal\entity_test\Entity\EntityTestMulChanged;
+use Drupal\field\Entity\FieldStorageConfig;
+use Drupal\field\Tests\EntityReference\EntityReferenceTestTrait;
+use Drupal\entity_test\Entity\EntityTest;
+use Drupal\entity_test\Entity\EntityTestMul;
+use Drupal\Tests\views\Kernel\ViewsKernelTestBase;
+use Drupal\views\Tests\ViewTestData;
+use Drupal\views\Views;
+
+/**
+ * Tests entity reference relationship data.
+ *
+ * @group entity_reference
+ *
+ * @see core_field_views_data()
+ */
+class EntityReferenceRelationshipTest extends ViewsKernelTestBase {
+
+  use EntityReferenceTestTrait;
+
+  /**
+   * Views used by this test.
+   *
+   * @var array
+   */
+  public static $testViews = [
+    'test_entity_reference_entity_test_view',
+    'test_entity_reference_entity_test_view_long',
+    'test_entity_reference_reverse_entity_test_view',
+    'test_entity_reference_entity_test_mul_view',
+    'test_entity_reference_reverse_entity_test_mul_view',
+    'test_entity_reference_group_by_empty_relationships',
+  ];
+
+  /**
+   * Modules to install.
+   *
+   * @var array
+   */
+  public static $modules = ['user', 'field', 'entity_test', 'views', 'entity_reference_test_views'];
+
+  /**
+   * The entity_test entities used by the test.
+   *
+   * @var array
+   */
+  protected $entities = [];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp($import_test_views = TRUE) {
+    parent::setUp();
+
+    $this->installEntitySchema('user');
+    $this->installEntitySchema('entity_test');
+    $this->installEntitySchema('entity_test_mul');
+    $this->installEntitySchema('entity_test_mul_changed');
+
+    // Create reference from entity_test to entity_test_mul.
+    $this->createEntityReferenceField('entity_test', 'entity_test', 'field_test_data', 'field_test_data', 'entity_test_mul');
+
+    // Create reference from entity_test_mul to entity_test.
+    $this->createEntityReferenceField('entity_test_mul', 'entity_test_mul', 'field_data_test', 'field_data_test', 'entity_test');
+
+    // Create another field for testing with a long name. So it's storage name
+    // will become hashed. Use entity_test_mul_changed, so the resulting field
+    // tables created will be greater than 48 chars long.
+    // @see \Drupal\Core\Entity\Sql\DefaultTableMapping::generateFieldTableName()
+    $this->createEntityReferenceField('entity_test_mul_changed', 'entity_test_mul_changed', 'field_test_data_with_a_long_name', 'field_test_data_with_a_long_name', 'entity_test');
+
+    // Create reference from entity_test_mul to entity_test cardinality: infinite.
+    $this->createEntityReferenceField('entity_test_mul', 'entity_test_mul', 'field_data_test_unlimited', 'field_data_test_unlimited', 'entity_test', 'default', [], FieldStorageConfig::CARDINALITY_UNLIMITED);
+
+    ViewTestData::createTestViews(get_class($this), ['entity_reference_test_views']);
+  }
+
+  /**
+   * Tests using the views relationship.
+   */
+  public function testNoDataTableRelationship() {
+
+    // Create some test entities which link each other.
+    $referenced_entity = EntityTestMul::create();
+    $referenced_entity->save();
+
+    $entity = EntityTest::create();
+    $entity->field_test_data->target_id = $referenced_entity->id();
+    $entity->save();
+    $this->assertEqual($entity->field_test_data[0]->entity->id(), $referenced_entity->id());
+    $this->entities[] = $entity;
+
+    $entity = EntityTest::create();
+    $entity->field_test_data->target_id = $referenced_entity->id();
+    $entity->save();
+    $this->assertEqual($entity->field_test_data[0]->entity->id(), $referenced_entity->id());
+    $this->entities[] = $entity;
+
+    Views::viewsData()->clear();
+
+    // Check the generated views data.
+    $views_data = Views::viewsData()->get('entity_test__field_test_data');
+    $this->assertEqual($views_data['field_test_data']['relationship']['id'], 'standard');
+    $this->assertEqual($views_data['field_test_data']['relationship']['base'], 'entity_test_mul_property_data');
+    $this->assertEqual($views_data['field_test_data']['relationship']['base field'], 'id');
+    $this->assertEqual($views_data['field_test_data']['relationship']['relationship field'], 'field_test_data_target_id');
+    $this->assertEqual($views_data['field_test_data']['relationship']['entity type'], 'entity_test_mul');
+
+    // Check the backwards reference.
+    $views_data = Views::viewsData()->get('entity_test_mul_property_data');
+    $this->assertEqual($views_data['reverse__entity_test__field_test_data']['relationship']['id'], 'entity_reverse');
+    $this->assertEqual($views_data['reverse__entity_test__field_test_data']['relationship']['base'], 'entity_test');
+    $this->assertEqual($views_data['reverse__entity_test__field_test_data']['relationship']['base field'], 'id');
+    $this->assertEqual($views_data['reverse__entity_test__field_test_data']['relationship']['field table'], 'entity_test__field_test_data');
+    $this->assertEqual($views_data['reverse__entity_test__field_test_data']['relationship']['field field'], 'field_test_data_target_id');
+    $this->assertEqual($views_data['reverse__entity_test__field_test_data']['relationship']['field_name'], 'field_test_data');
+    $this->assertEqual($views_data['reverse__entity_test__field_test_data']['relationship']['entity_type'], 'entity_test');
+    $this->assertEqual($views_data['reverse__entity_test__field_test_data']['relationship']['join_extra'][0], ['field' => 'deleted', 'value' => 0, 'numeric' => TRUE]);
+
+    // Check an actual test view.
+    $view = Views::getView('test_entity_reference_entity_test_view');
+    $this->executeView($view);
+    /** @var \Drupal\views\ResultRow $row */
+    foreach ($view->result as $index => $row) {
+      // Check that the actual ID of the entity is the expected one.
+      $this->assertEqual($row->id, $this->entities[$index]->id());
+
+      // Also check that we have the correct result entity.
+      $this->assertEqual($row->_entity->id(), $this->entities[$index]->id());
+
+      // Test the forward relationship.
+      $this->assertEqual($row->entity_test_mul_property_data_entity_test__field_test_data_i, 1);
+
+      // Test that the correct relationship entity is on the row.
+      $this->assertEqual($row->_relationship_entities['field_test_data']->id(), 1);
+      $this->assertEqual($row->_relationship_entities['field_test_data']->bundle(), 'entity_test_mul');
+    }
+
+    // Check the backwards reference view.
+    $view = Views::getView('test_entity_reference_reverse_entity_test_view');
+    $this->executeView($view);
+    /** @var \Drupal\views\ResultRow $row */
+    foreach ($view->result as $index => $row) {
+      $this->assertEqual($row->id, 1);
+      $this->assertEqual($row->_entity->id(), 1);
+
+      // Test the backwards relationship.
+      $this->assertEqual($row->field_test_data_entity_test_mul_property_data_id, $this->entities[$index]->id());
+
+      // Test that the correct relationship entity is on the row.
+      $this->assertEqual($row->_relationship_entities['reverse__entity_test__field_test_data']->id(), $this->entities[$index]->id());
+      $this->assertEqual($row->_relationship_entities['reverse__entity_test__field_test_data']->bundle(), 'entity_test');
+    }
+  }
+
+  /**
+   * Tests views data generated for relationship.
+   *
+   * @see entity_reference_field_views_data()
+   */
+  public function testDataTableRelationship() {
+
+    // Create some test entities which link each other.
+    $referenced_entity = EntityTest::create();
+    $referenced_entity->save();
+
+    $entity = EntityTestMul::create();
+    $entity->field_data_test->target_id = $referenced_entity->id();
+    $entity->save();
+    $this->assertEqual($entity->field_data_test[0]->entity->id(), $referenced_entity->id());
+    $this->entities[] = $entity;
+
+    $entity = EntityTestMul::create();
+    $entity->field_data_test->target_id = $referenced_entity->id();
+    $entity->save();
+    $this->assertEqual($entity->field_data_test[0]->entity->id(), $referenced_entity->id());
+    $this->entities[] = $entity;
+
+    Views::viewsData()->clear();
+
+    // Check the generated views data.
+    $views_data = Views::viewsData()->get('entity_test_mul__field_data_test');
+    $this->assertEqual($views_data['field_data_test']['relationship']['id'], 'standard');
+    $this->assertEqual($views_data['field_data_test']['relationship']['base'], 'entity_test');
+    $this->assertEqual($views_data['field_data_test']['relationship']['base field'], 'id');
+    $this->assertEqual($views_data['field_data_test']['relationship']['relationship field'], 'field_data_test_target_id');
+    $this->assertEqual($views_data['field_data_test']['relationship']['entity type'], 'entity_test');
+
+    // Check the backwards reference.
+    $views_data = Views::viewsData()->get('entity_test');
+    $this->assertEqual($views_data['reverse__entity_test_mul__field_data_test']['relationship']['id'], 'entity_reverse');
+    $this->assertEqual($views_data['reverse__entity_test_mul__field_data_test']['relationship']['base'], 'entity_test_mul_property_data');
+    $this->assertEqual($views_data['reverse__entity_test_mul__field_data_test']['relationship']['base field'], 'id');
+    $this->assertEqual($views_data['reverse__entity_test_mul__field_data_test']['relationship']['field table'], 'entity_test_mul__field_data_test');
+    $this->assertEqual($views_data['reverse__entity_test_mul__field_data_test']['relationship']['field field'], 'field_data_test_target_id');
+    $this->assertEqual($views_data['reverse__entity_test_mul__field_data_test']['relationship']['field_name'], 'field_data_test');
+    $this->assertEqual($views_data['reverse__entity_test_mul__field_data_test']['relationship']['entity_type'], 'entity_test_mul');
+    $this->assertEqual($views_data['reverse__entity_test_mul__field_data_test']['relationship']['join_extra'][0], ['field' => 'deleted', 'value' => 0, 'numeric' => TRUE]);
+
+    // Check an actual test view.
+    $view = Views::getView('test_entity_reference_entity_test_mul_view');
+    $this->executeView($view);
+    /** @var \Drupal\views\ResultRow $row */
+    foreach ($view->result as $index => $row) {
+      // Check that the actual ID of the entity is the expected one.
+      $this->assertEqual($row->id, $this->entities[$index]->id());
+
+      // Also check that we have the correct result entity.
+      $this->assertEqual($row->_entity->id(), $this->entities[$index]->id());
+
+      // Test the forward relationship.
+      $this->assertEqual($row->entity_test_entity_test_mul__field_data_test_id, 1);
+
+      // Test that the correct relationship entity is on the row.
+      $this->assertEqual($row->_relationship_entities['field_data_test']->id(), 1);
+      $this->assertEqual($row->_relationship_entities['field_data_test']->bundle(), 'entity_test');
+
+    }
+
+    // Check the backwards reference view.
+    $view = Views::getView('test_entity_reference_reverse_entity_test_mul_view');
+    $this->executeView($view);
+    /** @var \Drupal\views\ResultRow $row */
+    foreach ($view->result as $index => $row) {
+      $this->assertEqual($row->id, 1);
+      $this->assertEqual($row->_entity->id(), 1);
+
+      // Test the backwards relationship.
+      $this->assertEqual($row->field_data_test_entity_test_id, $this->entities[$index]->id());
+
+      // Test that the correct relationship entity is on the row.
+      $this->assertEqual($row->_relationship_entities['reverse__entity_test_mul__field_data_test']->id(), $this->entities[$index]->id());
+      $this->assertEqual($row->_relationship_entities['reverse__entity_test_mul__field_data_test']->bundle(), 'entity_test_mul');
+    }
+  }
+
+  /**
+   * Tests views data generated for relationship.
+   *
+   * @see entity_reference_field_views_data()
+   */
+  public function testDataTableRelationshipWithLongFieldName() {
+    // Create some test entities which link each other.
+    $referenced_entity = EntityTest::create();
+    $referenced_entity->save();
+
+    $entity = EntityTestMulChanged::create();
+    $entity->field_test_data_with_a_long_name->target_id = $referenced_entity->id();
+    $entity->save();
+    $this->entities[] = $entity;
+
+    $entity = EntityTestMulChanged::create();
+    $entity->field_test_data_with_a_long_name->target_id = $referenced_entity->id();
+    $entity->save();
+    $this->entities[] = $entity;
+
+    Views::viewsData()->clear();
+
+    // Check an actual test view.
+    $view = Views::getView('test_entity_reference_entity_test_view_long');
+    $this->executeView($view);
+    /** @var \Drupal\views\ResultRow $row */
+    foreach ($view->result as $index => $row) {
+      // Check that the actual ID of the entity is the expected one.
+      $this->assertEqual($row->id, $this->entities[$index]->id());
+
+      // Also check that we have the correct result entity.
+      $this->assertEqual($row->_entity->id(), $this->entities[$index]->id());
+
+      // Test the forward relationship.
+      //$this->assertEqual($row->entity_test_entity_test_mul__field_data_test_id, 1);
+
+      // Test that the correct relationship entity is on the row.
+      $this->assertEqual($row->_relationship_entities['field_test_data_with_a_long_name']->id(), 1);
+      $this->assertEqual($row->_relationship_entities['field_test_data_with_a_long_name']->bundle(), 'entity_test');
+
+    }
+  }
+
+  /**
+   * Tests group by with optional and empty relationship.
+   */
+  public function testGroupByWithEmptyRelationships() {
+    $entities = [];
+    // Create 4 entities with name1 and 3 entities with name2.
+    for ($i = 1; $i <= 4; $i++) {
+      $entity = [
+        'name' => 'name' . $i,
+      ];
+      $entity = EntityTest::create($entity);
+      $entities[] = $entity;
+      $entity->save();
+    }
+
+    $entity = EntityTestMul::create([
+      'name' => 'name1',
+    ]);
+    $entity->field_data_test_unlimited = [
+      ['target_id' => $entities[0]->id()],
+      ['target_id' => $entities[1]->id()],
+      ['target_id' => $entities[2]->id()],
+    ];
+    $entity->save();
+
+    $entity = EntityTestMul::create([
+      'name' => 'name2',
+    ]);
+    $entity->field_data_test_unlimited = [
+      ['target_id' => $entities[0]->id()],
+      ['target_id' => $entities[1]->id()],
+    ];
+    $entity->save();
+
+    $entity = EntityTestMul::create([
+      'name' => 'name3',
+    ]);
+    $entity->field_data_test_unlimited->target_id = $entities[0]->id();
+    $entity->save();
+
+    $view = Views::getView('test_entity_reference_group_by_empty_relationships');
+    $this->executeView($view);
+    $this->assertCount(4, $view->result);
+    // First three results should contain a reference from EntityTestMul.
+    $this->assertNotEmpty($view->getStyle()->getField(0, 'name_2'));
+    $this->assertNotEmpty($view->getStyle()->getField(1, 'name_2'));
+    $this->assertNotEmpty($view->getStyle()->getField(2, 'name_2'));
+    // Fourth result has no reference from EntityTestMul hence the output for
+    // should be empty.
+    $this->assertEqual('', $view->getStyle()->getField(3, 'name_2'));
+  }
+
+}