From fa3e38e10d26400d8ea83a9f718be716460a3112 Mon Sep 17 00:00:00 2001 From: webchick Date: Mon, 5 Feb 2018 14:12:20 -0800 Subject: [PATCH] Issue #2938185 by tedbow, JayKandari, navneet0693, acbramley, Eli-T, larowlan, webchick, markconroy, andrewmacpherson, David_Rothstein, smaz, ckrina: When installing Umami, only show warning if 'Demo Umami' radio button is selected (and ensure that it is obvious that warning message only applies to the Umami profile) --- .../Core/Installer/Form/SelectProfileForm.php | 29 ++++ core/profiles/demo_umami/demo_umami.info.yml | 4 +- .../Installer/Form/SelectProfileFormTest.php | 132 ++++++++++++++++++ 3 files changed, 163 insertions(+), 2 deletions(-) create mode 100644 core/tests/Drupal/FunctionalJavascriptTests/Core/Installer/Form/SelectProfileFormTest.php diff --git a/core/lib/Drupal/Core/Installer/Form/SelectProfileForm.php b/core/lib/Drupal/Core/Installer/Form/SelectProfileForm.php index ea209ad2c87..488242acee1 100644 --- a/core/lib/Drupal/Core/Installer/Form/SelectProfileForm.php +++ b/core/lib/Drupal/Core/Installer/Form/SelectProfileForm.php @@ -72,6 +72,11 @@ class SelectProfileForm extends FormBase { ]; foreach (array_keys($names) as $profile_name) { $form['profile'][$profile_name]['#description'] = isset($profiles[$profile_name]['description']) ? $this->t($profiles[$profile_name]['description']) : ''; + // @todo Remove hardcoding of 'demo_umami' profile for a generic warning + // system in https://www.drupal.org/project/drupal/issues/2822414. + if ($profile_name === 'demo_umami') { + $this->addUmamiWarning($form); + } } $form['actions'] = ['#type' => 'actions']; $form['actions']['submit'] = [ @@ -90,4 +95,28 @@ class SelectProfileForm extends FormBase { $install_state['parameters']['profile'] = $form_state->getValue('profile'); } + /** + * Show profile warning if 'demo_umami' profile is selected. + */ + protected function addUmamiWarning(array &$form) { + // Warning to show when this profile is selected. + $description = $form['profile']['demo_umami']['#description']; + // Re-defines radio #description to show warning when selected. + $form['profile']['demo_umami']['#description'] = [ + 'warning' => [ + '#type' => 'item', + '#markup' => $this->t('This profile is intended for demonstration purposes only.'), + '#wrapper_attributes' => [ + 'class' => ['messages', 'messages--warning'], + ], + '#states' => [ + 'visible' => [ + ':input[name="profile"]' => ['value' => 'demo_umami'], + ], + ], + ], + 'description' => ['#markup' => $description], + ]; + } + } diff --git a/core/profiles/demo_umami/demo_umami.info.yml b/core/profiles/demo_umami/demo_umami.info.yml index aa9367edd27..8e10250f8d7 100644 --- a/core/profiles/demo_umami/demo_umami.info.yml +++ b/core/profiles/demo_umami/demo_umami.info.yml @@ -1,6 +1,6 @@ -name: Umami Demo - Experimental +name: 'Demo: Umami Food Magazine (Experimental)' type: profile -description: 'Install with the Umami food magazine demonstration website, a sample Drupal website that shows off some of the features of what is possible with Drupal "Out of the Box".
' +description: 'Install an example site that shows off some of Drupal’s capabilities.' version: VERSION core: 8.x dependencies: diff --git a/core/tests/Drupal/FunctionalJavascriptTests/Core/Installer/Form/SelectProfileFormTest.php b/core/tests/Drupal/FunctionalJavascriptTests/Core/Installer/Form/SelectProfileFormTest.php new file mode 100644 index 00000000000..efad210c6a8 --- /dev/null +++ b/core/tests/Drupal/FunctionalJavascriptTests/Core/Installer/Form/SelectProfileFormTest.php @@ -0,0 +1,132 @@ +setupBaseUrl(); + + $this->prepareDatabasePrefix(); + + // Install Drupal test site. + $this->prepareEnvironment(); + + // Define information about the user 1 account. + $this->rootUser = new UserSession([ + 'uid' => 1, + 'name' => 'admin', + 'mail' => 'admin@example.com', + 'pass_raw' => $this->randomMachineName(), + ]); + + // If any $settings are defined for this test, copy and prepare an actual + // settings.php, so as to resemble a regular installation. + if (!empty($this->settings)) { + // Not using File API; a potential error must trigger a PHP warning. + copy(DRUPAL_ROOT . '/sites/default/default.settings.php', DRUPAL_ROOT . '/' . $this->siteDirectory . '/settings.php'); + $this->writeSettings($this->settings); + } + + // Note that FunctionalTestSetupTrait::installParameters() returns form + // input values suitable for a programmed + // \Drupal::formBuilder()->submitForm(). + // @see InstallerTestBase::translatePostValues() + $this->parameters = $this->installParameters(); + + // Set up a minimal container (required by BrowserTestBase). Set cookie and + // server information so that XDebug works. + // @see install_begin_request() + $request = Request::create($GLOBALS['base_url'] . '/core/install.php', 'GET', [], $_COOKIE, [], $_SERVER); + $this->container = new ContainerBuilder(); + $request_stack = new RequestStack(); + $request_stack->push($request); + $this->container + ->set('request_stack', $request_stack); + $this->container + ->setParameter('language.default_values', Language::$defaultValues); + $this->container + ->register('language.default', 'Drupal\Core\Language\LanguageDefault') + ->addArgument('%language.default_values%'); + $this->container + ->register('string_translation', 'Drupal\Core\StringTranslation\TranslationManager') + ->addArgument(new Reference('language.default')); + $this->container + ->register('http_client', 'GuzzleHttp\Client') + ->setFactory('http_client_factory:fromOptions'); + $this->container + ->register('http_client_factory', 'Drupal\Core\Http\ClientFactory') + ->setArguments([new Reference('http_handler_stack')]); + $handler_stack = HandlerStack::create(); + $test_http_client_middleware = new TestHttpClientMiddleware(); + $handler_stack->push($test_http_client_middleware(), 'test.http_client.middleware'); + $this->container + ->set('http_handler_stack', $handler_stack); + + $this->container + ->set('app.root', DRUPAL_ROOT); + \Drupal::setContainer($this->container); + + // Setup Mink. + $this->initMink(); + } + + /** + * {@inheritdoc} + */ + protected function initMink() { + // The temporary files directory doesn't exist yet, as install_base_system() + // has not run. We need to create the template cache directory recursively. + $path = $this->tempFilesDirectory . DIRECTORY_SEPARATOR . 'browsertestbase-templatecache'; + if (!file_exists($path)) { + mkdir($path, 0777, TRUE); + } + + parent::initMink(); + } + + /** + * {@inheritdoc} + * + * BrowserTestBase::refreshVariables() tries to operate on persistent storage, + * which is only available after the installer completed. + */ + protected function refreshVariables() { + // Intentionally empty as the site is not yet installed. + } + + /** + * Tests a warning message is displayed when the Umami profile is selected. + */ + public function testUmamiProfileWarningMessage() { + $this->drupalGet($GLOBALS['base_url'] . '/core/install.php'); + $edit = [ + 'langcode' => 'en', + ]; + $this->drupalPostForm(NULL, $edit, 'Save and continue'); + $page = $this->getSession()->getPage(); + $warning_message = $page->find('css', '.description .messages--warning'); + $this->assertFalse($warning_message->isVisible()); + $page->selectFieldOption('profile', 'demo_umami'); + $this->assertTrue($warning_message->isVisible()); + } + +}