function ConfigFileContentTest::testReadWriteConfig

Tests setting, writing, and reading of a configuration setting.

File

core/tests/Drupal/KernelTests/Core/Config/ConfigFileContentTest.php, line 30

Class

ConfigFileContentTest

Tests reading and writing of configuration files.

Namespace

Code

public function testReadWriteConfig() : void {
    $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);
}