class ConfigInstallTest in Drupal 8
Same name and namespace in other branches
- 9 core/tests/Drupal/KernelTests/Core/Config/ConfigInstallTest.php \Drupal\KernelTests\Core\Config\ConfigInstallTest
- 10 core/tests/Drupal/KernelTests/Core/Config/ConfigInstallTest.php \Drupal\KernelTests\Core\Config\ConfigInstallTest
Tests installation of configuration objects in installation functionality.
@group config
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\KernelTests\Core\Config\ConfigInstallTest
Expanded class hierarchy of ConfigInstallTest
See also
\Drupal\Core\Config\ConfigInstaller
File
- core/
tests/ Drupal/ KernelTests/ Core/ Config/ ConfigInstallTest.php, line 17
Namespace
Drupal\KernelTests\Core\ConfigView source
class ConfigInstallTest extends KernelTestBase {
/**
* {@inheritdoc}
*/
public static $modules = [
'system',
];
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
// Ensure the global variable being asserted by this test does not exist;
// a previous test executed in this request/process might have set it.
unset($GLOBALS['hook_config_test']);
}
/**
* Tests module installation.
*/
public function testModuleInstallation() {
$default_config = 'config_test.system';
$default_configuration_entity = 'config_test.dynamic.dotted.default';
// Verify that default module config does not exist before installation yet.
$config = $this
->config($default_config);
$this
->assertIdentical($config
->isNew(), TRUE);
$config = $this
->config($default_configuration_entity);
$this
->assertIdentical($config
->isNew(), TRUE);
// Ensure that schema provided by modules that are not installed is not
// available.
$this
->assertFalse(\Drupal::service('config.typed')
->hasConfigSchema('config_schema_test.someschema'), 'Configuration schema for config_schema_test.someschema does not exist.');
// Install the test module.
$this
->installModules([
'config_test',
]);
// Verify that default module config exists.
\Drupal::configFactory()
->reset($default_config);
\Drupal::configFactory()
->reset($default_configuration_entity);
$config = $this
->config($default_config);
$this
->assertIdentical($config
->isNew(), FALSE);
$config = $this
->config($default_configuration_entity);
$this
->assertIdentical($config
->isNew(), FALSE);
// Verify that config_test API hooks were invoked for the dynamic default
// configuration entity.
$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']));
// Install the schema test module.
$this
->enableModules([
'config_schema_test',
]);
$this
->installConfig([
'config_schema_test',
]);
// After module installation the new schema should exist.
$this
->assertTrue(\Drupal::service('config.typed')
->hasConfigSchema('config_schema_test.someschema'), 'Configuration schema for config_schema_test.someschema exists.');
// Test that uninstalling configuration removes configuration schema.
$this
->config('core.extension')
->set('module', [])
->save();
\Drupal::service('config.manager')
->uninstall('module', 'config_test');
$this
->assertFalse(\Drupal::service('config.typed')
->hasConfigSchema('config_schema_test.someschema'), 'Configuration schema for config_schema_test.someschema does not exist.');
}
/**
* Tests that collections are ignored if the event does not return anything.
*/
public function testCollectionInstallationNoCollections() {
// Install the test module.
$this
->enableModules([
'config_collection_install_test',
]);
$this
->installConfig([
'config_collection_install_test',
]);
/** @var \Drupal\Core\Config\StorageInterface $active_storage */
$active_storage = \Drupal::service('config.storage');
$this
->assertEqual([], $active_storage
->getAllCollectionNames());
}
/**
* Tests config objects in collections are installed as expected.
*/
public function testCollectionInstallationCollections() {
$collections = [
'another_collection',
'collection.test1',
'collection.test2',
];
// Set the event listener to return three possible collections.
// @see \Drupal\config_collection_install_test\EventSubscriber
\Drupal::state()
->set('config_collection_install_test.collection_names', $collections);
// Install the test module.
$this
->enableModules([
'config_collection_install_test',
]);
$this
->installConfig([
'config_collection_install_test',
]);
/** @var \Drupal\Core\Config\StorageInterface $active_storage */
$active_storage = \Drupal::service('config.storage');
$this
->assertEqual($collections, $active_storage
->getAllCollectionNames());
foreach ($collections as $collection) {
$collection_storage = $active_storage
->createCollection($collection);
$data = $collection_storage
->read('config_collection_install_test.test');
$this
->assertEqual($collection, $data['collection']);
}
// Tests that clashing configuration in collections is detected.
try {
\Drupal::service('module_installer')
->install([
'config_collection_clash_install_test',
]);
$this
->fail('Expected PreExistingConfigException not thrown.');
} catch (PreExistingConfigException $e) {
$this
->assertEqual($e
->getExtension(), 'config_collection_clash_install_test');
$this
->assertEqual($e
->getConfigObjects(), [
'another_collection' => [
'config_collection_install_test.test',
],
'collection.test1' => [
'config_collection_install_test.test',
],
'collection.test2' => [
'config_collection_install_test.test',
],
]);
$this
->assertEqual($e
->getMessage(), 'Configuration objects (another_collection/config_collection_install_test.test, collection/test1/config_collection_install_test.test, collection/test2/config_collection_install_test.test) provided by config_collection_clash_install_test already exist in active configuration');
}
// Test that the we can use the config installer to install all the
// available default configuration in a particular collection for enabled
// extensions.
\Drupal::service('config.installer')
->installCollectionDefaultConfig('entity');
// The 'entity' collection will not exist because the 'config_test' module
// is not enabled.
$this
->assertEqual($collections, $active_storage
->getAllCollectionNames());
// Enable the 'config_test' module and try again.
$this
->enableModules([
'config_test',
]);
\Drupal::service('config.installer')
->installCollectionDefaultConfig('entity');
$collections[] = 'entity';
$this
->assertEqual($collections, $active_storage
->getAllCollectionNames());
$collection_storage = $active_storage
->createCollection('entity');
$data = $collection_storage
->read('config_test.dynamic.dotted.default');
$this
->assertSame([
'label' => 'entity',
], $data);
// Test that the config manager uninstalls configuration from collections
// as expected.
\Drupal::service('config.manager')
->uninstall('module', 'config_collection_install_test');
$this
->assertEqual([
'entity',
], $active_storage
->getAllCollectionNames());
\Drupal::service('config.manager')
->uninstall('module', 'config_test');
$this
->assertEqual([], $active_storage
->getAllCollectionNames());
}
/**
* Tests collections which do not support config entities install correctly.
*
* Config entity detection during config installation is done by matching
* config name prefixes. If a collection provides a configuration with a
* matching name but does not support config entities it should be created
* using simple configuration.
*/
public function testCollectionInstallationCollectionConfigEntity() {
$collections = [
'entity',
];
\Drupal::state()
->set('config_collection_install_test.collection_names', $collections);
// Install the test module.
$this
->installModules([
'config_test',
'config_collection_install_test',
]);
/** @var \Drupal\Core\Config\StorageInterface $active_storage */
$active_storage = \Drupal::service('config.storage');
$this
->assertEqual($collections, $active_storage
->getAllCollectionNames());
$collection_storage = $active_storage
->createCollection('entity');
// The config_test.dynamic.dotted.default configuration object saved in the
// active store should be a configuration entity complete with UUID. Because
// the entity collection does not support configuration entities the
// configuration object stored there with the same name should only contain
// a label.
$name = 'config_test.dynamic.dotted.default';
$data = $active_storage
->read($name);
$this
->assertTrue(isset($data['uuid']));
$data = $collection_storage
->read($name);
$this
->assertSame([
'label' => 'entity',
], $data);
}
/**
* Tests the configuration with unmet dependencies is not installed.
*/
public function testDependencyChecking() {
$this
->installModules([
'config_test',
]);
try {
$this
->installModules([
'config_install_dependency_test',
]);
$this
->fail('Expected UnmetDependenciesException not thrown.');
} catch (UnmetDependenciesException $e) {
$this
->assertEqual($e
->getExtension(), 'config_install_dependency_test');
$this
->assertEqual($e
->getConfigObjects(), [
'config_test.dynamic.other_module_test_with_dependency' => [
'config_other_module_config_test',
'config_test.dynamic.dotted.english',
],
]);
$this
->assertEqual($e
->getMessage(), 'Configuration objects provided by <em class="placeholder">config_install_dependency_test</em> have unmet dependencies: <em class="placeholder">config_test.dynamic.other_module_test_with_dependency (config_other_module_config_test, config_test.dynamic.dotted.english)</em>');
}
try {
$this
->installModules([
'config_install_double_dependency_test',
]);
$this
->fail('Expected UnmetDependenciesException not thrown.');
} catch (UnmetDependenciesException $e) {
$this
->assertEquals('config_install_double_dependency_test', $e
->getExtension());
$this
->assertEquals([
'config_test.dynamic.other_module_test_with_dependency' => [
'config_other_module_config_test',
'config_test.dynamic.dotted.english',
],
], $e
->getConfigObjects());
$this
->assertEquals('Configuration objects provided by <em class="placeholder">config_install_double_dependency_test</em> have unmet dependencies: <em class="placeholder">config_test.dynamic.other_module_test_with_dependency (config_other_module_config_test, config_test.dynamic.dotted.english)</em>', $e
->getMessage());
}
$this
->installModules([
'config_test_language',
]);
try {
$this
->installModules([
'config_install_dependency_test',
]);
$this
->fail('Expected UnmetDependenciesException not thrown.');
} catch (UnmetDependenciesException $e) {
$this
->assertEqual($e
->getExtension(), 'config_install_dependency_test');
$this
->assertEqual($e
->getConfigObjects(), [
'config_test.dynamic.other_module_test_with_dependency' => [
'config_other_module_config_test',
],
]);
$this
->assertEqual($e
->getMessage(), 'Configuration objects provided by <em class="placeholder">config_install_dependency_test</em> have unmet dependencies: <em class="placeholder">config_test.dynamic.other_module_test_with_dependency (config_other_module_config_test)</em>');
}
$this
->installModules([
'config_other_module_config_test',
]);
$this
->installModules([
'config_install_dependency_test',
]);
$entity = \Drupal::entityTypeManager()
->getStorage('config_test')
->load('other_module_test_with_dependency');
$this
->assertNotEmpty($entity, 'The config_test.dynamic.other_module_test_with_dependency configuration has been created during install.');
// Ensure that dependencies can be added during module installation by
// hooks.
$this
->assertSame('config_install_dependency_test', $entity
->getDependencies()['module'][0]);
}
/**
* Tests imported configuration entities with and without language information.
*/
public function testLanguage() {
$this
->installModules([
'config_test_language',
]);
// Test imported configuration with implicit language code.
$storage = new InstallStorage();
$data = $storage
->read('config_test.dynamic.dotted.english');
$this
->assertTrue(!isset($data['langcode']));
$this
->assertEqual($this
->config('config_test.dynamic.dotted.english')
->get('langcode'), 'en');
// Test imported configuration with explicit language code.
$data = $storage
->read('config_test.dynamic.dotted.french');
$this
->assertEqual($data['langcode'], 'fr');
$this
->assertEqual($this
->config('config_test.dynamic.dotted.french')
->get('langcode'), 'fr');
}
/**
* Tests installing configuration where the filename and ID do not match.
*/
public function testIdMisMatch() {
$this
->expectException(Warning::class);
$this
->expectExceptionMessage('The configuration name "config_test.dynamic.no_id_match" does not match the ID "does_not_match"');
$this
->installModules([
'config_test_id_mismatch',
]);
}
/**
* Installs a module.
*
* @param array $modules
* The module names.
*/
protected function installModules(array $modules) {
$this->container
->get('module_installer')
->install($modules);
$this->container = \Drupal::getContainer();
}
}
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. | |
AssertHelperTrait:: |
protected static | function | Casts MarkupInterface objects into strings. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | ||
ConfigInstallTest:: |
public static | property |
Modules to enable. Overrides KernelTestBase:: |
|
ConfigInstallTest:: |
protected | function | Installs a module. | |
ConfigInstallTest:: |
protected | function |
Overrides KernelTestBase:: |
|
ConfigInstallTest:: |
public | function | Tests collections which do not support config entities install correctly. | |
ConfigInstallTest:: |
public | function | Tests config objects in collections are installed as expected. | |
ConfigInstallTest:: |
public | function | Tests that collections are ignored if the event does not return anything. | |
ConfigInstallTest:: |
public | function | Tests the configuration with unmet dependencies is not installed. | |
ConfigInstallTest:: |
public | function | Tests installing configuration where the filename and ID do not match. | |
ConfigInstallTest:: |
public | function | Tests imported configuration entities with and without language information. | |
ConfigInstallTest:: |
public | function | Tests module installation. | |
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
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 | property | @todo Move into Config test base class. | 7 |
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. | 1 |
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 | Returns whether the current test method is running in a separate process. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
26 |
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 | 6 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | BC: Automatically resolve former KernelTestBase class properties. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpunitCompatibilityTrait:: |
public | function | Returns a mock object for the specified class using the available method. | |
PhpunitCompatibilityTrait:: |
public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | |
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. |