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