/core/modules/system/tests/src/Kernel/Extension/ModuleHandlerTest.php
PHP | 321 lines | 159 code | 50 blank | 112 comment | 6 complexity | 7416029baa71e75b7d0c67f049f6f12b MD5 | raw file
- <?php
- namespace Drupal\Tests\system\Kernel\Extension;
- use Drupal\Core\Extension\MissingDependencyException;
- use \Drupal\Core\Extension\ModuleUninstallValidatorException;
- use Drupal\entity_test\Entity\EntityTest;
- use Drupal\KernelTests\KernelTestBase;
- /**
- * Tests ModuleHandler functionality.
- *
- * @group Extension
- */
- class ModuleHandlerTest extends KernelTestBase {
- /**
- * {@inheritdoc}
- */
- public static $modules = ['system'];
- /**
- * {@inheritdoc}
- */
- protected function setUp() {
- parent::setUp();
- // @todo ModuleInstaller calls system_rebuild_module_data which is part of
- // system.module, see https://www.drupal.org/node/2208429.
- include_once $this->root . '/core/modules/system/system.module';
- // Set up the state values so we know where to find the files when running
- // drupal_get_filename().
- // @todo Remove as part of https://www.drupal.org/node/2186491
- system_rebuild_module_data();
- }
- /**
- * The basic functionality of retrieving enabled modules.
- */
- function testModuleList() {
- $module_list = ['system'];
- $this->assertModuleList($module_list, 'Initial');
- // Try to install a new module.
- $this->moduleInstaller()->install(array('ban'));
- $module_list[] = 'ban';
- sort($module_list);
- $this->assertModuleList($module_list, 'After adding a module');
- // Try to mess with the module weights.
- module_set_weight('ban', 20);
- // Move ban to the end of the array.
- unset($module_list[array_search('ban', $module_list)]);
- $module_list[] = 'ban';
- $this->assertModuleList($module_list, 'After changing weights');
- // Test the fixed list feature.
- $fixed_list = array(
- 'system' => 'core/modules/system/system.module',
- 'menu' => 'core/modules/menu/menu.module',
- );
- $this->moduleHandler()->setModuleList($fixed_list);
- $new_module_list = array_combine(array_keys($fixed_list), array_keys($fixed_list));
- $this->assertModuleList($new_module_list, t('When using a fixed list'));
- }
- /**
- * Assert that the extension handler returns the expected values.
- *
- * @param array $expected_values
- * The expected values, sorted by weight and module name.
- * @param $condition
- */
- protected function assertModuleList(array $expected_values, $condition) {
- $expected_values = array_values(array_unique($expected_values));
- $enabled_modules = array_keys($this->container->get('module_handler')->getModuleList());
- $this->assertEqual($expected_values, $enabled_modules, format_string('@condition: extension handler returns correct results', array('@condition' => $condition)));
- }
- /**
- * Tests dependency resolution.
- *
- * Intentionally using fake dependencies added via hook_system_info_alter()
- * for modules that normally do not have any dependencies.
- *
- * To simplify things further, all of the manipulated modules are either
- * purely UI-facing or live at the "bottom" of all dependency chains.
- *
- * @see module_test_system_info_alter()
- * @see https://www.drupal.org/files/issues/dep.gv__0.png
- */
- function testDependencyResolution() {
- $this->enableModules(array('module_test'));
- $this->assertTrue($this->moduleHandler()->moduleExists('module_test'), 'Test module is enabled.');
- // Ensure that modules are not enabled.
- $this->assertFalse($this->moduleHandler()->moduleExists('color'), 'Color module is disabled.');
- $this->assertFalse($this->moduleHandler()->moduleExists('config'), 'Config module is disabled.');
- $this->assertFalse($this->moduleHandler()->moduleExists('help'), 'Help module is disabled.');
- // Create a missing fake dependency.
- // Color will depend on Config, which depends on a non-existing module Foo.
- // Nothing should be installed.
- \Drupal::state()->set('module_test.dependency', 'missing dependency');
- drupal_static_reset('system_rebuild_module_data');
- try {
- $result = $this->moduleInstaller()->install(array('color'));
- $this->fail(t('ModuleInstaller::install() throws an exception if dependencies are missing.'));
- }
- catch (MissingDependencyException $e) {
- $this->pass(t('ModuleInstaller::install() throws an exception if dependencies are missing.'));
- }
- $this->assertFalse($this->moduleHandler()->moduleExists('color'), 'ModuleInstaller::install() aborts if dependencies are missing.');
- // Fix the missing dependency.
- // Color module depends on Config. Config depends on Help module.
- \Drupal::state()->set('module_test.dependency', 'dependency');
- drupal_static_reset('system_rebuild_module_data');
- $result = $this->moduleInstaller()->install(array('color'));
- $this->assertTrue($result, 'ModuleInstaller::install() returns the correct value.');
- // Verify that the fake dependency chain was installed.
- $this->assertTrue($this->moduleHandler()->moduleExists('config') && $this->moduleHandler()->moduleExists('help'), 'Dependency chain was installed.');
- // Verify that the original module was installed.
- $this->assertTrue($this->moduleHandler()->moduleExists('color'), 'Module installation with dependencies succeeded.');
- // Verify that the modules were enabled in the correct order.
- $module_order = \Drupal::state()->get('module_test.install_order') ?: array();
- $this->assertEqual($module_order, array('help', 'config', 'color'));
- // Uninstall all three modules explicitly, but in the incorrect order,
- // and make sure that ModuleInstaller::uninstall() uninstalled them in the
- // correct sequence.
- $result = $this->moduleInstaller()->uninstall(array('config', 'help', 'color'));
- $this->assertTrue($result, 'ModuleInstaller::uninstall() returned TRUE.');
- foreach (array('color', 'config', 'help') as $module) {
- $this->assertEqual(drupal_get_installed_schema_version($module), SCHEMA_UNINSTALLED, "$module module was uninstalled.");
- }
- $uninstalled_modules = \Drupal::state()->get('module_test.uninstall_order') ?: array();
- $this->assertEqual($uninstalled_modules, array('color', 'config', 'help'), 'Modules were uninstalled in the correct order.');
- // Enable Color module again, which should enable both the Config module and
- // Help module. But, this time do it with Config module declaring a
- // dependency on a specific version of Help module in its info file. Make
- // sure that Drupal\Core\Extension\ModuleInstaller::install() still works.
- \Drupal::state()->set('module_test.dependency', 'version dependency');
- drupal_static_reset('system_rebuild_module_data');
- $result = $this->moduleInstaller()->install(array('color'));
- $this->assertTrue($result, 'ModuleInstaller::install() returns the correct value.');
- // Verify that the fake dependency chain was installed.
- $this->assertTrue($this->moduleHandler()->moduleExists('config') && $this->moduleHandler()->moduleExists('help'), 'Dependency chain was installed.');
- // Verify that the original module was installed.
- $this->assertTrue($this->moduleHandler()->moduleExists('color'), 'Module installation with version dependencies succeeded.');
- // Finally, verify that the modules were enabled in the correct order.
- $enable_order = \Drupal::state()->get('module_test.install_order') ?: array();
- $this->assertIdentical($enable_order, array('help', 'config', 'color'));
- }
- /**
- * Tests uninstalling a module that is a "dependency" of a profile.
- */
- function testUninstallProfileDependency() {
- $profile = 'minimal';
- $dependency = 'dblog';
- $this->setSetting('install_profile', $profile);
- // Prime the drupal_get_filename() static cache with the location of the
- // minimal profile as it is not the currently active profile and we don't
- // yet have any cached way to retrieve its location.
- // @todo Remove as part of https://www.drupal.org/node/2186491
- drupal_get_filename('profile', $profile, 'core/profiles/' . $profile . '/' . $profile . '.info.yml');
- $this->enableModules(array('module_test', $profile));
- drupal_static_reset('system_rebuild_module_data');
- $data = system_rebuild_module_data();
- $this->assertTrue(isset($data[$profile]->requires[$dependency]));
- $this->moduleInstaller()->install(array($dependency));
- $this->assertTrue($this->moduleHandler()->moduleExists($dependency));
- // Uninstall the profile module "dependency".
- $result = $this->moduleInstaller()->uninstall(array($dependency));
- $this->assertTrue($result, 'ModuleInstaller::uninstall() returns TRUE.');
- $this->assertFalse($this->moduleHandler()->moduleExists($dependency));
- $this->assertEqual(drupal_get_installed_schema_version($dependency), SCHEMA_UNINSTALLED, "$dependency module was uninstalled.");
- // Verify that the installation profile itself was not uninstalled.
- $uninstalled_modules = \Drupal::state()->get('module_test.uninstall_order') ?: array();
- $this->assertTrue(in_array($dependency, $uninstalled_modules), "$dependency module is in the list of uninstalled modules.");
- $this->assertFalse(in_array($profile, $uninstalled_modules), 'The installation profile is not in the list of uninstalled modules.');
- }
- /**
- * Tests uninstalling a module that has content.
- */
- function testUninstallContentDependency() {
- $this->enableModules(array('module_test', 'entity_test', 'text', 'user', 'help'));
- $this->assertTrue($this->moduleHandler()->moduleExists('entity_test'), 'Test module is enabled.');
- $this->assertTrue($this->moduleHandler()->moduleExists('module_test'), 'Test module is enabled.');
- $this->installSchema('user', 'users_data');
- $entity_types = \Drupal::entityManager()->getDefinitions();
- foreach ($entity_types as $entity_type) {
- if ('entity_test' == $entity_type->getProvider()) {
- $this->installEntitySchema($entity_type->id());
- }
- }
- // Create a fake dependency.
- // entity_test will depend on help. This way help can not be uninstalled
- // when there is test content preventing entity_test from being uninstalled.
- \Drupal::state()->set('module_test.dependency', 'dependency');
- drupal_static_reset('system_rebuild_module_data');
- // Create an entity so that the modules can not be disabled.
- $entity = EntityTest::create(array('name' => $this->randomString()));
- $entity->save();
- // Uninstalling entity_test is not possible when there is content.
- try {
- $message = 'ModuleInstaller::uninstall() throws ModuleUninstallValidatorException upon uninstalling a module which does not pass validation.';
- $this->moduleInstaller()->uninstall(array('entity_test'));
- $this->fail($message);
- }
- catch (ModuleUninstallValidatorException $e) {
- $this->pass(get_class($e) . ': ' . $e->getMessage());
- }
- // Uninstalling help needs entity_test to be un-installable.
- try {
- $message = 'ModuleInstaller::uninstall() throws ModuleUninstallValidatorException upon uninstalling a module which does not pass validation.';
- $this->moduleInstaller()->uninstall(array('help'));
- $this->fail($message);
- }
- catch (ModuleUninstallValidatorException $e) {
- $this->pass(get_class($e) . ': ' . $e->getMessage());
- }
- // Deleting the entity.
- $entity->delete();
- $result = $this->moduleInstaller()->uninstall(array('help'));
- $this->assertTrue($result, 'ModuleInstaller::uninstall() returns TRUE.');
- $this->assertEqual(drupal_get_installed_schema_version('entity_test'), SCHEMA_UNINSTALLED, "entity_test module was uninstalled.");
- }
- /**
- * Tests whether the correct module metadata is returned.
- */
- function testModuleMetaData() {
- // Generate the list of available modules.
- $modules = system_rebuild_module_data();
- // Check that the mtime field exists for the system module.
- $this->assertTrue(!empty($modules['system']->info['mtime']), 'The system.info.yml file modification time field is present.');
- // Use 0 if mtime isn't present, to avoid an array index notice.
- $test_mtime = !empty($modules['system']->info['mtime']) ? $modules['system']->info['mtime'] : 0;
- // Ensure the mtime field contains a number that is greater than zero.
- $this->assertTrue(is_numeric($test_mtime) && ($test_mtime > 0), 'The system.info.yml file modification time field contains a timestamp.');
- }
- /**
- * Tests whether module-provided stream wrappers are registered properly.
- */
- public function testModuleStreamWrappers() {
- // file_test.module provides (among others) a 'dummy' stream wrapper.
- // Verify that it is not registered yet to prevent false positives.
- $stream_wrappers = \Drupal::service('stream_wrapper_manager')->getWrappers();
- $this->assertFalse(isset($stream_wrappers['dummy']));
- $this->moduleInstaller()->install(['file_test']);
- // Verify that the stream wrapper is available even without calling
- // \Drupal::service('stream_wrapper_manager')->getWrappers() again.
- // If the stream wrapper is not available file_exists() will raise a notice.
- file_exists('dummy://');
- $stream_wrappers = \Drupal::service('stream_wrapper_manager')->getWrappers();
- $this->assertTrue(isset($stream_wrappers['dummy']));
- }
- /**
- * Tests whether the correct theme metadata is returned.
- */
- function testThemeMetaData() {
- // Generate the list of available themes.
- $themes = \Drupal::service('theme_handler')->rebuildThemeData();
- // Check that the mtime field exists for the bartik theme.
- $this->assertTrue(!empty($themes['bartik']->info['mtime']), 'The bartik.info.yml file modification time field is present.');
- // Use 0 if mtime isn't present, to avoid an array index notice.
- $test_mtime = !empty($themes['bartik']->info['mtime']) ? $themes['bartik']->info['mtime'] : 0;
- // Ensure the mtime field contains a number that is greater than zero.
- $this->assertTrue(is_numeric($test_mtime) && ($test_mtime > 0), 'The bartik.info.yml file modification time field contains a timestamp.');
- }
- /**
- * Returns the ModuleHandler.
- *
- * @return \Drupal\Core\Extension\ModuleHandlerInterface
- */
- protected function moduleHandler() {
- return $this->container->get('module_handler');
- }
- /**
- * Returns the ModuleInstaller.
- *
- * @return \Drupal\Core\Extension\ModuleInstallerInterface
- */
- protected function moduleInstaller() {
- return $this->container->get('module_installer');
- }
- }