function ConfigCRUDTest::testCRUD

Tests CRUD operations.

File

core/tests/Drupal/KernelTests/Core/Config/ConfigCRUDTest.php, line 41

Class

ConfigCRUDTest

Tests CRUD operations on configuration objects.

Namespace

Code

public function testCRUD() : void {
    $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' => 'foo',
    ];
    $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');
}