class EntityApiTest in Drupal 9
Same name and namespace in other branches
- 8 core/tests/Drupal/KernelTests/Core/Entity/EntityApiTest.php \Drupal\KernelTests\Core\Entity\EntityApiTest
Tests basic CRUD functionality.
@group Entity
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase uses UserCreationTrait
- class \Drupal\KernelTests\Core\Entity\EntityApiTest
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase uses UserCreationTrait
Expanded class hierarchy of EntityApiTest
File
- core/
tests/ Drupal/ KernelTests/ Core/ Entity/ EntityApiTest.php, line 16
Namespace
Drupal\KernelTests\Core\EntityView source
class EntityApiTest extends EntityKernelTestBase {
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
foreach (entity_test_entity_types() as $entity_type_id) {
// The entity_test schema is installed by the parent.
if ($entity_type_id != 'entity_test') {
$this
->installEntitySchema($entity_type_id);
}
}
}
/**
* Tests basic CRUD functionality of the Entity API.
*/
public function testCRUD() {
// All entity variations have to have the same results.
foreach (entity_test_entity_types() as $entity_type) {
$this
->assertCRUD($entity_type, $this
->createUser());
}
}
/**
* Executes a test set for a defined entity type and user.
*
* @param string $entity_type
* The entity type to run the tests with.
* @param \Drupal\user\UserInterface $user1
* The user to run the tests with.
*/
protected function assertCRUD($entity_type, UserInterface $user1) {
// Create some test entities.
$entity = $this->container
->get('entity_type.manager')
->getStorage($entity_type)
->create([
'name' => 'test',
'user_id' => $user1
->id(),
]);
$entity
->save();
$entity = $this->container
->get('entity_type.manager')
->getStorage($entity_type)
->create([
'name' => 'test2',
'user_id' => $user1
->id(),
]);
$entity
->save();
$entity = $this->container
->get('entity_type.manager')
->getStorage($entity_type)
->create([
'name' => 'test',
'user_id' => NULL,
]);
$entity
->save();
/** @var \Drupal\Core\Entity\EntityStorageInterface $storage */
$storage = $this->container
->get('entity_type.manager')
->getStorage($entity_type);
$entities = array_values($storage
->loadByProperties([
'name' => 'test',
]));
$this
->assertEquals('test', $entities[0]->name->value, new FormattableMarkup('%entity_type: Created and loaded entity', [
'%entity_type' => $entity_type,
]));
$this
->assertEquals('test', $entities[1]->name->value, new FormattableMarkup('%entity_type: Created and loaded entity', [
'%entity_type' => $entity_type,
]));
// Test loading a single entity.
$loaded_entity = $storage
->load($entity
->id());
$this
->assertEquals($entity
->id(), $loaded_entity
->id(), new FormattableMarkup('%entity_type: Loaded a single entity by id.', [
'%entity_type' => $entity_type,
]));
// Test deleting an entity.
$entities = array_values($storage
->loadByProperties([
'name' => 'test2',
]));
$entities[0]
->delete();
$entities = array_values($storage
->loadByProperties([
'name' => 'test2',
]));
$this
->assertEquals([], $entities, new FormattableMarkup('%entity_type: Entity deleted.', [
'%entity_type' => $entity_type,
]));
// Test updating an entity.
$entities = array_values($storage
->loadByProperties([
'name' => 'test',
]));
$entities[0]->name->value = 'test3';
$entities[0]
->save();
$entity = $storage
->load($entities[0]
->id());
$this
->assertEquals('test3', $entity->name->value, new FormattableMarkup('%entity_type: Entity updated.', [
'%entity_type' => $entity_type,
]));
// Try deleting multiple test entities by deleting all.
$entities = $storage
->loadMultiple();
$storage
->delete($entities);
$all = $storage
->loadMultiple();
$this
->assertTrue(empty($all), new FormattableMarkup('%entity_type: Deleted all entities.', [
'%entity_type' => $entity_type,
]));
// Verify that all data got deleted.
$definition = \Drupal::entityTypeManager()
->getDefinition($entity_type);
$connection = Database::getConnection();
$this
->assertEquals(0, (int) $connection
->select($definition
->getBaseTable())
->countQuery()
->execute()
->fetchField(), 'Base table was emptied');
if ($data_table = $definition
->getDataTable()) {
$this
->assertEquals(0, (int) $connection
->select($data_table)
->countQuery()
->execute()
->fetchField(), 'Data table was emptied');
}
if ($revision_table = $definition
->getRevisionTable()) {
$this
->assertEquals(0, (int) $connection
->select($revision_table)
->countQuery()
->execute()
->fetchField(), 'Revision table was emptied');
}
if ($revision_data_table = $definition
->getRevisionDataTable()) {
$this
->assertEquals(0, (int) $connection
->select($revision_data_table)
->countQuery()
->execute()
->fetchField(), 'Revision data table was emptied');
}
// Test deleting a list of entities not indexed by entity id.
$entities = [];
$entity = $storage
->create([
'name' => 'test',
'user_id' => $user1
->id(),
]);
$entity
->save();
$entities['test'] = $entity;
$entity = $storage
->create([
'name' => 'test2',
'user_id' => $user1
->id(),
]);
$entity
->save();
$entities['test2'] = $entity;
$controller = \Drupal::entityTypeManager()
->getStorage($entity_type);
$controller
->delete($entities);
// Verify that entities got deleted.
$all = $storage
->loadMultiple();
$this
->assertTrue(empty($all), new FormattableMarkup('%entity_type: Deleted all entities.', [
'%entity_type' => $entity_type,
]));
// Verify that all data got deleted from the tables.
$definition = \Drupal::entityTypeManager()
->getDefinition($entity_type);
$this
->assertEquals(0, (int) $connection
->select($definition
->getBaseTable())
->countQuery()
->execute()
->fetchField(), 'Base table was emptied');
if ($data_table = $definition
->getDataTable()) {
$this
->assertEquals(0, (int) $connection
->select($data_table)
->countQuery()
->execute()
->fetchField(), 'Data table was emptied');
}
if ($revision_table = $definition
->getRevisionTable()) {
$this
->assertEquals(0, (int) $connection
->select($revision_table)
->countQuery()
->execute()
->fetchField(), 'Revision table was emptied');
}
if ($revision_data_table = $definition
->getRevisionDataTable()) {
$this
->assertEquals(0, (int) $connection
->select($revision_data_table)
->countQuery()
->execute()
->fetchField(), 'Revision data table was emptied');
}
}
/**
* Tests that the Entity storage loads the entities in the correct order.
*
* Entities should be returned in the same order as the passed IDs.
*/
public function testLoadMultiple() {
// Entity load.
$storage = $this->container
->get('entity_type.manager')
->getStorage('entity_test');
$ids = [];
$entity = $storage
->create([
'name' => 'test',
]);
$entity
->save();
$ids[] = $entity
->id();
$entity = $storage
->create([
'name' => 'test2',
]);
$entity
->save();
$ids[] = $entity
->id();
// We load the entities in an initial and reverse order, with both static
// cache in place and reset, to ensure we always get the same result.
$entities = $storage
->loadMultiple($ids);
$this
->assertEquals($ids, array_keys($entities));
// Reverse the order and load again.
$ids = array_reverse($ids);
$entities = $storage
->loadMultiple($ids);
$this
->assertEquals($ids, array_keys($entities));
// Reverse the order again, reset the cache and load again.
$storage
->resetCache();
$ids = array_reverse($ids);
$entities = $storage
->loadMultiple($ids);
$this
->assertEquals($ids, array_keys($entities));
// Entity revision load.
$storage = $this->container
->get('entity_type.manager')
->getStorage('entity_test_rev');
$ids = [];
$entity = $storage
->create([
'name' => 'test_rev',
]);
$entity
->save();
$ids[] = $entity
->getRevisionId();
$revision = $storage
->createRevision($entity, TRUE);
$revision
->save();
$ids[] = $revision
->getRevisionId();
$entities = $storage
->loadMultipleRevisions($ids);
$this
->assertEquals($ids, array_keys($entities));
// Reverse the order and load again.
$ids = array_reverse($ids);
$entities = $storage
->loadMultipleRevisions($ids);
$this
->assertEquals($ids, array_keys($entities));
// Reverse the order again, reset the cache and load again.
$ids = array_reverse($ids);
$storage
->resetCache();
$entities = $storage
->loadMultipleRevisions($ids);
$this
->assertEquals($ids, array_keys($entities));
}
/**
* Tests that exceptions are thrown when saving or deleting an entity.
*/
public function testEntityStorageExceptionHandling() {
$entity = EntityTest::create([
'name' => 'test',
]);
try {
$GLOBALS['entity_test_throw_exception'] = TRUE;
$entity
->save();
$this
->fail('Entity presave EntityStorageException thrown but not caught.');
} catch (EntityStorageException $e) {
$this
->assertEquals(1, $e
->getcode(), 'Entity presave EntityStorageException caught.');
}
$entity = EntityTest::create([
'name' => 'test2',
]);
try {
unset($GLOBALS['entity_test_throw_exception']);
$entity
->save();
} catch (EntityStorageException $e) {
$this
->assertNotEquals(1, $e
->getCode(), 'Entity presave EntityStorageException caught.');
}
$entity = EntityTest::create([
'name' => 'test3',
]);
$entity
->save();
try {
$GLOBALS['entity_test_throw_exception'] = TRUE;
$entity
->delete();
$this
->fail('Entity predelete EntityStorageException not thrown.');
} catch (EntityStorageException $e) {
$this
->assertEquals(2, $e
->getCode(), 'Entity predelete EntityStorageException caught.');
}
unset($GLOBALS['entity_test_throw_exception']);
$entity = EntityTest::create([
'name' => 'test4',
]);
$entity
->save();
try {
$entity
->delete();
} catch (EntityStorageException $e) {
$this
->assertNotEquals(2, $e
->getCode(), 'Entity predelete EntityStorageException thrown.');
}
}
/**
* Tests that resaving a revision with a different revision ID throws an exception.
*/
public function testUpdateWithRevisionId() {
$storage = \Drupal::entityTypeManager()
->getStorage('entity_test_mulrev');
// Create a new entity.
/** @var \Drupal\entity_test\Entity\EntityTestMulRev $entity */
$entity = $storage
->create([
'name' => 'revision_test',
]);
$entity
->save();
$this
->expectException(EntityStorageException::class);
$this
->expectExceptionMessage("Update existing 'entity_test_mulrev' entity revision while changing the revision ID is not supported.");
$entity->revision_id = 60;
$entity
->save();
}
/**
* Tests that resaving an entity with a different entity ID throws an exception.
*/
public function testUpdateWithId() {
$storage = \Drupal::entityTypeManager()
->getStorage('entity_test_mulrev');
// Create a new entity.
/** @var \Drupal\entity_test\Entity\EntityTestMulRev $entity */
$entity = $storage
->create([
'name' => 'revision_test',
]);
$entity
->save();
$this
->expectException(EntityStorageException::class);
$this
->expectExceptionMessage("Update existing 'entity_test_mulrev' entity while changing the ID is not supported.");
$entity->id = 60;
$entity
->save();
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
EntityApiTest:: |
protected | function | Executes a test set for a defined entity type and user. | |
EntityApiTest:: |
protected | function |
Overrides EntityKernelTestBase:: |
|
EntityApiTest:: |
public | function | Tests basic CRUD functionality of the Entity API. | |
EntityApiTest:: |
public | function | Tests that exceptions are thrown when saving or deleting an entity. | |
EntityApiTest:: |
public | function | Tests that the Entity storage loads the entities in the correct order. | |
EntityApiTest:: |
public | function | Tests that resaving an entity with a different entity ID throws an exception. | |
EntityApiTest:: |
public | function | Tests that resaving a revision with a different revision ID throws an exception. | |
EntityKernelTestBase:: |
protected | property | The entity type manager service. | 1 |
EntityKernelTestBase:: |
protected | property | A list of generated identifiers. | |
EntityKernelTestBase:: |
protected static | property |
Modules to enable. Overrides KernelTestBase:: |
57 |
EntityKernelTestBase:: |
protected | property | The state service. | |
EntityKernelTestBase:: |
protected | function | Creates a user. | |
EntityKernelTestBase:: |
protected | function | Generates a random ID avoiding collisions. | |
EntityKernelTestBase:: |
protected | function | Returns the entity_test hook invocation info. | |
EntityKernelTestBase:: |
protected | function | Installs a module and refreshes services. | |
EntityKernelTestBase:: |
protected | function | Refresh services. | 1 |
EntityKernelTestBase:: |
protected | function | Reloads the given entity from the storage and returns it. | |
EntityKernelTestBase:: |
protected | function | Uninstalls a module and refreshes services. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
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:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 3 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
24 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 4 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions | |
UserCreationTrait:: |
protected | function | Creates an administrative role. Aliased as: drupalCreateAdminRole | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. Aliased as: drupalCreateRole | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. Aliased as: drupalCreateUser | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. Aliased as: drupalGrantPermissions | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. Aliased as: drupalSetCurrentUser | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser |