class KeyValueContentEntityStorageTest in Drupal 10

Same name and namespace in other branches

8 core/tests/Drupal/KernelTests/Core/KeyValueStore/KeyValueContentEntityStorageTest.php \Drupal\KernelTests\Core\KeyValueStore\KeyValueContentEntityStorageTest
9 core/tests/Drupal/KernelTests/Core/KeyValueStore/KeyValueContentEntityStorageTest.php \Drupal\KernelTests\Core\KeyValueStore\KeyValueContentEntityStorageTest

Tests KeyValueEntityStorage for content entities.

@group KeyValueStore

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\KeyValueStore\KeyValueContentEntityStorageTest

Expanded class hierarchy of KeyValueContentEntityStorageTest

File

core/tests/Drupal/KernelTests/Core/KeyValueStore/KeyValueContentEntityStorageTest.php, line 15

Namespace

Drupal\KernelTests\Core\KeyValueStore

View source

class KeyValueContentEntityStorageTest extends KernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'user',
    'entity_test',
    'keyvalue_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->installEntitySchema('user');
  }

  /**
   * Tests CRUD operations.
   *
   * @covers \Drupal\Core\Entity\KeyValueStore\KeyValueEntityStorage::hasData
   */
  public function testCRUD() {
    $default_langcode = \Drupal::languageManager()
      ->getDefaultLanguage()
      ->getId();
    $storage = \Drupal::entityTypeManager()
      ->getStorage('entity_test_label');
    $this
      ->assertFalse($storage
      ->hasData());

    // Verify default properties on a newly created empty entity.
    $empty = EntityTestLabel::create();
    $this
      ->assertNull($empty->id->value);
    $this
      ->assertNull($empty->name->value);
    $this
      ->assertNotEmpty($empty->uuid->value);
    $this
      ->assertSame($default_langcode, $empty->langcode->value);

    // Verify ConfigEntity properties/methods on the newly created empty entity.
    $this
      ->assertTrue($empty
      ->isNew());
    $this
      ->assertSame('entity_test_label', $empty
      ->bundle());
    $this
      ->assertNull($empty
      ->id());
    $this
      ->assertNotEmpty($empty
      ->uuid());
    $this
      ->assertNull($empty
      ->label());

    // Verify Entity properties/methods on the newly created empty entity.
    $this
      ->assertSame('entity_test_label', $empty
      ->getEntityTypeId());

    // The URI can only be checked after saving.
    try {
      $empty
        ->toUrl();
      $this
        ->fail('EntityMalformedException was thrown.');
    } catch (EntityMalformedException $e) {

      // Expected exception; just continue testing.
    }

    // Verify that an empty entity cannot be saved.
    try {
      $empty
        ->save();
      $this
        ->fail('EntityMalformedException was thrown.');
    } catch (EntityMalformedException $e) {

      // Expected exception; just continue testing.
    }

    // Verify that an entity with an empty ID string is considered empty, too.
    $empty_id = EntityTestLabel::create([
      'id' => '',
    ]);
    $this
      ->assertTrue($empty_id
      ->isNew());
    try {
      $empty_id
        ->save();
      $this
        ->fail('EntityMalformedException was thrown.');
    } catch (EntityMalformedException $e) {

      // Expected exception; just continue testing.
    }

    // Verify properties on a newly created entity.
    $entity_test = EntityTestLabel::create($expected = [
      'id' => $this
        ->randomMachineName(),
      'name' => $this
        ->randomString(),
    ]);
    $this
      ->assertSame($expected['id'], $entity_test->id->value);
    $this
      ->assertNotEmpty($entity_test->uuid->value);
    $this
      ->assertNotEquals($empty->uuid->value, $entity_test->uuid->value);
    $this
      ->assertSame($expected['name'], $entity_test->name->value);
    $this
      ->assertSame($default_langcode, $entity_test->langcode->value);

    // Verify methods on the newly created entity.
    $this
      ->assertTrue($entity_test
      ->isNew());
    $this
      ->assertSame($expected['id'], $entity_test
      ->id());
    $this
      ->assertNotEmpty($entity_test
      ->uuid());
    $expected['uuid'] = $entity_test
      ->uuid();
    $this
      ->assertSame($expected['name'], $entity_test
      ->label());

    // Verify that the entity can be saved.
    try {
      $status = $entity_test
        ->save();
    } catch (EntityMalformedException $e) {
      $this
        ->fail('EntityMalformedException was not thrown.');
    }

    // Verify that hasData() returns the expected result.
    $this
      ->assertTrue($storage
      ->hasData());

    // Verify that the correct status is returned and properties did not change.
    $this
      ->assertSame(SAVED_NEW, $status);
    $this
      ->assertSame($expected['id'], $entity_test
      ->id());
    $this
      ->assertSame($expected['uuid'], $entity_test
      ->uuid());
    $this
      ->assertSame($expected['name'], $entity_test
      ->label());
    $this
      ->assertFalse($entity_test
      ->isNew());

    // Save again, and verify correct status and properties again.
    $status = $entity_test
      ->save();
    $this
      ->assertSame(SAVED_UPDATED, $status);
    $this
      ->assertSame($expected['id'], $entity_test
      ->id());
    $this
      ->assertSame($expected['uuid'], $entity_test
      ->uuid());
    $this
      ->assertSame($expected['name'], $entity_test
      ->label());
    $this
      ->assertFalse($entity_test
      ->isNew());

    // Ensure that creating an entity with the same id as an existing one is not
    // possible.
    $same_id = EntityTestLabel::create([
      'id' => $entity_test
        ->id(),
    ]);
    $this
      ->assertTrue($same_id
      ->isNew());
    try {
      $same_id
        ->save();
      $this
        ->fail('Not possible to overwrite an entity.');
    } catch (EntityStorageException $e) {

      // Expected exception; just continue testing.
    }

    // Verify that renaming the ID returns correct status and properties.
    $ids = [
      $expected['id'],
      'second_' . $this
        ->randomMachineName(4),
      'third_' . $this
        ->randomMachineName(4),
    ];
    for ($i = 1; $i < 3; $i++) {
      $old_id = $ids[$i - 1];
      $new_id = $ids[$i];

      // Before renaming, everything should point to the current ID.
      $this
        ->assertSame($old_id, $entity_test
        ->id());

      // Rename.
      $entity_test->id = $new_id;
      $this
        ->assertSame($new_id, $entity_test
        ->id());
      $status = $entity_test
        ->save();
      $this
        ->assertSame(SAVED_UPDATED, $status);
      $this
        ->assertFalse($entity_test
        ->isNew());

      // Verify that originalID points to new ID directly after renaming.
      $this
        ->assertSame($new_id, $entity_test
        ->id());
    }
  }

  /**
   * Tests uninstallation of a module that does not use the SQL entity storage.
   */
  public function testUninstall() {
    $uninstall_validator_reasons = \Drupal::service('content_uninstall_validator')
      ->validate('keyvalue_test');
    $this
      ->assertEmpty($uninstall_validator_reasons);
  }

}

Members

Name	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::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.
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.
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.	3
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.	4
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.	2
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::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	14
KernelTestBase::render	protected	function	Renders a render array.
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
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	1
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		3
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.
KeyValueContentEntityStorageTest::$modules	protected static	property	Modules to enable. Overrides KernelTestBase::$modules
KeyValueContentEntityStorageTest::setUp	protected	function	Overrides KernelTestBase::setUp
KeyValueContentEntityStorageTest::testCRUD	public	function	Tests CRUD operations.
KeyValueContentEntityStorageTest::testUninstall	public	function	Tests uninstallation of a module that does not use the SQL entity storage.
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.
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.
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.

You are here

class KeyValueContentEntityStorageTest in Drupal 10

Hierarchy

File

Namespace

Members

API Navigation