diff --git a/core/modules/system/src/Form/ModulesListExperimentalConfirmForm.php b/core/modules/system/src/Form/ModulesListExperimentalConfirmForm.php new file mode 100644 index 0000000..32b6ec1 --- /dev/null +++ b/core/modules/system/src/Form/ModulesListExperimentalConfirmForm.php @@ -0,0 +1,68 @@ +t('Are you sure you wish to enable experimental modules?'); + } + + /** + * {@inheritdoc} + */ + public function getFormId() { + return 'system_modules_experimental_confirm_form'; + } + + /** + * {@inheritdoc} + */ + public function buildForm(array $form, FormStateInterface $form_state) { + $account = $this->currentUser()->id(); + $this->modules = $this->keyValueExpirable->get($account); + + // Redirect to the modules list page if the key value store is empty. + if (!$this->modules) { + return $this->redirect('system.modules_list'); + } + + drupal_set_message($this->t('Experimental modules are provided for testing purposes only. Use at your own risk.', [':url' => 'https://www.drupal.org/core/experimental']), 'warning'); + + $items = []; + // Display a list of required modules that have to be installed as well but + // were not manually selected. + if (!empty($this->modules['dependencies'])) { + foreach ($this->modules['dependencies'] as $module => $dependencies) { + $items[] = $this->formatPlural(count($dependencies), 'You must enable the @required module to install @module.', 'You must enable the @required modules to install @module.', array( + '@module' => $this->modules['install'][$module], + '@required' => implode(', ', $dependencies), + )); + } + } + + // Add the list of experimental modules after any other messages. + $items[] = $this->t('The following modules are experimental: @modules', ['@modules' => implode(', ', array_values($this->modules['experimental']))]); + $form['experimental_message'] = [ + '#theme' => 'item_list', + '#items' => $items, + ]; + + return ConfirmFormBase::buildForm($form, $form_state); + } + +} diff --git a/core/modules/system/src/Form/ModulesListForm.php b/core/modules/system/src/Form/ModulesListForm.php index e8a6cea..140ca10 100644 --- a/core/modules/system/src/Form/ModulesListForm.php +++ b/core/modules/system/src/Form/ModulesListForm.php @@ -368,6 +368,7 @@ protected function buildModuleList(FormStateInterface $form_state) { $modules = array( 'install' => array(), 'dependencies' => array(), + 'experimental' => [], ); // Required modules have to be installed. @@ -380,10 +381,14 @@ protected function buildModuleList(FormStateInterface $form_state) { } // First, build a list of all modules that were selected. - foreach ($packages as $items) { + foreach ($packages as $package => $items) { foreach ($items as $name => $checkbox) { if ($checkbox['enable'] && !$this->moduleHandler->moduleExists($name)) { $modules['install'][$name] = $data[$name]->info['name']; + // Identify experimental modules. + if ($package == 'Core (Experimental)') { + $modules['experimental'][$name] = $data[$name]->info['name']; + } } } } @@ -394,6 +399,11 @@ protected function buildModuleList(FormStateInterface $form_state) { if (!isset($modules['install'][$dependency]) && !$this->moduleHandler->moduleExists($dependency)) { $modules['dependencies'][$module][$dependency] = $data[$dependency]->info['name']; $modules['install'][$dependency] = $data[$dependency]->info['name']; + + // Identify experimental modules. + if ($data[$dependency]->info['package'] == 'Core (Experimental)') { + $modules['experimental'][$dependency] = $data[$dependency]->info['name']; + } } } } @@ -423,6 +433,20 @@ public function submitForm(array &$form, FormStateInterface $form_state) { // Retrieve a list of modules to install and their dependencies. $modules = $this->buildModuleList($form_state); + // Check whether any module is experimental, and if so, redirect to the + // confirmation form. + if (!empty($modules['experimental'])) { + // Write the list of changed module states into a key value store. + $account = $this->currentUser()->id(); + $this->keyValueExpirable->setWithExpire($account, $modules, 60); + + // Redirect to the confirmation form. + $form_state->setRedirect('system.modules_list_experimental_confirm'); + + // Exit here; the user must confirm enabling experimental modules. + return; + } + // Check if we have to install any dependencies. If there is one or more // dependencies that are not installed yet, redirect to the confirmation // form. diff --git a/core/modules/system/src/Tests/Module/ExperimentalModuleTest.php b/core/modules/system/src/Tests/Module/ExperimentalModuleTest.php new file mode 100644 index 0000000..09d58fc --- /dev/null +++ b/core/modules/system/src/Tests/Module/ExperimentalModuleTest.php @@ -0,0 +1,131 @@ +adminUser = $this->drupalCreateUser(['access administration pages', 'administer modules']); + $this->drupalLogin($this->adminUser); + } + + /** + * Tests installing experimental modules and dependencies in the UI. + */ + function testExperimentalConfirmForm() { + + // First, test installing a non-experimental module with no dependencies. + // There should be no confirmation form and no experimental module warning. + $edit = []; + $edit["modules[Testing][test_page_test][enable]"] = TRUE; + $this->drupalPostForm('admin/modules', $edit, t('Install')); + $this->assertText('Module Test page has been enabled.'); + $this->assertNoText('Experimental modules are provided for testing purposes only.'); + + // Uninstall the module. + \Drupal::service('module_installer')->uninstall(['test_page_test']); + + // Next, test installing an experimental module with no dependencies. + // There should be a confirmation form with an experimental warning, but no + // list of dependencies. + $edit = []; + $edit["modules[Core (Experimental)][experimental_module_test][enable]"] = TRUE; + $this->drupalPostForm('admin/modules', $edit, 'Install'); + + // The module should not be enabled and there should be a warning and a + // list of the experimental modules with only this one. + $this->assertNoText('Experimental Test has been enabled.'); + $this->assertText('Experimental modules are provided for testing purposes only.'); + $this->assertText('The following modules are experimental: Experimental Test'); + + // There should be no message about enabling dependencies. + $this->assertNoText('You must enable'); + + // Enable the module and confirm that it worked. + $this->drupalPostForm(NULL, [], 'Continue'); + $this->assertText('Experimental Test has been enabled.'); + + // Uninstall the module. + \Drupal::service('module_installer')->uninstall(['experimental_module_test']); + + // Test enabling a module that is not itself experimental, but that depends + // on an experimental module. + $edit = []; + $edit["modules[Testing][experimental_module_dependency_test][enable]"] = TRUE; + $this->drupalPostForm('admin/modules', $edit, 'Install'); + + // The module should not be enabled and there should be a warning and a + // list of the experimental modules with only this one. + $this->assertNoText('2 modules have been enabled: Experimental Dependency Test, Experimental Test'); + $this->assertText('Experimental modules are provided for testing purposes only.'); + + $this->assertText('The following modules are experimental: Experimental Test'); + + // Ensure the non-experimental module is not listed as experimental. + $this->assertNoText('The following modules are experimental: Experimental Test, Experimental Dependency Test'); + $this->assertNoText('The following modules are experimental: Experimental Dependency Test'); + + // There should be a message about enabling dependencies. + $this->assertText('You must enable the Experimental Test module to install Experimental Dependency Test'); + + // Enable the module and confirm that it worked. + $this->drupalPostForm(NULL, [], 'Continue'); + $this->assertText('2 modules have been enabled: Experimental Dependency Test, Experimental Test'); + + // Uninstall the modules. + \Drupal::service('module_installer')->uninstall(['experimental_module_test', 'experimental_module_dependency_test']); + + // Finally, check both the module and its experimental dependency. There is + // still a warning about experimental modules, but no message about + // dependencies, since the user specifically enabled the dependency. + $edit = []; + $edit["modules[Core (Experimental)][experimental_module_test][enable]"] = TRUE; + $edit["modules[Testing][experimental_module_dependency_test][enable]"] = TRUE; + $this->drupalPostForm('admin/modules', $edit, 'Install'); + + // The module should not be enabled and there should be a warning and a + // list of the experimental modules with only this one. + $this->assertNoText('2 modules have been enabled: Experimental Dependency Test, Experimental Test'); + $this->assertText('Experimental modules are provided for testing purposes only.'); + + $this->assertText('The following modules are experimental: Experimental Test'); + + // Ensure the non-experimental module is not listed as experimental. + $this->assertNoText('The following modules are experimental: Experimental Test, Experimental Dependency Test'); + $this->assertNoText('The following modules are experimental: Experimental Dependency Test'); + + // There should be no message about enabling dependencies. + $this->assertNoText('You must enable'); + + // Enable the module and confirm that it worked. + $this->drupalPostForm(NULL, [], 'Continue'); + $this->assertText('2 modules have been enabled: Experimental Test, Experimental Dependency Test'); + + } + +} diff --git a/core/modules/system/src/Tests/Module/InstallUninstallTest.php b/core/modules/system/src/Tests/Module/InstallUninstallTest.php index f50c68a..cfaa7e4 100644 --- a/core/modules/system/src/Tests/Module/InstallUninstallTest.php +++ b/core/modules/system/src/Tests/Module/InstallUninstallTest.php @@ -100,9 +100,24 @@ public function testInstallUninstall() { $edit["modules[$package][$name][enable]"] = TRUE; $this->drupalPostForm('admin/modules', $edit, t('Install')); + // Handle experimental modules, which require a confirmation screen. + if ($package == 'Core (Experimental)') { + $this->assertText('Are you sure you wish to enable experimental modules?'); + if (count($modules_to_install) > 1) { + // When there are experimental modules, needed dependencies do not + // result in the same page title, but there will be expected text + // indicating they need to be enabled. + $this->assertText('You must enable'); + } + $this->drupalPostForm(NULL, array(), t('Continue')); + } // Handle the case where modules were installed along with this one and // where we therefore hit a confirmation screen. - if (count($modules_to_install) > 1) { + elseif (count($modules_to_install) > 1) { + // Verify that we are on the correct form and that the expected text + // about enabling dependencies appears. + $this->assertText('Some required modules must be enabled'); + $this->assertText('You must enable'); $this->drupalPostForm(NULL, array(), t('Continue')); } @@ -178,10 +193,21 @@ public function testInstallUninstall() { // - That enabling more than one module at the same time does not lead to // any errors. $edit = array(); + $experimental = FALSE; foreach ($all_modules as $name => $module) { $edit['modules[' . $module->info['package'] . '][' . $name . '][enable]'] = TRUE; + // Track whether there is at least one experimental module. + if ($module->info['package'] == 'Core (Experimental)') { + $experimental = TRUE; + } } $this->drupalPostForm('admin/modules', $edit, t('Install')); + + // If there are experimental modules, click the confirm form. + if ($experimental) { + $this->assertText('Are you sure you wish to enable experimental modules?'); + $this->drupalPostForm(NULL, array(), t('Continue')); + } $this->assertText(t('@count modules have been enabled: ', array('@count' => count($all_modules))), 'Modules status has been updated.'); } diff --git a/core/modules/system/system.routing.yml b/core/modules/system/system.routing.yml index e6108ac..aca62db 100644 --- a/core/modules/system/system.routing.yml +++ b/core/modules/system/system.routing.yml @@ -273,6 +273,14 @@ system.modules_list_confirm: requirements: _permission: 'administer modules' +system.modules_list_experimental_confirm: + path: '/admin/modules/list/confirm-experimental' + defaults: + _form: 'Drupal\system\Form\ModulesListExperimentalConfirmForm' + _title: 'Experimental modules' + requirements: + _permission: 'administer modules' + system.theme_uninstall: path: '/admin/appearance/uninstall' defaults: diff --git a/core/modules/system/tests/modules/experimental_module_dependency_test/experimental_module_dependency_test.info.yml b/core/modules/system/tests/modules/experimental_module_dependency_test/experimental_module_dependency_test.info.yml new file mode 100644 index 0000000..665417f --- /dev/null +++ b/core/modules/system/tests/modules/experimental_module_dependency_test/experimental_module_dependency_test.info.yml @@ -0,0 +1,8 @@ +name: 'Experimental Dependency Test' +type: module +description: 'Module with a dependency in the experimental package.' +package: Testing +dependencies: + - experimental_module_test +version: VERSION +core: 8.x diff --git a/core/modules/system/tests/modules/experimental_module_dependency_test/experimental_module_dependency_test.module b/core/modules/system/tests/modules/experimental_module_dependency_test/experimental_module_dependency_test.module new file mode 100644 index 0000000..6136004 --- /dev/null +++ b/core/modules/system/tests/modules/experimental_module_dependency_test/experimental_module_dependency_test.module @@ -0,0 +1,6 @@ +