You are here

Home » API reference » Entity Reference Revisions 8 » EntityReferenceRevisionsCompositeTest.php

class EntityReferenceRevisionsCompositeTest in Entity Reference Revisions 8

Tests the entity_reference_revisions composite relationship.

@group entity_reference_revisions

Hierarchy

Expanded class hierarchy of EntityReferenceRevisionsCompositeTest

File

tests/src/Kernel/EntityReferenceRevisionsCompositeTest.php, line 20

Namespace

Drupal\Tests\entity_reference_revisions\Kernel
View source 
class EntityReferenceRevisionsCompositeTest extends EntityKernelTestBase {
  use ContentTypeCreationTrait;
  use NodeCreationTrait;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'node',
    'field',
    'entity_reference_revisions',
    'entity_composite_relationship_test',
    'language',
  );

  /**
   * The current database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   *
   */
  protected $entityTypeManager;

  /**
   * The cron service.
   *
   * @var \Drupal\Core\Cron
   */
  protected $cron;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('entity_test_composite');
    $this
      ->installSchema('node', [
      'node_access',
    ]);

    // Create article content type.
    NodeType::create([
      'type' => 'article',
      'name' => 'Article',
    ])
      ->save();

    // Create the reference to the composite entity test.
    $field_storage = FieldStorageConfig::create(array(
      'field_name' => 'composite_reference',
      'entity_type' => 'node',
      'type' => 'entity_reference_revisions',
      'settings' => array(
        'target_type' => 'entity_test_composite',
      ),
    ));
    $field_storage
      ->save();
    $field = FieldConfig::create(array(
      'field_storage' => $field_storage,
      'bundle' => 'article',
      'translatable' => FALSE,
    ));
    $field
      ->save();

    // Inject database connection, entity type manager and cron for the tests.
    $this->database = \Drupal::database();
    $this->entityTypeManager = \Drupal::entityTypeManager();
    $this->cron = \Drupal::service('cron');
  }

  /**
   * Test for maintaining composite relationship.
   *
   * Tests that the referenced entity saves the parent type and id when saving.
   */
  public function testEntityReferenceRevisionsCompositeRelationship() {

    // Create the test composite entity.
    $composite = EntityTestCompositeRelationship::create(array(
      'uuid' => $this
        ->randomMachineName(),
      'name' => $this
        ->randomMachineName(),
    ));
    $composite
      ->save();

    // Assert that there is only 1 revision of the composite entity.
    $composite_revisions_count = \Drupal::entityQuery('entity_test_composite')
      ->condition('uuid', $composite
      ->uuid())
      ->allRevisions()
      ->count()
      ->execute();
    $this
      ->assertEquals(1, $composite_revisions_count);

    // Create a node with a reference to the test composite entity.

    /** @var \Drupal\node\NodeInterface $node */
    $node = Node::create(array(
      'title' => $this
        ->randomMachineName(),
      'type' => 'article',
    ));
    $node
      ->save();
    $node
      ->set('composite_reference', $composite);
    $this
      ->assertTrue($node
      ->hasTranslationChanges());
    $node
      ->save();

    // Assert that there is only 1 revision when creating a node.
    $node_revisions_count = \Drupal::entityQuery('node')
      ->condition('nid', $node
      ->id())
      ->allRevisions()
      ->count()
      ->execute();
    $this
      ->assertEquals(1, $node_revisions_count);

    // Assert there is no new composite revision after creating a host entity.
    $composite_revisions_count = \Drupal::entityQuery('entity_test_composite')
      ->condition('uuid', $composite
      ->uuid())
      ->allRevisions()
      ->count()
      ->execute();
    $this
      ->assertEquals(1, $composite_revisions_count);

    // Verify the value of parent type and id after create a node.
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertEquals($node
      ->getEntityTypeId(), $composite->parent_type->value);
    $this
      ->assertEquals($node
      ->id(), $composite->parent_id->value);
    $this
      ->assertEquals('composite_reference', $composite->parent_field_name->value);

    // Create second revision of the node.
    $original_composite_revision = $node->composite_reference[0]->target_revision_id;
    $original_node_revision = $node
      ->getRevisionId();
    $node
      ->setTitle('2nd revision');
    $node
      ->setNewRevision();
    $node
      ->save();
    $node = Node::load($node
      ->id());

    // Check the revision of the node.
    $this
      ->assertEquals('2nd revision', $node
      ->getTitle(), 'New node revision has changed data.');
    $this
      ->assertNotEquals($original_composite_revision, $node->composite_reference[0]->target_revision_id, 'Composite entity got new revision when its host did.');

    // Make sure that there are only 2 revisions.
    $node_revisions_count = \Drupal::entityQuery('node')
      ->condition('nid', $node
      ->id())
      ->allRevisions()
      ->count()
      ->execute();
    $this
      ->assertEquals(2, $node_revisions_count);

    // Revert to first revision of the node.
    $node = $this->entityTypeManager
      ->getStorage('node')
      ->loadRevision($original_node_revision);
    $node
      ->setNewRevision();
    $node
      ->isDefaultRevision(TRUE);
    $node
      ->save();
    $node = Node::load($node
      ->id());

    // Check the revision of the node.
    $this
      ->assertNotEquals('2nd revision', $node
      ->getTitle(), 'Node did not keep changed title after reversion.');
    $this
      ->assertNotEquals($original_composite_revision, $node->composite_reference[0]->target_revision_id, 'Composite entity got new revision when its host reverted to an old revision.');
    $node_storage = $this->entityTypeManager
      ->getStorage('node');

    // Test that removing composite references results in translation changes.
    $node
      ->set('composite_reference', []);
    $this
      ->assertTrue($node
      ->hasTranslationChanges());

    // Test that changing composite reference results in translation changes.
    $changed_composite_reference = $composite;
    $changed_composite_reference
      ->set('name', 'Changing composite reference');
    $this
      ->assertTrue((bool) $changed_composite_reference
      ->isRevisionTranslationAffected());
    $node
      ->set('composite_reference', $changed_composite_reference);
    $node
      ->setNewRevision();
    $this
      ->assertTrue($node
      ->hasTranslationChanges());
    $node
      ->save();
    $nid = $node
      ->id();
    $node_storage
      ->resetCache([
      $nid,
    ]);

    /** @var \Drupal\node\NodeInterface $node */
    $node = $node_storage
      ->load($nid);

    // Check the composite has changed.
    $this
      ->assertEquals('Changing composite reference', $node
      ->get('composite_reference')->entity
      ->getName());

    // Make sure the node has 4 revisions.
    $node_revisions_count = $node_storage
      ->getQuery()
      ->condition('nid', $nid)
      ->allRevisions()
      ->count()
      ->execute();
    $this
      ->assertEqual($node_revisions_count, 4);

    // Make sure the node has no revision with revision translation affected
    // flag set to NULL.
    $node_revisions_count = $node_storage
      ->getQuery()
      ->condition('nid', $nid)
      ->allRevisions()
      ->condition('revision_translation_affected', NULL, 'IS NULL')
      ->count()
      ->execute();
    $this
      ->assertEqual($node_revisions_count, 0, 'Node has a revision with revision translation affected set to NULL');

    // Revert the changes to avoid interfering with the delete test.
    $node
      ->set('composite_reference', $composite);

    // Test that the composite entity is deleted when its parent is deleted.
    $node
      ->delete();
    $this
      ->assertNotNull(EntityTestCompositeRelationship::load($composite
      ->id()));
    $this->cron
      ->run();
    $this
      ->assertNull(EntityTestCompositeRelationship::load($composite
      ->id()));

    // Test that the deleting composite entity does not break the parent entity
    // when creating a new revision.
    $composite = EntityTestCompositeRelationship::create([
      'name' => $this
        ->randomMachineName(),
    ]);
    $composite
      ->save();

    // Create a node with a reference to the test composite entity.

    /** @var \Drupal\node\NodeInterface $node */
    $node = Node::create([
      'title' => $this
        ->randomMachineName(),
      'type' => 'article',
      'composite_reference' => $composite,
    ]);
    $node
      ->save();

    // Delete the composite entity.
    $composite
      ->delete();

    // Re-apply the field item values to unset the computed "entity" property.
    $field_item = $node
      ->get('composite_reference')
      ->get(0);
    $field_item
      ->setValue($field_item
      ->getValue(), FALSE);
    $new_revision = $this->entityTypeManager
      ->getStorage('node')
      ->createRevision($node);
    $this
      ->assertTrue($new_revision
      ->get('composite_reference')
      ->isEmpty());
  }

  /**
   * Tests composite relationship with translations and an untranslatable field.
   */
  function testCompositeRelationshipWithTranslationNonTranslatableField() {
    ConfigurableLanguage::createFromLangcode('de')
      ->save();

    // Create the test composite entity with a translation.
    $composite = EntityTestCompositeRelationship::create(array(
      'uuid' => $this
        ->randomMachineName(),
      'name' => $this
        ->randomMachineName(),
    ));
    $composite
      ->addTranslation('de', $composite
      ->toArray());
    $composite
      ->save();

    // Create a node with a reference to the test composite entity.
    $node = Node::create(array(
      'title' => $this
        ->randomMachineName(),
      'type' => 'article',
      'composite_reference' => $composite,
    ));
    $node
      ->addTranslation('de', $node
      ->toArray());
    $node
      ->save();

    // Verify the value of parent type and id after create a node.
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertEquals($node
      ->getEntityTypeId(), $composite->parent_type->value);
    $this
      ->assertEquals($node
      ->id(), $composite->parent_id->value);
    $this
      ->assertEquals('composite_reference', $composite->parent_field_name->value);
    $this
      ->assertTrue($composite
      ->hasTranslation('de'));

    // Test that the composite entity is not deleted when the german translation
    // of the parent is deleted.
    $node
      ->removeTranslation('de');
    $node
      ->save();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNotNull($composite);
    $this
      ->assertFalse($composite
      ->hasTranslation('de'));

    // Change the language of the entity, ensure that doesn't try to delete
    // the default translation.
    $node
      ->set('langcode', 'de');
    $node
      ->save();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNotNull($composite);

    // Test that the composite entity is deleted when its parent is deleted.
    $node
      ->delete();
    $this->cron
      ->run();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNull($composite);
  }

  /**
   * Tests composite relationship with translations and a translatable field.
   */
  function testCompositeRelationshipWithTranslationTranslatableField() {
    $field_config = FieldConfig::loadByName('node', 'article', 'composite_reference');
    $field_config
      ->setTranslatable(TRUE);
    $field_config
      ->save();
    ConfigurableLanguage::createFromLangcode('de')
      ->save();

    // Create the test composite entity with a translation.
    $composite = EntityTestCompositeRelationship::create(array(
      'uuid' => $this
        ->randomMachineName(),
      'name' => $this
        ->randomMachineName(),
    ));
    $composite
      ->addTranslation('de', $composite
      ->toArray());
    $composite
      ->save();

    // Create a node with a reference to the test composite entity.
    $node = Node::create(array(
      'title' => $this
        ->randomMachineName(),
      'type' => 'article',
      'composite_reference' => $composite,
    ));
    $node
      ->addTranslation('de', $node
      ->toArray());
    $node
      ->save();

    // Verify the value of parent type and id after create a node.
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertEquals($node
      ->getEntityTypeId(), $composite->parent_type->value);
    $this
      ->assertEquals($node
      ->id(), $composite->parent_id->value);
    $this
      ->assertEquals('composite_reference', $composite->parent_field_name->value);

    // Test that the composite entity is not deleted when the German parent
    // translation is removed.
    $node
      ->removeTranslation('de');
    $node
      ->save();
    $this->cron
      ->run();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNotNull($composite);

    // Test that the composite entity is deleted when its parent is deleted.
    $node
      ->delete();
    $this->cron
      ->run();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNull($composite);
  }

  /**
   * Tests composite relationship with revisions.
   */
  function testCompositeRelationshipWithRevisions() {

    // Create the test composite entity with a translation.
    $composite = EntityTestCompositeRelationship::create(array(
      'uuid' => $this
        ->randomMachineName(),
      'name' => $this
        ->randomMachineName(),
    ));
    $composite
      ->save();

    // Create a node with a reference to the test composite entity.
    $node = Node::create(array(
      'title' => $this
        ->randomMachineName(),
      'type' => 'article',
      'composite_reference' => $composite,
    ));
    $node
      ->save();

    // Verify the value of parent type and id after create a node.
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $composite_original_revision_id = $composite
      ->getRevisionId();
    $node_original_revision_id = $node
      ->getRevisionId();
    $this
      ->assertEquals($node
      ->getEntityTypeId(), $composite->parent_type->value);
    $this
      ->assertEquals($node
      ->id(), $composite->parent_id->value);
    $this
      ->assertEquals('composite_reference', $composite->parent_field_name->value);
    $node
      ->setNewRevision(TRUE);
    $node
      ->save();

    // Ensure that we saved a new revision ID.
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNotEquals($composite_original_revision_id, $composite
      ->getRevisionId());

    // Test that deleting the first revision does not delete the composite.
    $this->entityTypeManager
      ->getStorage('node')
      ->deleteRevision($node_original_revision_id);
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNotNull($composite);

    // Ensure that the composite revision was deleted as well.
    $composite_revision = $this->entityTypeManager
      ->getStorage('entity_test_composite')
      ->loadRevision($composite_original_revision_id);
    $this
      ->assertNull($composite_revision);

    // Test that the composite entity is deleted when its parent is deleted.
    $node
      ->delete();
    $this->cron
      ->run();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNull($composite);
  }

  /**
   * Tests that the composite revision is not deleted if it is the default one.
   */
  function testCompositeRelationshipDefaultRevision() {

    // Create a node with a reference to a test composite entity.
    $composite = EntityTestCompositeRelationship::create([
      'uuid' => $this
        ->randomMachineName(),
      'name' => $this
        ->randomMachineName(),
    ]);
    $composite
      ->save();
    $node = Node::create([
      'title' => $this
        ->randomMachineName(),
      'type' => 'article',
      'composite_reference' => $composite,
    ]);
    $node
      ->save();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $composite_original_revision_id = $composite
      ->getRevisionId();
    $node_original_revision_id = $node
      ->getRevisionId();

    // Set a new revision, composite entity should have a new revision as well.
    $node
      ->setNewRevision(TRUE);
    $node
      ->save();

    // Ensure that we saved a new revision ID.
    $composite2 = EntityTestCompositeRelationship::load($composite
      ->id());
    $composite2_rev_id = $composite2
      ->getRevisionId();
    $this
      ->assertNotEquals($composite2_rev_id, $composite_original_revision_id);

    // Revert default composite entity revision to the original revision.
    $composite_original = $this->entityTypeManager
      ->getStorage('entity_test_composite')
      ->loadRevision($composite_original_revision_id);
    $composite_original
      ->isDefaultRevision(TRUE);
    $composite_original
      ->save();

    // Check the default composite revision is the original composite revision.
    $this
      ->assertEquals($composite_original_revision_id, $composite_original
      ->getrevisionId());

    // Test deleting the first node revision, referencing to the default
    // composite revision, does not delete the default composite revision.
    $this->entityTypeManager
      ->getStorage('node')
      ->deleteRevision($node_original_revision_id);
    $composite_default = EntityTestCompositeRelationship::load($composite_original
      ->id());
    $this
      ->assertNotNull($composite_default);
    $composite_default_revision = $this->entityTypeManager
      ->getStorage('entity_test_composite')
      ->loadRevision($composite_original
      ->getrevisionId());
    $this
      ->assertNotNull($composite_default_revision);

    // Ensure the second revision still exists.
    $composite2_revision = $this->entityTypeManager
      ->getStorage('entity_test_composite')
      ->loadRevision($composite2_rev_id);
    $this
      ->assertNotNull($composite2_revision);
  }

  /**
   * Tests that the composite revision is not deleted if it is still in use.
   */
  function testCompositeRelationshipDuplicatedRevisions() {

    // Create a node with a reference to a test composite entity.
    $composite = EntityTestCompositeRelationship::create([
      'uuid' => $this
        ->randomMachineName(),
      'name' => $this
        ->randomMachineName(),
    ]);
    $composite
      ->save();
    $node = Node::create([
      'title' => $this
        ->randomMachineName(),
      'type' => 'article',
      'composite_reference' => $composite,
    ]);
    $node
      ->save();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $composite_original_revision_id = $composite
      ->getRevisionId();
    $node_original_revision_id = $node
      ->getRevisionId();

    // Set a new revision, composite entity should have a new revision as well.
    $node
      ->setNewRevision(TRUE);
    $node
      ->save();

    // Ensure that we saved a new revision ID.
    $composite2 = EntityTestCompositeRelationship::load($composite
      ->id());
    $composite2_rev_id = $composite2
      ->getRevisionId();
    $this
      ->assertNotEquals($composite2_rev_id, $composite_original_revision_id);

    // Set the new node revision to reference to the original composite
    // revision as well to test this composite revision will not be deleted.
    $this->database
      ->update('node__composite_reference')
      ->fields([
      'composite_reference_target_revision_id' => $composite_original_revision_id,
    ])
      ->condition('revision_id', $node
      ->getRevisionId())
      ->execute();
    $this->database
      ->update('node_revision__composite_reference')
      ->fields([
      'composite_reference_target_revision_id' => $composite_original_revision_id,
    ])
      ->condition('revision_id', $node
      ->getRevisionId())
      ->execute();

    // Test deleting the first revision does not delete the composite.
    $this->entityTypeManager
      ->getStorage('node')
      ->deleteRevision($node_original_revision_id);
    $composite2 = EntityTestCompositeRelationship::load($composite2
      ->id());
    $this
      ->assertNotNull($composite2);

    // Ensure the original composite revision is not deleted because it is
    // still referenced by the second node revision.
    $composite_original_revision = $this->entityTypeManager
      ->getStorage('entity_test_composite')
      ->loadRevision($composite_original_revision_id);
    $this
      ->assertNotNull($composite_original_revision);

    // Ensure the second revision still exists.
    $composite2_revision = $this->entityTypeManager
      ->getStorage('entity_test_composite')
      ->loadRevision($composite2_rev_id);
    $this
      ->assertNotNull($composite2_revision);

    // Test that the composite entity is deleted when its parent is deleted.
    $node
      ->delete();
    $this->cron
      ->run();
    $composite = EntityTestCompositeRelationship::load($composite2
      ->id());
    $this
      ->assertNull($composite);
  }

  /**
   * Tests the composite entity is deleted after removing its reference.
   */
  public function testCompositeDeleteAfterRemovingReference() {
    list($composite, $node) = $this
      ->assignCompositeToNode();

    // Remove reference to the composite entity from the node.
    $node
      ->set('composite_reference', NULL);
    $node
      ->save();

    // Verify that the composite entity is not yet removed after deleting the
    // parent.
    $node
      ->delete();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNotNull($composite);

    // Verify that the composite entity is removed after running cron.
    $this->cron
      ->run();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNull($composite);
  }

  /**
   * Tests the composite entity is deleted after removing its reference.
   *
   * Includes revisions on the host entity.
   */
  public function testCompositeDeleteAfterRemovingReferenceWithRevisions() {
    list($composite, $node) = $this
      ->assignCompositeToNode();

    // Remove reference to the composite entity from the node in a new revision.
    $node
      ->set('composite_reference', NULL);
    $node
      ->setNewRevision();
    $node
      ->save();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());

    // Verify the composite entity is not removed on nodes with revisions.
    $this
      ->assertNotNull($composite);

    // Verify that the composite entity is not yet removed after deleting the
    // parent.
    $node
      ->delete();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNotNull($composite);

    // Verify that the composite entity is removed after running cron.
    $this->cron
      ->run();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNull($composite);
  }

  /**
   * Tests the composite entity is not deleted when changing parents.
   *
   * Includes revisions on the host entity.
   */
  public function testCompositeDeleteAfterChangingParent() {
    list($composite, $node) = $this
      ->assignCompositeToNode();

    // Remove reference to the composite entity from the node.
    $node
      ->set('composite_reference', NULL);
    $node
      ->setNewRevision();
    $node
      ->save();

    // Setting a new revision of the composite entity in the second node.
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $composite
      ->setNewRevision(TRUE);
    $composite
      ->save();
    $second_node = Node::create([
      'title' => 'Second node',
      'type' => 'article',
      'composite_reference' => $composite,
    ]);
    $second_node
      ->save();

    // Remove reference to the composite entity from the node.
    $second_node
      ->set('composite_reference', NULL);
    $second_node
      ->setNewRevision(TRUE);
    $second_node
      ->save();

    // Verify the composite entity is not removed on nodes with revisions.
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNotNull($composite);

    // Verify the amount of revisions of each entity.
    $this
      ->assertRevisionCount(2, 'entity_test_composite', $composite
      ->id());
    $this
      ->assertRevisionCount(2, 'node', $node
      ->id());
    $this
      ->assertRevisionCount(2, 'node', $second_node
      ->id());

    // Test that the composite entity is not deleted when its new parent is
    // deleted, since it is still being used in a previous revision with a
    // different parent.
    $second_node
      ->delete();
    $this->cron
      ->run();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNotNull($composite);

    // Delete the parent of the previous revision.
    $node
      ->delete();

    // Verify that the composite entity is removed after running cron.
    $this->cron
      ->run();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNull($composite);
  }

  /**
   * Composite entity with revisions isn't deleted when changing parents.
   *
   * Includes revisions on the host entity.
   */
  public function testCompositeDeleteRevisionAfterChangingParent() {
    list($composite, $node) = $this
      ->assignCompositeToNode();

    // Remove reference to the composite entity from the node.
    $node
      ->set('composite_reference', NULL);
    $node
      ->setNewRevision();
    $node
      ->save();

    // Setting a new revision of the composite entity in the second node.
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $composite
      ->setNewRevision(TRUE);
    $composite
      ->save();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $second_node = Node::create([
      'title' => 'Second node',
      'type' => 'article',
      'composite_reference' => $composite,
    ]);
    $second_node
      ->save();

    // Remove reference to the composite entity from the node.
    $second_node
      ->set('composite_reference', NULL);
    $second_node
      ->setNewRevision(TRUE);
    $second_node
      ->save();

    // Verify the composite entity is not removed on nodes with revisions.
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNotNull($composite);

    // Verify the amount of revisions of each entity.
    $this
      ->assertRevisionCount(2, 'entity_test_composite', $composite
      ->id());
    $this
      ->assertRevisionCount(2, 'node', $node
      ->id());
    $this
      ->assertRevisionCount(2, 'node', $second_node
      ->id());

    // Test that the composite entity is not deleted when its old parent is
    // deleted.
    $node
      ->delete();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNotNull($composite);

    // Verify that the composite entity is not removed after running cron but
    // the previous unused revision is deleted.
    $this->cron
      ->run();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNotNull($composite);
    $this
      ->assertRevisionCount(1, 'entity_test_composite', $composite
      ->id());
  }

  /**
   * Tests the composite entity is not deleted when duplicating host entity.
   *
   * Includes revisions on the host entity.
   */
  public function testCompositeDeleteAfterDuplicatingParent() {
    list($composite, $node) = $this
      ->assignCompositeToNode();
    $node
      ->setNewRevision(TRUE);
    $node
      ->save();

    // Create a duplicate of the node.
    $duplicate_node = $node
      ->createDuplicate();
    $duplicate_node
      ->save();
    $duplicate_node
      ->setNewRevision(TRUE);
    $duplicate_node
      ->save();

    // Verify the amount of revisions of each entity.
    $this
      ->assertRevisionCount(3, 'entity_test_composite', $composite
      ->id());
    $this
      ->assertRevisionCount(2, 'node', $node
      ->id());
    $this
      ->assertRevisionCount(2, 'node', $duplicate_node
      ->id());

    // Test that the composite entity is not deleted when the duplicate is
    // deleted.
    $duplicate_node
      ->delete();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNotNull($composite);
    $this->cron
      ->run();
    $composite = EntityTestCompositeRelationship::load($composite
      ->id());
    $this
      ->assertNotNull($composite);
  }

  /**
   * Asserts the revision count of a certain entity.
   *
   * @param int $expected
   *   The expected count.
   * @param string $entity_type_id
   *   The entity type ID, e.g. node.
   * @param int $entity_id
   *   The entity ID.
   */
  protected function assertRevisionCount($expected, $entity_type_id, $entity_id) {
    $id_field = \Drupal::entityTypeManager()
      ->getDefinition($entity_type_id)
      ->getKey('id');
    $revision_count = \Drupal::entityQuery($entity_type_id)
      ->condition($id_field, $entity_id)
      ->allRevisions()
      ->count()
      ->execute();
    $this
      ->assertEquals($expected, $revision_count);
  }

  /**
   * Creates and assigns the composite entity to a node.
   *
   * @param string $node_type
   *   The node type.
   *
   * @return array
   *   An array containing a composite and a node entity.
   */
  protected function assignCompositeToNode($node_type = 'article') {
    $composite = EntityTestCompositeRelationship::create([
      'uuid' => $this
        ->randomMachineName(),
      'name' => $this
        ->randomMachineName(),
    ]);
    $composite
      ->save();
    $node = Node::create([
      'title' => $this
        ->randomMachineName(),
      'type' => $node_type,
      'composite_reference' => $composite,
    ]);
    $node
      ->save();
    return [
      $composite,
      $node,
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. 1
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
EntityKernelTestBase::$deprecatedProperties protected property The list of deprecated services.
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
EntityReferenceRevisionsCompositeTest::$cron protected property The cron service.
EntityReferenceRevisionsCompositeTest::$database protected property The current database connection.
EntityReferenceRevisionsCompositeTest::$entityTypeManager protected property The entity type manager. Overrides EntityKernelTestBase::$entityTypeManager
EntityReferenceRevisionsCompositeTest::$modules public static property Modules to enable. Overrides EntityKernelTestBase::$modules
EntityReferenceRevisionsCompositeTest::assertRevisionCount protected function Asserts the revision count of a certain entity.
EntityReferenceRevisionsCompositeTest::assignCompositeToNode protected function Creates and assigns the composite entity to a node.
EntityReferenceRevisionsCompositeTest::setUp protected function Overrides EntityKernelTestBase::setUp
EntityReferenceRevisionsCompositeTest::testCompositeDeleteAfterChangingParent public function Tests the composite entity is not deleted when changing parents.
EntityReferenceRevisionsCompositeTest::testCompositeDeleteAfterDuplicatingParent public function Tests the composite entity is not deleted when duplicating host entity.
EntityReferenceRevisionsCompositeTest::testCompositeDeleteAfterRemovingReference public function Tests the composite entity is deleted after removing its reference.
EntityReferenceRevisionsCompositeTest::testCompositeDeleteAfterRemovingReferenceWithRevisions public function Tests the composite entity is deleted after removing its reference.
EntityReferenceRevisionsCompositeTest::testCompositeDeleteRevisionAfterChangingParent public function Composite entity with revisions isn't deleted when changing parents.
EntityReferenceRevisionsCompositeTest::testCompositeRelationshipDefaultRevision function Tests that the composite revision is not deleted if it is the default one.
EntityReferenceRevisionsCompositeTest::testCompositeRelationshipDuplicatedRevisions function Tests that the composite revision is not deleted if it is still in use.
EntityReferenceRevisionsCompositeTest::testCompositeRelationshipWithRevisions function Tests composite relationship with revisions.
EntityReferenceRevisionsCompositeTest::testCompositeRelationshipWithTranslationNonTranslatableField function Tests composite relationship with translations and an untranslatable field.
EntityReferenceRevisionsCompositeTest::testCompositeRelationshipWithTranslationTranslatableField function Tests composite relationship with translations and a translatable field.
EntityReferenceRevisionsCompositeTest::testEntityReferenceRevisionsCompositeRelationship public function Test for maintaining composite relationship.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
NodeCreationTrait::createNode protected function Creates a node based on default settings.
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser