comparison core/tests/Drupal/FunctionalTests/Installer/InstallerTestBase.php @ 0:c75dbcec494b

Initial commit from drush-created site

+<?php
+
+namespace Drupal\FunctionalTests\Installer;
+
+use Drupal\Core\DrupalKernel;
+use Drupal\Core\Language\Language;
+use Drupal\Core\Session\UserSession;
+use Drupal\Core\Site\Settings;
+use Drupal\Core\Test\HttpClientMiddleware\TestHttpClientMiddleware;
+use Drupal\Tests\BrowserTestBase;
+use GuzzleHttp\HandlerStack;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
+
+/**
+ * Base class for testing the interactive installer.
+ */
+abstract class InstallerTestBase extends BrowserTestBase {
+
+  /**
+   * Custom settings.php values to write for a test run.
+   *
+   * @var array
+   *   An array of settings to write out, in the format expected by
+   *   drupal_rewrite_settings().
+   */
+  protected $settings = [];
+
+  /**
+   * The language code in which to install Drupal.
+   *
+   * @var string
+   */
+  protected $langcode = 'en';
+
+  /**
+   * The installation profile to install.
+   *
+   * @var string
+   */
+  protected $profile = 'testing';
+
+  /**
+   * Additional parameters to use for installer screens.
+   *
+   * @see FunctionalTestSetupTrait::installParameters()
+   *
+   * @var array
+   */
+  protected $parameters = [];
+
+  /**
+   * A string translation map used for translated installer screens.
+   *
+   * Keys are English strings, values are translated strings.
+   *
+   * @var array
+   */
+  protected $translations = [
+    'Save and continue' => 'Save and continue',
+  ];
+
+  /**
+   * Whether the installer has completed.
+   *
+   * @var bool
+   */
+  protected $isInstalled = FALSE;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    $this->isInstalled = FALSE;
+
+    $this->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' => '[e-mail]',
+      '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();
+
+    $this->visitInstaller();
+
+    // Select language.
+    $this->setUpLanguage();
+
+    // Select profile.
+    $this->setUpProfile();
+
+    // Address the requirements problem screen, if any.
+    $this->setUpRequirementsProblem();
+
+    // Configure settings.
+    $this->setUpSettings();
+
+    // @todo Allow test classes based on this class to act on further installer
+    //   screens.
+
+    // Configure site.
+    $this->setUpSite();
+
+    if ($this->isInstalled) {
+      // Import new settings.php written by the installer.
+      $request = Request::createFromGlobals();
+      $class_loader = require $this->container->get('app.root') . '/autoload.php';
+      Settings::initialize($this->container->get('app.root'), DrupalKernel::findSitePath($request), $class_loader);
+      foreach ($GLOBALS['config_directories'] as $type => $path) {
+        $this->configDirectories[$type] = $path;
+      }
+
+      // After writing settings.php, the installer removes write permissions
+      // from the site directory. To allow drupal_generate_test_ua() to write
+      // a file containing the private key for drupal_valid_test_ua(), the site
+      // directory has to be writable.
+      // BrowserTestBase::tearDown() will delete the entire test site directory.
+      // Not using File API; a potential error must trigger a PHP warning.
+      chmod($this->container->get('app.root') . '/' . $this->siteDirectory, 0777);
+      $this->kernel = DrupalKernel::createFromRequest($request, $class_loader, 'prod', FALSE);
+      $this->kernel->prepareLegacyRequest($request);
+      $this->container = $this->kernel->getContainer();
+
+      // Manually configure the test mail collector implementation to prevent
+      // tests from sending out emails and collect them in state instead.
+      $this->container->get('config.factory')
+        ->getEditable('system.mail')
+        ->set('interface.default', 'test_mail_collector')
+        ->save();
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function initFrontPage() {
+    // We don't want to visit the front page with the installer when
+    // initializing Mink, so we do nothing here.
+  }
+
+  /**
+   * Visits the interactive installer.
+   */
+  protected function visitInstaller() {
+    $this->drupalGet($GLOBALS['base_url'] . '/core/install.php');
+  }
+
+  /**
+   * Installer step: Select language.
+   */
+  protected function setUpLanguage() {
+    $edit = [
+      'langcode' => $this->langcode,
+    ];
+    $this->drupalPostForm(NULL, $edit, $this->translations['Save and continue']);
+  }
+
+  /**
+   * Installer step: Select installation profile.
+   */
+  protected function setUpProfile() {
+    $edit = [
+      'profile' => $this->profile,
+    ];
+    $this->drupalPostForm(NULL, $edit, $this->translations['Save and continue']);
+  }
+
+  /**
+   * Installer step: Configure settings.
+   */
+  protected function setUpSettings() {
+    $edit = $this->translatePostValues($this->parameters['forms']['install_settings_form']);
+    $this->drupalPostForm(NULL, $edit, $this->translations['Save and continue']);
+  }
+
+  /**
+   * Installer step: Requirements problem.
+   *
+   * Override this method to test specific requirements warnings or errors
+   * during the installer.
+   *
+   * @see system_requirements()
+   */
+  protected function setUpRequirementsProblem() {
+    // By default, skip the "recommended PHP version" warning on older test
+    // environments. This allows the installer to be tested consistently on
+    // both recommended PHP versions and older (but still supported) versions.
+    if (version_compare(phpversion(), '7.0') < 0) {
+      $this->continueOnExpectedWarnings(['PHP']);
+    }
+  }
+
+  /**
+   * Final installer step: Configure site.
+   */
+  protected function setUpSite() {
+    $edit = $this->translatePostValues($this->parameters['forms']['install_configure_form']);
+    $this->drupalPostForm(NULL, $edit, $this->translations['Save and continue']);
+    // If we've got to this point the site is installed using the regular
+    // installation workflow.
+    $this->isInstalled = TRUE;
+  }
+
+  /**
+   * {@inheritdoc}
+   *
+   * FunctionalTestSetupTrait::refreshVariables() tries to operate on persistent
+   * storage, which is only available after the installer completed.
+   */
+  protected function refreshVariables() {
+    if ($this->isInstalled) {
+      parent::refreshVariables();
+    }
+  }
+
+  /**
+   * Continues installation when an expected warning is found.
+   *
+   * @param string[] $expected_warnings
+   *   A list of warning summaries to expect on the requirements screen (e.g.
+   *   'PHP', 'PHP OPcode caching', etc.). If only the expected warnings
+   *   are found, the test will click the "continue anyway" link to go to the
+   *   next screen of the installer. If an expected warning is not found, or if
+   *   a warning not in the list is present, a fail is raised.
+   */
+  protected function continueOnExpectedWarnings($expected_warnings = []) {
+    // Don't try to continue if there are errors.
+    if (strpos($this->getTextContent(), 'Errors found') !== FALSE) {
+      return;
+    }
+    // Allow only details elements that are directly after the warning header
+    // or each other. There is no guaranteed wrapper we can rely on across
+    // distributions. When there are multiple warnings, the selectors will be:
+    // - h3#warning+details summary
+    // - h3#warning+details+details summary
+    // - etc.
+    // We add one more selector than expected warnings to confirm that there
+    // isn't any other warning before clicking the link.
+    // @todo Make this more reliable in
+    //   https://www.drupal.org/project/drupal/issues/2927345.
+    $selectors = [];
+    for ($i = 0; $i <= count($expected_warnings); $i++) {
+      $selectors[] = 'h3#warning' . implode('', array_fill(0, $i + 1, '+details')) . ' summary';
+    }
+    $warning_elements = $this->cssSelect(implode(', ', $selectors));
+
+    // Confirm that there are only the expected warnings.
+    $warnings = [];
+    foreach ($warning_elements as $warning) {
+      $warnings[] = trim($warning->getText());
+    }
+    $this->assertEquals($expected_warnings, $warnings);
+    $this->clickLink('continue anyway');
+    $this->checkForMetaRefresh();
+  }
+
+}