annotate core/modules/simpletest/src/InstallerTestBase.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\simpletest;
Chris@0 4
Chris@17 5 @trigger_error(__NAMESPACE__ . '\InstallerTestBase is deprecated in Drupal 8.6.0 and will be removed before Drupal 9.0.0. Instead, use \Drupal\FunctionalTests\Installer\InstallerTestBase, see https://www.drupal.org/node/2988752.', E_USER_DEPRECATED);
Chris@17 6
Chris@0 7 use Drupal\Core\DrupalKernel;
Chris@0 8 use Drupal\Core\Language\Language;
Chris@0 9 use Drupal\Core\Session\UserSession;
Chris@0 10 use Drupal\Core\Site\Settings;
Chris@18 11 use Drupal\Tests\RequirementsPageTrait;
Chris@0 12 use Symfony\Component\DependencyInjection\ContainerBuilder;
Chris@0 13 use Symfony\Component\DependencyInjection\Reference;
Chris@0 14 use Symfony\Component\HttpFoundation\Request;
Chris@0 15 use Symfony\Component\HttpFoundation\RequestStack;
Chris@0 16
Chris@0 17 /**
Chris@0 18 * Base class for testing the interactive installer.
Chris@17 19 *
Chris@17 20 * @deprecated in Drupal 8.6.0 and will be removed before Drupal 9.0.0.
Chris@17 21 * Use \Drupal\FunctionalTests\Installer\InstallerTestBase. See
Chris@17 22 * https://www.drupal.org/node/2988752
Chris@0 23 */
Chris@0 24 abstract class InstallerTestBase extends WebTestBase {
Chris@0 25
Chris@18 26 use RequirementsPageTrait;
Chris@18 27
Chris@0 28 /**
Chris@0 29 * Custom settings.php values to write for a test run.
Chris@0 30 *
Chris@0 31 * @var array
Chris@0 32 * An array of settings to write out, in the format expected by
Chris@0 33 * drupal_rewrite_settings().
Chris@0 34 */
Chris@0 35 protected $settings = [];
Chris@0 36
Chris@0 37 /**
Chris@0 38 * The language code in which to install Drupal.
Chris@0 39 *
Chris@0 40 * @var string
Chris@0 41 */
Chris@0 42 protected $langcode = 'en';
Chris@0 43
Chris@0 44 /**
Chris@0 45 * The installation profile to install.
Chris@0 46 *
Chris@0 47 * @var string
Chris@0 48 */
Chris@0 49 protected $profile = 'testing';
Chris@0 50
Chris@0 51 /**
Chris@0 52 * Additional parameters to use for installer screens.
Chris@0 53 *
Chris@0 54 * @see WebTestBase::installParameters()
Chris@0 55 *
Chris@0 56 * @var array
Chris@0 57 */
Chris@0 58 protected $parameters = [];
Chris@0 59
Chris@0 60 /**
Chris@0 61 * A string translation map used for translated installer screens.
Chris@0 62 *
Chris@0 63 * Keys are English strings, values are translated strings.
Chris@0 64 *
Chris@0 65 * @var array
Chris@0 66 */
Chris@0 67 protected $translations = [
Chris@0 68 'Save and continue' => 'Save and continue',
Chris@0 69 ];
Chris@0 70
Chris@0 71 /**
Chris@0 72 * Whether the installer has completed.
Chris@0 73 *
Chris@0 74 * @var bool
Chris@0 75 */
Chris@0 76 protected $isInstalled = FALSE;
Chris@0 77
Chris@0 78 /**
Chris@0 79 * {@inheritdoc}
Chris@0 80 */
Chris@0 81 protected function setUp() {
Chris@0 82 $this->isInstalled = FALSE;
Chris@0 83
Chris@0 84 // Define information about the user 1 account.
Chris@0 85 $this->rootUser = new UserSession([
Chris@0 86 'uid' => 1,
Chris@0 87 'name' => 'admin',
Chris@0 88 'mail' => 'admin@example.com',
Chris@0 89 'pass_raw' => $this->randomMachineName(),
Chris@0 90 ]);
Chris@0 91
Chris@0 92 // If any $settings are defined for this test, copy and prepare an actual
Chris@0 93 // settings.php, so as to resemble a regular installation.
Chris@0 94 if (!empty($this->settings)) {
Chris@0 95 // Not using File API; a potential error must trigger a PHP warning.
Chris@0 96 copy(DRUPAL_ROOT . '/sites/default/default.settings.php', DRUPAL_ROOT . '/' . $this->siteDirectory . '/settings.php');
Chris@0 97 $this->writeSettings($this->settings);
Chris@0 98 }
Chris@0 99
Chris@0 100 // Note that WebTestBase::installParameters() returns form input values
Chris@0 101 // suitable for a programmed \Drupal::formBuilder()->submitForm().
Chris@0 102 // @see WebTestBase::translatePostValues()
Chris@0 103 $this->parameters = $this->installParameters();
Chris@0 104
Chris@0 105 // Set up a minimal container (required by WebTestBase). Set cookie and
Chris@0 106 // server information so that XDebug works.
Chris@0 107 // @see install_begin_request()
Chris@0 108 $request = Request::create($GLOBALS['base_url'] . '/core/install.php', 'GET', [], $_COOKIE, [], $_SERVER);
Chris@0 109 $this->container = new ContainerBuilder();
Chris@0 110 $request_stack = new RequestStack();
Chris@0 111 $request_stack->push($request);
Chris@0 112 $this->container
Chris@0 113 ->set('request_stack', $request_stack);
Chris@0 114 $this->container
Chris@0 115 ->setParameter('language.default_values', Language::$defaultValues);
Chris@0 116 $this->container
Chris@0 117 ->register('language.default', 'Drupal\Core\Language\LanguageDefault')
Chris@0 118 ->addArgument('%language.default_values%');
Chris@0 119 $this->container
Chris@0 120 ->register('string_translation', 'Drupal\Core\StringTranslation\TranslationManager')
Chris@0 121 ->addArgument(new Reference('language.default'));
Chris@0 122 $this->container
Chris@0 123 ->set('app.root', DRUPAL_ROOT);
Chris@0 124 \Drupal::setContainer($this->container);
Chris@0 125
Chris@0 126 $this->visitInstaller();
Chris@0 127
Chris@0 128 // Select language.
Chris@0 129 $this->setUpLanguage();
Chris@0 130
Chris@0 131 // Select profile.
Chris@0 132 $this->setUpProfile();
Chris@0 133
Chris@14 134 // Address the requirements problem screen, if any.
Chris@14 135 $this->setUpRequirementsProblem();
Chris@14 136
Chris@0 137 // Configure settings.
Chris@0 138 $this->setUpSettings();
Chris@0 139
Chris@0 140 // @todo Allow test classes based on this class to act on further installer
Chris@0 141 // screens.
Chris@0 142
Chris@0 143 // Configure site.
Chris@0 144 $this->setUpSite();
Chris@0 145
Chris@0 146 if ($this->isInstalled) {
Chris@0 147 // Import new settings.php written by the installer.
Chris@0 148 $request = Request::createFromGlobals();
Chris@0 149 $class_loader = require $this->container->get('app.root') . '/autoload.php';
Chris@0 150 Settings::initialize($this->container->get('app.root'), DrupalKernel::findSitePath($request), $class_loader);
Chris@0 151 foreach ($GLOBALS['config_directories'] as $type => $path) {
Chris@0 152 $this->configDirectories[$type] = $path;
Chris@0 153 }
Chris@0 154
Chris@0 155 // After writing settings.php, the installer removes write permissions
Chris@0 156 // from the site directory. To allow drupal_generate_test_ua() to write
Chris@0 157 // a file containing the private key for drupal_valid_test_ua(), the site
Chris@0 158 // directory has to be writable.
Chris@0 159 // WebTestBase::tearDown() will delete the entire test site directory.
Chris@0 160 // Not using File API; a potential error must trigger a PHP warning.
Chris@0 161 chmod($this->container->get('app.root') . '/' . $this->siteDirectory, 0777);
Chris@0 162 $this->kernel = DrupalKernel::createFromRequest($request, $class_loader, 'prod', FALSE);
Chris@0 163 $this->kernel->prepareLegacyRequest($request);
Chris@0 164 $this->container = $this->kernel->getContainer();
Chris@0 165
Chris@0 166 // Manually configure the test mail collector implementation to prevent
Chris@0 167 // tests from sending out emails and collect them in state instead.
Chris@0 168 $this->container->get('config.factory')
Chris@0 169 ->getEditable('system.mail')
Chris@0 170 ->set('interface.default', 'test_mail_collector')
Chris@0 171 ->save();
Chris@0 172 }
Chris@0 173 }
Chris@0 174
Chris@0 175 /**
Chris@0 176 * Visits the interactive installer.
Chris@0 177 */
Chris@0 178 protected function visitInstaller() {
Chris@0 179 $this->drupalGet($GLOBALS['base_url'] . '/core/install.php');
Chris@0 180 }
Chris@0 181
Chris@0 182 /**
Chris@0 183 * Installer step: Select language.
Chris@0 184 */
Chris@0 185 protected function setUpLanguage() {
Chris@0 186 $edit = [
Chris@0 187 'langcode' => $this->langcode,
Chris@0 188 ];
Chris@0 189 $this->drupalPostForm(NULL, $edit, $this->translations['Save and continue']);
Chris@0 190 }
Chris@0 191
Chris@0 192 /**
Chris@0 193 * Installer step: Select installation profile.
Chris@0 194 */
Chris@0 195 protected function setUpProfile() {
Chris@0 196 $edit = [
Chris@0 197 'profile' => $this->profile,
Chris@0 198 ];
Chris@0 199 $this->drupalPostForm(NULL, $edit, $this->translations['Save and continue']);
Chris@0 200 }
Chris@0 201
Chris@0 202 /**
Chris@0 203 * Installer step: Configure settings.
Chris@0 204 */
Chris@0 205 protected function setUpSettings() {
Chris@0 206 $edit = $this->translatePostValues($this->parameters['forms']['install_settings_form']);
Chris@0 207 $this->drupalPostForm(NULL, $edit, $this->translations['Save and continue']);
Chris@0 208 }
Chris@0 209
Chris@0 210 /**
Chris@14 211 * Installer step: Requirements problem.
Chris@14 212 *
Chris@14 213 * Override this method to test specific requirements warnings or errors
Chris@14 214 * during the installer.
Chris@14 215 *
Chris@14 216 * @see system_requirements()
Chris@14 217 */
Chris@14 218 protected function setUpRequirementsProblem() {
Chris@18 219 // Do nothing.
Chris@14 220 }
Chris@14 221
Chris@14 222 /**
Chris@0 223 * Final installer step: Configure site.
Chris@0 224 */
Chris@0 225 protected function setUpSite() {
Chris@0 226 $edit = $this->translatePostValues($this->parameters['forms']['install_configure_form']);
Chris@0 227 $this->drupalPostForm(NULL, $edit, $this->translations['Save and continue']);
Chris@0 228 // If we've got to this point the site is installed using the regular
Chris@0 229 // installation workflow.
Chris@0 230 $this->isInstalled = TRUE;
Chris@0 231 }
Chris@0 232
Chris@0 233 /**
Chris@0 234 * {@inheritdoc}
Chris@0 235 *
Chris@0 236 * WebTestBase::refreshVariables() tries to operate on persistent storage,
Chris@0 237 * which is only available after the installer completed.
Chris@0 238 */
Chris@0 239 protected function refreshVariables() {
Chris@0 240 if ($this->isInstalled) {
Chris@0 241 parent::refreshVariables();
Chris@0 242 }
Chris@0 243 }
Chris@0 244
Chris@0 245 }