--- /dev/null
+<?php
+
+namespace Drupal\KernelTests\Core\Config;
+
+use Drupal\Component\Utility\Html;
+use Drupal\Component\Utility\SafeMarkup;
+use Drupal\Core\Config\ConfigImporter;
+use Drupal\Core\Config\ConfigImporterException;
+use Drupal\Core\Config\StorageComparer;
+use Drupal\KernelTests\KernelTestBase;
+
+/**
+ * Tests importing configuration from files into active configuration.
+ *
+ * @group config
+ */
+class ConfigImporterTest extends KernelTestBase {
+
+ /**
+ * Config Importer object used for testing.
+ *
+ * @var \Drupal\Core\Config\ConfigImporter
+ */
+ protected $configImporter;
+
+ /**
+ * Modules to enable.
+ *
+ * @var array
+ */
+ public static $modules = ['config_test', 'system', 'config_import_test'];
+
+ protected function setUp() {
+ parent::setUp();
+
+ $this->installConfig(['config_test']);
+ // Installing config_test's default configuration pollutes the global
+ // variable being used for recording hook invocations by this test already,
+ // so it has to be cleared out manually.
+ unset($GLOBALS['hook_config_test']);
+
+ $this->copyConfig($this->container->get('config.storage'), $this->container->get('config.storage.sync'));
+
+ // Set up the ConfigImporter object for testing.
+ $storage_comparer = new StorageComparer(
+ $this->container->get('config.storage.sync'),
+ $this->container->get('config.storage'),
+ $this->container->get('config.manager')
+ );
+ $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')
+ );
+ }
+
+ /**
+ * Tests omission of module APIs for bare configuration operations.
+ */
+ public function testNoImport() {
+ $dynamic_name = 'config_test.dynamic.dotted.default';
+
+ // Verify the default configuration values exist.
+ $config = $this->config($dynamic_name);
+ $this->assertIdentical($config->get('id'), 'dotted.default');
+
+ // Verify that a bare $this->config() does not involve module APIs.
+ $this->assertFalse(isset($GLOBALS['hook_config_test']));
+ }
+
+ /**
+ * Tests that trying to import from an empty sync configuration directory
+ * fails.
+ */
+ public function testEmptyImportFails() {
+ try {
+ $this->container->get('config.storage.sync')->deleteAll();
+ $this->configImporter->reset()->import();
+ $this->fail('ConfigImporterException thrown, successfully stopping an empty import.');
+ }
+ catch (ConfigImporterException $e) {
+ $this->pass('ConfigImporterException thrown, successfully stopping an empty import.');
+ }
+ }
+
+ /**
+ * Tests verification of site UUID before importing configuration.
+ */
+ public function testSiteUuidValidate() {
+ $sync = \Drupal::service('config.storage.sync');
+ // Create updated configuration object.
+ $config_data = $this->config('system.site')->get();
+ // Generate a new site UUID.
+ $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) {
+ $this->assertEqual($e->getMessage(), 'There were errors validating the config synchronization.');
+ $error_log = $this->configImporter->getErrors();
+ $expected = ['Site UUID in source storage does not match the target storage.'];
+ $this->assertEqual($expected, $error_log);
+ }
+ }
+
+ /**
+ * Tests deletion of configuration during import.
+ */
+ public function testDeleted() {
+ $dynamic_name = 'config_test.dynamic.dotted.default';
+ $storage = $this->container->get('config.storage');
+ $sync = $this->container->get('config.storage.sync');
+
+ // Verify the default configuration values exist.
+ $config = $this->config($dynamic_name);
+ $this->assertIdentical($config->get('id'), 'dotted.default');
+
+ // Delete the file from the sync directory.
+ $sync->delete($dynamic_name);
+
+ // Import.
+ $this->configImporter->reset()->import();
+
+ // Verify the file has been removed.
+ $this->assertIdentical($storage->read($dynamic_name), FALSE);
+
+ $config = $this->config($dynamic_name);
+ $this->assertIdentical($config->get('id'), NULL);
+
+ // Verify that appropriate module API hooks have been invoked.
+ $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->assertEqual(count($logs), 0);
+ }
+
+ /**
+ * Tests creation of configuration during import.
+ */
+ public function testNew() {
+ $dynamic_name = 'config_test.dynamic.new';
+ $storage = $this->container->get('config.storage');
+ $sync = $this->container->get('config.storage.sync');
+
+ // Verify the configuration to create does not exist yet.
+ $this->assertIdentical($storage->exists($dynamic_name), FALSE, $dynamic_name . ' not found.');
+
+ // Create new config entity.
+ $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->assertIdentical($sync->exists($dynamic_name), TRUE, $dynamic_name . ' found.');
+
+ // Import.
+ $this->configImporter->reset()->import();
+
+ // Verify the values appeared.
+ $config = $this->config($dynamic_name);
+ $this->assertIdentical($config->get('label'), $original_dynamic_data['label']);
+
+ // Verify that appropriate module API hooks have been invoked.
+ $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']));
+
+ // Verify that hook_config_import_steps_alter() can add steps to
+ // configuration synchronization.
+ $this->assertTrue(isset($GLOBALS['hook_config_test']['config_import_steps_alter']));
+
+ // Verify that there is nothing more to import.
+ $this->assertFalse($this->configImporter->hasUnprocessedConfigurationChanges());
+ $logs = $this->configImporter->getErrors();
+ $this->assertEqual(count($logs), 0);
+ }
+
+ /**
+ * Tests that secondary writes are overwritten.
+ */
+ 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(),
+ // Add a dependency on primary, to ensure that is synced first.
+ 'dependencies' => [
+ 'config' => [$name_primary],
+ ]
+ ];
+ $sync->write($name_secondary, $values_secondary);
+
+ // Import.
+ $this->configImporter->reset()->import();
+
+ $entity_storage = \Drupal::entityManager()->getStorage('config_test');
+ $primary = $entity_storage->load('primary');
+ $this->assertEqual($primary->id(), 'primary');
+ $this->assertEqual($primary->uuid(), $values_primary['uuid']);
+ $this->assertEqual($primary->label(), $values_primary['label']);
+ $secondary = $entity_storage->load('secondary');
+ $this->assertEqual($secondary->id(), 'secondary');
+ $this->assertEqual($secondary->uuid(), $values_secondary['uuid']);
+ $this->assertEqual($secondary->label(), $values_secondary['label']);
+
+ $logs = $this->configImporter->getErrors();
+ $this->assertEqual(count($logs), 1);
+ $this->assertEqual($logs[0], SafeMarkup::format('Deleted and replaced configuration entity "@name"', ['@name' => $name_secondary]));
+ }
+
+ /**
+ * Tests that secondary writes are overwritten.
+ */
+ 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(),
+ // Add a dependency on secondary, so that is synced first.
+ '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);
+
+ // Import.
+ $this->configImporter->reset()->import();
+
+ $entity_storage = \Drupal::entityManager()->getStorage('config_test');
+ $primary = $entity_storage->load('primary');
+ $this->assertEqual($primary->id(), 'primary');
+ $this->assertEqual($primary->uuid(), $values_primary['uuid']);
+ $this->assertEqual($primary->label(), $values_primary['label']);
+ $secondary = $entity_storage->load('secondary');
+ $this->assertEqual($secondary->id(), 'secondary');
+ $this->assertEqual($secondary->uuid(), $values_secondary['uuid']);
+ $this->assertEqual($secondary->label(), $values_secondary['label']);
+
+ $logs = $this->configImporter->getErrors();
+ $this->assertEqual(count($logs), 1);
+ $this->assertEqual($logs[0], Html::escape("Unexpected error during import with operation create for $name_primary: 'config_test' entity with ID 'secondary' already exists."));
+ }
+
+ /**
+ * Tests that secondary updates for deleted files work as expected.
+ */
+ 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(),
+ // Add a dependency on deleter, to make sure that is synced first.
+ 'dependencies' => [
+ 'config' => [$name_deleter],
+ ]
+ ];
+ $storage->write($name_deletee, $values_deletee);
+ $values_deletee['label'] = 'Updated Deletee';
+ $sync->write($name_deletee, $values_deletee);
+
+ // Ensure that import will continue after the error.
+ $values_other = [
+ 'id' => 'other',
+ 'label' => 'Other',
+ 'weight' => 0,
+ 'uuid' => $uuid->generate(),
+ // Add a dependency on deleter, to make sure that is synced first. This
+ // will also be synced after the deletee due to alphabetical ordering.
+ 'dependencies' => [
+ 'config' => [$name_deleter],
+ ]
+ ];
+ $storage->write($name_other, $values_other);
+ $values_other['label'] = 'Updated other';
+ $sync->write($name_other, $values_other);
+
+ // Check update changelist order.
+ $updates = $this->configImporter->reset()->getStorageComparer()->getChangelist('update');
+ $expected = [
+ $name_deleter,
+ $name_deletee,
+ $name_other,
+ ];
+ $this->assertIdentical($expected, $updates);
+
+ // Import.
+ $this->configImporter->import();
+
+ $entity_storage = \Drupal::entityManager()->getStorage('config_test');
+ $deleter = $entity_storage->load('deleter');
+ $this->assertEqual($deleter->id(), 'deleter');
+ $this->assertEqual($deleter->uuid(), $values_deleter['uuid']);
+ $this->assertEqual($deleter->label(), $values_deleter['label']);
+
+ // The deletee was deleted in
+ // \Drupal\config_test\Entity\ConfigTest::postSave().
+ $this->assertFalse($entity_storage->load('deletee'));
+
+ $other = $entity_storage->load('other');
+ $this->assertEqual($other->id(), 'other');
+ $this->assertEqual($other->uuid(), $values_other['uuid']);
+ $this->assertEqual($other->label(), $values_other['label']);
+
+ $logs = $this->configImporter->getErrors();
+ $this->assertEqual(count($logs), 1);
+ $this->assertEqual($logs[0], SafeMarkup::format('Update target "@name" is missing.', ['@name' => $name_deletee]));
+ }
+
+ /**
+ * Tests that secondary updates for deleted files work as expected.
+ *
+ * This test is completely hypothetical since we only support full
+ * configuration tree imports. Therefore, any configuration updates that cause
+ * secondary deletes should be reflected already in the staged configuration.
+ */
+ 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(),
+ // Add a dependency on deletee, to make sure that is synced first.
+ '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);
+
+ // Import.
+ $this->configImporter->reset()->import();
+
+ $entity_storage = \Drupal::entityManager()->getStorage('config_test');
+ // Both entities are deleted. ConfigTest::postSave() causes updates of the
+ // deleter entity to delete the deletee entity. Since the deleter depends on
+ // the deletee, removing the deletee causes the deleter to be removed.
+ $this->assertFalse($entity_storage->load('deleter'));
+ $this->assertFalse($entity_storage->load('deletee'));
+ $logs = $this->configImporter->getErrors();
+ $this->assertEqual(count($logs), 0);
+ }
+
+ /**
+ * Tests that secondary deletes for deleted files work as expected.
+ */
+ 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(),
+ // Add a dependency on deletee, to make sure this delete is synced first.
+ '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);
+
+ // Import.
+ $this->configImporter->reset()->import();
+
+ $entity_storage = \Drupal::entityManager()->getStorage('config_test');
+ $this->assertFalse($entity_storage->load('deleter'));
+ $this->assertFalse($entity_storage->load('deletee'));
+ // The deletee entity does not exist as the delete worked and although the
+ // delete occurred in \Drupal\config_test\Entity\ConfigTest::postDelete()
+ // this does not matter.
+ $logs = $this->configImporter->getErrors();
+ $this->assertEqual(count($logs), 0);
+ }
+
+ /**
+ * Tests updating of configuration during import.
+ */
+ 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');
+
+ // Verify that the configuration objects to import exist.
+ $this->assertIdentical($storage->exists($name), TRUE, $name . ' found.');
+ $this->assertIdentical($storage->exists($dynamic_name), TRUE, $dynamic_name . ' found.');
+
+ // Replace the file content of the existing configuration objects in the
+ // sync directory.
+ $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);
+
+ // Verify the active configuration still returns the default values.
+ $config = $this->config($name);
+ $this->assertIdentical($config->get('foo'), 'bar');
+ $config = $this->config($dynamic_name);
+ $this->assertIdentical($config->get('label'), 'Default');
+
+ // Import.
+ $this->configImporter->reset()->import();
+
+ // Verify the values were updated.
+ \Drupal::configFactory()->reset($name);
+ $config = $this->config($name);
+ $this->assertIdentical($config->get('foo'), 'beer');
+ $config = $this->config($dynamic_name);
+ $this->assertIdentical($config->get('label'), 'Updated');
+
+ // Verify that the original file content is still the same.
+ $this->assertIdentical($sync->read($name), $original_name_data);
+ $this->assertIdentical($sync->read($dynamic_name), $original_dynamic_data);
+
+ // Verify that appropriate module API hooks have been invoked.
+ $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']));
+
+ // Verify that there is nothing more to import.
+ $this->assertFalse($this->configImporter->hasUnprocessedConfigurationChanges());
+ $logs = $this->configImporter->getErrors();
+ $this->assertEqual(count($logs), 0);
+ }
+
+ /**
+ * Tests the isInstallable method()
+ */
+ 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));
+ }
+
+ /**
+ * Tests dependency validation during configuration import.
+ *
+ * @see \Drupal\Core\EventSubscriber\ConfigImportSubscriber
+ * @see \Drupal\Core\Config\ConfigImporter::createExtensionChangelist()
+ */
+ public function testUnmetDependency() {
+ $storage = $this->container->get('config.storage');
+ $sync = $this->container->get('config.storage.sync');
+
+ // Test an unknown configuration owner.
+ $sync->write('unknown.config', ['test' => 'test']);
+
+ // Make a config entity have unmet dependencies.
+ $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);
+
+ // Make an active config depend on something that is missing in sync.
+ // The whole configuration needs to be consistent, not only the updated one.
+ $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');
+ // Add a module and a theme that do not exist.
+ $extensions['module']['unknown_module'] = 0;
+ $extensions['theme']['unknown_theme'] = 0;
+ // Add a module and a theme that depend on uninstalled extensions.
+ $extensions['module']['book'] = 0;
+ $extensions['theme']['bartik'] = 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) {
+ $this->assertEqual($e->getMessage(), 'There were errors validating the config synchronization.');
+ $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.',
+ 'Unable to install the <em class="placeholder">Bartik</em> theme since it requires the <em class="placeholder">Classy</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.',
+ ];
+ foreach ($expected as $expected_message) {
+ $this->assertTrue(in_array($expected_message, $error_log), $expected_message);
+ }
+ }
+
+ // Make a config entity have mulitple unmet dependencies.
+ $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) {
+ $this->assertEqual($e->getMessage(), 'There were errors validating the config synchronization.');
+ $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->assertTrue(in_array($expected_message, $error_log), $expected_message);
+ }
+ }
+ }
+
+ /**
+ * Tests missing core.extension during configuration import.
+ *
+ * @see \Drupal\Core\EventSubscriber\ConfigImportSubscriber
+ */
+ 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) {
+ $this->assertEqual($e->getMessage(), 'There were errors validating the config synchronization.');
+ $error_log = $this->configImporter->getErrors();
+ $this->assertEqual(['The core.extension configuration does not exist.'], $error_log);
+ }
+ }
+
+ /**
+ * Tests install profile validation during configuration import.
+ *
+ * @see \Drupal\Core\EventSubscriber\ConfigImportSubscriber
+ */
+ public function testInstallProfile() {
+ $sync = $this->container->get('config.storage.sync');
+
+ $extensions = $sync->read('core.extension');
+ // Add an install profile.
+ $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) {
+ $this->assertEqual($e->getMessage(), 'There were errors validating the config synchronization.');
+ $error_log = $this->configImporter->getErrors();
+ // Install profiles should not even be scanned at this point.
+ $this->assertEqual(['Unable to install the <em class="placeholder">standard</em> module since it does not exist.'], $error_log);
+ }
+ }
+
+ /**
+ * Tests install profile validation during configuration import.
+ *
+ * @see \Drupal\Core\EventSubscriber\ConfigImportSubscriber
+ */
+ public function testInstallProfileMisMatch() {
+ $sync = $this->container->get('config.storage.sync');
+
+ $extensions = $sync->read('core.extension');
+ // Change the install profile.
+ $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) {
+ $this->assertEqual($e->getMessage(), 'There were errors validating the config synchronization.');
+ $error_log = $this->configImporter->getErrors();
+ // Install profiles can not be changed. Note that KernelTestBase currently
+ // does not use an install profile. This situation should be impossible
+ // to get in but site's can removed the install profile setting from
+ // settings.php so the test is valid.
+ $this->assertEqual(['Cannot change the install profile from <em class="placeholder">this_will_not_work</em> to <em class="placeholder"></em> once Drupal is installed.'], $error_log);
+ }
+ }
+
+ /**
+ * Tests config_get_config_directory().
+ */
+ public function testConfigGetConfigDirectory() {
+ global $config_directories;
+ $directory = config_get_config_directory(CONFIG_SYNC_DIRECTORY);
+ $this->assertEqual($config_directories[CONFIG_SYNC_DIRECTORY], $directory);
+
+ $message = 'Calling config_get_config_directory() with CONFIG_ACTIVE_DIRECTORY results in an exception.';
+ try {
+ config_get_config_directory(CONFIG_ACTIVE_DIRECTORY);
+ $this->fail($message);
+ }
+ catch (\Exception $e) {
+ $this->pass($message);
+ }
+ }
+
+ /**
+ * Tests the isSyncing flags.
+ */
+ public function testIsSyncingInHooks() {
+ $dynamic_name = 'config_test.dynamic.dotted.default';
+ $storage = $this->container->get('config.storage');
+
+ // Verify the default configuration values exist.
+ $config = $this->config($dynamic_name);
+ $this->assertSame('dotted.default', $config->get('id'));
+
+ // Delete the config so that create hooks will fire.
+ $storage->delete($dynamic_name);
+ \Drupal::state()->set('config_test.store_isSyncing', []);
+ $this->configImporter->reset()->import();
+
+ // The values of the syncing values should be stored in state by
+ // config_test_config_test_create().
+ $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');
+
+ // Cause a config update so update hooks will fire.
+ $config = $this->config($dynamic_name);
+ $config->set('label', 'A new name')->save();
+ \Drupal::state()->set('config_test.store_isSyncing', []);
+ $this->configImporter->reset()->import();
+
+ // The values of the syncing values should be stored in state by
+ // config_test_config_test_create().
+ $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');
+
+ // Cause a config delete so delete hooks will fire.
+ $sync = $this->container->get('config.storage.sync');
+ $sync->delete($dynamic_name);
+ \Drupal::state()->set('config_test.store_isSyncing', []);
+ $this->configImporter->reset()->import();
+
+ // The values of the syncing values should be stored in state by
+ // config_test_config_test_create().
+ $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');
+ }
+
+ /**
+ * Tests that the isConfigSyncing flag is cleanup after an invalid step.
+ */
+ 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->pass('Expected \InvalidArgumentException thrown');
+ }
+ $this->assertFalse(\Drupal::isConfigSyncing(), 'After an invalid step \Drupal::isConfigSyncing() returns FALSE');
+ }
+
+ /**
+ * Tests that the isConfigSyncing flag is set correctly during a custom step.
+ */
+ 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');
+ }
+
+ /**
+ * Helper meothd to test custom config installer steps.
+ *
+ * @param array $context
+ * Batch context.
+ * @param \Drupal\Core\Config\ConfigImporter $importer
+ * The config importer.
+ */
+ public static function customStep(array &$context, ConfigImporter $importer) {
+ $context['is_syncing'] = \Drupal::isConfigSyncing();
+ }
+
+}
projects / yaffs-website / blobdiff