class ConfigFileContentTest
Tests reading and writing of configuration files.
@group config
Hierarchy
- class \Drupal\KernelTests\KernelTestBase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertLegacyTrait, \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\ExtensionListTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait extends \PHPUnit\Framework\TestCase- class \Drupal\KernelTests\Core\Config\ConfigFileContentTest extends \Drupal\KernelTests\KernelTestBase
 
Expanded class hierarchy of ConfigFileContentTest
File
- 
              core/tests/ Drupal/ KernelTests/ Core/ Config/ ConfigFileContentTest.php, line 14 
Namespace
Drupal\KernelTests\Core\ConfigView source
class ConfigFileContentTest extends KernelTestBase {
  
  /**
   * Exempt from strict schema checking.
   *
   * @see \Drupal\Core\Config\Development\ConfigSchemaChecker
   *
   * @var bool
   */
  protected $strictConfigSchema = FALSE;
  
  /**
   * Tests setting, writing, and reading of a configuration setting.
   */
  public function testReadWriteConfig() {
    $storage = $this->container
      ->get('config.storage');
    $name = 'foo.bar';
    $key = 'foo';
    $value = 'bar';
    $nested_key = 'biff.bang';
    $nested_value = 'pow';
    $array_key = 'array';
    $array_value = [
      'foo' => 'bar',
      'biff' => [
        'bang' => 'pow',
      ],
    ];
    $casting_array_key = 'casting_array';
    $casting_array_false_value_key = 'casting_array.cast.false';
    $casting_array_value = [
      'cast' => [
        'false' => FALSE,
      ],
    ];
    $nested_array_key = 'nested.array';
    $true_key = 'true';
    $false_key = 'false';
    // Attempt to read non-existing configuration.
    $config = $this->config($name);
    // Verify a configuration object is returned.
    $this->assertEquals($name, $config->getName());
    $this->assertNotEmpty($config, 'Config object created.');
    // Verify the configuration object is empty.
    $this->assertEquals([], $config->get(), 'New config object is empty.');
    // Verify nothing was saved.
    $data = $storage->read($name);
    $this->assertFalse($data);
    // Add a top level value.
    $config = $this->config($name);
    $config->set($key, $value);
    // Add a nested value.
    $config->set($nested_key, $nested_value);
    // Add an array.
    $config->set($array_key, $array_value);
    // Add a nested array.
    $config->set($nested_array_key, $array_value);
    // Add a boolean false value. Should get cast to 0.
    $config->set($false_key, FALSE);
    // Add a boolean true value. Should get cast to 1.
    $config->set($true_key, TRUE);
    // Add a null value. Should get cast to an empty string.
    $config->set('null', NULL);
    // Add an array with a nested boolean false that should get cast to 0.
    $config->set($casting_array_key, $casting_array_value);
    $config->save();
    // Verify the database entry exists.
    $data = $storage->read($name);
    $this->assertNotEmpty($data);
    // Read top level value.
    $config = $this->config($name);
    $this->assertEquals($name, $config->getName());
    $this->assertNotEmpty($config, 'Config object created.');
    $this->assertEquals('bar', $config->get($key), 'Top level configuration value found.');
    // Read nested value.
    $this->assertEquals($nested_value, $config->get($nested_key), 'Nested configuration value found.');
    // Read array.
    $this->assertEquals($array_value, $config->get($array_key), 'Top level array configuration value found.');
    // Read nested array.
    $this->assertEquals($array_value, $config->get($nested_array_key), 'Nested array configuration value found.');
    // Read a top level value that doesn't exist.
    $this->assertNull($config->get('i_do_not_exist'), 'Non-existent top level value returned NULL.');
    // Read a nested value that doesn't exist.
    $this->assertNull($config->get('i.do.not.exist'), 'Non-existent nested value returned NULL.');
    // Read false value.
    $this->assertFalse($config->get($false_key), "Boolean FALSE value returned the FALSE.");
    // Read true value.
    $this->assertTrue($config->get($true_key), "Boolean TRUE value returned the TRUE.");
    // Read null value.
    $this->assertNull($config->get('null'));
    // Read false that had been nested in an array value.
    $this->assertFalse($config->get($casting_array_false_value_key), "Nested boolean FALSE value returned FALSE.");
    // Unset a top level value.
    $config->clear($key);
    // Unset a nested value.
    $config->clear($nested_key);
    $config->save();
    $config = $this->config($name);
    // Read unset top level value.
    $this->assertNull($config->get($key), 'Top level value unset.');
    // Read unset nested value.
    $this->assertNull($config->get($nested_key), 'Nested value unset.');
    // Create two new configuration files to test listing.
    $config = $this->config('foo.baz');
    $config->set($key, $value);
    $config->save();
    // Test chained set()->save().
    $chained_name = 'biff.bang';
    $config = $this->config($chained_name);
    $config->set($key, $value)
      ->save();
    // Verify the database entry exists from a chained save.
    $data = $storage->read($chained_name);
    $this->assertEquals($config->get(), $data);
    // Get file listing for all files starting with 'foo'. Should return
    // two elements.
    $files = $storage->listAll('foo');
    $this->assertCount(2, $files, 'Two files listed with the prefix \'foo\'.');
    // Get file listing for all files starting with 'biff'. Should return
    // one element.
    $files = $storage->listAll('biff');
    $this->assertCount(1, $files, 'One file listed with the prefix \'biff\'.');
    // Get file listing for all files starting with 'foo.bar'. Should return
    // one element.
    $files = $storage->listAll('foo.bar');
    $this->assertCount(1, $files, 'One file listed with the prefix \'foo.bar\'.');
    // Get file listing for all files starting with 'bar'. Should return
    // an empty array.
    $files = $storage->listAll('bar');
    $this->assertEquals([], $files, 'No files listed with the prefix \'bar\'.');
    // Delete the configuration.
    $config = $this->config($name);
    $config->delete();
    // Verify the database entry no longer exists.
    $data = $storage->read($name);
    $this->assertFalse($data);
  }
  
  /**
   * Tests serialization of configuration to file.
   */
  public function testSerialization() {
    $name = $this->randomMachineName(10) . '.' . $this->randomMachineName(10);
    $config_data = [
      // Indexed arrays; the order of elements is essential.
'numeric keys' => [
        'i',
        'n',
        'd',
        'e',
        'x',
        'e',
        'd',
      ],
      // Infinitely nested keys using arbitrary element names.
'nested keys' => [
        // HTML/XML in values.
'HTML' => '<strong> <bold> <em> <blockquote>',
        // UTF-8 in values.
'UTF-8' => 'FrançAIS is ÜBER-åwesome',
        // Unicode in keys and values.
        // cSpell:disable-next-line
'ΑΒΓΔΕΖΗΘΙΚΛΜΝΞΟΣὨ' => 'αβγδεζηθικλμνξοσὠ',
      ],
      'invalid xml' => '</title><script type="text/javascript">alert("Title XSS!");</script> & < > " \' ',
    ];
    // Encode and write, and reload and decode the configuration data.
    $filestorage = new FileStorage(Settings::get('config_sync_directory'));
    $filestorage->write($name, $config_data);
    $config_parsed = $filestorage->read($name);
    $key = 'numeric keys';
    $this->assertSame($config_data[$key], $config_parsed[$key]);
    $key = 'nested keys';
    $this->assertSame($config_data[$key], $config_parsed[$key]);
    $key = 'HTML';
    $this->assertSame($config_data['nested keys'][$key], $config_parsed['nested keys'][$key]);
    $key = 'UTF-8';
    $this->assertSame($config_data['nested keys'][$key], $config_parsed['nested keys'][$key]);
    // cSpell:disable-next-line
    $key = 'ΑΒΓΔΕΖΗΘΙΚΛΜΝΞΟΣὨ';
    $this->assertSame($config_data['nested keys'][$key], $config_parsed['nested keys'][$key]);
    $key = 'invalid xml';
    $this->assertSame($config_data[$key], $config_parsed[$key]);
  }
}Members
| Title Sort descending | Deprecated | 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::getUrl | protected | function | Get the current URL from the cURL handler. | 1 | ||
| 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. | |||
| AssertLegacyTrait::assert | Deprecated | protected | function | |||
| AssertLegacyTrait::assertEqual | Deprecated | protected | function | |||
| AssertLegacyTrait::assertIdentical | Deprecated | protected | function | |||
| AssertLegacyTrait::assertIdenticalObject | Deprecated | protected | function | |||
| AssertLegacyTrait::assertNotEqual | Deprecated | protected | function | |||
| AssertLegacyTrait::assertNotIdentical | Deprecated | protected | function | |||
| AssertLegacyTrait::pass | Deprecated | protected | function | |||
| AssertLegacyTrait::verbose | Deprecated | protected | function | |||
| ConfigFileContentTest::$strictConfigSchema | protected | property | Exempt from strict schema checking. | Overrides KernelTestBase::$strictConfigSchema | ||
| ConfigFileContentTest::testReadWriteConfig | public | function | Tests setting, writing, and reading of a configuration setting. | |||
| ConfigFileContentTest::testSerialization | public | function | Tests serialization of configuration to file. | |||
| 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. | |||
| ExtensionListTestTrait::getModulePath | protected | function | Gets the path for the specified module. | |||
| ExtensionListTestTrait::getThemePath | protected | function | Gets the path for the specified theme. | |||
| KernelTestBase::$backupGlobals | protected | property | Back up and restore any global variables that may be changed by tests. | |||
| 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. | |||
| 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 enable. | 487 | ||
| KernelTestBase::$preserveGlobalState | protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |||
| KernelTestBase::$root | protected | property | The app root. | |||
| KernelTestBase::$runTestInSeparateProcess | 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::$siteDirectory | protected | property | ||||
| 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 | private | function | Bootstraps a kernel for a test. | |||
| 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. | |||
| 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. | 3 | ||
| KernelTestBase::getDatabasePrefix | public | function | ||||
| KernelTestBase::getExtensionsForModules | private | function | Returns Extension objects for $modules to enable. | |||
| KernelTestBase::getModulesToEnable | private static | function | Returns the modules to enable 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 | 26 | |
| 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 | 353 | |||
| KernelTestBase::setUpBeforeClass | public static | function | 1 | |||
| KernelTestBase::setUpFilesystem | protected | function | Sets up the filesystem, so things like the file directory. | 3 | ||
| KernelTestBase::stop | protected | function | Stops test execution. | |||
| KernelTestBase::tearDown | protected | function | 5 | |||
| KernelTestBase::tearDownCloseDatabaseConnection | public | function | @after | |||
| KernelTestBase::vfsDump | protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |||
| KernelTestBase::__sleep | public | function | Prevents serializing any properties. | |||
| PhpUnitWarnings::$deprecationWarnings | private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |||
| PhpUnitWarnings::addWarning | public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |||
| RandomGeneratorTrait::$randomGenerator | protected | property | The random generator. | |||
| 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. | 1 | ||
| 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. | |||
| RandomGeneratorTrait::randomStringValidate | public | function | Callback for random string validation. | |||
| StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | |||
| TestRequirementsTrait::checkModuleRequirements | private | function | Checks missing module requirements. | |||
| TestRequirementsTrait::checkRequirements | protected | function | Check module requirements for the Drupal use case. | |||
| 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.
