EntityRevisionsTest.php
Same filename in this branch
Same filename in other branches
- 9 core/modules/system/tests/src/Functional/Entity/EntityRevisionsTest.php
- 9 core/tests/Drupal/KernelTests/Core/Entity/EntityRevisionsTest.php
- 10 core/modules/system/tests/src/Functional/Entity/EntityRevisionsTest.php
- 10 core/tests/Drupal/KernelTests/Core/Entity/EntityRevisionsTest.php
- 11.x core/modules/system/tests/src/Functional/Entity/EntityRevisionsTest.php
- 11.x core/tests/Drupal/KernelTests/Core/Entity/EntityRevisionsTest.php
Namespace
Drupal\Tests\system\Functional\EntityFile
-
core/
modules/ system/ tests/ src/ Functional/ Entity/ EntityRevisionsTest.php
View source
<?php
namespace Drupal\Tests\system\Functional\Entity;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\entity_test\Entity\EntityTestMulRev;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\language\Entity\ConfigurableLanguage;
use Drupal\Tests\BrowserTestBase;
/**
* Create a entity with revisions and test viewing, saving, reverting, and
* deleting revisions.
*
* @group Entity
*/
class EntityRevisionsTest extends BrowserTestBase {
/**
* Modules to enable.
*
* @var array
*/
public static $modules = [
'entity_test',
'language',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* A user with permission to administer entity_test content.
*
* @var \Drupal\user\UserInterface
*/
protected $webUser;
protected function setUp() {
parent::setUp();
// Create and log in user.
$this->webUser = $this->drupalCreateUser([
'administer entity_test content',
'view test entity',
]);
$this->drupalLogin($this->webUser);
// Enable an additional language.
ConfigurableLanguage::createFromLangcode('de')->save();
}
/**
* Check node revision related operations.
*/
public function testRevisions() {
// All revisable entity variations have to have the same results.
foreach (entity_test_entity_types(ENTITY_TEST_TYPES_REVISABLE) as $entity_type) {
$this->runRevisionsTests($entity_type);
}
}
/**
* Executes the revision tests for the given entity type.
*
* @param string $entity_type
* The entity type to run the tests with.
*/
protected function runRevisionsTests($entity_type) {
// Create a translatable test field.
$field_storage = FieldStorageConfig::create([
'entity_type' => $entity_type,
'field_name' => 'translatable_test_field',
'type' => 'text',
'cardinality' => 2,
]);
$field_storage->save();
$field = FieldConfig::create([
'field_storage' => $field_storage,
'label' => $this->randomMachineName(),
'bundle' => $entity_type,
'translatable' => TRUE,
]);
$field->save();
\Drupal::service('entity_display.repository')->getFormDisplay($entity_type, $entity_type, 'default')
->setComponent('translatable_test_field')
->save();
/** @var \Drupal\Core\Entity\ContentEntityStorageInterface $storage */
$storage = \Drupal::entityTypeManager()->getStorage($entity_type);
// Create initial entity.
/** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
$entity = $storage->create([
'name' => 'foo',
'user_id' => $this->webUser
->id(),
]);
$entity->translatable_test_field->value = 'bar';
$entity->addTranslation('de', [
'name' => 'foo - de',
]);
$entity->save();
$values = [];
$revision_ids = [];
// Create three revisions.
$revision_count = 3;
for ($i = 0; $i < $revision_count; $i++) {
$legacy_revision_id = $entity->revision_id->value;
$legacy_name = $entity->name->value;
$legacy_text = $entity->translatable_test_field->value;
$entity = $storage->load($entity->id->value);
$entity->setNewRevision(TRUE);
$values['en'][$i] = [
'name' => $this->randomMachineName(32),
'translatable_test_field' => [
$this->randomMachineName(32),
$this->randomMachineName(32),
],
'created' => time() + $i + 1,
];
$entity->set('name', $values['en'][$i]['name']);
$entity->set('translatable_test_field', $values['en'][$i]['translatable_test_field']);
$entity->set('created', $values['en'][$i]['created']);
$entity->save();
$revision_ids[] = $entity->revision_id->value;
// Add some values for a translation of this revision.
if ($entity->getEntityType()
->isTranslatable()) {
$values['de'][$i] = [
'name' => $this->randomMachineName(32),
'translatable_test_field' => [
$this->randomMachineName(32),
$this->randomMachineName(32),
],
];
$translation = $entity->getTranslation('de');
$translation->set('name', $values['de'][$i]['name']);
$translation->set('translatable_test_field', $values['de'][$i]['translatable_test_field']);
$translation->save();
}
// Check that the fields and properties contain new content.
$this->assertTrue($entity->revision_id->value > $legacy_revision_id, new FormattableMarkup('%entity_type: Revision ID changed.', [
'%entity_type' => $entity_type,
]));
$this->assertNotEqual($entity->name->value, $legacy_name, new FormattableMarkup('%entity_type: Name changed.', [
'%entity_type' => $entity_type,
]));
$this->assertNotEqual($entity->translatable_test_field->value, $legacy_text, new FormattableMarkup('%entity_type: Text changed.', [
'%entity_type' => $entity_type,
]));
}
$revisions = $storage->loadMultipleRevisions($revision_ids);
for ($i = 0; $i < $revision_count; $i++) {
// Load specific revision.
$entity_revision = $revisions[$revision_ids[$i]];
// Check if properties and fields contain the revision specific content.
$this->assertEqual($entity_revision->revision_id->value, $revision_ids[$i], new FormattableMarkup('%entity_type: Revision ID matches.', [
'%entity_type' => $entity_type,
]));
$this->assertEqual($entity_revision->name->value, $values['en'][$i]['name'], new FormattableMarkup('%entity_type: Name matches.', [
'%entity_type' => $entity_type,
]));
$this->assertEqual($entity_revision->translatable_test_field[0]->value, $values['en'][$i]['translatable_test_field'][0], new FormattableMarkup('%entity_type: Text matches.', [
'%entity_type' => $entity_type,
]));
$this->assertEqual($entity_revision->translatable_test_field[1]->value, $values['en'][$i]['translatable_test_field'][1], new FormattableMarkup('%entity_type: Text matches.', [
'%entity_type' => $entity_type,
]));
// Check the translated values.
if ($entity->getEntityType()
->isTranslatable()) {
$revision_translation = $entity_revision->getTranslation('de');
$this->assertEqual($revision_translation->name->value, $values['de'][$i]['name'], new FormattableMarkup('%entity_type: Name matches.', [
'%entity_type' => $entity_type,
]));
$this->assertEqual($revision_translation->translatable_test_field[0]->value, $values['de'][$i]['translatable_test_field'][0], new FormattableMarkup('%entity_type: Text matches.', [
'%entity_type' => $entity_type,
]));
$this->assertEqual($revision_translation->translatable_test_field[1]->value, $values['de'][$i]['translatable_test_field'][1], new FormattableMarkup('%entity_type: Text matches.', [
'%entity_type' => $entity_type,
]));
}
// Check non-revisioned values are loaded.
$this->assertTrue(isset($entity_revision->created->value), new FormattableMarkup('%entity_type: Non-revisioned field is loaded.', [
'%entity_type' => $entity_type,
]));
$this->assertEqual($entity_revision->created->value, $values['en'][2]['created'], new FormattableMarkup('%entity_type: Non-revisioned field value is the same between revisions.', [
'%entity_type' => $entity_type,
]));
}
// Confirm the correct revision text appears in the edit form.
$entity = $storage->load($entity->id->value);
$this->drupalGet($entity_type . '/manage/' . $entity->id->value . '/edit');
$this->assertFieldById('edit-name-0-value', $entity->name->value, new FormattableMarkup('%entity_type: Name matches in UI.', [
'%entity_type' => $entity_type,
]));
$this->assertFieldById('edit-translatable-test-field-0-value', $entity->translatable_test_field->value, new FormattableMarkup('%entity_type: Text matches in UI.', [
'%entity_type' => $entity_type,
]));
}
/**
* Tests that an entity revision is upcasted in the correct language.
*/
public function testEntityRevisionParamConverter() {
// Create a test entity with multiple revisions and translations for them.
$entity = EntityTestMulRev::create([
'name' => 'default revision - en',
'user_id' => $this->webUser,
'language' => 'en',
]);
$entity->addTranslation('de', [
'name' => 'default revision - de',
]);
$entity->save();
$pending_revision = \Drupal::entityTypeManager()->getStorage('entity_test_mulrev')
->loadUnchanged($entity->id());
$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();
// Check that the entity revision is upcasted in the correct language.
$revision_url = 'entity_test_mulrev/' . $entity->id() . '/revision/' . $pending_revision->getRevisionId() . '/view';
$this->drupalGet($revision_url);
$this->assertText('pending revision - en');
$this->assertNoText('pending revision - de');
$this->drupalGet('de/' . $revision_url);
$this->assertText('pending revision - de');
$this->assertNoText('pending revision - en');
}
/**
* Tests manual revert of the revision ID value.
*
* @covers \Drupal\Core\Entity\ContentEntityBase::getRevisionId
* @covers \Drupal\Core\Entity\ContentEntityBase::getLoadedRevisionId
* @covers \Drupal\Core\Entity\ContentEntityBase::setNewRevision
* @covers \Drupal\Core\Entity\ContentEntityBase::isNewRevision
*/
public function testNewRevisionRevert() {
$entity = EntityTestMulRev::create([
'name' => 'EntityLoadedRevisionTest',
]);
$entity->save();
// Check that revision ID field is reset while the loaded revision ID is
// preserved when flagging a new revision.
$revision_id = $entity->getRevisionId();
$entity->setNewRevision();
$this->assertNull($entity->getRevisionId());
$this->assertEquals($revision_id, $entity->getLoadedRevisionId());
$this->assertTrue($entity->isNewRevision());
// Check that after manually restoring the original revision ID, the entity
// is stored without creating a new revision.
$key = $entity->getEntityType()
->getKey('revision');
$entity->set($key, $revision_id);
$entity->save();
$this->assertEquals($revision_id, $entity->getRevisionId());
$this->assertEquals($revision_id, $entity->getLoadedRevisionId());
// Check that manually restoring the original revision ID causes the "new
// revision" state to be reverted.
$entity->setNewRevision();
$this->assertNull($entity->getRevisionId());
$this->assertEquals($revision_id, $entity->getLoadedRevisionId());
$this->assertTrue($entity->isNewRevision());
$entity->set($key, $revision_id);
$this->assertFalse($entity->isNewRevision());
$this->assertEquals($revision_id, $entity->getRevisionId());
$this->assertEquals($revision_id, $entity->getLoadedRevisionId());
// Check that flagging a new revision again works correctly.
$entity->setNewRevision();
$this->assertNull($entity->getRevisionId());
$this->assertEquals($revision_id, $entity->getLoadedRevisionId());
$this->assertTrue($entity->isNewRevision());
// Check that calling setNewRevision() on a new entity without a revision ID
// and then with a revision ID does not unset the revision ID.
$entity = EntityTestMulRev::create([
'name' => 'EntityLoadedRevisionTest',
]);
$entity->set('revision_id', NULL);
$entity->set('revision_id', 5);
$this->assertTrue($entity->isNewRevision());
$entity->setNewRevision();
$this->assertEquals(5, $entity->get('revision_id')->value);
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
EntityRevisionsTest | Create a entity with revisions and test viewing, saving, reverting, and deleting revisions. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.