abstract class StorageTestBase in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/system/src/Tests/KeyValueStore/StorageTestBase.php \Drupal\system\Tests\KeyValueStore\StorageTestBase
Base class for testing key-value storages.
Hierarchy
- class \Drupal\simpletest\TestBase uses AssertHelperTrait, RandomGeneratorTrait, SessionTestTrait
- class \Drupal\simpletest\KernelTestBase uses AssertContentTrait
- class \Drupal\system\Tests\KeyValueStore\StorageTestBase
- class \Drupal\simpletest\KernelTestBase uses AssertContentTrait
Expanded class hierarchy of StorageTestBase
File
- core/
modules/ system/ src/ Tests/ KeyValueStore/ StorageTestBase.php, line 15 - Contains \Drupal\system\Tests\KeyValueStore\StorageTestBase.
Namespace
Drupal\system\Tests\KeyValueStoreView source
abstract class StorageTestBase extends KernelTestBase {
/**
* An array of random stdClass objects.
*
* @var array
*/
protected $objects = array();
/**
* An array of data collection labels.
*
* @var array
*/
protected $collections = array();
/**
* Whether we are using an expirable key/value store.
*
* @var bool
*/
protected $factory = 'keyvalue';
protected function setUp() {
parent::setUp();
// Define two data collections,
$this->collections = array(
0 => 'zero',
1 => 'one',
);
// Create several objects for testing.
for ($i = 0; $i <= 5; $i++) {
$this->objects[$i] = $this
->randomObject();
}
}
/**
* Tests CRUD operations.
*/
public function testCRUD() {
$stores = $this
->createStorage();
// Verify that each store returns its own collection name.
$this
->assertIdentical($stores[0]
->getCollectionName(), $this->collections[0]);
$this
->assertIdentical($stores[1]
->getCollectionName(), $this->collections[1]);
// Verify that an item can be stored.
$stores[0]
->set('foo', $this->objects[0]);
$this
->assertTrue($stores[0]
->has('foo'));
$this
->assertIdenticalObject($this->objects[0], $stores[0]
->get('foo'));
// Verify that the other collection is not affected.
$this
->assertFalse($stores[1]
->has('foo'));
$this
->assertFalse($stores[1]
->get('foo'));
// Verify that an item can be updated.
$stores[0]
->set('foo', $this->objects[1]);
$this
->assertIdenticalObject($this->objects[1], $stores[0]
->get('foo'));
// Verify that the other collection is still not affected.
$this
->assertFalse($stores[1]
->get('foo'));
// Verify that a collection/name pair is unique.
$stores[1]
->set('foo', $this->objects[2]);
$this
->assertIdenticalObject($this->objects[1], $stores[0]
->get('foo'));
$this
->assertIdenticalObject($this->objects[2], $stores[1]
->get('foo'));
// Verify that an item can be deleted.
$stores[0]
->delete('foo');
$this
->assertFalse($stores[0]
->has('foo'));
$this
->assertFalse($stores[0]
->get('foo'));
// Verify that the other collection is not affected.
$this
->assertTrue($stores[1]
->has('foo'));
$this
->assertIdenticalObject($this->objects[2], $stores[1]
->get('foo'));
$stores[1]
->delete('foo');
$this
->assertFalse($stores[1]
->get('foo'));
// Verify that multiple items can be stored.
$values = array(
'foo' => $this->objects[3],
'bar' => $this->objects[4],
);
$stores[0]
->setMultiple($values);
// Verify that multiple items can be retrieved.
$result = $stores[0]
->getMultiple(array(
'foo',
'bar',
));
foreach ($values as $j => $value) {
$this
->assertIdenticalObject($value, $result[$j]);
}
// Verify that the other collection was not affected.
$this
->assertFalse($stores[1]
->get('foo'));
$this
->assertFalse($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]);
$result = $stores[0]
->getAll();
// Not using assertIdentical(), since the order is not defined for getAll().
$this
->assertEqual(count($result), count($values));
foreach ($result as $key => $value) {
$this
->assertEqual($values[$key], $value);
}
// Verify that all items in the other collection are different.
$result = $stores[1]
->getAll();
$this
->assertEqual($result, array(
'foo' => $this->objects[5],
));
// Verify that multiple items can be deleted.
$stores[0]
->deleteMultiple(array_keys($values));
$this
->assertFalse($stores[0]
->get('foo'));
$this
->assertFalse($stores[0]
->get('bar'));
$this
->assertFalse($stores[0]
->getMultiple(array(
'foo',
'bar',
)));
// Verify that deleting no items does not cause an error.
$stores[0]
->deleteMultiple(array());
// Verify that the item in the other collection still exists.
$this
->assertIdenticalObject($this->objects[5], $stores[1]
->get('foo'));
}
/**
* Tests expected behavior for non-existing keys.
*/
public function testNonExistingKeys() {
$stores = $this
->createStorage();
// Verify that a non-existing key returns NULL as value.
$this
->assertNull($stores[0]
->get('foo'));
// Verify that a non-existing key with a default returns the default.
$this
->assertIdentical($stores[0]
->get('foo', 'bar'), 'bar');
// Verify that a FALSE value can be stored.
$stores[0]
->set('foo', FALSE);
$this
->assertIdentical($stores[0]
->get('foo'), FALSE);
// Verify that a deleted key returns NULL as value.
$stores[0]
->delete('foo');
$this
->assertNull($stores[0]
->get('foo'));
// Verify that a non-existing key is not returned when getting multiple keys.
$stores[0]
->set('bar', 'baz');
$values = $stores[0]
->getMultiple(array(
'foo',
'bar',
));
$this
->assertFalse(isset($values['foo']), "Key 'foo' not found.");
$this
->assertIdentical($values['bar'], 'baz');
}
/**
* Tests the setIfNotExists() method.
*/
public function testSetIfNotExists() {
$stores = $this
->createStorage();
$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]));
$this
->assertIdenticalObject($this->objects[0], $stores[0]
->get($key));
// Verify that the other collection is not affected.
$this
->assertFalse($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
->assertIdenticalObject($this->objects[1], $stores[0]
->get($key));
// Verify that the other collection is still not affected.
$this
->assertFalse($stores[1]
->get($key));
}
/**
* Tests the rename operation.
*/
public function testRename() {
$stores = $this
->createStorage();
$store = $stores[0];
$store
->set('old', 'thing');
$this
->assertIdentical($store
->get('old'), 'thing');
$store
->rename('old', 'new');
$this
->assertIdentical($store
->get('new'), 'thing');
$this
->assertNull($store
->get('old'));
}
/**
* Creates storage objects for each collection defined for this class.
*
* Storing the storage objects in a class member variable causes a fatal
* exception in DatabaseStorageExpirableTest, because in that situation
* garbage collection is not triggered until the test class itself is
* destructed, after tearDown() has deleted the database tables. Instead,
* create the storage objects locally in each test using this method.
*
* @see \Drupal\system\Tests\KeyValueStore\DatabaseStorageExpirable
* @see \Drupal\Core\KeyValueStore\DatabaseStorageExpirable::garbageCollection()
*/
protected function createStorage() {
$stores = array();
foreach ($this->collections as $i => $collection) {
$stores[$i] = $this->container
->get($this->factory)
->get($collection);
}
return $stores;
}
}
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. | 2 |
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 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. | |
AssertHelperTrait:: |
protected | function | Casts MarkupInterface objects into strings. | |
KernelTestBase:: |
protected | property | The configuration directories for this test run. | |
KernelTestBase:: |
protected | property | A KeyValueMemoryFactory instance to use when building the container. | |
KernelTestBase:: |
private | property | ||
KernelTestBase:: |
public static | property | Modules to enable. | 192 |
KernelTestBase:: |
protected | property | Array of registered stream wrappers. | |
KernelTestBase:: |
private | property | ||
KernelTestBase:: |
protected | function |
Act on global state information before the environment is altered for a test. Overrides TestBase:: |
|
KernelTestBase:: |
public | function | Sets up the base service container for this test. | 12 |
KernelTestBase:: |
protected | function | Provides the data for setting the default language on the container. | 1 |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
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 a specific table from a module schema definition. | |
KernelTestBase:: |
protected | function | Create and set new configuration directories. | 1 |
KernelTestBase:: |
protected | function | Registers a stream wrapper for this test. | |
KernelTestBase:: |
protected | function | Renders a render array. | |
KernelTestBase:: |
protected | function |
Performs cleanup tasks after each individual test method has been run. Overrides TestBase:: |
|
KernelTestBase:: |
function |
Constructor for Test. Overrides TestBase:: |
||
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. | |
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. | |
SessionTestTrait:: |
protected | property | The name of the session cookie. | |
SessionTestTrait:: |
protected | function | Generates a session cookie name. | |
SessionTestTrait:: |
protected | function | Returns the session name in use on the child site. | |
StorageTestBase:: |
protected | property | An array of data collection labels. | |
StorageTestBase:: |
protected | property | Whether we are using an expirable key/value store. | |
StorageTestBase:: |
protected | property | An array of random stdClass objects. | |
StorageTestBase:: |
protected | function | Creates storage objects for each collection defined for this class. | |
StorageTestBase:: |
protected | function |
Performs setup tasks before each individual test method is run. Overrides KernelTestBase:: |
2 |
StorageTestBase:: |
public | function | Tests CRUD operations. | |
StorageTestBase:: |
public | function | Tests expected behavior for non-existing keys. | |
StorageTestBase:: |
public | function | Tests the rename operation. | |
StorageTestBase:: |
public | function | Tests the setIfNotExists() method. | |
TestBase:: |
protected | property | Assertions thrown in that test case. | |
TestBase:: |
protected | property | The config importer that can used in a test. | 5 |
TestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
TestBase:: |
protected | property | The dependency injection container used in the test. | |
TestBase:: |
protected | property | The database prefix of this test run. | |
TestBase:: |
public | property | Whether to die in case any test assertion fails. | |
TestBase:: |
protected | property | HTTP authentication credentials (<username>:<password>). | |
TestBase:: |
protected | property | HTTP authentication method (specified as a CURLAUTH_* constant). | |
TestBase:: |
protected | property | The DrupalKernel instance used in the test. | 1 |
TestBase:: |
protected | property | The original configuration (variables), if available. | |
TestBase:: |
protected | property | The original configuration (variables). | |
TestBase:: |
protected | property | The original configuration directories. | |
TestBase:: |
protected | property | The original container. | |
TestBase:: |
protected | property | The original file directory, before it was changed for testing purposes. | |
TestBase:: |
protected | property | The original language. | |
TestBase:: |
protected | property | The original database prefix when running inside Simpletest. | |
TestBase:: |
protected | property | The original installation profile. | |
TestBase:: |
protected | property | The name of the session cookie of the test-runner. | |
TestBase:: |
protected | property | The settings array. | |
TestBase:: |
protected | property | The original array of shutdown function callbacks. | 1 |
TestBase:: |
protected | property | The site directory of the original parent site. | |
TestBase:: |
protected | property | The original user, before testing began. | 1 |
TestBase:: |
protected | property | The private file directory for the test environment. | |
TestBase:: |
protected | property | The public file directory for the test environment. | |
TestBase:: |
public | property | Current results of this test case. | |
TestBase:: |
protected | property | The site directory of this test run. | |
TestBase:: |
protected | property | This class is skipped when looking for the source of an assertion. | |
TestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 4 |
TestBase:: |
protected | property | The temporary file directory for the test environment. | |
TestBase:: |
protected | property | The test run ID. | |
TestBase:: |
protected | property | Time limit for the test. | |
TestBase:: |
protected | property | The translation file directory for the test environment. | |
TestBase:: |
public | property | TRUE if verbose debugging is enabled. | |
TestBase:: |
protected | property | Safe class name for use in verbose output filenames. | |
TestBase:: |
protected | property | Directory where verbose output files are put. | |
TestBase:: |
protected | property | URL to the verbose output file directory. | |
TestBase:: |
protected | property | Incrementing identifier for verbose output filenames. | |
TestBase:: |
protected | function | Internal helper: stores the assert. | |
TestBase:: |
protected | function | Check to see if two values are equal. | |
TestBase:: |
protected | function | Asserts that a specific error has been logged to the PHP error log. | |
TestBase:: |
protected | function | Check to see if a value is false. | |
TestBase:: |
protected | function | Check to see if two values are identical. | |
TestBase:: |
protected | function | Checks to see if two objects are identical. | |
TestBase:: |
protected | function | Asserts that no errors have been logged to the PHP error.log thus far. | |
TestBase:: |
protected | function | Check to see if two values are not equal. | |
TestBase:: |
protected | function | Check to see if two values are not identical. | |
TestBase:: |
protected | function | Check to see if a value is not NULL. | |
TestBase:: |
protected | function | Check to see if a value is NULL. | |
TestBase:: |
protected | function | Check to see if a value is not false. | |
TestBase:: |
private | function | Changes the database connection to the prefixed one. | |
TestBase:: |
protected | function | Checks the matching requirements for Test. | 2 |
TestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
TestBase:: |
public | function | Returns a ConfigImporter object to import test importing of configuration. | 5 |
TestBase:: |
public | function | Copies configuration objects from source storage to target storage. | |
TestBase:: |
public static | function | Delete an assertion record by message ID. | |
TestBase:: |
protected | function | Fire an error assertion. | 3 |
TestBase:: |
public | function | Handle errors during test runs. | |
TestBase:: |
protected | function | Handle exceptions. | |
TestBase:: |
protected | function | Fire an assertion that is always negative. | |
TestBase:: |
public static | function | Ensures test files are deletable within file_unmanaged_delete_recursive(). | |
TestBase:: |
public static | function | Converts a list of possible parameters into a stack of permutations. | |
TestBase:: |
protected | function | Cycles through backtrace until the first non-assertion method is found. | |
TestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
TestBase:: |
public static | function | Returns the database connection to the site running Simpletest. | |
TestBase:: |
public | function | Gets the database prefix. | |
TestBase:: |
public | function | Gets the temporary files directory. | |
TestBase:: |
public static | function | Store an assertion from outside the testing context. | |
TestBase:: |
protected | function | Fire an assertion that is always positive. | |
TestBase:: |
private | function | Generates a database prefix for running tests. | |
TestBase:: |
private | function | Prepares the current environment for running the test. | |
TestBase:: |
private | function | Cleans up the test environment and restores the original environment. | |
TestBase:: |
public | function | Run all tests in this class. | 1 |
TestBase:: |
protected | function | Changes in memory settings. | |
TestBase:: |
protected | function | Helper method to store an assertion record in the configured database. | |
TestBase:: |
protected | function | Logs a verbose message in a text file. |