class TempStoreDatabaseTest

Same name in this branch
  1. 8.9.x core/tests/Drupal/KernelTests/Core/TempStore/TempStoreDatabaseTest.php \Drupal\KernelTests\Core\TempStore\TempStoreDatabaseTest
Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/TempStore/TempStoreDatabaseTest.php \Drupal\KernelTests\Core\TempStore\TempStoreDatabaseTest
  2. 10 core/tests/Drupal/KernelTests/Core/TempStore/TempStoreDatabaseTest.php \Drupal\KernelTests\Core\TempStore\TempStoreDatabaseTest
  3. 11.x core/tests/Drupal/KernelTests/Core/TempStore/TempStoreDatabaseTest.php \Drupal\KernelTests\Core\TempStore\TempStoreDatabaseTest

Tests the temporary object storage system.

@group user @group legacy

Hierarchy

Expanded class hierarchy of TempStoreDatabaseTest

See also

\Drupal\user\SharedTempStore

File

core/modules/user/tests/src/Kernel/TempStoreDatabaseTest.php, line 18

Namespace

Drupal\Tests\user\Kernel
View source
class TempStoreDatabaseTest extends KernelTestBase {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    public static $modules = [
        'system',
        'user',
    ];
    
    /**
     * A key/value store factory.
     *
     * @var \Drupal\user\SharedTempStoreFactory
     */
    protected $storeFactory;
    
    /**
     * The name of the key/value collection to set and retrieve.
     *
     * @var string
     */
    protected $collection;
    
    /**
     * An array of (fake) user IDs.
     *
     * @var array
     */
    protected $users = [];
    
    /**
     * An array of random stdClass objects.
     *
     * @var array
     */
    protected $objects = [];
    protected function setUp() {
        parent::setUp();
        // Install system tables to test the key/value storage without installing a
        // full Drupal environment.
        $this->installSchema('system', [
            'key_value_expire',
        ]);
        // Create several objects for testing.
        for ($i = 0; $i <= 3; $i++) {
            $this->objects[$i] = $this->randomObject();
        }
    }
    
    /**
     * Tests the UserTempStore API.
     *
     * @expectedDeprecation \Drupal\user\SharedTempStoreFactory is scheduled for removal in Drupal 9.0.0. Use \Drupal\Core\TempStore\SharedTempStoreFactory instead. See https://www.drupal.org/node/2935639.
     * @expectedDeprecation \Drupal\user\SharedTempStore is scheduled for removal in Drupal 9.0.0. Use \Drupal\Core\TempStore\SharedTempStore instead. See https://www.drupal.org/node/2935639.
     */
    public function testUserTempStore() {
        // Create a key/value collection.
        $factory = new SharedTempStoreFactory(new KeyValueExpirableFactory(\Drupal::getContainer()), new DatabaseLockBackend(Database::getConnection()), $this->container
            ->get('request_stack'));
        $collection = $this->randomMachineName();
        // Create two mock users.
        for ($i = 0; $i <= 1; $i++) {
            $users[$i] = mt_rand(500, 5000000);
            // Storing the SharedTempStore objects in a class member variable causes a
            // fatal exception, because in that situation garbage collection is not
            // triggered until the test class itself is destructed, after tearDown()
            // has deleted the database tables. Store the objects locally instead.
            $stores[$i] = $factory->get($collection, $users[$i]);
        }
        $key = $this->randomMachineName();
        // Test that setIfNotExists() succeeds only the first time.
        for ($i = 0; $i <= 1; $i++) {
            // setIfNotExists() should be TRUE the first time (when $i is 0) and
            // FALSE the second time (when $i is 1).
            $this->assertEqual(!$i, $stores[0]->setIfNotExists($key, $this->objects[$i]));
            $metadata = $stores[0]->getMetadata($key);
            $this->assertEqual($users[0], $metadata->owner);
            $this->assertEquals($this->objects[0], $stores[0]->get($key));
            // Another user should get the same result.
            $metadata = $stores[1]->getMetadata($key);
            $this->assertEqual($users[0], $metadata->owner);
            $this->assertEquals($this->objects[0], $stores[1]->get($key));
        }
        // Remove the item and try to set it again.
        $stores[0]->delete($key);
        $stores[0]->setIfNotExists($key, $this->objects[1]);
        // This time it should succeed.
        $this->assertEquals($this->objects[1], $stores[0]->get($key));
        // This user can update the object.
        $stores[0]->set($key, $this->objects[2]);
        $this->assertEquals($this->objects[2], $stores[0]->get($key));
        // The object is the same when another user loads it.
        $this->assertEquals($this->objects[2], $stores[1]->get($key));
        // This user should be allowed to get, update, delete.
        $this->assertTrue($stores[0]->getIfOwner($key) instanceof \stdClass);
        $this->assertTrue($stores[0]->setIfOwner($key, $this->objects[1]));
        $this->assertTrue($stores[0]->deleteIfOwner($key));
        // Another user can update the object and become the owner.
        $stores[1]->set($key, $this->objects[3]);
        $this->assertEquals($this->objects[3], $stores[0]->get($key));
        $this->assertEquals($this->objects[3], $stores[1]->get($key));
        $metadata = $stores[1]->getMetadata($key);
        $this->assertEqual($users[1], $metadata->owner);
        // The first user should be informed that the second now owns the data.
        $metadata = $stores[0]->getMetadata($key);
        $this->assertEqual($users[1], $metadata->owner);
        // The first user should no longer be allowed to get, update, delete.
        $this->assertNull($stores[0]->getIfOwner($key));
        $this->assertFalse($stores[0]->setIfOwner($key, $this->objects[1]));
        $this->assertFalse($stores[0]->deleteIfOwner($key));
        // Now manually expire the item (this is not exposed by the API) and then
        // assert it is no longer accessible.
        Database::getConnection()->update('key_value_expire')
            ->fields([
            'expire' => REQUEST_TIME - 1,
        ])
            ->condition('collection', "user.shared_tempstore.{$collection}")
            ->condition('name', $key)
            ->execute();
        $this->assertEmpty($stores[0]->get($key));
        $this->assertEmpty($stores[1]->get($key));
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary 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 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.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function
AssertLegacyTrait::assertEqual protected function
AssertLegacyTrait::assertIdentical protected function
AssertLegacyTrait::assertIdenticalObject protected function
AssertLegacyTrait::assertNotEqual protected function
AssertLegacyTrait::assertNotIdentical protected function
AssertLegacyTrait::pass protected function
AssertLegacyTrait::verbose 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.
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. 1
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::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
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. 2
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::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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.
TempStoreDatabaseTest::$collection protected property The name of the key/value collection to set and retrieve.
TempStoreDatabaseTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
TempStoreDatabaseTest::$objects protected property An array of random stdClass objects.
TempStoreDatabaseTest::$storeFactory protected property A key/value store factory.
TempStoreDatabaseTest::$users protected property An array of (fake) user IDs.
TempStoreDatabaseTest::setUp protected function Overrides KernelTestBase::setUp
TempStoreDatabaseTest::testUserTempStore public function Tests the UserTempStore API.
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.