class ConfigCRUDTest in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/config/src/Tests/ConfigCRUDTest.php \Drupal\config\Tests\ConfigCRUDTest
Tests CRUD operations on configuration objects.
@group config
Hierarchy
- class \Drupal\simpletest\TestBase uses AssertHelperTrait, RandomGeneratorTrait, SessionTestTrait
- class \Drupal\simpletest\KernelTestBase uses AssertContentTrait
- class \Drupal\config\Tests\ConfigCRUDTest
- class \Drupal\simpletest\KernelTestBase uses AssertContentTrait
Expanded class hierarchy of ConfigCRUDTest
File
- core/
modules/ config/ src/ Tests/ ConfigCRUDTest.php, line 23 - Contains \Drupal\config\Tests\ConfigCRUDTest.
Namespace
Drupal\config\TestsView source
class ConfigCRUDTest extends KernelTestBase {
/**
* Exempt from strict schema checking.
*
* @see \Drupal\Core\Config\Testing\ConfigSchemaChecker
*
* @var bool
*/
protected $strictConfigSchema = FALSE;
/**
* Modules to enable.
*
* @var array
*/
public static $modules = array(
'system',
);
/**
* Tests CRUD operations.
*/
function testCRUD() {
$storage = $this->container
->get('config.storage');
$config_factory = $this->container
->get('config.factory');
$name = 'config_test.crud';
$config = $this
->config($name);
$this
->assertIdentical($config
->isNew(), TRUE);
// Create a new configuration object.
$config
->set('value', 'initial');
$config
->save();
$this
->assertIdentical($config
->isNew(), FALSE);
// Verify the active configuration contains the saved value.
$actual_data = $storage
->read($name);
$this
->assertIdentical($actual_data, array(
'value' => 'initial',
));
// Update the configuration object instance.
$config
->set('value', 'instance-update');
$config
->save();
$this
->assertIdentical($config
->isNew(), FALSE);
// Verify the active configuration contains the updated value.
$actual_data = $storage
->read($name);
$this
->assertIdentical($actual_data, array(
'value' => 'instance-update',
));
// Verify a call to $this->config() immediately returns the updated value.
$new_config = $this
->config($name);
$this
->assertIdentical($new_config
->get(), $config
->get());
$this
->assertIdentical($config
->isNew(), FALSE);
// Pollute the config factory static cache.
$config_factory
->getEditable($name);
// Delete the configuration object.
$config
->delete();
// Verify the configuration object is empty.
$this
->assertIdentical($config
->get(), array());
$this
->assertIdentical($config
->isNew(), TRUE);
// Verify that all copies of the configuration has been removed from the
// static cache.
$this
->assertIdentical($config_factory
->getEditable($name)
->isNew(), TRUE);
// Verify the active configuration contains no value.
$actual_data = $storage
->read($name);
$this
->assertIdentical($actual_data, FALSE);
// Verify $this->config() returns no data.
$new_config = $this
->config($name);
$this
->assertIdentical($new_config
->get(), $config
->get());
$this
->assertIdentical($config
->isNew(), TRUE);
// Re-create the configuration object.
$config
->set('value', 're-created');
$config
->save();
$this
->assertIdentical($config
->isNew(), FALSE);
// Verify the active configuration contains the updated value.
$actual_data = $storage
->read($name);
$this
->assertIdentical($actual_data, array(
'value' => 're-created',
));
// Verify a call to $this->config() immediately returns the updated value.
$new_config = $this
->config($name);
$this
->assertIdentical($new_config
->get(), $config
->get());
$this
->assertIdentical($config
->isNew(), FALSE);
// 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
->assertIdentical($renamed_config
->get(), $config
->get());
$this
->assertIdentical($renamed_config
->isNew(), FALSE);
// Ensure that the old configuration object is removed from both the cache
// and the configuration storage.
$config = $this
->config($name);
$this
->assertIdentical($config
->get(), array());
$this
->assertIdentical($config
->isNew(), TRUE);
// 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
->assertIdentical($renamed_config
->get(), $config
->get());
$this
->assertIdentical($renamed_config
->isNew(), FALSE);
// Ensure the overrides static cache has been cleared.
$this
->assertIdentical($config_factory
->get($name)
->isNew(), TRUE);
// Ensure the non-overrides static cache has been cleared.
$this
->assertIdentical($config_factory
->getEditable($name)
->isNew(), TRUE);
// Merge data into the configuration object.
$new_config = $this
->config($new_name);
$expected_values = array(
'value' => 'herp',
'404' => 'derp',
);
$new_config
->merge($expected_values);
$new_config
->save();
$this
->assertIdentical($new_config
->get('value'), $expected_values['value']);
$this
->assertIdentical($new_config
->get('404'), $expected_values['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
->assertEqual(0, count($config_factory
->loadMultiple([
'non_existing_key',
])), 'loadMultiple() does not return new objects');
}
/**
* Tests the validation of configuration object names.
*/
function testNameValidation() {
// Verify that an object name without namespace causes an exception.
$name = 'nonamespace';
$message = 'Expected ConfigNameException was thrown for a name without a namespace.';
try {
$this
->config($name)
->save();
$this
->fail($message);
} catch (ConfigNameException $e) {
$this
->pass($message);
}
// 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';
$message = 'Expected ConfigNameException was thrown for a name longer than Config::MAX_NAME_LENGTH.';
try {
$this
->config($name)
->save();
$this
->fail($message);
} catch (ConfigNameException $e) {
$this
->pass($message);
}
// Verify that disallowed characters in the name cause an exception.
$characters = $test_characters = array(
':',
'?',
'*',
'<',
'>',
'"',
'\'',
'/',
'\\',
);
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), format_string('Expected ConfigNameException was thrown for all invalid name characters: @characters', array(
'@characters' => implode(' ', $characters),
)));
// Verify that a valid config object name can be saved.
$name = 'namespace.object';
$message = 'ConfigNameException was not thrown for a valid object name.';
try {
$config = $this
->config($name);
$config
->save();
$this
->pass($message);
} catch (ConfigNameException $e) {
$this
->fail($message);
}
}
/**
* Tests the validation of configuration object values.
*/
function testValueValidation() {
// Verify that setData() will catch dotted keys.
$message = 'Expected ConfigValueException was thrown from setData() for value with dotted keys.';
try {
$this
->config('namespace.object')
->setData(array(
'key.value' => 12,
))
->save();
$this
->fail($message);
} catch (ConfigValueException $e) {
$this
->pass($message);
}
// Verify that set() will catch dotted keys.
$message = 'Expected ConfigValueException was thrown from set() for value with dotted keys.';
try {
$this
->config('namespace.object')
->set('foo', array(
'key.value' => 12,
))
->save();
$this
->fail($message);
} catch (ConfigValueException $e) {
$this
->pass($message);
}
}
/**
* Tests data type handling.
*/
public function testDataTypes() {
\Drupal::service('module_installer')
->install(array(
'config_test',
));
$storage = new DatabaseStorage($this->container
->get('database'), 'config');
$name = 'config_test.types';
$config = $this
->config($name);
$original_content = file_get_contents(drupal_get_path('module', 'config_test') . '/' . InstallStorage::CONFIG_INSTALL_DIRECTORY . "/{$name}.yml");
$this
->verbose('<pre>' . $original_content . "\n" . var_export($storage
->read($name), TRUE));
// Verify variable data types are intact.
$data = array(
'array' => array(),
'boolean' => TRUE,
'exp' => 1.2E+34,
'float' => 3.14159,
'float_as_integer' => (double) 1,
'hex' => 0xc,
'int' => 99,
'octal' => 0775,
'string' => 'string',
'string_int' => '1',
);
$this
->assertIdentical($config
->get(), $data);
// Re-set each key using Config::set().
foreach ($data as $key => $value) {
$config
->set($key, $value);
}
$config
->save();
$this
->assertIdentical($config
->get(), $data);
// Assert the data against the file storage.
$this
->assertIdentical($storage
->read($name), $data);
$this
->verbose('<pre>' . $name . var_export($storage
->read($name), TRUE));
// Set data using config::setData().
$config
->setData($data)
->save();
$this
->assertIdentical($config
->get(), $data);
$this
->assertIdentical($storage
->read($name), $data);
// Test that schema type enforcement can be overridden by trusting the data.
$this
->assertIdentical(99, $config
->get('int'));
$config
->set('int', '99')
->save(TRUE);
$this
->assertIdentical('99', $config
->get('int'));
// Test that re-saving without testing the data enforces the schema type.
$config
->save();
$this
->assertIdentical($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) {
$this
->pass(SafeMarkup::format('%class thrown upon saving invalid data type.', array(
'%class' => get_class($e),
)));
}
// 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) {
$this
->pass(SafeMarkup::format('%class thrown upon saving invalid data type.', array(
'%class' => get_class($e),
)));
}
}
}
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. | |
ConfigCRUDTest:: |
public static | property |
Modules to enable. Overrides KernelTestBase:: |
|
ConfigCRUDTest:: |
protected | property |
Exempt from strict schema checking. Overrides TestBase:: |
|
ConfigCRUDTest:: |
function | Tests CRUD operations. | ||
ConfigCRUDTest:: |
public | function | Tests data type handling. | |
ConfigCRUDTest:: |
function | Tests the validation of configuration object names. | ||
ConfigCRUDTest:: |
function | Tests the validation of configuration object values. | ||
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:: |
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 setup tasks before each individual test method is run. Overrides TestBase:: |
|
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. | |
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 | 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. |