class ConfigImporterTest in Drupal 9
Same name and namespace in other branches
- 8 core/tests/Drupal/KernelTests/Core/Config/ConfigImporterTest.php \Drupal\KernelTests\Core\Config\ConfigImporterTest
Tests importing configuration from files into active configuration.
@group config
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\KernelTests\Core\Config\ConfigImporterTest
Expanded class hierarchy of ConfigImporterTest
File
- core/
tests/ Drupal/ KernelTests/ Core/ Config/ ConfigImporterTest.php, line 17
Namespace
Drupal\KernelTests\Core\ConfigView source
class ConfigImporterTest extends KernelTestBase {
/**
* The beginning of an import validation error.
*/
const FAIL_MESSAGE = 'There were errors validating the config synchronization.';
/**
* Config Importer object used for testing.
*
* @var \Drupal\Core\Config\ConfigImporter
*/
protected $configImporter;
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = [
'config_test',
'system',
'config_import_test',
];
protected function setUp() : void {
parent::setUp();
$this
->installConfig([
'system',
'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->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'));
}
/**
* 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
->assertSame('dotted.default', $config
->get('id'));
// 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() {
$this
->expectException(ConfigImporterException::class);
$this->container
->get('config.storage.sync')
->deleteAll();
$this->configImporter
->reset()
->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) {
$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);
}
}
}
/**
* 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
->assertSame('dotted.default', $config
->get('id'));
// Delete the file from the sync directory.
$sync
->delete($dynamic_name);
// Import.
$this->configImporter
->reset()
->import();
// Verify the file has been removed.
$this
->assertFalse($storage
->read($dynamic_name));
$config = $this
->config($dynamic_name);
$this
->assertNull($config
->get('id'));
// 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
->assertCount(0, $logs);
}
/**
* 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
->assertFalse($storage
->exists($dynamic_name), $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
->assertTrue($sync
->exists($dynamic_name), $dynamic_name . ' found.');
// Import.
$this->configImporter
->reset()
->import();
// Verify the values appeared.
$config = $this
->config($dynamic_name);
$this
->assertSame($original_dynamic_data['label'], $config
->get('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
->assertCount(0, $logs);
}
/**
* 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::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]);
}
/**
* 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::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]);
}
/**
* 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
->assertSame($expected, $updates);
// Import.
$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());
// The deletee was deleted in
// \Drupal\config_test\Entity\ConfigTest::postSave().
$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]);
}
/**
* 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::entityTypeManager()
->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
->assertNull($entity_storage
->load('deleter'));
$this
->assertNull($entity_storage
->load('deletee'));
$logs = $this->configImporter
->getErrors();
$this
->assertCount(0, $logs);
}
/**
* 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::entityTypeManager()
->getStorage('config_test');
$this
->assertNull($entity_storage
->load('deleter'));
$this
->assertNull($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
->assertCount(0, $logs);
}
/**
* 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
->assertTrue($storage
->exists($name), $name . ' found.');
$this
->assertTrue($storage
->exists($dynamic_name), $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
->assertSame('bar', $config
->get('foo'));
$config = $this
->config($dynamic_name);
$this
->assertSame('Default', $config
->get('label'));
// Import.
$this->configImporter
->reset()
->import();
// Verify the values were updated.
\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'));
// Verify that the original file content is still the same.
$this
->assertSame($original_name_data, $sync
->read($name));
$this
->assertSame($original_dynamic_data, $sync
->read($dynamic_name));
// 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
->assertCount(0, $logs);
}
/**
* 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']['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);
}
}
// Make a config entity have multiple 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) {
$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);
}
}
}
/**
* 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) {
$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);
}
}
/**
* 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) {
$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();
// Install profiles should not even be scanned at this point.
$this
->assertEquals([
'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) {
$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();
// 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
->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);
}
}
/**
* 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) {
// Expected exception; just continue testing.
}
$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 method 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();
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
ConfigImporterTest:: |
protected | property |
Config Importer object used for testing. Overrides KernelTestBase:: |
|
ConfigImporterTest:: |
protected static | property |
Modules to enable. Overrides KernelTestBase:: |
|
ConfigImporterTest:: |
public static | function | Helper method to test custom config installer steps. | |
ConfigImporterTest:: |
constant | The beginning of an import validation error. | ||
ConfigImporterTest:: |
protected | function |
Overrides KernelTestBase:: |
|
ConfigImporterTest:: |
public | function | Tests that the isConfigSyncing flag is set correctly during a custom step. | |
ConfigImporterTest:: |
public | function | Tests deletion of configuration during import. | |
ConfigImporterTest:: |
public | function | Tests that trying to import from an empty sync configuration directory fails. | |
ConfigImporterTest:: |
public | function | Tests install profile validation during configuration import. | |
ConfigImporterTest:: |
public | function | Tests install profile validation during configuration import. | |
ConfigImporterTest:: |
public | function | Tests that the isConfigSyncing flag is cleanup after an invalid step. | |
ConfigImporterTest:: |
public | function | Tests the isInstallable method() | |
ConfigImporterTest:: |
public | function | Tests the isSyncing flags. | |
ConfigImporterTest:: |
public | function | Tests missing core.extension during configuration import. | |
ConfigImporterTest:: |
public | function | Tests creation of configuration during import. | |
ConfigImporterTest:: |
public | function | Tests omission of module APIs for bare configuration operations. | |
ConfigImporterTest:: |
public | function | Tests that secondary deletes for deleted files work as expected. | |
ConfigImporterTest:: |
public | function | Tests that secondary updates for deleted files work as expected. | |
ConfigImporterTest:: |
public | function | Tests that secondary updates for deleted files work as expected. | |
ConfigImporterTest:: |
public | function | Tests that secondary writes are overwritten. | |
ConfigImporterTest:: |
public | function | Tests that secondary writes are overwritten. | |
ConfigImporterTest:: |
public | function | Tests verification of site UUID before importing configuration. | |
ConfigImporterTest:: |
public | function | Tests dependency validation during configuration import. | |
ConfigImporterTest:: |
public | function | Tests updating of configuration during import. | |
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
protected | property | Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 3 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
24 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 4 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. |