class EntityRevisionTranslationTest in Drupal 10

Tests proper revision propagation of entities.

@group Entity

Hierarchy

• class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, ConfigTestTrait, ExtensionListTestTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
  • class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase uses UserCreationTrait
    • class \Drupal\KernelTests\Core\Entity\EntityRevisionTranslationTest

File

core/tests/Drupal/KernelTests/Core/Entity/EntityRevisionTranslationTest.php, line 14

Namespace

Drupal\KernelTests\Core\Entity

class EntityRevisionTranslationTest extends EntityKernelTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'language',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Enable some additional languages.
    ConfigurableLanguage::createFromLangcode('de')
      ->save();
    ConfigurableLanguage::createFromLangcode('it')
      ->save();
    $this
      ->installEntitySchema('entity_test_mul');
    $this
      ->installEntitySchema('entity_test_mulrev');
  }

  /**
   * Tests if the translation object has the right revision id after new revision.
   */
  public function testNewRevisionAfterTranslation() {
    $user = $this
      ->createUser();

    // Create a test entity.
    $entity = EntityTestMulRev::create([
      'name' => $this
        ->randomString(),
      'user_id' => $user
        ->id(),
      'language' => 'en',
    ]);
    $entity
      ->save();
    $old_rev_id = $entity
      ->getRevisionId();
    $translation = $entity
      ->addTranslation('de');
    $translation
      ->setNewRevision();
    $translation
      ->save();

    // Verify that the saved translation for the new translation has a newer
    // revision ID.
    $this
      ->assertGreaterThan($old_rev_id, $translation
      ->getRevisionId());

    // Verify that the entity from the storage has a newer revision ID.
    $this
      ->assertGreaterThan($old_rev_id, $this
      ->reloadEntity($entity)
      ->getRevisionId());
  }

  /**
   * Tests if the translation object has the right revision id after new revision.
   */
  public function testRevertRevisionAfterTranslation() {
    $user = $this
      ->createUser();
    $storage = $this->entityTypeManager
      ->getStorage('entity_test_mulrev');

    // Create a test entity.
    $entity = EntityTestMulRev::create([
      'name' => $this
        ->randomString(),
      'user_id' => $user
        ->id(),
      'language' => 'en',
    ]);
    $entity
      ->save();
    $old_rev_id = $entity
      ->getRevisionId();
    $translation = $entity
      ->addTranslation('de');
    $translation
      ->setNewRevision();
    $translation
      ->save();
    $entity = $this
      ->reloadEntity($entity);
    $this
      ->assertTrue($entity
      ->hasTranslation('de'));
    $entity = $storage
      ->loadRevision($old_rev_id);
    $entity
      ->setNewRevision();
    $entity
      ->isDefaultRevision(TRUE);
    $entity
      ->save();
    $entity = $this
      ->reloadEntity($entity);
    $this
      ->assertFalse($entity
      ->hasTranslation('de'));
  }

  /**
   * Tests the translation values when saving a pending revision.
   */
  public function testTranslationValuesWhenSavingPendingRevisions() {
    $user = $this
      ->createUser();
    $storage = $this->entityTypeManager
      ->getStorage('entity_test_mulrev');

    // Create a test entity and a translation for it.
    $entity = EntityTestMulRev::create([
      'name' => 'default revision - en',
      'user_id' => $user
        ->id(),
      'language' => 'en',
    ]);
    $entity
      ->addTranslation('de', [
      'name' => 'default revision - de',
    ]);
    $entity
      ->save();

    // Create a pending revision for the entity and change a field value for
    // both languages.
    $pending_revision = $this
      ->reloadEntity($entity);
    $pending_revision
      ->setNewRevision();
    $pending_revision
      ->isDefaultRevision(FALSE);
    $pending_revision->name = 'pending revision - en';
    $pending_revision
      ->save();
    $pending_revision_translation = $pending_revision
      ->getTranslation('de');
    $pending_revision_translation->name = 'pending revision - de';
    $pending_revision_translation
      ->save();
    $pending_revision_id = $pending_revision
      ->getRevisionId();
    $pending_revision = $storage
      ->loadRevision($pending_revision_id);

    // Change the value of the field in the default language, save the pending
    // revision and check that the value of the field in the second language is
    // also taken from the pending revision, *not* from the default revision.
    $pending_revision->name = 'updated pending revision - en';
    $pending_revision
      ->save();
    $pending_revision = $storage
      ->loadRevision($pending_revision_id);
    $this
      ->assertEquals('updated pending revision - en', $pending_revision->name->value);
    $this
      ->assertEquals('pending revision - de', $pending_revision
      ->getTranslation('de')->name->value);
  }

  /**
   * Tests changing the default revision flag is propagated to all translations.
   */
  public function testDefaultRevision() {

    // Create a test entity with a translation, which will internally trigger
    // entity cloning for the new translation and create references for some of
    // the entity properties.
    $entity = EntityTestMulRev::create([
      'name' => 'original',
      'language' => 'en',
    ]);
    $translation = $entity
      ->addTranslation('de');
    $entity
      ->save();

    // Assert that the entity is in the default revision.
    $this
      ->assertTrue($entity
      ->isDefaultRevision());
    $this
      ->assertTrue($translation
      ->isDefaultRevision());

    // Change the default revision flag on one of the entity translations and
    // assert that the change is propagated to all entity translation objects.
    $translation
      ->isDefaultRevision(FALSE);
    $this
      ->assertFalse($entity
      ->isDefaultRevision());
    $this
      ->assertFalse($translation
      ->isDefaultRevision());
  }

  /**
   * @covers \Drupal\Core\Entity\ContentEntityBase::setNewRevision
   */
  public function testSetNewRevision() {
    $user = $this
      ->createUser();

    // All revisionable entity variations have to have the same results.
    foreach (entity_test_entity_types(ENTITY_TEST_TYPES_REVISABLE) as $entity_type) {
      $this
        ->installEntitySchema($entity_type);
      $storage = \Drupal::entityTypeManager()
        ->getStorage($entity_type);
      $entity = $storage
        ->create([
        'name' => 'foo',
        'user_id' => $user
          ->id(),
      ]);
      $entity
        ->save();
      $entity_id = $entity
        ->id();
      $entity_rev_id = $entity
        ->getRevisionId();
      $entity = $storage
        ->loadUnchanged($entity_id);
      $entity
        ->setNewRevision(TRUE);
      $entity
        ->setNewRevision(FALSE);
      $entity
        ->save();
      $entity = $storage
        ->loadUnchanged($entity_id);
      $this
        ->assertEquals($entity_rev_id, $entity
        ->getRevisionId(), 'A new entity revision was not created.');
    }
  }

  /**
   * Tests that revision translations are correctly detected.
   *
   * @covers \Drupal\Core\Entity\ContentEntityStorageBase::isAnyStoredRevisionTranslated
   */
  public function testIsAnyStoredRevisionTranslated() {

    /** @var \Drupal\Core\Entity\ContentEntityStorageInterface $storage */
    $storage = $this->entityTypeManager
      ->getStorage('entity_test_mul');
    $method = new \ReflectionMethod(get_class($storage), 'isAnyStoredRevisionTranslated');
    $method
      ->setAccessible(TRUE);

    // Check that a non-revisionable new entity is handled correctly.
    $entity = EntityTestMul::create();
    $this
      ->assertEmpty($entity
      ->getTranslationLanguages(FALSE));
    $this
      ->assertFalse($method
      ->invoke($storage, $entity));
    $entity
      ->addTranslation('it');
    $this
      ->assertNotEmpty($entity
      ->getTranslationLanguages(FALSE));
    $this
      ->assertFalse($method
      ->invoke($storage, $entity));

    // Check that not yet stored translations are handled correctly.
    $entity = EntityTestMul::create();
    $entity
      ->save();
    $entity
      ->addTranslation('it');
    $this
      ->assertNotEmpty($entity
      ->getTranslationLanguages(FALSE));
    $this
      ->assertFalse($method
      ->invoke($storage, $entity));

    // Check that removed translations are handled correctly.
    $entity
      ->save();
    $entity
      ->removeTranslation('it');
    $this
      ->assertEmpty($entity
      ->getTranslationLanguages(FALSE));
    $this
      ->assertTrue($method
      ->invoke($storage, $entity));
    $entity
      ->save();
    $this
      ->assertEmpty($entity
      ->getTranslationLanguages(FALSE));
    $this
      ->assertFalse($method
      ->invoke($storage, $entity));
    $entity
      ->addTranslation('de');
    $entity
      ->removeTranslation('de');
    $this
      ->assertEmpty($entity
      ->getTranslationLanguages(FALSE));
    $this
      ->assertFalse($method
      ->invoke($storage, $entity));

    // Check that a non-revisionable not translated entity is handled correctly.
    $entity = EntityTestMul::create();
    $entity
      ->save();
    $this
      ->assertEmpty($entity
      ->getTranslationLanguages(FALSE));
    $this
      ->assertFalse($method
      ->invoke($storage, $entity));

    // Check that a non-revisionable translated entity is handled correctly.
    $entity
      ->addTranslation('it');
    $entity
      ->save();
    $this
      ->assertNotEmpty($entity
      ->getTranslationLanguages(FALSE));
    $this
      ->assertTrue($method
      ->invoke($storage, $entity));

    /** @var \Drupal\Core\Entity\ContentEntityStorageInterface $storage */
    $storage = $this->entityTypeManager
      ->getStorage('entity_test_mulrev');

    // Check that a revisionable new entity is handled correctly.
    $entity = EntityTestMulRev::create();
    $this
      ->assertEmpty($entity
      ->getTranslationLanguages(FALSE));
    $this
      ->assertFalse($method
      ->invoke($storage, $entity));
    $entity
      ->addTranslation('it');
    $this
      ->assertNotEmpty($entity
      ->getTranslationLanguages(FALSE));
    $this
      ->assertFalse($method
      ->invoke($storage, $entity));

    // Check that a revisionable not translated entity is handled correctly.
    $entity = EntityTestMulRev::create();
    $entity
      ->save();
    $this
      ->assertEmpty($entity
      ->getTranslationLanguages(FALSE));
    $this
      ->assertFalse($method
      ->invoke($storage, $entity));

    // Check that a revisionable translated pending revision is handled
    // correctly.

    /** @var \Drupal\Core\Entity\ContentEntityInterface $new_revision */
    $new_revision = $storage
      ->createRevision($entity, FALSE);
    $new_revision
      ->addTranslation('it');
    $new_revision
      ->save();

    /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
    $entity = $storage
      ->loadUnchanged($entity
      ->id());
    $this
      ->assertEmpty($entity
      ->getTranslationLanguages(FALSE));
    $this
      ->assertNotEmpty($new_revision
      ->getTranslationLanguages(FALSE));
    $this
      ->assertTrue($method
      ->invoke($storage, $entity));

    // Check that a revisionable translated default revision is handled
    // correctly.
    $new_revision
      ->isDefaultRevision(TRUE);
    $new_revision
      ->save();

    /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
    $entity = $storage
      ->loadUnchanged($entity
      ->id());
    $this
      ->assertNotEmpty($entity
      ->getTranslationLanguages(FALSE));
    $this
      ->assertNotEmpty($new_revision
      ->getTranslationLanguages(FALSE));
    $this
      ->assertTrue($method
      ->invoke($storage, $entity));
  }

}