class RevisionableContentEntityBaseTest
Same name in other branches
- 8.9.x core/tests/Drupal/KernelTests/Core/Entity/RevisionableContentEntityBaseTest.php \Drupal\KernelTests\Core\Entity\RevisionableContentEntityBaseTest
- 10 core/tests/Drupal/KernelTests/Core/Entity/RevisionableContentEntityBaseTest.php \Drupal\KernelTests\Core\Entity\RevisionableContentEntityBaseTest
- 11.x core/tests/Drupal/KernelTests/Core/Entity/RevisionableContentEntityBaseTest.php \Drupal\KernelTests\Core\Entity\RevisionableContentEntityBaseTest
Test the revision system.
This test uses the entity_test_revlog module, which intentionally omits the entity_metadata_keys fields. This causes deprecation errors.
@coversDefaultClass \Drupal\Core\Entity\RevisionableContentEntityBase @group Entity
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertLegacyTrait, \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\ExtensionListTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase extends \Drupal\KernelTests\KernelTestBase uses \Drupal\Tests\user\Traits\UserCreationTrait
- class \Drupal\KernelTests\Core\Entity\RevisionableContentEntityBaseTest extends \Drupal\KernelTests\Core\Entity\EntityKernelTestBase
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase extends \Drupal\KernelTests\KernelTestBase uses \Drupal\Tests\user\Traits\UserCreationTrait
Expanded class hierarchy of RevisionableContentEntityBaseTest
File
-
core/
tests/ Drupal/ KernelTests/ Core/ Entity/ RevisionableContentEntityBaseTest.php, line 21
Namespace
Drupal\KernelTests\Core\EntityView source
class RevisionableContentEntityBaseTest extends EntityKernelTestBase {
/**
* {@inheritdoc}
*/
protected static $modules = [
'entity_test_revlog',
'system',
'user',
];
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->installEntitySchema('entity_test_mul_revlog');
}
/**
* Tests the correct functionality CRUD operations of entity revisions.
*/
public function testRevisionableContentEntity() {
$entity_type = 'entity_test_mul_revlog';
$definition = \Drupal::entityTypeManager()->getDefinition($entity_type);
$user = User::create([
'name' => 'test name',
]);
$user->save();
/** @var \Drupal\entity_test_revlog\Entity\EntityTestMulWithRevisionLog $entity */
$entity = EntityTestMulWithRevisionLog::create([
'type' => $entity_type,
]);
// Save the entity, this creates the first revision.
$entity->save();
$revision_ids[] = $entity->getRevisionId();
$this->assertItemsTableCount(1, $definition);
// Create the second revision.
$entity->setNewRevision(TRUE);
$random_timestamp = rand(100000000.0, 200000000.0);
$this->createRevision($entity, $user, $random_timestamp, 'This is my log message');
$revision_id = $entity->getRevisionId();
$revision_ids[] = $revision_id;
$storage = \Drupal::entityTypeManager()->getStorage('entity_test_mul_revlog');
$entity = $storage->loadRevision($revision_id);
$this->assertEquals($random_timestamp, $entity->getRevisionCreationTime());
$this->assertEquals($user->id(), $entity->getRevisionUserId());
$this->assertEquals($user->id(), $entity->getRevisionUser()
->id());
$this->assertEquals('This is my log message', $entity->getRevisionLogMessage());
// Create the third revision.
$random_timestamp = rand(100000000.0, 200000000.0);
$this->createRevision($entity, $user, $random_timestamp, 'This is my log message');
$this->assertItemsTableCount(3, $definition);
$revision_ids[] = $entity->getRevisionId();
// Create another 3 revisions.
foreach (range(1, 3) as $count) {
$timestamp = rand(100000000.0, 200000000.0);
$this->createRevision($entity, $user, $timestamp, 'This is my log message number: ' . $count);
$revision_ids[] = $entity->getRevisionId();
}
$this->assertItemsTableCount(6, $definition);
$this->assertCount(6, $revision_ids);
// Delete the first 3 revisions.
foreach (range(0, 2) as $key) {
$storage->deleteRevision($revision_ids[$key]);
}
// We should have only data for three revisions.
$this->assertItemsTableCount(3, $definition);
}
/**
* Tests the behavior of the "revision_default" flag.
*
* @covers \Drupal\Core\Entity\ContentEntityBase::wasDefaultRevision
*/
public function testWasDefaultRevision() {
$entity_type_id = 'entity_test_mul_revlog';
$entity = EntityTestMulWithRevisionLog::create([
'type' => $entity_type_id,
]);
// Checks that in a new entity ::wasDefaultRevision() always matches
// ::isDefaultRevision().
$this->assertEquals($entity->isDefaultRevision(), $entity->wasDefaultRevision());
$entity->isDefaultRevision(FALSE);
$this->assertEquals($entity->isDefaultRevision(), $entity->wasDefaultRevision());
// Check that a new entity is always flagged as a default revision on save,
// regardless of its default revision status.
$entity->save();
$this->assertTrue($entity->wasDefaultRevision());
// Check that a pending revision is not flagged as default.
$entity->setNewRevision();
$entity->isDefaultRevision(FALSE);
$entity->save();
$this->assertFalse($entity->wasDefaultRevision());
// Check that a default revision is flagged as such.
$entity->setNewRevision();
$entity->isDefaultRevision(TRUE);
$entity->save();
$this->assertTrue($entity->wasDefaultRevision());
// Check that a manually set value for the "revision_default" flag is
// ignored on save.
$entity->setNewRevision();
$entity->isDefaultRevision(FALSE);
$entity->set('revision_default', TRUE);
$this->assertTrue($entity->wasDefaultRevision());
$entity->save();
$this->assertFalse($entity->wasDefaultRevision());
// Check that the default revision status was stored correctly.
$storage = $this->entityTypeManager
->getStorage($entity_type_id);
foreach ([
TRUE,
FALSE,
TRUE,
FALSE,
] as $index => $expected) {
/** @var \Drupal\entity_test_revlog\Entity\EntityTestMulWithRevisionLog $revision */
$revision = $storage->loadRevision($index + 1);
$this->assertEquals($expected, $revision->wasDefaultRevision());
}
// Check that the default revision is flagged correctly.
/** @var \Drupal\entity_test_revlog\Entity\EntityTestMulWithRevisionLog $entity */
$entity = $storage->loadUnchanged($entity->id());
$this->assertTrue($entity->wasDefaultRevision());
// Check that the "revision_default" flag cannot be changed once set.
/** @var \Drupal\entity_test_revlog\Entity\EntityTestMulWithRevisionLog $entity2 */
$entity2 = EntityTestMulWithRevisionLog::create([
'type' => $entity_type_id,
]);
$entity2->save();
$this->assertTrue($entity2->wasDefaultRevision());
$entity2->isDefaultRevision(FALSE);
$entity2->save();
$this->assertTrue($entity2->wasDefaultRevision());
}
/**
* Asserts the amount of items on entity related tables.
*
* @param int $count
* The number of items expected to be in revisions related tables.
* @param \Drupal\Core\Entity\EntityTypeInterface $definition
* The definition and metadata of the entity being tested.
*
* @internal
*/
protected function assertItemsTableCount(int $count, EntityTypeInterface $definition) : void {
$connection = Database::getConnection();
$this->assertEquals(1, (int) $connection->select($definition->getBaseTable())
->countQuery()
->execute()
->fetchField());
$this->assertEquals(1, (int) $connection->select($definition->getDataTable())
->countQuery()
->execute()
->fetchField());
$this->assertEquals($count, (int) $connection->select($definition->getRevisionTable())
->countQuery()
->execute()
->fetchField());
$this->assertEquals($count, (int) $connection->select($definition->getRevisionDataTable())
->countQuery()
->execute()
->fetchField());
}
/**
* Creates a new revision in the entity of this test class.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity where revision will be created.
* @param \Drupal\user\UserInterface $user
* The author of the new revision.
* @param int $timestamp
* The timestamp of the new revision.
* @param string $log_message
* The log message of the new revision.
*/
protected function createRevision(EntityInterface $entity, UserInterface $user, $timestamp, $log_message) {
$entity->setNewRevision(TRUE);
$entity->setRevisionCreationTime($timestamp);
$entity->setRevisionUserId($user->id());
$entity->setRevisionLogMessage($log_message);
$entity->save();
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | 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 raw text IS NOT found escaped on 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. | ||||
AssertLegacyTrait::assert | Deprecated | protected | function | ||||
AssertLegacyTrait::assertEqual | Deprecated | protected | function | ||||
AssertLegacyTrait::assertIdentical | Deprecated | protected | function | ||||
AssertLegacyTrait::assertIdenticalObject | Deprecated | protected | function | ||||
AssertLegacyTrait::assertNotEqual | Deprecated | protected | function | ||||
AssertLegacyTrait::assertNotIdentical | Deprecated | protected | function | ||||
AssertLegacyTrait::pass | Deprecated | protected | function | ||||
AssertLegacyTrait::verbose | Deprecated | 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. | ||||
EntityKernelTestBase::$entityTypeManager | protected | property | The entity type manager service. | 1 | |||
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. | ||||
ExtensionListTestTrait::getModulePath | protected | function | Gets the path for the specified module. | ||||
ExtensionListTestTrait::getThemePath | protected | function | Gets the path for the specified theme. | ||||
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. | 6 | |||
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::$keyValue | protected | property | The key_value service that must persist between container rebuilds. | ||||
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. | 7 | |||
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. | 3 | |||
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::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. | 3 | |||
KernelTestBase::stop | protected | function | Stops test execution. | ||||
KernelTestBase::tearDown | protected | function | 5 | ||||
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. | ||||
PhpUnitWarnings::$deprecationWarnings | private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | ||||
PhpUnitWarnings::addWarning | public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | ||||
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. | ||||
RevisionableContentEntityBaseTest::$modules | protected static | property | Modules to enable. | Overrides EntityKernelTestBase::$modules | |||
RevisionableContentEntityBaseTest::assertItemsTableCount | protected | function | Asserts the amount of items on entity related tables. | ||||
RevisionableContentEntityBaseTest::createRevision | protected | function | Creates a new revision in the entity of this test class. | ||||
RevisionableContentEntityBaseTest::setUp | protected | function | Overrides EntityKernelTestBase::setUp | ||||
RevisionableContentEntityBaseTest::testRevisionableContentEntity | public | function | Tests the correct functionality CRUD operations of entity revisions. | ||||
RevisionableContentEntityBaseTest::testWasDefaultRevision | public | function | Tests the behavior of the "revision_default" flag. | ||||
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. | ||||
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 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.