class ConfigStorageTestBase
Same name in other branches
- 9 core/tests/Drupal/KernelTests/Core/Config/Storage/ConfigStorageTestBase.php \Drupal\KernelTests\Core\Config\Storage\ConfigStorageTestBase
- 8.9.x core/tests/Drupal/KernelTests/Core/Config/Storage/ConfigStorageTestBase.php \Drupal\KernelTests\Core\Config\Storage\ConfigStorageTestBase
- 10 core/tests/Drupal/KernelTests/Core/Config/Storage/ConfigStorageTestBase.php \Drupal\KernelTests\Core\Config\Storage\ConfigStorageTestBase
Base class for testing storage operations.
All configuration storages are expected to behave identically in terms of reading, writing, listing, deleting, as well as error handling.
Therefore, storage tests use an uncommon test case class structure; the base class defines the test method(s) to execute, which are identical for all storages. The storage specific test case classes supply the necessary helper methods to interact with the raw/native storage directly.
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\ExtensionListTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait
- class \Drupal\KernelTests\Core\Config\Storage\ConfigStorageTestBase extends \Drupal\KernelTests\KernelTestBase
Expanded class hierarchy of ConfigStorageTestBase
File
-
core/
tests/ Drupal/ KernelTests/ Core/ Config/ Storage/ ConfigStorageTestBase.php, line 21
Namespace
Drupal\KernelTests\Core\Config\StorageView source
abstract class ConfigStorageTestBase extends KernelTestBase {
/**
* @var \Drupal\Core\Config\StorageInterface
*/
protected $storage;
/**
* @var \Drupal\Core\Config\StorageInterface
*/
protected $invalidStorage;
/**
* Tests storage CRUD operations.
*
* @todo Coverage: Trigger PDOExceptions / Database exceptions.
*/
public function testCRUD() : void {
$name = 'config_test.storage';
// Checking whether a non-existing name exists returns FALSE.
$this->assertFalse($this->storage
->exists($name));
// Checking whether readMultiple() works with empty storage.
$this->assertEmpty($this->storage
->readMultiple([
$name,
]));
// readMultiple() accepts an empty array.
$this->assertSame([], $this->storage
->readMultiple([]), 'Empty query should return empty array');
// Reading a non-existing name returns FALSE.
$data = $this->storage
->read($name);
$this->assertFalse($data);
// Writing data returns TRUE and the data has been written.
$data = [
'foo' => 'bar',
];
$result = $this->storage
->write($name, $data);
$this->assertTrue($result);
$raw_data = $this->read($name);
$this->assertSame($data, $raw_data);
// Checking whether an existing name exists returns TRUE.
$this->assertTrue($this->storage
->exists($name));
// Writing the identical data again still returns TRUE.
$result = $this->storage
->write($name, $data);
$this->assertTrue($result);
// Listing all names returns all.
$this->storage
->write('system.performance', []);
$names = $this->storage
->listAll();
$this->assertContains('system.performance', $names);
$this->assertContains($name, $names);
// Listing all names with prefix returns names with that prefix only.
$names = $this->storage
->listAll('config_test.');
$this->assertNotContains('system.performance', $names);
$this->assertContains($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->assertSame($data, $raw_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->assertTrue($result);
// Deleting a non-existing name returns FALSE.
$result = $this->storage
->delete($name);
$this->assertFalse($result);
// Deleting all names with prefix deletes the appropriate data and returns
// TRUE.
$files = [
'config_test.test.biff',
'config_test.test.bang',
'config_test.test.pow',
];
foreach ($files as $name) {
$this->storage
->write($name, $data);
}
// Test that deleting a prefix that returns no configuration returns FALSE
// because nothing is deleted.
$this->assertFalse($this->storage
->deleteAll('some_thing_that_cannot_exist'));
$result = $this->storage
->deleteAll('config_test.');
$names = $this->storage
->listAll('config_test.');
$this->assertTrue($result);
$this->assertSame([], $names);
// Test renaming an object that does not exist returns FALSE.
$this->assertFalse($this->storage
->rename('config_test.storage_does_not_exist', 'config_test.storage_does_not_exist_rename'));
// Test renaming to an object that already returns FALSE.
$data = [
'foo' => 'bar',
];
$this->assertTrue($this->storage
->write($name, $data));
$this->assertFalse($this->storage
->rename('config_test.storage_does_not_exist', $name));
}
/**
* Tests an invalid storage.
*/
public function testInvalidStorage() : void {
$name = 'config_test.storage';
// Write something to the valid storage to prove that the storages do not
// pollute one another.
$data = [
'foo' => 'bar',
];
$result = $this->storage
->write($name, $data);
$this->assertTrue($result);
$raw_data = $this->read($name);
$this->assertSame($data, $raw_data);
// Reading from a non-existing storage bin returns FALSE.
$result = $this->invalidStorage
->read($name);
$this->assertFalse($result);
// 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) {
// An exception occurred as expected; just continue.
}
// Listing on a non-existing storage bin returns an empty array.
$result = $this->invalidStorage
->listAll();
$this->assertSame([], $result);
// Getting all collections on a non-existing storage bin return an empty
// array.
$this->assertSame([], $this->invalidStorage
->getAllCollectionNames());
// Writing to a non-existing storage bin creates the bin.
$this->invalidStorage
->write($name, [
'foo' => 'bar',
]);
$result = $this->invalidStorage
->read($name);
$this->assertSame([
'foo' => 'bar',
], $result);
}
/**
* Tests storage writing and reading data preserving data type.
*/
public function testDataTypes() : void {
$name = 'config_test.types';
$data = [
'array' => [],
'boolean' => TRUE,
'exp' => 1.2E+34,
'float' => 3.14159,
'hex' => 0xc,
'int' => 99,
'octal' => 0775,
'string' => 'string',
'string_int' => '1',
];
$result = $this->storage
->write($name, $data);
$this->assertTrue($result);
$read_data = $this->storage
->read($name);
$this->assertSame($data, $read_data);
}
/**
* Tests that the storage supports collections.
*/
public function testCollection() : void {
$name = 'config_test.storage';
$data = [
'foo' => 'bar',
];
$result = $this->storage
->write($name, $data);
$this->assertTrue($result);
$this->assertSame($data, $this->storage
->read($name));
// Create configuration in a new collection.
$new_storage = $this->storage
->createCollection('collection.sub.new');
$this->assertFalse($new_storage->exists($name));
$this->assertEquals([], $new_storage->listAll());
$this->assertFalse($new_storage->delete($name));
$this->assertFalse($new_storage->deleteAll('config_test.'));
$this->assertFalse($new_storage->deleteAll());
$this->assertFalse($new_storage->rename($name, 'config_test.another_name'));
$new_storage->write($name, $data);
$this->assertTrue($result);
$this->assertSame($data, $new_storage->read($name));
$this->assertEquals([
$name,
], $new_storage->listAll());
$this->assertTrue($new_storage->exists($name));
$new_data = [
'foo' => 'baz',
];
$new_storage->write($name, $new_data);
$this->assertTrue($result);
$this->assertSame($new_data, $new_storage->read($name));
// Create configuration in another collection.
$another_storage = $this->storage
->createCollection('collection.sub.another');
$this->assertFalse($another_storage->exists($name));
$this->assertEquals([], $another_storage->listAll());
$another_storage->write($name, $new_data);
$this->assertTrue($result);
$this->assertSame($new_data, $another_storage->read($name));
$this->assertEquals([
$name,
], $another_storage->listAll());
$this->assertTrue($another_storage->exists($name));
// Create configuration in yet another collection.
$alt_storage = $this->storage
->createCollection('alternate');
$alt_storage->write($name, $new_data);
$this->assertTrue($result);
$this->assertSame($new_data, $alt_storage->read($name));
// Switch back to the collection-less mode and check the data still exists
// add has not been touched.
$this->assertSame($data, $this->storage
->read($name));
// Check that the getAllCollectionNames() method works.
$this->assertSame([
'alternate',
'collection.sub.another',
'collection.sub.new',
], $this->storage
->getAllCollectionNames());
// Check that the collections are removed when they are empty.
$alt_storage->delete($name);
$this->assertSame([
'collection.sub.another',
'collection.sub.new',
], $this->storage
->getAllCollectionNames());
// Create configuration in collection called 'collection'. This ensures that
// FileStorage's collection storage works regardless of its use of
// subdirectories.
$parent_storage = $this->storage
->createCollection('collection');
$this->assertFalse($parent_storage->exists($name));
$this->assertEquals([], $parent_storage->listAll());
$parent_storage->write($name, $new_data);
$this->assertTrue($result);
$this->assertSame($new_data, $parent_storage->read($name));
$this->assertEquals([
$name,
], $parent_storage->listAll());
$this->assertTrue($parent_storage->exists($name));
$this->assertSame([
'collection',
'collection.sub.another',
'collection.sub.new',
], $this->storage
->getAllCollectionNames());
$parent_storage->deleteAll();
$this->assertSame([
'collection.sub.another',
'collection.sub.new',
], $this->storage
->getAllCollectionNames());
// Test operations on a collection emptied through deletion.
$this->assertFalse($parent_storage->exists($name));
$this->assertEquals([], $parent_storage->listAll());
$this->assertFalse($parent_storage->delete($name));
$this->assertFalse($parent_storage->deleteAll('config_test.'));
$this->assertFalse($parent_storage->deleteAll());
$this->assertFalse($parent_storage->rename($name, 'config_test.another_name'));
// Check that the having an empty collection-less storage does not break
// anything. Before deleting check that the previous delete did not affect
// data in another collection.
$this->assertSame($data, $this->storage
->read($name));
$this->storage
->delete($name);
$this->assertSame([
'collection.sub.another',
'collection.sub.new',
], $this->storage
->getAllCollectionNames());
}
protected abstract function read($name);
protected abstract function insert($name, $data);
protected abstract function update($name, $data);
protected abstract function delete($name);
}
Members
Title Sort descending | 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 raw text IS NOT found escaped on 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. | ||
ConfigStorageTestBase::$invalidStorage | protected | property | |||
ConfigStorageTestBase::$storage | protected | property | |||
ConfigStorageTestBase::delete | abstract protected | function | 6 | ||
ConfigStorageTestBase::insert | abstract protected | function | 6 | ||
ConfigStorageTestBase::read | abstract protected | function | 6 | ||
ConfigStorageTestBase::testCollection | public | function | Tests that the storage supports collections. | ||
ConfigStorageTestBase::testCRUD | public | function | Tests storage CRUD operations. | ||
ConfigStorageTestBase::testDataTypes | public | function | Tests storage writing and reading data preserving data type. | ||
ConfigStorageTestBase::testInvalidStorage | public | function | Tests an invalid storage. | 4 | |
ConfigStorageTestBase::update | abstract protected | function | 6 | ||
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. | ||
ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. | ||
ExpectDeprecationTrait::getCallableName | private static | function | Returns a callable as a string suitable for inclusion in a message. | ||
ExpectDeprecationTrait::setUpErrorHandler | public | function | Sets up the test error handler. | ||
ExpectDeprecationTrait::tearDownErrorHandler | public | function | Tears down the test error handler. | ||
ExtensionListTestTrait::getModulePath | protected | function | Gets the path for the specified module. | ||
ExtensionListTestTrait::getThemePath | protected | function | Gets the path for the specified theme. | ||
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. | 6 | |
KernelTestBase::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | 4 | |
KernelTestBase::$container | protected | property | |||
KernelTestBase::$databasePrefix | protected | property | |||
KernelTestBase::$keyValue | protected | property | The key_value service that must persist between container rebuilds. | ||
KernelTestBase::$modules | protected static | property | Modules to install. | 562 | |
KernelTestBase::$root | protected | property | The app root. | ||
KernelTestBase::$siteDirectory | protected | property | |||
KernelTestBase::$strictConfigSchema | protected | property | Set to TRUE to strict check all configuration saved. | 9 | |
KernelTestBase::$usesSuperUserAccessPolicy | protected | property | Set to TRUE to make user 1 a super user. | 3 | |
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 | protected | function | Bootstraps a kernel for a test. | 1 | |
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. | 1 | |
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 install. | ||
KernelTestBase::getModulesToEnable | private static | function | Returns the modules to install 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::register | public | function | Registers test-specific services. | Overrides ServiceProviderInterface::register | 27 |
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::setUp | protected | function | 410 | ||
KernelTestBase::setUpBeforeClass | public static | function | 1 | ||
KernelTestBase::setUpFilesystem | protected | function | Sets up the filesystem, so things like the file directory. | 2 | |
KernelTestBase::tearDown | protected | function | 7 | ||
KernelTestBase::tearDownCloseDatabaseConnection | public | function | Additional tear down method to close the connection at the end. | ||
KernelTestBase::vfsDump | protected | function | Dumps the current state of the virtual filesystem to STDOUT. | ||
KernelTestBase::__construct | public | function | |||
KernelTestBase::__sleep | public | function | Prevents serializing any properties. | ||
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. | ||
StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | ||
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.