class ModuleInstallerTest
Same name in other branches
- 9 core/tests/Drupal/KernelTests/Core/Extension/ModuleInstallerTest.php \Drupal\KernelTests\Core\Extension\ModuleInstallerTest
- 8.9.x core/tests/Drupal/KernelTests/Core/Extension/ModuleInstallerTest.php \Drupal\KernelTests\Core\Extension\ModuleInstallerTest
- 10 core/tests/Drupal/KernelTests/Core/Extension/ModuleInstallerTest.php \Drupal\KernelTests\Core\Extension\ModuleInstallerTest
Tests the ModuleInstaller class.
@coversDefaultClass \Drupal\Core\Extension\ModuleInstaller
@group Extension
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\ExtensionListTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait
- class \Drupal\KernelTests\Core\Extension\ModuleInstallerTest extends \Drupal\KernelTests\KernelTestBase
Expanded class hierarchy of ModuleInstallerTest
File
-
core/
tests/ Drupal/ KernelTests/ Core/ Extension/ ModuleInstallerTest.php, line 22
Namespace
Drupal\KernelTests\Core\ExtensionView source
class ModuleInstallerTest extends KernelTestBase {
/**
* Tests that routes are rebuilt during install and uninstall of modules.
*
* @covers ::install
* @covers ::uninstall
*/
public function testRouteRebuild() : void {
// Remove the routing table manually to ensure it can be created lazily
// properly.
Database::getConnection()->schema()
->dropTable('router');
$this->container
->get('module_installer')
->install([
'router_test',
]);
$route = $this->container
->get('router.route_provider')
->getRouteByName('router_test.1');
$this->assertEquals('/router_test/test1', $route->getPath());
$this->container
->get('module_installer')
->uninstall([
'router_test',
]);
$this->expectException(RouteNotFoundException::class);
$this->container
->get('router.route_provider')
->getRouteByName('router_test.1');
}
/**
* Tests config changes by hook_install() are saved for dependent modules.
*
* @covers ::install
*/
public function testConfigChangeOnInstall() : void {
// Install the child module so the parent is installed automatically.
$this->container
->get('module_installer')
->install([
'module_handler_test_multiple_child',
]);
$modules = $this->config('core.extension')
->get('module');
$this->assertArrayHasKey('module_handler_test_multiple', $modules, 'Module module_handler_test_multiple is installed');
$this->assertArrayHasKey('module_handler_test_multiple_child', $modules, 'Module module_handler_test_multiple_child is installed');
$this->assertEquals(1, $modules['module_handler_test_multiple'], 'Weight of module_handler_test_multiple is set.');
$this->assertEquals(1, $modules['module_handler_test_multiple_child'], 'Weight of module_handler_test_multiple_child is set.');
}
/**
* Tests cache bins defined by modules are removed when uninstalled.
*
* @covers ::removeCacheBins
*/
public function testCacheBinCleanup() : void {
$schema = $this->container
->get('database')
->schema();
$table = 'cache_module_cache_bin';
$module_installer = $this->container
->get('module_installer');
$module_installer->install([
'module_cache_bin',
]);
// Prime the bin.
/** @var \Drupal\Core\Cache\CacheBackendInterface $cache_bin */
$cache_bin = $this->container
->get('module_cache_bin.cache_bin');
$cache_bin->set('foo', 'bar');
// A database backend is used so there is a convenient way check whether the
// backend is uninstalled.
$this->assertTrue($schema->tableExists($table));
$module_installer->uninstall([
'module_cache_bin',
]);
$this->assertFalse($schema->tableExists($table));
}
/**
* Ensure that rebuilding the container in hook_install() works.
*/
public function testKernelRebuildDuringHookInstall() : void {
\Drupal::state()->set('module_test_install:rebuild_container', TRUE);
$module_installer = $this->container
->get('module_installer');
$this->assertTrue($module_installer->install([
'module_test',
]));
}
/**
* Tests install with a module with an invalid core version constraint.
*
* @dataProvider providerTestInvalidCoreInstall
* @covers ::install
*/
public function testInvalidCoreInstall($module_name, $install_dependencies) : void {
$this->expectException(MissingDependencyException::class);
$this->expectExceptionMessage("Unable to install modules: module '{$module_name}' is incompatible with this version of Drupal core.");
$this->container
->get('module_installer')
->install([
$module_name,
], $install_dependencies);
}
/**
* Data provider for testInvalidCoreInstall().
*/
public static function providerTestInvalidCoreInstall() {
return [
'no dependencies system_core_incompatible_semver_test' => [
'system_core_incompatible_semver_test',
FALSE,
],
'install_dependencies system_core_incompatible_semver_test' => [
'system_core_incompatible_semver_test',
TRUE,
],
];
}
/**
* Tests install with a dependency with an invalid core version constraint.
*
* @covers ::install
*/
public function testDependencyInvalidCoreInstall() : void {
$this->expectException(MissingDependencyException::class);
$this->expectExceptionMessage("Unable to install modules: module 'system_incompatible_core_version_dependencies_test'. Its dependency module 'system_core_incompatible_semver_test' is incompatible with this version of Drupal core.");
$this->container
->get('module_installer')
->install([
'system_incompatible_core_version_dependencies_test',
]);
}
/**
* Tests no dependencies install with a dependency with invalid core.
*
* @covers ::install
*/
public function testDependencyInvalidCoreInstallNoDependencies() : void {
$this->assertTrue($this->container
->get('module_installer')
->install([
'system_incompatible_core_version_dependencies_test',
], FALSE));
}
/**
* Tests trying to install an obsolete module.
*
* @covers ::install
*/
public function testObsoleteInstall() : void {
$this->expectException(ObsoleteExtensionException::class);
$this->expectExceptionMessage("Unable to install modules: module 'system_status_obsolete_test' is obsolete.");
$this->container
->get('module_installer')
->install([
'system_status_obsolete_test',
]);
}
/**
* Tests trying to install a deprecated module.
*
* @covers ::install
*
* @group legacy
*/
public function testDeprecatedInstall() : void {
$this->expectDeprecation("The module 'deprecated_module' is deprecated. See http://example.com/deprecated");
\Drupal::service('module_installer')->install([
'deprecated_module',
]);
$this->assertTrue(\Drupal::service('module_handler')->moduleExists('deprecated_module'));
}
/**
* Tests the BC layer for uninstall validators.
*
* @covers ::__construct
* @covers ::addUninstallValidator
*
* @group legacy
*/
public function testUninstallValidatorsBC() : void {
$this->expectDeprecation('The "module_installer.uninstall_validators" service is deprecated in drupal:11.1.0 and is removed from drupal:12.0.0. Inject "!tagged_iterator module_install.uninstall_validator" instead. See https://www.drupal.org/node/3432595');
$module_installer = new ModuleInstaller($this->container
->getParameter('app.root'), $this->container
->get('module_handler'), $this->container
->get('kernel'), $this->container
->get('database'), $this->container
->get('update.update_hook_registry'), $this->container
->get('logger.channel.default'));
$this->expectDeprecation('Drupal\\Core\\Extension\\ModuleInstaller::addUninstallValidator is deprecated in drupal:11.1.0 and is removed from drupal:12.0.0. Inject the uninstall validators into the constructor instead. See https://www.drupal.org/node/3432595');
$module_installer->addUninstallValidator($this->createMock(ModuleUninstallValidatorInterface::class));
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
AssertContentTrait::$content | protected | property | The current raw content. | ||
AssertContentTrait::$drupalSettings | protected | property | The drupalSettings value from the current raw $content. | ||
AssertContentTrait::$elements | protected | property | The XML structure parsed from the current raw $content. | 1 | |
AssertContentTrait::$plainTextContent | protected | property | The plain-text content of raw $content (text nodes). | ||
AssertContentTrait::assertEscaped | protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | ||
AssertContentTrait::assertField | protected | function | Asserts that a field exists with the given name or ID. | ||
AssertContentTrait::assertFieldById | protected | function | Asserts that a field exists with the given ID and value. | ||
AssertContentTrait::assertFieldByName | protected | function | Asserts that a field exists with the given name and value. | ||
AssertContentTrait::assertFieldByXPath | protected | function | Asserts that a field exists in the current page by the given XPath. | ||
AssertContentTrait::assertFieldChecked | protected | function | Asserts that a checkbox field in the current page is checked. | ||
AssertContentTrait::assertFieldsByValue | protected | function | Asserts that a field exists in the current page with a given Xpath result. | ||
AssertContentTrait::assertLink | protected | function | Passes if a link with the specified label is found. | ||
AssertContentTrait::assertLinkByHref | protected | function | Passes if a link containing a given href (part) is found. | ||
AssertContentTrait::assertNoDuplicateIds | protected | function | Asserts that each HTML ID is used for just a single element. | ||
AssertContentTrait::assertNoEscaped | protected | function | Passes if raw text IS NOT found escaped on loaded page, fail otherwise. | ||
AssertContentTrait::assertNoField | protected | function | Asserts that a field does not exist with the given name or ID. | ||
AssertContentTrait::assertNoFieldById | protected | function | Asserts that a field does not exist with the given ID and value. | ||
AssertContentTrait::assertNoFieldByName | protected | function | Asserts that a field does not exist with the given name and value. | ||
AssertContentTrait::assertNoFieldByXPath | protected | function | Asserts that a field does not exist or its value does not match, by XPath. | ||
AssertContentTrait::assertNoFieldChecked | protected | function | Asserts that a checkbox field in the current page is not checked. | ||
AssertContentTrait::assertNoLink | protected | function | Passes if a link with the specified label is not found. | ||
AssertContentTrait::assertNoLinkByHref | protected | function | Passes if a link containing a given href (part) is not found. | ||
AssertContentTrait::assertNoLinkByHrefInMainRegion | protected | function | Passes if a link containing a given href is not found in the main region. | ||
AssertContentTrait::assertNoOption | protected | function | Asserts that a select option in the current page does not exist. | ||
AssertContentTrait::assertNoOptionSelected | protected | function | Asserts that a select option in the current page is not checked. | ||
AssertContentTrait::assertNoPattern | protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | ||
AssertContentTrait::assertNoRaw | protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | ||
AssertContentTrait::assertNoText | protected | function | Passes if the page (with HTML stripped) does not contains the text. | ||
AssertContentTrait::assertNoTitle | protected | function | Pass if the page title is not the given string. | ||
AssertContentTrait::assertNoUniqueText | protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | ||
AssertContentTrait::assertOption | protected | function | Asserts that a select option in the current page exists. | ||
AssertContentTrait::assertOptionByText | protected | function | Asserts that a select option with the visible text exists. | ||
AssertContentTrait::assertOptionSelected | protected | function | Asserts that a select option in the current page is checked. | ||
AssertContentTrait::assertOptionSelectedWithDrupalSelector | protected | function | Asserts that a select option in the current page is checked. | ||
AssertContentTrait::assertOptionWithDrupalSelector | protected | function | Asserts that a select option in the current page exists. | ||
AssertContentTrait::assertPattern | protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | ||
AssertContentTrait::assertRaw | protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | ||
AssertContentTrait::assertText | protected | function | Passes if the page (with HTML stripped) contains the text. | ||
AssertContentTrait::assertTextHelper | protected | function | Helper for assertText and assertNoText. | ||
AssertContentTrait::assertTextPattern | protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | ||
AssertContentTrait::assertThemeOutput | protected | function | Asserts themed output. | ||
AssertContentTrait::assertTitle | protected | function | Pass if the page title is the given string. | ||
AssertContentTrait::assertUniqueText | protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | ||
AssertContentTrait::assertUniqueTextHelper | protected | function | Helper for assertUniqueText and assertNoUniqueText. | ||
AssertContentTrait::buildXPathQuery | protected | function | Builds an XPath query. | ||
AssertContentTrait::constructFieldXpath | protected | function | Helper: Constructs an XPath for the given set of attributes and value. | ||
AssertContentTrait::cssSelect | protected | function | Searches elements using a CSS selector in the raw content. | ||
AssertContentTrait::getAllOptions | protected | function | Get all option elements, including nested options, in a select. | ||
AssertContentTrait::getDrupalSettings | protected | function | Gets the value of drupalSettings for the currently-loaded page. | ||
AssertContentTrait::getRawContent | protected | function | Gets the current raw content. | ||
AssertContentTrait::getSelectedItem | protected | function | Get the selected value from a select field. | ||
AssertContentTrait::getTextContent | protected | function | Retrieves the plain-text content from the current raw content. | ||
AssertContentTrait::parse | protected | function | Parse content returned from curlExec using DOM and SimpleXML. | ||
AssertContentTrait::removeWhiteSpace | protected | function | Removes all white-space between HTML tags from the raw content. | ||
AssertContentTrait::setDrupalSettings | protected | function | Sets the value of drupalSettings for the currently-loaded page. | ||
AssertContentTrait::setRawContent | protected | function | Sets the raw content (e.g. HTML). | ||
AssertContentTrait::xpath | protected | function | Performs an xpath search on the contents of the internal browser. | ||
ConfigTestTrait::configImporter | protected | function | Returns a ConfigImporter object to import test configuration. | ||
ConfigTestTrait::copyConfig | protected | function | Copies configuration objects from source storage to target storage. | ||
ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. | ||
ExpectDeprecationTrait::getCallableName | private static | function | Returns a callable as a string suitable for inclusion in a message. | ||
ExpectDeprecationTrait::setUpErrorHandler | public | function | Sets up the test error handler. | ||
ExpectDeprecationTrait::tearDownErrorHandler | public | function | Tears down the test error handler. | ||
ExtensionListTestTrait::getModulePath | protected | function | Gets the path for the specified module. | ||
ExtensionListTestTrait::getThemePath | protected | function | Gets the path for the specified theme. | ||
KernelTestBase::$backupStaticAttributes | protected | property | Back up and restore static class properties that may be changed by tests. | ||
KernelTestBase::$backupStaticAttributesBlacklist | protected | property | Contains a few static class properties for performance. | ||
KernelTestBase::$classLoader | protected | property | |||
KernelTestBase::$configImporter | protected | property | @todo Move into Config test base class. | 6 | |
KernelTestBase::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | 4 | |
KernelTestBase::$container | protected | property | |||
KernelTestBase::$databasePrefix | protected | property | |||
KernelTestBase::$keyValue | protected | property | The key_value service that must persist between container rebuilds. | ||
KernelTestBase::$modules | protected static | property | Modules to install. | 563 | |
KernelTestBase::$root | protected | property | The app root. | ||
KernelTestBase::$siteDirectory | protected | property | |||
KernelTestBase::$strictConfigSchema | protected | property | Set to TRUE to strict check all configuration saved. | 9 | |
KernelTestBase::$usesSuperUserAccessPolicy | protected | property | Set to TRUE to make user 1 a super user. | 3 | |
KernelTestBase::$vfsRoot | protected | property | The virtual filesystem root directory. | ||
KernelTestBase::assertPostConditions | protected | function | 1 | ||
KernelTestBase::bootEnvironment | protected | function | Bootstraps a basic test environment. | ||
KernelTestBase::bootKernel | protected | function | Bootstraps a kernel for a test. | 1 | |
KernelTestBase::config | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | ||
KernelTestBase::disableModules | protected | function | Disables modules for this test. | ||
KernelTestBase::enableModules | protected | function | Enables modules for this test. | 1 | |
KernelTestBase::getConfigSchemaExclusions | protected | function | Gets the config schema exclusions for this test. | ||
KernelTestBase::getDatabaseConnectionInfo | protected | function | Returns the Database connection info to be used for this test. | 2 | |
KernelTestBase::getDatabasePrefix | public | function | |||
KernelTestBase::getExtensionsForModules | private | function | Returns Extension objects for $modules to install. | ||
KernelTestBase::getModulesToEnable | private static | function | Returns the modules to install for this test. | ||
KernelTestBase::initFileCache | protected | function | Initializes the FileCache component. | ||
KernelTestBase::installConfig | protected | function | Installs default configuration for a given list of modules. | ||
KernelTestBase::installEntitySchema | protected | function | Installs the storage schema for a specific entity type. | ||
KernelTestBase::installSchema | protected | function | Installs database tables from a module schema definition. | ||
KernelTestBase::register | public | function | Registers test-specific services. | Overrides ServiceProviderInterface::register | 27 |
KernelTestBase::render | protected | function | Renders a render array. | 1 | |
KernelTestBase::setInstallProfile | protected | function | Sets the install profile and rebuilds the container to update it. | ||
KernelTestBase::setSetting | protected | function | Sets an in-memory Settings variable. | ||
KernelTestBase::setUp | protected | function | 410 | ||
KernelTestBase::setUpBeforeClass | public static | function | 1 | ||
KernelTestBase::setUpFilesystem | protected | function | Sets up the filesystem, so things like the file directory. | 2 | |
KernelTestBase::tearDown | protected | function | 7 | ||
KernelTestBase::tearDownCloseDatabaseConnection | public | function | Additional tear down method to close the connection at the end. | ||
KernelTestBase::vfsDump | protected | function | Dumps the current state of the virtual filesystem to STDOUT. | ||
KernelTestBase::__construct | public | function | |||
KernelTestBase::__sleep | public | function | Prevents serializing any properties. | ||
ModuleInstallerTest::providerTestInvalidCoreInstall | public static | function | Data provider for testInvalidCoreInstall(). | ||
ModuleInstallerTest::testCacheBinCleanup | public | function | Tests cache bins defined by modules are removed when uninstalled. | ||
ModuleInstallerTest::testConfigChangeOnInstall | public | function | Tests config changes by hook_install() are saved for dependent modules. | ||
ModuleInstallerTest::testDependencyInvalidCoreInstall | public | function | Tests install with a dependency with an invalid core version constraint. | ||
ModuleInstallerTest::testDependencyInvalidCoreInstallNoDependencies | public | function | Tests no dependencies install with a dependency with invalid core. | ||
ModuleInstallerTest::testDeprecatedInstall | public | function | Tests trying to install a deprecated module. | ||
ModuleInstallerTest::testInvalidCoreInstall | public | function | Tests install with a module with an invalid core version constraint. | ||
ModuleInstallerTest::testKernelRebuildDuringHookInstall | public | function | Ensure that rebuilding the container in hook_install() works. | ||
ModuleInstallerTest::testObsoleteInstall | public | function | Tests trying to install an obsolete module. | ||
ModuleInstallerTest::testRouteRebuild | public | function | Tests that routes are rebuilt during install and uninstall of modules. | ||
ModuleInstallerTest::testUninstallValidatorsBC | public | function | Tests the BC layer for uninstall validators. | ||
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | ||
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | ||
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | ||
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | ||
StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | ||
TestRequirementsTrait::getDrupalRoot | protected static | function | Returns the Drupal root directory. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.