You are here

Home » API reference » Drupal 9 » DatabaseStorageExpirableTest.php

class DatabaseStorageExpirableTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/tests/Drupal/KernelTests/Core/KeyValueStore/DatabaseStorageExpirableTest.php \Drupal\KernelTests\Core\KeyValueStore\DatabaseStorageExpirableTest

Tests the key-value database storage.

@group KeyValueStore

Hierarchy

Expanded class hierarchy of DatabaseStorageExpirableTest

File

core/tests/Drupal/KernelTests/Core/KeyValueStore/DatabaseStorageExpirableTest.php, line 13

Namespace

Drupal\KernelTests\Core\KeyValueStore
View source 
class DatabaseStorageExpirableTest extends StorageTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'system',
  ];
  protected function setUp() : void {
    parent::setUp();
    $this->factory = 'keyvalue.expirable';
  }

  /**
   * {@inheritdoc}
   */
  public function register(ContainerBuilder $container) {
    parent::register($container);
    $parameter[KeyValueFactory::DEFAULT_SETTING] = 'keyvalue.expirable.database';
    $container
      ->setParameter('factory.keyvalue.expirable', $parameter);
  }

  /**
   * Tests CRUD functionality with expiration.
   */
  public function testCRUDWithExpiration() {
    $stores = $this
      ->createStorage();

    // Verify that an item can be stored with setWithExpire().
    // Use a random expiration in each test.
    $stores[0]
      ->setWithExpire('foo', $this->objects[0], rand(500, 100000));
    $this
      ->assertEquals($this->objects[0], $stores[0]
      ->get('foo'));

    // Verify that the other collection is not affected.
    $this
      ->assertNull($stores[1]
      ->get('foo'));

    // Verify that an item can be updated with setWithExpire().
    $stores[0]
      ->setWithExpire('foo', $this->objects[1], rand(500, 100000));
    $this
      ->assertEquals($this->objects[1], $stores[0]
      ->get('foo'));

    // Verify that the other collection is still not affected.
    $this
      ->assertNull($stores[1]
      ->get('foo'));

    // Verify that the expirable data key is unique.
    $stores[1]
      ->setWithExpire('foo', $this->objects[2], rand(500, 100000));
    $this
      ->assertEquals($this->objects[1], $stores[0]
      ->get('foo'));
    $this
      ->assertEquals($this->objects[2], $stores[1]
      ->get('foo'));

    // Verify that multiple items can be stored with setMultipleWithExpire().
    $values = [
      'foo' => $this->objects[3],
      'bar' => $this->objects[4],
    ];
    $stores[0]
      ->setMultipleWithExpire($values, rand(500, 100000));
    $result = $stores[0]
      ->getMultiple([
      'foo',
      'bar',
    ]);
    foreach ($values as $j => $value) {
      $this
        ->assertEquals($value, $result[$j]);
    }

    // Verify that the other collection was not affected.
    $this
      ->assertEquals($this->objects[2], $stores[1]
      ->get('foo'));
    $this
      ->assertNull($stores[1]
      ->get('bar'));

    // Verify that all items in a collection can be retrieved.
    // Ensure that an item with the same name exists in the other collection.
    $stores[1]
      ->set('foo', $this->objects[5]);

    // Not using assertSame(), since the order is not defined for getAll().
    $this
      ->assertEquals($values, $stores[0]
      ->getAll());

    // Verify that all items in the other collection are different.
    $result = $stores[1]
      ->getAll();
    $this
      ->assertEquals([
      'foo' => $this->objects[5],
    ], $result);

    // Verify that multiple items can be deleted.
    $stores[0]
      ->deleteMultiple(array_keys($values));
    $this
      ->assertNull($stores[0]
      ->get('foo'));
    $this
      ->assertNull($stores[0]
      ->get('bar'));
    $this
      ->assertEmpty($stores[0]
      ->getMultiple([
      'foo',
      'bar',
    ]));

    // Verify that the item in the other collection still exists.
    $this
      ->assertEquals($this->objects[5], $stores[1]
      ->get('foo'));

    // Test that setWithExpireIfNotExists() succeeds only the first time.
    $key = $this
      ->randomMachineName();
    for ($i = 0; $i <= 1; $i++) {

      // setWithExpireIfNotExists() should be TRUE the first time (when $i is
      // 0) and FALSE the second time (when $i is 1).
      $this
        ->assertEquals(!$i, $stores[0]
        ->setWithExpireIfNotExists($key, $this->objects[$i], rand(500, 100000)));
      $this
        ->assertEquals($this->objects[0], $stores[0]
        ->get($key));

      // Verify that the other collection is not affected.
      $this
        ->assertNull($stores[1]
        ->get($key));
    }

    // Remove the item and try to set it again.
    $stores[0]
      ->delete($key);
    $stores[0]
      ->setWithExpireIfNotExists($key, $this->objects[1], rand(500, 100000));

    // This time it should succeed.
    $this
      ->assertEquals($this->objects[1], $stores[0]
      ->get($key));

    // Verify that the other collection is still not affected.
    $this
      ->assertNull($stores[1]
      ->get($key));
  }

  /**
   * Tests data expiration.
   */
  public function testExpiration() {
    $stores = $this
      ->createStorage();
    $day = 604800;

    // Set an item to expire in the past and another without an expiration.
    $stores[0]
      ->setWithExpire('yesterday', 'all my troubles seemed so far away', -1 * $day);
    $stores[0]
      ->set('troubles', 'here to stay');

    // Only the non-expired item should be returned.
    $this
      ->assertFalse($stores[0]
      ->has('yesterday'));
    $this
      ->assertNull($stores[0]
      ->get('yesterday'));
    $this
      ->assertTrue($stores[0]
      ->has('troubles'));
    $this
      ->assertSame('here to stay', $stores[0]
      ->get('troubles'));
    $this
      ->assertCount(1, $stores[0]
      ->getMultiple([
      'yesterday',
      'troubles',
    ]));

    // Store items set to expire in the past in various ways.
    $stores[0]
      ->setWithExpire($this
      ->randomMachineName(), $this->objects[0], -7 * $day);
    $stores[0]
      ->setWithExpireIfNotExists($this
      ->randomMachineName(), $this->objects[1], -5 * $day);
    $stores[0]
      ->setMultipleWithExpire([
      $this
        ->randomMachineName() => $this->objects[2],
      $this
        ->randomMachineName() => $this->objects[3],
    ], -3 * $day);
    $stores[0]
      ->setWithExpireIfNotExists('yesterday', "you'd forgiven me", -1 * $day);
    $stores[0]
      ->setWithExpire('still', "'til we say we're sorry", 2 * $day);

    // Ensure only non-expired items are retrieved.
    $all = $stores[0]
      ->getAll();
    $this
      ->assertCount(2, $all);
    foreach ([
      'troubles',
      'still',
    ] as $key) {
      $this
        ->assertTrue(!empty($all[$key]));
    }

    // Test DatabaseStorageExpirable::setWithExpireIfNotExists() will overwrite
    // expired items.
    $this
      ->assertNull($stores[0]
      ->get('yesterday'));
    $stores[0]
      ->setWithExpireIfNotExists('yesterday', 'Oh, yesterday came suddenly', $day);
    $this
      ->assertSame('Oh, yesterday came suddenly', $stores[0]
      ->get('yesterday'));
  }

}

Members

Namesort descending 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::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.
DatabaseStorageExpirableTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
DatabaseStorageExpirableTest::register public function Registers test-specific services. Overrides KernelTestBase::register
DatabaseStorageExpirableTest::setUp protected function Overrides StorageTestBase::setUp
DatabaseStorageExpirableTest::testCRUDWithExpiration public function Tests CRUD functionality with expiration.
DatabaseStorageExpirableTest::testExpiration public function Tests data expiration.
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. 7
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. 6
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::prepareTemplate protected function
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. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 4
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
StorageTestBase::$collections protected property An array of data collection labels.
StorageTestBase::$factory protected property Whether we are using an expirable key/value store.
StorageTestBase::$objects protected property An array of random stdClass objects.
StorageTestBase::createStorage protected function Creates storage objects for each collection defined for this class.
StorageTestBase::testCRUD public function Tests CRUD operations.
StorageTestBase::testNonExistingKeys public function Tests expected behavior for non-existing keys.
StorageTestBase::testRename public function Tests the rename operation.
StorageTestBase::testSetIfNotExists public function Tests the setIfNotExists() method.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.