class ConfigCRUDTest in Drupal 9
Same name and namespace in other branches
- 8 core/tests/Drupal/KernelTests/Core/Config/ConfigCRUDTest.php \Drupal\KernelTests\Core\Config\ConfigCRUDTest
Tests CRUD operations on configuration objects.
@group config
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\KernelTests\Core\Config\ConfigCRUDTest
Expanded class hierarchy of ConfigCRUDTest
File
- core/
tests/ Drupal/ KernelTests/ Core/ Config/ ConfigCRUDTest.php, line 19
Namespace
Drupal\KernelTests\Core\ConfigView source
class ConfigCRUDTest extends KernelTestBase {
/**
* Exempt from strict schema checking.
*
* @see \Drupal\Core\Config\Development\ConfigSchemaChecker
*
* @var bool
*/
protected $strictConfigSchema = FALSE;
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = [
'system',
];
/**
* Tests CRUD operations.
*/
public function testCRUD() {
$event_dispatcher = $this->container
->get('event_dispatcher');
$typed_config_manager = $this->container
->get('config.typed');
$storage = $this->container
->get('config.storage');
$collection_storage = $storage
->createCollection('test_collection');
$config_factory = $this->container
->get('config.factory');
$name = 'config_test.crud';
// Create a new configuration object in the default collection.
$config = $this
->config($name);
$this
->assertTrue($config
->isNew());
$config
->set('value', 'initial');
$config
->save();
$this
->assertFalse($config
->isNew());
// Verify the active configuration contains the saved value.
$actual_data = $storage
->read($name);
$this
->assertSame([
'value' => 'initial',
], $actual_data);
// Verify the config factory contains the saved value.
$actual_data = $config_factory
->get($name)
->getRawData();
$this
->assertSame([
'value' => 'initial',
], $actual_data);
// Create another instance of the config object using a custom collection.
$collection_config = new Config($name, $collection_storage, $event_dispatcher, $typed_config_manager);
$collection_config
->set('value', 'overridden');
$collection_config
->save();
// Verify that the config factory still returns the right value, from the
// config instance in the default collection.
$actual_data = $config_factory
->get($name)
->getRawData();
$this
->assertSame([
'value' => 'initial',
], $actual_data);
// Update the configuration object instance.
$config
->set('value', 'instance-update');
$config
->save();
$this
->assertFalse($config
->isNew());
// Verify the active configuration contains the updated value.
$actual_data = $storage
->read($name);
$this
->assertSame([
'value' => 'instance-update',
], $actual_data);
// Verify a call to $this->config() immediately returns the updated value.
$new_config = $this
->config($name);
$this
->assertSame($config
->get(), $new_config
->get());
$this
->assertFalse($config
->isNew());
// Pollute the config factory static cache.
$config_factory
->getEditable($name);
// Delete the config object that uses a custom collection. This should not
// affect the instance returned by the config factory which depends on the
// default collection storage.
$collection_config
->delete();
$actual_config = $config_factory
->get($name);
$this
->assertFalse($actual_config
->isNew());
$this
->assertSame([
'value' => 'instance-update',
], $actual_config
->getRawData());
// Delete the configuration object.
$config
->delete();
// Verify the configuration object is empty.
$this
->assertSame([], $config
->get());
$this
->assertTrue($config
->isNew());
// Verify that all copies of the configuration has been removed from the
// static cache.
$this
->assertTrue($config_factory
->getEditable($name)
->isNew());
// Verify the active configuration contains no value.
$actual_data = $storage
->read($name);
$this
->assertFalse($actual_data);
// Verify $this->config() returns no data.
$new_config = $this
->config($name);
$this
->assertSame($config
->get(), $new_config
->get());
$this
->assertTrue($config
->isNew());
// Re-create the configuration object.
$config
->set('value', 're-created');
$config
->save();
$this
->assertFalse($config
->isNew());
// Verify the active configuration contains the updated value.
$actual_data = $storage
->read($name);
$this
->assertSame([
'value' => 're-created',
], $actual_data);
// Verify a call to $this->config() immediately returns the updated value.
$new_config = $this
->config($name);
$this
->assertSame($config
->get(), $new_config
->get());
$this
->assertFalse($config
->isNew());
// Rename the configuration object.
$new_name = 'config_test.crud_rename';
$this->container
->get('config.factory')
->rename($name, $new_name);
$renamed_config = $this
->config($new_name);
$this
->assertSame($config
->get(), $renamed_config
->get());
$this
->assertFalse($renamed_config
->isNew());
// Ensure that the old configuration object is removed from both the cache
// and the configuration storage.
$config = $this
->config($name);
$this
->assertSame([], $config
->get());
$this
->assertTrue($config
->isNew());
// Test renaming when config.factory does not have the object in its static
// cache.
$name = 'config_test.crud_rename';
// Pollute the non-overrides static cache.
$config_factory
->getEditable($name);
// Pollute the overrides static cache.
$config = $config_factory
->get($name);
// Rename and ensure that happened properly.
$new_name = 'config_test.crud_rename_no_cache';
$config_factory
->rename($name, $new_name);
$renamed_config = $config_factory
->get($new_name);
$this
->assertSame($config
->get(), $renamed_config
->get());
$this
->assertFalse($renamed_config
->isNew());
// Ensure the overrides static cache has been cleared.
$this
->assertTrue($config_factory
->get($name)
->isNew());
// Ensure the non-overrides static cache has been cleared.
$this
->assertTrue($config_factory
->getEditable($name)
->isNew());
// Merge data into the configuration object.
$new_config = $this
->config($new_name);
$expected_values = [
'value' => 'herp',
'404' => 'derp',
];
$new_config
->merge($expected_values);
$new_config
->save();
$this
->assertSame($expected_values['value'], $new_config
->get('value'));
$this
->assertSame($expected_values['404'], $new_config
->get('404'));
// Test that getMultiple() does not return new config objects that were
// previously accessed with get()
$new_config = $config_factory
->get('non_existing_key');
$this
->assertTrue($new_config
->isNew());
$this
->assertCount(0, $config_factory
->loadMultiple([
'non_existing_key',
]), 'loadMultiple() does not return new objects');
}
/**
* Tests the validation of configuration object names.
*/
public function testNameValidation() {
// Verify that an object name without namespace causes an exception.
$name = 'nonamespace';
try {
$this
->config($name)
->save();
$this
->fail('Expected ConfigNameException was thrown for a name without a namespace.');
} catch (\Exception $e) {
$this
->assertInstanceOf(ConfigNameException::class, $e);
}
// Verify that a name longer than the maximum length causes an exception.
$name = 'config_test.herman_melville.moby_dick_or_the_whale.harper_1851.now_small_fowls_flew_screaming_over_the_yet_yawning_gulf_a_sullen_white_surf_beat_against_its_steep_sides_then_all_collapsed_and_the_great_shroud_of_the_sea_rolled_on_as_it_rolled_five_thousand_years_ago';
try {
$this
->config($name)
->save();
$this
->fail('Expected ConfigNameException was thrown for a name longer than Config::MAX_NAME_LENGTH.');
} catch (\Exception $e) {
$this
->assertInstanceOf(ConfigNameException::class, $e);
}
// Verify that disallowed characters in the name cause an exception.
$characters = $test_characters = [
':',
'?',
'*',
'<',
'>',
'"',
'\'',
'/',
'\\',
];
foreach ($test_characters as $i => $c) {
try {
$name = 'namespace.object' . $c;
$config = $this
->config($name);
$config
->save();
} catch (ConfigNameException $e) {
unset($test_characters[$i]);
}
}
$this
->assertTrue(empty($test_characters), new FormattableMarkup('Expected ConfigNameException was thrown for all invalid name characters: @characters', [
'@characters' => implode(' ', $characters),
]));
// Verify that a valid config object name can be saved.
$name = 'namespace.object';
try {
$config = $this
->config($name);
$config
->save();
} catch (ConfigNameException $e) {
$this
->fail('ConfigNameException was not thrown for a valid object name.');
}
}
/**
* Tests the validation of configuration object values.
*/
public function testValueValidation() {
// Verify that setData() will catch dotted keys.
try {
$this
->config('namespace.object')
->setData([
'key.value' => 12,
])
->save();
$this
->fail('Expected ConfigValueException was thrown from setData() for value with dotted keys.');
} catch (\Exception $e) {
$this
->assertInstanceOf(ConfigValueException::class, $e);
}
// Verify that set() will catch dotted keys.
try {
$this
->config('namespace.object')
->set('foo', [
'key.value' => 12,
])
->save();
$this
->fail('Expected ConfigValueException was thrown from set() for value with dotted keys.');
} catch (\Exception $e) {
$this
->assertInstanceOf(ConfigValueException::class, $e);
}
}
/**
* Tests data type handling.
*/
public function testDataTypes() {
\Drupal::service('module_installer')
->install([
'config_test',
]);
$storage = new DatabaseStorage($this->container
->get('database'), 'config');
$name = 'config_test.types';
$config = $this
->config($name);
// Verify variable data types are intact.
$data = [
'array' => [],
'boolean' => TRUE,
'exp' => 1.2E+34,
'float' => 3.14159,
'float_as_integer' => (double) 1,
'hex' => 0xc,
'int' => 99,
// Symfony 5.1's YAML parser issues a deprecation when reading octal with
// a leading zero, to comply with YAML 1.2. However PECL YAML is still
// YAML 1.1 compliant.
// @todo: revisit parsing of octal once PECL YAML supports YAML 1.2.
// See https://www.drupal.org/project/drupal/issues/3205480
// 'octal' => 0775,
'string' => 'string',
'string_int' => '1',
];
$data['_core']['default_config_hash'] = Crypt::hashBase64(serialize($data));
$this
->assertSame($data, $config
->get());
// Re-set each key using Config::set().
foreach ($data as $key => $value) {
$config
->set($key, $value);
}
$config
->save();
$this
->assertSame($data, $config
->get());
// Assert the data against the file storage.
$this
->assertSame($data, $storage
->read($name));
// Set data using config::setData().
$config
->setData($data)
->save();
$this
->assertSame($data, $config
->get());
$this
->assertSame($data, $storage
->read($name));
// Test that schema type enforcement can be overridden by trusting the data.
$this
->assertSame(99, $config
->get('int'));
$config
->set('int', '99')
->save(TRUE);
$this
->assertSame('99', $config
->get('int'));
// Test that re-saving without testing the data enforces the schema type.
$config
->save();
$this
->assertSame($data, $config
->get());
// Test that setting an unsupported type for a config object with a schema
// fails.
try {
$config
->set('stream', fopen(__FILE__, 'r'))
->save();
$this
->fail('No Exception thrown upon saving invalid data type.');
} catch (UnsupportedDataTypeConfigException $e) {
// Expected exception; just continue testing.
}
// Test that setting an unsupported type for a config object with no schema
// also fails.
$typed_config_manager = $this->container
->get('config.typed');
$config_name = 'config_test.no_schema';
$config = $this
->config($config_name);
$this
->assertFalse($typed_config_manager
->hasConfigSchema($config_name));
try {
$config
->set('stream', fopen(__FILE__, 'r'))
->save();
$this
->fail('No Exception thrown upon saving invalid data type.');
} catch (UnsupportedDataTypeConfigException $e) {
// Expected exception; just continue testing.
}
}
}
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. | 1 |
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 with the visible text 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. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
ConfigCRUDTest:: |
protected static | property |
Modules to enable. Overrides KernelTestBase:: |
|
ConfigCRUDTest:: |
protected | property |
Exempt from strict schema checking. Overrides KernelTestBase:: |
|
ConfigCRUDTest:: |
public | function | Tests CRUD operations. | |
ConfigCRUDTest:: |
public | function | Tests data type handling. | |
ConfigCRUDTest:: |
public | function | Tests the validation of configuration object names. | |
ConfigCRUDTest:: |
public | function | Tests the validation of configuration object values. | |
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
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:: |
protected | property | ||
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 3 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
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 database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
24 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
protected | function | 334 | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 4 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
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. | 1 |
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. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. |