View source
<?php
namespace Drupal\KernelTests\Core\Config;
use Drupal\Component\Utility\Html;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Core\Config\ConfigImporter;
use Drupal\Core\Config\ConfigImporterException;
use Drupal\Core\Config\StorageComparer;
use Drupal\KernelTests\KernelTestBase;
class ConfigImporterTest extends KernelTestBase {
const FAIL_MESSAGE = 'There were errors validating the config synchronization.';
protected $configImporter;
protected static $modules = [
'config_test',
'system',
'config_import_test',
];
protected function setUp() : void {
parent::setUp();
$this
->installConfig([
'system',
'config_test',
]);
unset($GLOBALS['hook_config_test']);
$this
->copyConfig($this->container
->get('config.storage'), $this->container
->get('config.storage.sync'));
$storage_comparer = new StorageComparer($this->container
->get('config.storage.sync'), $this->container
->get('config.storage'));
$this->configImporter = new ConfigImporter($storage_comparer
->createChangelist(), $this->container
->get('event_dispatcher'), $this->container
->get('config.manager'), $this->container
->get('lock'), $this->container
->get('config.typed'), $this->container
->get('module_handler'), $this->container
->get('module_installer'), $this->container
->get('theme_handler'), $this->container
->get('string_translation'), $this->container
->get('extension.list.module'));
}
public function testNoImport() {
$dynamic_name = 'config_test.dynamic.dotted.default';
$config = $this
->config($dynamic_name);
$this
->assertSame('dotted.default', $config
->get('id'));
$this
->assertFalse(isset($GLOBALS['hook_config_test']));
}
public function testEmptyImportFails() {
$this
->expectException(ConfigImporterException::class);
$this->container
->get('config.storage.sync')
->deleteAll();
$this->configImporter
->reset()
->import();
}
public function testSiteUuidValidate() {
$sync = \Drupal::service('config.storage.sync');
$config_data = $this
->config('system.site')
->get();
$config_data['uuid'] = \Drupal::service('uuid')
->generate();
$sync
->write('system.site', $config_data);
try {
$this->configImporter
->reset()
->import();
$this
->fail('ConfigImporterException not thrown, invalid import was not stopped due to mis-matching site UUID.');
} catch (ConfigImporterException $e) {
$actual_message = $e
->getMessage();
$actual_error_log = $this->configImporter
->getErrors();
$expected_error_log = [
'Site UUID in source storage does not match the target storage.',
];
$this
->assertEquals($expected_error_log, $actual_error_log);
$expected = static::FAIL_MESSAGE . PHP_EOL . 'Site UUID in source storage does not match the target storage.';
$this
->assertEquals($expected, $actual_message);
foreach ($expected_error_log as $log_row) {
$this
->assertMatchesRegularExpression("/{$log_row}/", $actual_message);
}
}
}
public function testDeleted() {
$dynamic_name = 'config_test.dynamic.dotted.default';
$storage = $this->container
->get('config.storage');
$sync = $this->container
->get('config.storage.sync');
$config = $this
->config($dynamic_name);
$this
->assertSame('dotted.default', $config
->get('id'));
$sync
->delete($dynamic_name);
$this->configImporter
->reset()
->import();
$this
->assertFalse($storage
->read($dynamic_name));
$config = $this
->config($dynamic_name);
$this
->assertNull($config
->get('id'));
$this
->assertTrue(isset($GLOBALS['hook_config_test']['load']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['presave']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['insert']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['update']));
$this
->assertTrue(isset($GLOBALS['hook_config_test']['predelete']));
$this
->assertTrue(isset($GLOBALS['hook_config_test']['delete']));
$this
->assertFalse($this->configImporter
->hasUnprocessedConfigurationChanges());
$logs = $this->configImporter
->getErrors();
$this
->assertCount(0, $logs);
}
public function testNew() {
$dynamic_name = 'config_test.dynamic.new';
$storage = $this->container
->get('config.storage');
$sync = $this->container
->get('config.storage.sync');
$this
->assertFalse($storage
->exists($dynamic_name), $dynamic_name . ' not found.');
$original_dynamic_data = [
'uuid' => '30df59bd-7b03-4cf7-bb35-d42fc49f0651',
'langcode' => \Drupal::languageManager()
->getDefaultLanguage()
->getId(),
'status' => TRUE,
'dependencies' => [],
'id' => 'new',
'label' => 'New',
'weight' => 0,
'style' => '',
'size' => '',
'size_value' => '',
'protected_property' => '',
];
$sync
->write($dynamic_name, $original_dynamic_data);
$this
->assertTrue($sync
->exists($dynamic_name), $dynamic_name . ' found.');
$this->configImporter
->reset()
->import();
$config = $this
->config($dynamic_name);
$this
->assertSame($original_dynamic_data['label'], $config
->get('label'));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['load']));
$this
->assertTrue(isset($GLOBALS['hook_config_test']['presave']));
$this
->assertTrue(isset($GLOBALS['hook_config_test']['insert']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['update']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['predelete']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['delete']));
$this
->assertTrue(isset($GLOBALS['hook_config_test']['config_import_steps_alter']));
$this
->assertFalse($this->configImporter
->hasUnprocessedConfigurationChanges());
$logs = $this->configImporter
->getErrors();
$this
->assertCount(0, $logs);
}
public function testSecondaryWritePrimaryFirst() {
$name_primary = 'config_test.dynamic.primary';
$name_secondary = 'config_test.dynamic.secondary';
$sync = $this->container
->get('config.storage.sync');
$uuid = $this->container
->get('uuid');
$values_primary = [
'id' => 'primary',
'label' => 'Primary',
'weight' => 0,
'uuid' => $uuid
->generate(),
];
$sync
->write($name_primary, $values_primary);
$values_secondary = [
'id' => 'secondary',
'label' => 'Secondary Sync',
'weight' => 0,
'uuid' => $uuid
->generate(),
'dependencies' => [
'config' => [
$name_primary,
],
],
];
$sync
->write($name_secondary, $values_secondary);
$this->configImporter
->reset()
->import();
$entity_storage = \Drupal::entityTypeManager()
->getStorage('config_test');
$primary = $entity_storage
->load('primary');
$this
->assertEquals('primary', $primary
->id());
$this
->assertEquals($values_primary['uuid'], $primary
->uuid());
$this
->assertEquals($values_primary['label'], $primary
->label());
$secondary = $entity_storage
->load('secondary');
$this
->assertEquals('secondary', $secondary
->id());
$this
->assertEquals($values_secondary['uuid'], $secondary
->uuid());
$this
->assertEquals($values_secondary['label'], $secondary
->label());
$logs = $this->configImporter
->getErrors();
$this
->assertCount(1, $logs);
$this
->assertEquals(new FormattableMarkup('Deleted and replaced configuration entity "@name"', [
'@name' => $name_secondary,
]), $logs[0]);
}
public function testSecondaryWriteSecondaryFirst() {
$name_primary = 'config_test.dynamic.primary';
$name_secondary = 'config_test.dynamic.secondary';
$sync = $this->container
->get('config.storage.sync');
$uuid = $this->container
->get('uuid');
$values_primary = [
'id' => 'primary',
'label' => 'Primary',
'weight' => 0,
'uuid' => $uuid
->generate(),
'dependencies' => [
'config' => [
$name_secondary,
],
],
];
$sync
->write($name_primary, $values_primary);
$values_secondary = [
'id' => 'secondary',
'label' => 'Secondary Sync',
'weight' => 0,
'uuid' => $uuid
->generate(),
];
$sync
->write($name_secondary, $values_secondary);
$this->configImporter
->reset()
->import();
$entity_storage = \Drupal::entityTypeManager()
->getStorage('config_test');
$primary = $entity_storage
->load('primary');
$this
->assertEquals('primary', $primary
->id());
$this
->assertEquals($values_primary['uuid'], $primary
->uuid());
$this
->assertEquals($values_primary['label'], $primary
->label());
$secondary = $entity_storage
->load('secondary');
$this
->assertEquals('secondary', $secondary
->id());
$this
->assertEquals($values_secondary['uuid'], $secondary
->uuid());
$this
->assertEquals($values_secondary['label'], $secondary
->label());
$logs = $this->configImporter
->getErrors();
$this
->assertCount(1, $logs);
$this
->assertEquals(Html::escape("Unexpected error during import with operation create for {$name_primary}: 'config_test' entity with ID 'secondary' already exists."), $logs[0]);
}
public function testSecondaryUpdateDeletedDeleterFirst() {
$name_deleter = 'config_test.dynamic.deleter';
$name_deletee = 'config_test.dynamic.deletee';
$name_other = 'config_test.dynamic.other';
$storage = $this->container
->get('config.storage');
$sync = $this->container
->get('config.storage.sync');
$uuid = $this->container
->get('uuid');
$values_deleter = [
'id' => 'deleter',
'label' => 'Deleter',
'weight' => 0,
'uuid' => $uuid
->generate(),
];
$storage
->write($name_deleter, $values_deleter);
$values_deleter['label'] = 'Updated Deleter';
$sync
->write($name_deleter, $values_deleter);
$values_deletee = [
'id' => 'deletee',
'label' => 'Deletee',
'weight' => 0,
'uuid' => $uuid
->generate(),
'dependencies' => [
'config' => [
$name_deleter,
],
],
];
$storage
->write($name_deletee, $values_deletee);
$values_deletee['label'] = 'Updated Deletee';
$sync
->write($name_deletee, $values_deletee);
$values_other = [
'id' => 'other',
'label' => 'Other',
'weight' => 0,
'uuid' => $uuid
->generate(),
'dependencies' => [
'config' => [
$name_deleter,
],
],
];
$storage
->write($name_other, $values_other);
$values_other['label'] = 'Updated other';
$sync
->write($name_other, $values_other);
$updates = $this->configImporter
->reset()
->getStorageComparer()
->getChangelist('update');
$expected = [
$name_deleter,
$name_deletee,
$name_other,
];
$this
->assertSame($expected, $updates);
$this->configImporter
->import();
$entity_storage = \Drupal::entityTypeManager()
->getStorage('config_test');
$deleter = $entity_storage
->load('deleter');
$this
->assertEquals('deleter', $deleter
->id());
$this
->assertEquals($values_deleter['uuid'], $deleter
->uuid());
$this
->assertEquals($values_deleter['label'], $deleter
->label());
$this
->assertNull($entity_storage
->load('deletee'));
$other = $entity_storage
->load('other');
$this
->assertEquals('other', $other
->id());
$this
->assertEquals($values_other['uuid'], $other
->uuid());
$this
->assertEquals($values_other['label'], $other
->label());
$logs = $this->configImporter
->getErrors();
$this
->assertCount(1, $logs);
$this
->assertEquals(new FormattableMarkup('Update target "@name" is missing.', [
'@name' => $name_deletee,
]), $logs[0]);
}
public function testSecondaryUpdateDeletedDeleteeFirst() {
$name_deleter = 'config_test.dynamic.deleter';
$name_deletee = 'config_test.dynamic.deletee';
$storage = $this->container
->get('config.storage');
$sync = $this->container
->get('config.storage.sync');
$uuid = $this->container
->get('uuid');
$values_deleter = [
'id' => 'deleter',
'label' => 'Deleter',
'weight' => 0,
'uuid' => $uuid
->generate(),
'dependencies' => [
'config' => [
$name_deletee,
],
],
];
$storage
->write($name_deleter, $values_deleter);
$values_deleter['label'] = 'Updated Deleter';
$sync
->write($name_deleter, $values_deleter);
$values_deletee = [
'id' => 'deletee',
'label' => 'Deletee',
'weight' => 0,
'uuid' => $uuid
->generate(),
];
$storage
->write($name_deletee, $values_deletee);
$values_deletee['label'] = 'Updated Deletee';
$sync
->write($name_deletee, $values_deletee);
$this->configImporter
->reset()
->import();
$entity_storage = \Drupal::entityTypeManager()
->getStorage('config_test');
$this
->assertNull($entity_storage
->load('deleter'));
$this
->assertNull($entity_storage
->load('deletee'));
$logs = $this->configImporter
->getErrors();
$this
->assertCount(0, $logs);
}
public function testSecondaryDeletedDeleteeSecond() {
$name_deleter = 'config_test.dynamic.deleter';
$name_deletee = 'config_test.dynamic.deletee';
$storage = $this->container
->get('config.storage');
$uuid = $this->container
->get('uuid');
$values_deleter = [
'id' => 'deleter',
'label' => 'Deleter',
'weight' => 0,
'uuid' => $uuid
->generate(),
'dependencies' => [
'config' => [
$name_deletee,
],
],
];
$storage
->write($name_deleter, $values_deleter);
$values_deletee = [
'id' => 'deletee',
'label' => 'Deletee',
'weight' => 0,
'uuid' => $uuid
->generate(),
];
$storage
->write($name_deletee, $values_deletee);
$this->configImporter
->reset()
->import();
$entity_storage = \Drupal::entityTypeManager()
->getStorage('config_test');
$this
->assertNull($entity_storage
->load('deleter'));
$this
->assertNull($entity_storage
->load('deletee'));
$logs = $this->configImporter
->getErrors();
$this
->assertCount(0, $logs);
}
public function testUpdated() {
$name = 'config_test.system';
$dynamic_name = 'config_test.dynamic.dotted.default';
$storage = $this->container
->get('config.storage');
$sync = $this->container
->get('config.storage.sync');
$this
->assertTrue($storage
->exists($name), $name . ' found.');
$this
->assertTrue($storage
->exists($dynamic_name), $dynamic_name . ' found.');
$original_name_data = [
'foo' => 'beer',
];
$sync
->write($name, $original_name_data);
$original_dynamic_data = $storage
->read($dynamic_name);
$original_dynamic_data['label'] = 'Updated';
$sync
->write($dynamic_name, $original_dynamic_data);
$config = $this
->config($name);
$this
->assertSame('bar', $config
->get('foo'));
$config = $this
->config($dynamic_name);
$this
->assertSame('Default', $config
->get('label'));
$this->configImporter
->reset()
->import();
\Drupal::configFactory()
->reset($name);
$config = $this
->config($name);
$this
->assertSame('beer', $config
->get('foo'));
$config = $this
->config($dynamic_name);
$this
->assertSame('Updated', $config
->get('label'));
$this
->assertSame($original_name_data, $sync
->read($name));
$this
->assertSame($original_dynamic_data, $sync
->read($dynamic_name));
$this
->assertTrue(isset($GLOBALS['hook_config_test']['load']));
$this
->assertTrue(isset($GLOBALS['hook_config_test']['presave']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['insert']));
$this
->assertTrue(isset($GLOBALS['hook_config_test']['update']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['predelete']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['delete']));
$this
->assertFalse($this->configImporter
->hasUnprocessedConfigurationChanges());
$logs = $this->configImporter
->getErrors();
$this
->assertCount(0, $logs);
}
public function testIsInstallable() {
$config_name = 'config_test.dynamic.isinstallable';
$this
->assertFalse($this->container
->get('config.storage')
->exists($config_name));
\Drupal::state()
->set('config_test.isinstallable', TRUE);
$this
->installConfig([
'config_test',
]);
$this
->assertTrue($this->container
->get('config.storage')
->exists($config_name));
}
public function testUnmetDependency() {
$storage = $this->container
->get('config.storage');
$sync = $this->container
->get('config.storage.sync');
$sync
->write('unknown.config', [
'test' => 'test',
]);
$config_entity_data = $sync
->read('config_test.dynamic.dotted.default');
$config_entity_data['dependencies'] = [
'module' => [
'unknown',
],
];
$sync
->write('config_test.dynamic.dotted.module', $config_entity_data);
$config_entity_data['dependencies'] = [
'theme' => [
'unknown',
],
];
$sync
->write('config_test.dynamic.dotted.theme', $config_entity_data);
$config_entity_data['dependencies'] = [
'config' => [
'unknown',
],
];
$sync
->write('config_test.dynamic.dotted.config', $config_entity_data);
$config_entity_data['dependencies'] = [];
$storage
->write('config_test.dynamic.dotted.deleted', $config_entity_data);
$config_entity_data['dependencies'] = [
'config' => [
'config_test.dynamic.dotted.deleted',
],
];
$storage
->write('config_test.dynamic.dotted.existing', $config_entity_data);
$sync
->write('config_test.dynamic.dotted.existing', $config_entity_data);
$extensions = $sync
->read('core.extension');
$extensions['module']['unknown_module'] = 0;
$extensions['theme']['unknown_theme'] = 0;
$extensions['module']['book'] = 0;
$extensions['theme']['test_subtheme'] = 0;
$sync
->write('core.extension', $extensions);
try {
$this->configImporter
->reset()
->import();
$this
->fail('ConfigImporterException not thrown; an invalid import was not stopped due to missing dependencies.');
} catch (ConfigImporterException $e) {
$expected = [
static::FAIL_MESSAGE,
'Unable to install the <em class="placeholder">unknown_module</em> module since it does not exist.',
'Unable to install the <em class="placeholder">Book</em> module since it requires the <em class="placeholder">Node, Text, Field, Filter, User</em> modules.',
'Unable to install the <em class="placeholder">unknown_theme</em> theme since it does not exist.',
'Unable to install the <em class="placeholder">Theme test subtheme</em> theme since it requires the <em class="placeholder">Theme test base theme</em> theme.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.config</em> depends on the <em class="placeholder">unknown</em> configuration that will not exist after import.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.existing</em> depends on the <em class="placeholder">config_test.dynamic.dotted.deleted</em> configuration that will not exist after import.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.module</em> depends on the <em class="placeholder">unknown</em> module that will not be installed after import.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.theme</em> depends on the <em class="placeholder">unknown</em> theme that will not be installed after import.',
'Configuration <em class="placeholder">unknown.config</em> depends on the <em class="placeholder">unknown</em> extension that will not be installed after import.',
];
$this
->assertEquals(implode(PHP_EOL, $expected), $e
->getMessage());
$error_log = $this->configImporter
->getErrors();
$expected = [
'Unable to install the <em class="placeholder">unknown_module</em> module since it does not exist.',
'Unable to install the <em class="placeholder">Book</em> module since it requires the <em class="placeholder">Node, Text, Field, Filter, User</em> modules.',
'Unable to install the <em class="placeholder">unknown_theme</em> theme since it does not exist.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.config</em> depends on the <em class="placeholder">unknown</em> configuration that will not exist after import.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.existing</em> depends on the <em class="placeholder">config_test.dynamic.dotted.deleted</em> configuration that will not exist after import.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.module</em> depends on the <em class="placeholder">unknown</em> module that will not be installed after import.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.theme</em> depends on the <em class="placeholder">unknown</em> theme that will not be installed after import.',
'Configuration <em class="placeholder">unknown.config</em> depends on the <em class="placeholder">unknown</em> extension that will not be installed after import.',
];
foreach ($expected as $expected_message) {
$this
->assertContainsEquals($expected_message, $error_log, $expected_message);
}
}
$config_entity_data = $sync
->read('config_test.dynamic.dotted.default');
$config_entity_data['dependencies'] = [
'module' => [
'unknown',
'dblog',
],
];
$sync
->write('config_test.dynamic.dotted.module', $config_entity_data);
$config_entity_data['dependencies'] = [
'theme' => [
'unknown',
'seven',
],
];
$sync
->write('config_test.dynamic.dotted.theme', $config_entity_data);
$config_entity_data['dependencies'] = [
'config' => [
'unknown',
'unknown2',
],
];
$sync
->write('config_test.dynamic.dotted.config', $config_entity_data);
try {
$this->configImporter
->reset()
->import();
$this
->fail('ConfigImporterException not thrown, invalid import was not stopped due to missing dependencies.');
} catch (ConfigImporterException $e) {
$expected = [
static::FAIL_MESSAGE,
'Unable to install the <em class="placeholder">unknown_module</em> module since it does not exist.',
'Unable to install the <em class="placeholder">Book</em> module since it requires the <em class="placeholder">Node, Text, Field, Filter, User</em> modules.',
'Unable to install the <em class="placeholder">unknown_theme</em> theme since it does not exist.',
'Unable to install the <em class="placeholder">Theme test subtheme</em> theme since it requires the <em class="placeholder">Theme test base theme</em> theme.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.config</em> depends on the <em class="placeholder">unknown</em> configuration that will not exist after import.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.existing</em> depends on the <em class="placeholder">config_test.dynamic.dotted.deleted</em> configuration that will not exist after import.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.module</em> depends on the <em class="placeholder">unknown</em> module that will not be installed after import.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.theme</em> depends on the <em class="placeholder">unknown</em> theme that will not be installed after import.',
'Configuration <em class="placeholder">unknown.config</em> depends on the <em class="placeholder">unknown</em> extension that will not be installed after import.',
'Unable to install the <em class="placeholder">unknown_module</em> module since it does not exist.',
'Unable to install the <em class="placeholder">Book</em> module since it requires the <em class="placeholder">Node, Text, Field, Filter, User</em> modules.',
'Unable to install the <em class="placeholder">unknown_theme</em> theme since it does not exist.',
'Unable to install the <em class="placeholder">Theme test subtheme</em> theme since it requires the <em class="placeholder">Theme test base theme</em> theme.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.config</em> depends on configuration (<em class="placeholder">unknown, unknown2</em>) that will not exist after import.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.existing</em> depends on the <em class="placeholder">config_test.dynamic.dotted.deleted</em> configuration that will not exist after import.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.module</em> depends on modules (<em class="placeholder">unknown, Database Logging</em>) that will not be installed after import.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.theme</em> depends on themes (<em class="placeholder">unknown, Seven</em>) that will not be installed after import.',
'Configuration <em class="placeholder">unknown.config</em> depends on the <em class="placeholder">unknown</em> extension that will not be installed after import.',
];
$this
->assertEquals(implode(PHP_EOL, $expected), $e
->getMessage());
$error_log = $this->configImporter
->getErrors();
$expected = [
'Configuration <em class="placeholder">config_test.dynamic.dotted.config</em> depends on configuration (<em class="placeholder">unknown, unknown2</em>) that will not exist after import.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.module</em> depends on modules (<em class="placeholder">unknown, Database Logging</em>) that will not be installed after import.',
'Configuration <em class="placeholder">config_test.dynamic.dotted.theme</em> depends on themes (<em class="placeholder">unknown, Seven</em>) that will not be installed after import.',
];
foreach ($expected as $expected_message) {
$this
->assertContainsEquals($expected_message, $error_log, $expected_message);
}
}
}
public function testMissingCoreExtension() {
$sync = $this->container
->get('config.storage.sync');
$sync
->delete('core.extension');
try {
$this->configImporter
->reset()
->import();
$this
->fail('ConfigImporterException not thrown, invalid import was not stopped due to missing dependencies.');
} catch (ConfigImporterException $e) {
$expected = static::FAIL_MESSAGE . PHP_EOL . 'The core.extension configuration does not exist.';
$this
->assertEquals($expected, $e
->getMessage());
$error_log = $this->configImporter
->getErrors();
$this
->assertEquals([
'The core.extension configuration does not exist.',
], $error_log);
}
}
public function testInstallProfile() {
$sync = $this->container
->get('config.storage.sync');
$extensions = $sync
->read('core.extension');
$extensions['module']['standard'] = 0;
$sync
->write('core.extension', $extensions);
try {
$this->configImporter
->reset()
->import();
$this
->fail('ConfigImporterException not thrown; an invalid import was not stopped due to missing dependencies.');
} catch (ConfigImporterException $e) {
$expected = static::FAIL_MESSAGE . PHP_EOL . 'Unable to install the <em class="placeholder">standard</em> module since it does not exist.';
$this
->assertEquals($expected, $e
->getMessage(), 'There were errors validating the config synchronization.');
$error_log = $this->configImporter
->getErrors();
$this
->assertEquals([
'Unable to install the <em class="placeholder">standard</em> module since it does not exist.',
], $error_log);
}
}
public function testInstallProfileMisMatch() {
$sync = $this->container
->get('config.storage.sync');
$extensions = $sync
->read('core.extension');
$extensions['profile'] = 'this_will_not_work';
$sync
->write('core.extension', $extensions);
try {
$this->configImporter
->reset()
->import();
$this
->fail('ConfigImporterException not thrown; an invalid import was not stopped due to missing dependencies.');
} catch (ConfigImporterException $e) {
$expected = static::FAIL_MESSAGE . PHP_EOL . 'Cannot change the install profile from <em class="placeholder"></em> to <em class="placeholder">this_will_not_work</em> once Drupal is installed.';
$this
->assertEquals($expected, $e
->getMessage(), 'There were errors validating the config synchronization.');
$error_log = $this->configImporter
->getErrors();
$this
->assertEquals([
'Cannot change the install profile from <em class="placeholder"></em> to <em class="placeholder">this_will_not_work</em> once Drupal is installed.',
], $error_log);
}
}
public function testIsSyncingInHooks() {
$dynamic_name = 'config_test.dynamic.dotted.default';
$storage = $this->container
->get('config.storage');
$config = $this
->config($dynamic_name);
$this
->assertSame('dotted.default', $config
->get('id'));
$storage
->delete($dynamic_name);
\Drupal::state()
->set('config_test.store_isSyncing', []);
$this->configImporter
->reset()
->import();
$state = \Drupal::state()
->get('config_test.store_isSyncing');
$this
->assertTrue($state['global_state::create'], '\\Drupal::isConfigSyncing() returns TRUE');
$this
->assertTrue($state['entity_state::create'], 'ConfigEntity::isSyncing() returns TRUE');
$this
->assertTrue($state['global_state::presave'], '\\Drupal::isConfigSyncing() returns TRUE');
$this
->assertTrue($state['entity_state::presave'], 'ConfigEntity::isSyncing() returns TRUE');
$this
->assertTrue($state['global_state::insert'], '\\Drupal::isConfigSyncing() returns TRUE');
$this
->assertTrue($state['entity_state::insert'], 'ConfigEntity::isSyncing() returns TRUE');
$config = $this
->config($dynamic_name);
$config
->set('label', 'A new name')
->save();
\Drupal::state()
->set('config_test.store_isSyncing', []);
$this->configImporter
->reset()
->import();
$state = \Drupal::state()
->get('config_test.store_isSyncing');
$this
->assertTrue($state['global_state::presave'], '\\Drupal::isConfigSyncing() returns TRUE');
$this
->assertTrue($state['entity_state::presave'], 'ConfigEntity::isSyncing() returns TRUE');
$this
->assertTrue($state['global_state::update'], '\\Drupal::isConfigSyncing() returns TRUE');
$this
->assertTrue($state['entity_state::update'], 'ConfigEntity::isSyncing() returns TRUE');
$sync = $this->container
->get('config.storage.sync');
$sync
->delete($dynamic_name);
\Drupal::state()
->set('config_test.store_isSyncing', []);
$this->configImporter
->reset()
->import();
$state = \Drupal::state()
->get('config_test.store_isSyncing');
$this
->assertTrue($state['global_state::predelete'], '\\Drupal::isConfigSyncing() returns TRUE');
$this
->assertTrue($state['entity_state::predelete'], 'ConfigEntity::isSyncing() returns TRUE');
$this
->assertTrue($state['global_state::delete'], '\\Drupal::isConfigSyncing() returns TRUE');
$this
->assertTrue($state['entity_state::delete'], 'ConfigEntity::isSyncing() returns TRUE');
}
public function testInvalidStep() {
$this
->assertFalse(\Drupal::isConfigSyncing(), 'Before an import \\Drupal::isConfigSyncing() returns FALSE');
$context = [];
try {
$this->configImporter
->doSyncStep('a_non_existent_step', $context);
$this
->fail('Expected \\InvalidArgumentException thrown');
} catch (\InvalidArgumentException $e) {
}
$this
->assertFalse(\Drupal::isConfigSyncing(), 'After an invalid step \\Drupal::isConfigSyncing() returns FALSE');
}
public function testCustomStep() {
$this
->assertFalse(\Drupal::isConfigSyncing(), 'Before an import \\Drupal::isConfigSyncing() returns FALSE');
$context = [];
$this->configImporter
->doSyncStep([
self::class,
'customStep',
], $context);
$this
->assertTrue($context['is_syncing'], 'Inside a custom step \\Drupal::isConfigSyncing() returns TRUE');
$this
->assertFalse(\Drupal::isConfigSyncing(), 'After an valid custom step \\Drupal::isConfigSyncing() returns FALSE');
}
public static function customStep(array &$context, ConfigImporter $importer) {
$context['is_syncing'] = \Drupal::isConfigSyncing();
}
}