class ConfigFileContentTest

Tests reading and writing file contents.

Hierarchy

Expanded class hierarchy of ConfigFileContentTest

File

drupal/core/modules/config/lib/Drupal/config/Tests/ConfigFileContentTest.php, line 16
Definition of Drupal\config\Tests\ConfigFileContentTest.

Namespace

Drupal\config\Tests
View source
class ConfigFileContentTest extends DrupalUnitTestBase {
  public static function getInfo() {
    return array(
      'name' => 'File content',
      'description' => 'Tests reading and writing of configuration files.',
      'group' => 'Configuration',
    );
  }

  /**
   * Tests setting, writing, and reading of a configuration setting.
   */
  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 = array(
      'foo' => 'bar',
      'biff' => array(
        'bang' => 'pow',
      ),
    );
    $casting_array_key = 'casting_array';
    $casting_array_false_value_key = 'casting_array.cast.false';
    $casting_array_value = array(
      'cast' => array(
        'false' => FALSE,
      ),
    );
    $nested_array_key = 'nested.array';
    $true_key = 'true';
    $false_key = 'false';

    // Attempt to read non-existing configuration.
    $config = config($name);

    // Verify an configuration object is returned.
    $this
      ->assertEqual($config
      ->getName(), $name);
    $this
      ->assertTrue($config, 'Config object created.');

    // Verify the configuration object is empty.
    $this
      ->assertEqual($config
      ->get(), array(), 'New config object is empty.');

    // Verify nothing was saved.
    $data = $storage
      ->read($name);
    $this
      ->assertIdentical($data, FALSE);

    // Add a top level value
    $config = 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
      ->assertTrue($data);

    // Read top level value
    $config = config($name);
    $this
      ->assertEqual($config
      ->getName(), $name);
    $this
      ->assertTrue($config, 'Config object created.');
    $this
      ->assertEqual($config
      ->get($key), 'bar', 'Top level configuration value found.');

    // Read nested value
    $this
      ->assertEqual($config
      ->get($nested_key), $nested_value, 'Nested configuration value found.');

    // Read array
    $this
      ->assertEqual($config
      ->get($array_key), $array_value, 'Top level array configuration value found.');

    // Read nested array
    $this
      ->assertEqual($config
      ->get($nested_array_key), $array_value, 'Nested array configuration value found.');

    // Read a top level value that doesn't exist
    $this
      ->assertNull($config
      ->get('i_dont_exist'), 'Non-existent top level value returned NULL.');

    // Read a nested value that doesn't exist
    $this
      ->assertNull($config
      ->get('i.dont.exist'), 'Non-existent nested value returned NULL.');

    // Read false value
    $this
      ->assertEqual($config
      ->get($false_key), '0', format_string("Boolean FALSE value returned the string '0'."));

    // Read true value
    $this
      ->assertEqual($config
      ->get($true_key), '1', format_string("Boolean TRUE value returned the string '1'."));

    // Read null value.
    $this
      ->assertIdentical($config
      ->get('null'), '');

    // Read false that had been nested in an array value
    $this
      ->assertEqual($config
      ->get($casting_array_false_value_key), '0', format_string("Nested boolean FALSE value returned the string '0'."));

    // Unset a top level value
    $config
      ->clear($key);

    // Unset a nested value
    $config
      ->clear($nested_key);
    $config
      ->save();
    $config = 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 = config('foo.baz');
    $config
      ->set($key, $value);
    $config
      ->save();

    // Test chained set()->save()
    $chained_name = 'biff.bang';
    $config = config($chained_name);
    $config
      ->set($key, $value)
      ->save();

    // Verify the database entry exists from a chained save.
    $data = $storage
      ->read($chained_name);
    $this
      ->assertEqual($data, $config
      ->get());

    // Get file listing for all files starting with 'foo'. Should return
    // two elements.
    $files = $storage
      ->listAll('foo');
    $this
      ->assertEqual(count($files), 2, '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
      ->assertEqual(count($files), 1, '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
      ->assertEqual(count($files), 1, '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
      ->assertEqual($files, array(), 'No files listed with the prefix \'bar\'.');

    // Delete the configuration.
    $config = config($name);
    $config
      ->delete();

    // Verify the database entry no longer exists.
    $data = $storage
      ->read($name);
    $this
      ->assertIdentical($data, FALSE);
  }

  /**
   * Tests serialization of configuration to file.
   */
  function testSerialization() {
    $name = $this
      ->randomName(10) . '.' . $this
      ->randomName(10);
    $config_data = array(
      // Indexed arrays; the order of elements is essential.
      'numeric keys' => array(
        'i',
        'n',
        'd',
        'e',
        'x',
        'e',
        'd',
      ),
      // Infinitely nested keys using arbitrary element names.
      'nested keys' => array(
        // 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.
        'ΑΒΓΔΕΖΗΘΙΚΛΜΝΞΟΣὨ' => 'αβγδεζηθικλμνξοσὠ',
      ),
      'invalid xml' => '</title><script type="text/javascript">alert("Title XSS!");</script> & < > " \' ',
    );

    // Encode and write, and reload and decode the configuration data.
    $filestorage = new FileStorage($this->configDirectories[CONFIG_ACTIVE_DIRECTORY]);
    $filestorage
      ->write($name, $config_data);
    $config_parsed = $filestorage
      ->read($name);
    $key = 'numeric keys';
    $this
      ->assertIdentical($config_data[$key], $config_parsed[$key]);
    $key = 'nested keys';
    $this
      ->assertIdentical($config_data[$key], $config_parsed[$key]);
    $key = 'HTML';
    $this
      ->assertIdentical($config_data['nested keys'][$key], $config_parsed['nested keys'][$key]);
    $key = 'UTF-8';
    $this
      ->assertIdentical($config_data['nested keys'][$key], $config_parsed['nested keys'][$key]);
    $key = 'ΑΒΓΔΕΖΗΘΙΚΛΜΝΞΟΣὨ';
    $this
      ->assertIdentical($config_data['nested keys'][$key], $config_parsed['nested keys'][$key]);
    $key = 'invalid xml';
    $this
      ->assertIdentical($config_data[$key], $config_parsed[$key]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFileContentTest::getInfo public static function
ConfigFileContentTest::testReadWriteConfig function Tests setting, writing, and reading of a configuration setting.
ConfigFileContentTest::testSerialization function Tests serialization of configuration to file.
DrupalUnitTestBase::$moduleFiles private property
DrupalUnitTestBase::$moduleList private property Fixed module list being used by this test.
DrupalUnitTestBase::$modules public static property Modules to enable. 6
DrupalUnitTestBase::$themeData private property
DrupalUnitTestBase::$themeFiles private property
DrupalUnitTestBase::containerBuild public function Sets up the base service container for this test.
DrupalUnitTestBase::enableModules protected function Enables modules for this test.
DrupalUnitTestBase::installSchema protected function Installs a specific table from a module schema definition.
DrupalUnitTestBase::setUp protected function Sets up Drupal unit test environment. Overrides UnitTestBase::setUp 9
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$results public property Current results of this test case.
TestBase::$setup protected property Flag to indicate whether the test has been set up.
TestBase::$setupDatabasePrefix protected property
TestBase::$setupEnvironment protected property
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$verbose protected property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or FALSE).
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
TestBase::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 3
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 1
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix protected function Generates a database prefix for running tests.
TestBase::prepareEnvironment protected function Prepares the current environment for running the test.
TestBase::randomName public static function Generates a random string containing letters and numbers.
TestBase::randomObject public static function Generates a random PHP object.
TestBase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
TestBase::rebuildContainer protected function Rebuild drupal_container().
TestBase::run public function Run all tests in this class.
TestBase::tearDown protected function Deletes created files, database tables, and reverts all environment changes. 10
TestBase::verbose protected function Logs verbose message in a text file.
UnitTestBase::$configDirectories protected property
UnitTestBase::__construct function Constructor for UnitTestBase. Overrides TestBase::__construct 6