Base class for testing storage controller operations.
All configuration storage controllers are expected to behave identically in terms of reading, writing, listing, deleting, as well as error handling.
Therefore, storage controller tests use a uncommon test case class structure; the base class defines the test method(s) to execute, which are identical for all storage controllers. The storage controller specific test case classes supply the necessary helper methods to interact with the raw/native storage directly.
Expanded class hierarchy of ConfigStorageTestBase
abstract class ConfigStorageTestBase extends DrupalUnitTestBase {
/**
* Tests storage controller CRUD operations.
*
* @todo Coverage: Trigger PDOExceptions / Database exceptions.
* @todo Coverage: Trigger Yaml's ParseException and DumpException.
*/
function testCRUD() {
$name = 'config_test.storage';
// Checking whether a non-existing name exists returns FALSE.
$this
->assertIdentical($this->storage
->exists($name), FALSE);
// Reading a non-existing name returns FALSE.
$data = $this->storage
->read($name);
$this
->assertIdentical($data, FALSE);
// Reading a name containing non-decodeable data returns FALSE.
$this
->insert($name, '');
$data = $this->storage
->read($name);
$this
->assertIdentical($data, FALSE);
$this
->update($name, 'foo');
$data = $this->storage
->read($name);
$this
->assertIdentical($data, FALSE);
$this
->delete($name);
// Writing data returns TRUE and the data has been written.
$data = array(
'foo' => 'bar',
);
$result = $this->storage
->write($name, $data);
$this
->assertIdentical($result, TRUE);
$raw_data = $this
->read($name);
$this
->assertIdentical($raw_data, $data);
// Checking whether an existing name exists returns TRUE.
$this
->assertIdentical($this->storage
->exists($name), TRUE);
// Writing the identical data again still returns TRUE.
$result = $this->storage
->write($name, $data);
$this
->assertIdentical($result, TRUE);
// Listing all names returns all.
$names = $this->storage
->listAll();
$this
->assertTrue(in_array('system.performance', $names));
$this
->assertTrue(in_array($name, $names));
// Listing all names with prefix returns names with that prefix only.
$names = $this->storage
->listAll('config_test.');
$this
->assertFalse(in_array('system.performance', $names));
$this
->assertTrue(in_array($name, $names));
// Rename the configuration storage object.
$new_name = 'config_test.storage_rename';
$this->storage
->rename($name, $new_name);
$raw_data = $this
->read($new_name);
$this
->assertIdentical($raw_data, $data);
// Rename it back so further tests work.
$this->storage
->rename($new_name, $name);
// Deleting an existing name returns TRUE.
$result = $this->storage
->delete($name);
$this
->assertIdentical($result, TRUE);
// Deleting a non-existing name returns FALSE.
$result = $this->storage
->delete($name);
$this
->assertIdentical($result, FALSE);
// Reading from a non-existing storage bin returns FALSE.
$result = $this->invalidStorage
->read($name);
$this
->assertIdentical($result, FALSE);
// Deleting all names with prefix deletes the appropriate data and returns
// TRUE.
$files = array(
'config_test.test.biff',
'config_test.test.bang',
'config_test.test.pow',
);
foreach ($files as $name) {
$this->storage
->write($name, $data);
}
$result = $this->storage
->deleteAll('config_test.');
$names = $this->storage
->listAll('config_test.');
$this
->assertIdentical($result, TRUE);
$this
->assertIdentical($names, array());
// Writing to a non-existing storage bin throws an exception.
try {
$this->invalidStorage
->write($name, array(
'foo' => 'bar',
));
$this
->fail('Exception not thrown upon writing to a non-existing storage bin.');
} catch (\Exception $e) {
$class = get_class($e);
$this
->pass($class . ' thrown upon writing to a non-existing storage bin.');
}
// Deleting from a non-existing storage bin throws an exception.
try {
$this->invalidStorage
->delete($name);
$this
->fail('Exception not thrown upon deleting from a non-existing storage bin.');
} catch (\Exception $e) {
$class = get_class($e);
$this
->pass($class . ' thrown upon deleting from a non-existing storage bin.');
}
// Listing on a non-existing storage bin throws an exception.
try {
$this->invalidStorage
->listAll();
$this
->fail('Exception not thrown upon listing from a non-existing storage bin.');
} catch (\Exception $e) {
$class = get_class($e);
$this
->pass($class . ' thrown upon listing from a non-existing storage bin.');
}
// Test renaming an object that does not exist throws an exception.
try {
$this->storage
->rename('config_test.storage_does_not_exist', 'config_test.storage_does_not_exist_rename');
} catch (\Exception $e) {
$class = get_class($e);
$this
->pass($class . ' thrown upon renaming a nonexistent storage bin.');
}
// Test renaming to an object that already exists throws an exception.
try {
$this->storage
->rename('system.cron', 'system.performance');
} catch (\Exception $e) {
$class = get_class($e);
$this
->pass($class . ' thrown upon renaming a nonexistent storage bin.');
}
}
protected abstract function read($name);
protected abstract function insert($name, $data);
protected abstract function update($name, $data);
protected abstract function delete($name);
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigStorageTestBase:: |
function | Tests storage controller CRUD operations. | ||
ConfigStorageTestBase:: |
abstract protected | function | 2 | |
ConfigStorageTestBase:: |
abstract protected | function | 2 | |
ConfigStorageTestBase:: |
abstract protected | function | 2 | |
ConfigStorageTestBase:: |
abstract protected | function | 2 | |
DrupalUnitTestBase:: |
function |
Overrides \Drupal\simpletest\UnitTestBase::__construct(). Overrides UnitTestBase:: |
||
DrupalUnitTestBase:: |
protected | function |
Sets up Drupal unit test environment. Overrides UnitTestBase:: |
44 |
DrupalUnitTestBase:: |
protected | function |
Deletes created files, database tables, and reverts all environment changes. Overrides TestBase:: |
2 |
DrupalUnitTestBase:: |
public | function | Sets up the base service container for this test. | 1 |
DrupalUnitTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
DrupalUnitTestBase:: |
protected | function | Installs a specific table from a module schema definition. | |
DrupalUnitTestBase:: |
protected | function | Enables modules for this test. | |
DrupalUnitTestBase:: |
protected | function | Disables modules for this test. | |
TestBase:: |
protected | function | Checks the matching requirements for Test. | 4 |
TestBase:: |
protected | function | Internal helper: stores the assert. | |
TestBase:: |
public static | function | Store an assertion from outside the testing context. | |
TestBase:: |
public static | function | Delete an assertion record by message ID. | |
TestBase:: |
public static | function | Returns the database connection to the site running Simpletest. | |
TestBase:: |
protected | function | Cycles through backtrace until the first non-assertion method is found. | |
TestBase:: |
protected | function | Check to see if a value is not false (not an empty string, 0, NULL, or FALSE). | |
TestBase:: |
protected | function | Check to see if a value is false (an empty string, 0, NULL, or FALSE). | |
TestBase:: |
protected | function | Check to see if a value is NULL. | |
TestBase:: |
protected | function | Check to see if a value is not NULL. | |
TestBase:: |
protected | function | Check to see if two values are equal. | |
TestBase:: |
protected | function | Check to see if two values are not equal. | |
TestBase:: |
protected | function | Check to see if two values are identical. | |
TestBase:: |
protected | function | Check to see if two values are not identical. | |
TestBase:: |
protected | function | Checks to see if two objects are identical. | |
TestBase:: |
protected | function | Fire an assertion that is always positive. | |
TestBase:: |
protected | function | Fire an assertion that is always negative. | |
TestBase:: |
protected | function | Fire an error assertion. | 1 |
TestBase:: |
protected | function | Logs verbose message in a text file. | |
TestBase:: |
public | function | Run all tests in this class. | |
TestBase:: |
protected | function | Generates a database prefix for running tests. | |
TestBase:: |
protected | function | Changes the database connection to the prefixed one. | |
TestBase:: |
protected | function | Prepares the current environment for running the test. | |
TestBase:: |
protected | function | Create and set new configuration directories. | 1 |
TestBase:: |
protected | function | Rebuild drupal_container(). | 1 |
TestBase:: |
public | function | Handle errors during test runs. | |
TestBase:: |
protected | function | Handle exceptions. | |
TestBase:: |
protected | function | Changes in memory settings. | |
TestBase:: |
public static | function | Generates a random string of ASCII characters of codes 32 to 126. | |
TestBase:: |
public static | function | Generates a random string containing letters and numbers. | |
TestBase:: |
public static | function | Generates a random PHP object. | |
TestBase:: |
public static | function | Converts a list of possible parameters into a stack of permutations. | |
TestBase:: |
public static | function | Ensures test files are deletable within file_unmanaged_delete_recursive(). | |
TestBase:: |
public | function | Returns a ConfigImporter object to import test importing of configuration. | 1 |
TestBase:: |
public | function | Copies configuration objects from source storage to target storage. | |
DrupalUnitTestBase:: |
public static | property | Modules to enable. | 51 |
DrupalUnitTestBase:: |
private | property | ||
DrupalUnitTestBase:: |
private | property | ||
DrupalUnitTestBase:: |
private | property | ||
DrupalUnitTestBase:: |
protected | property | A KeyValueMemoryFactory instance to use when building the container. | |
UnitTestBase:: |
protected | property | ||
TestBase:: |
protected | property | The test run ID. | |
TestBase:: |
protected | property | The database prefix of this test run. | |
TestBase:: |
protected | property | The original file directory, before it was changed for testing purposes. | |
TestBase:: |
protected | property | Time limit for the test. | |
TestBase:: |
public | property | Current results of this test case. | |
TestBase:: |
protected | property | Assertions thrown in that test case. | |
TestBase:: |
protected | property | This class is skipped when looking for the source of an assertion. | |
TestBase:: |
protected | property | Flag to indicate whether the test has been set up. | |
TestBase:: |
protected | property | ||
TestBase:: |
protected | property | ||
TestBase:: |
protected | property | TRUE if verbose debugging is enabled. | |
TestBase:: |
protected | property | Incrementing identifier for verbose output filenames. | |
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 | The original database prefix when running inside Simpletest. | |
TestBase:: |
protected | property | URL to the verbose output file directory. | |
TestBase:: |
protected | property | The settings array. | |
TestBase:: |
protected | property | The public file directory for the test environment. | |
TestBase:: |
public | property | Whether to die in case any test assertion fails. | |
TestBase:: |
protected | property | The dependency injection container used in the test. | 1 |
TestBase:: |
protected | property | The config importer that can used in a test. | 1 |