class InstallerTest
Same name in other branches
- 9 core/tests/Drupal/FunctionalTests/Installer/InstallerTest.php \Drupal\FunctionalTests\Installer\InstallerTest
- 8.9.x core/tests/Drupal/FunctionalTests/Installer/InstallerTest.php \Drupal\FunctionalTests\Installer\InstallerTest
- 10 core/tests/Drupal/FunctionalTests/Installer/InstallerTest.php \Drupal\FunctionalTests\Installer\InstallerTest
Tests the interactive installer.
@group Installer
Hierarchy
- class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Core\Test\FunctionalTestSetupTrait, \Drupal\Tests\UiHelperTrait, \Drupal\Core\Test\TestSetupTrait, \Drupal\Tests\block\Traits\BlockCreationTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\node\Traits\NodeCreationTrait, \Drupal\Tests\node\Traits\ContentTypeCreationTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\user\Traits\UserCreationTrait, \Drupal\Tests\XdebugRequestTrait, \Drupal\Tests\PhpUnitCompatibilityTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\ExtensionListTestTrait
- class \Drupal\FunctionalTests\Installer\InstallerTestBase extends \Drupal\Tests\BrowserTestBase uses \Drupal\Tests\RequirementsPageTrait
- class \Drupal\FunctionalTests\Installer\InstallerTest extends \Drupal\FunctionalTests\Installer\InstallerTestBase
- class \Drupal\FunctionalTests\Installer\InstallerTestBase extends \Drupal\Tests\BrowserTestBase uses \Drupal\Tests\RequirementsPageTrait
Expanded class hierarchy of InstallerTest
File
-
core/
tests/ Drupal/ FunctionalTests/ Installer/ InstallerTest.php, line 19
Namespace
Drupal\FunctionalTests\InstallerView source
class InstallerTest extends InstallerTestBase {
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* Ensures that the user page is available after installation.
*/
public function testInstaller() : void {
$this->assertNotEquals('0', \Drupal::service('asset.query_string')->get(), 'The dummy query string should be set during install');
$this->assertSession()
->addressEquals('user/1');
$this->assertSession()
->statusCodeEquals(200);
// Confirm that we are logged-in after installation.
$this->assertSession()
->pageTextContains($this->rootUser
->getAccountName());
// Verify that the confirmation message appears.
require_once $this->root . '/core/includes/install.inc';
$this->assertSession()
->pageTextContains('Congratulations, you installed Drupal!');
// Ensure that the timezone is correct for sites under test after installing
// interactively.
$this->assertEquals('Australia/Sydney', $this->config('system.date')
->get('timezone.default'));
// Ensure the profile has a weight of 1000.
$module_extension_list = \Drupal::service('extension.list.module');
$extensions = $module_extension_list->getList();
$this->assertArrayHasKey('testing', $extensions);
$this->assertEquals(1000, $extensions['testing']->weight);
// Ensures that router is not rebuilt unnecessarily during the install.
$this->assertSame(1, \Drupal::service('core.performance.test.recorder')->getCount('event', RoutingEvents::FINISHED));
}
/**
* Installer step: Select language.
*/
protected function setUpLanguage() : void {
// Test that \Drupal\Core\Render\BareHtmlPageRenderer adds assets and
// metatags as expected to the first page of the installer.
$this->assertSession()
->responseContains("css/components/button.css");
$this->assertSession()
->responseContains('<meta charset="utf-8" />');
// Assert that the expected title is present.
$this->assertEquals('Choose language', $this->cssSelect('main h2')[0]
->getText());
parent::setUpLanguage();
}
/**
* {@inheritdoc}
*/
protected function setUpProfile() : void {
$settings_services_file = DRUPAL_ROOT . '/sites/default/default.services.yml';
// Copy the testing-specific service overrides in place.
copy($settings_services_file, $this->siteDirectory . '/services.yml');
PerformanceTestRecorder::registerService($this->siteDirectory . '/services.yml', TRUE);
// Assert that the expected title is present.
$this->assertEquals('Select an installation profile', $this->cssSelect('main h2')[0]
->getText());
// Verify that Title/Label are not displayed when '#title_display' =>
// 'invisible' attribute is set.
$this->assertSession()
->elementsCount('xpath', "//span[contains(@class, 'visually-hidden') and contains(text(), 'Select an installation profile')]", 1);
parent::setUpProfile();
}
/**
* {@inheritdoc}
*/
protected function setUpSettings() : void {
// Assert that the expected title is present.
$this->assertEquals('Database configuration', $this->cssSelect('main h2')[0]
->getText());
// Assert that we use the by core supported database drivers by default and
// not the ones from the driver_test module.
$this->assertSession()
->elementTextEquals('xpath', '//label[@for="edit-driver-drupalmysqldriverdatabasemysql"]', 'MySQL, MariaDB, Percona Server, or equivalent');
$this->assertSession()
->elementTextEquals('xpath', '//label[@for="edit-driver-drupalpgsqldriverdatabasepgsql"]', 'PostgreSQL');
parent::setUpSettings();
}
/**
* {@inheritdoc}
*/
protected function setUpSite() : void {
// Assert that the expected title is present.
$this->assertEquals('Configure site', $this->cssSelect('main h2')[0]
->getText());
// Test that SiteConfigureForm::buildForm() has made the site directory and
// the settings file non-writable.
$site_directory = $this->container
->getParameter('app.root') . '/' . $this->siteDirectory;
$this->assertDirectoryIsNotWritable($site_directory);
$this->assertFileIsNotWritable($site_directory . '/settings.php');
parent::setUpSite();
}
/**
* {@inheritdoc}
*/
protected function visitInstaller() : void {
parent::visitInstaller();
// Assert the title is correct and has the title suffix.
$this->assertSession()
->titleEquals('Choose language | Drupal');
}
/**
* Confirms that the installation succeeded.
*/
public function testInstalled() : void {
$this->assertSession()
->addressEquals('user/1');
$this->assertSession()
->statusCodeEquals(200);
$database = Database::getConnection();
$module = $database->getProvider();
$module_handler = \Drupal::service('module_handler');
$module_extension_list = \Drupal::service('extension.list.module');
// Ensure the update module is not installed.
$this->assertFalse($module_handler->moduleExists('update'), 'The Update module is not installed.');
// Assert that the module that is providing the database driver has been
// installed.
$this->assertTrue($module_handler->moduleExists($module));
// The module that is providing the database driver should be uninstallable.
try {
$this->container
->get('module_installer')
->uninstall([
$module,
]);
$this->fail("Uninstalled {$module} module.");
} catch (ModuleUninstallValidatorException $e) {
$module_name = $module_extension_list->getName($module);
$driver = $database->driver();
$this->assertStringContainsString("The module '{$module_name}' is providing the database driver '{$driver}'.", $e->getMessage());
}
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|
BlockCreationTrait::placeBlock | protected | function | Creates a block instance based on default settings. | Aliased as: drupalPlaceBlock | ||
BrowserHtmlDebugTrait::$htmlOutputBaseUrl | protected | property | The Base URI to use for links to the output files. | |||
BrowserHtmlDebugTrait::$htmlOutputClassName | protected | property | Class name for HTML output logging. | |||
BrowserHtmlDebugTrait::$htmlOutputCounter | protected | property | Counter for HTML output logging. | |||
BrowserHtmlDebugTrait::$htmlOutputCounterStorage | protected | property | Counter storage for HTML output logging. | |||
BrowserHtmlDebugTrait::$htmlOutputDirectory | protected | property | Directory name for HTML output logging. | |||
BrowserHtmlDebugTrait::$htmlOutputEnabled | protected | property | HTML output enabled. | |||
BrowserHtmlDebugTrait::$htmlOutputTestId | protected | property | HTML output test ID. | |||
BrowserHtmlDebugTrait::formatHtmlOutputHeaders | protected | function | Formats HTTP headers as string for HTML output logging. | |||
BrowserHtmlDebugTrait::getHtmlOutputHeaders | protected | function | Returns headers in HTML output format. | 1 | ||
BrowserHtmlDebugTrait::getResponseLogHandler | protected | function | Provides a Guzzle middleware handler to log every response received. | |||
BrowserHtmlDebugTrait::htmlOutput | protected | function | Logs a HTML output message in a text file. | |||
BrowserHtmlDebugTrait::initBrowserOutputFile | protected | function | Creates the directory to store browser output. | |||
BrowserTestBase::$baseUrl | protected | property | The base URL. | |||
BrowserTestBase::$configImporter | protected | property | The config importer that can be used in a test. | |||
BrowserTestBase::$customTranslations | protected | property | An array of custom translations suitable for SettingsEditor::rewrite(). | |||
BrowserTestBase::$mink | protected | property | Mink session manager. | |||
BrowserTestBase::$minkDefaultDriverArgs | protected | property | Mink default driver params. | |||
BrowserTestBase::$minkDefaultDriverClass | protected | property | Mink class for the default driver to use. | 1 | ||
BrowserTestBase::$modules | protected static | property | Modules to install. | 723 | ||
BrowserTestBase::$originalContainer | protected | property | The original container. | |||
BrowserTestBase::$originalShutdownCallbacks | protected | property | The original array of shutdown function callbacks. | |||
BrowserTestBase::$timeLimit | protected | property | Time limit in seconds for the test. | |||
BrowserTestBase::$translationFilesDirectory | protected | property | The translation file directory for the test environment. | |||
BrowserTestBase::cleanupEnvironment | protected | function | Clean up the test environment. | |||
BrowserTestBase::config | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |||
BrowserTestBase::filePreDeleteCallback | public static | function | Ensures test files are deletable. | |||
BrowserTestBase::getDefaultDriverInstance | protected | function | Gets an instance of the default Mink driver. | |||
BrowserTestBase::getDrupalSettings | protected | function | Gets the JavaScript drupalSettings variable for the currently-loaded page. | 1 | ||
BrowserTestBase::getHttpClient | protected | function | Obtain the HTTP client for the system under test. | |||
BrowserTestBase::getMinkDriverArgs | protected | function | Gets the Mink driver args from an environment variable. | 1 | ||
BrowserTestBase::getOptions | protected | function | Helper function to get the options of select field. | |||
BrowserTestBase::getSession | public | function | Returns Mink session. | |||
BrowserTestBase::getSessionCookies | protected | function | Get session cookies from current session. | |||
BrowserTestBase::getTestMethodCaller | protected | function | Retrieves the current calling line in the class under test. | Overrides BrowserHtmlDebugTrait::getTestMethodCaller | ||
BrowserTestBase::initMink | protected | function | Initializes Mink sessions. | 1 | ||
BrowserTestBase::registerSessions | protected | function | Registers additional Mink sessions. | |||
BrowserTestBase::setUpAppRoot | protected | function | Sets up the root application path. | |||
BrowserTestBase::setUpBeforeClass | public static | function | 1 | |||
BrowserTestBase::tearDown | protected | function | 3 | |||
BrowserTestBase::translatePostValues | protected | function | Transforms a nested array into a flat array suitable for submitForm(). | |||
BrowserTestBase::xpath | protected | function | Performs an xpath search on the contents of the internal browser. | |||
BrowserTestBase::__construct | public | function | 1 | |||
BrowserTestBase::__sleep | public | function | Prevents serializing any properties. | |||
ConfigTestTrait::configImporter | protected | function | Returns a ConfigImporter object to import test configuration. | |||
ConfigTestTrait::copyConfig | protected | function | Copies configuration objects from source storage to target storage. | |||
ContentTypeCreationTrait::createContentType | protected | function | Creates a custom content type based on default settings. | Aliased as: drupalCreateContentType | 1 | |
ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. | |||
ExpectDeprecationTrait::getCallableName | private static | function | Returns a callable as a string suitable for inclusion in a message. | |||
ExpectDeprecationTrait::setUpErrorHandler | public | function | Sets up the test error handler. | |||
ExpectDeprecationTrait::tearDownErrorHandler | public | function | Tears down the test error handler. | |||
ExtensionListTestTrait::getModulePath | protected | function | Gets the path for the specified module. | |||
ExtensionListTestTrait::getThemePath | protected | function | Gets the path for the specified theme. | |||
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix | protected | property | The flag to set 'apcu_ensure_unique_prefix' setting. | 1 | ||
FunctionalTestSetupTrait::$classLoader | protected | property | The class loader to use for installation and initialization of setup. | |||
FunctionalTestSetupTrait::$rootUser | protected | property | The "#1" admin user. | |||
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy | protected | property | Set to TRUE to make user 1 a super user. | 8 | ||
FunctionalTestSetupTrait::doInstall | protected | function | Execute the non-interactive installer. | 1 | ||
FunctionalTestSetupTrait::getDatabaseTypes | protected | function | Returns all supported database driver installer objects. | |||
FunctionalTestSetupTrait::initConfig | protected | function | Initialize various configurations post-installation. | 1 | ||
FunctionalTestSetupTrait::initKernel | protected | function | Initializes the kernel after installation. | |||
FunctionalTestSetupTrait::initSettings | protected | function | Initialize settings created during install. | |||
FunctionalTestSetupTrait::initUserSession | protected | function | Initializes user 1 for the site to be installed. | |||
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty | protected | function | Installs the default theme defined by `static::$defaultTheme` when needed. | 1 | ||
FunctionalTestSetupTrait::installModulesFromClassProperty | protected | function | Install modules defined by `static::$modules`. | 1 | ||
FunctionalTestSetupTrait::prepareEnvironment | protected | function | Prepares the current environment for running the test. | 29 | ||
FunctionalTestSetupTrait::prepareRequestForGenerator | protected | function | Creates a mock request and sets it on the generator. | |||
FunctionalTestSetupTrait::prepareSettings | protected | function | Prepares site settings and services before installation. | 4 | ||
FunctionalTestSetupTrait::rebuildAll | protected | function | Resets and rebuilds the environment after setup. | |||
FunctionalTestSetupTrait::rebuildContainer | protected | function | Rebuilds \Drupal::getContainer(). | |||
FunctionalTestSetupTrait::resetAll | protected | function | Resets all data structures after having enabled new modules. | |||
FunctionalTestSetupTrait::setContainerParameter | protected | function | Changes parameters in the services.yml file. | |||
FunctionalTestSetupTrait::setupBaseUrl | protected | function | Sets up the base URL based upon the environment variable. | |||
FunctionalTestSetupTrait::writeSettings | protected | function | Rewrites the settings.php file of the test site. | 1 | ||
InstallerTest::$defaultTheme | protected | property | The theme to install as the default for testing. | Overrides BrowserTestBase::$defaultTheme | ||
InstallerTest::setUpLanguage | protected | function | Installer step: Select language. | Overrides InstallerTestBase::setUpLanguage | ||
InstallerTest::setUpProfile | protected | function | Installer step: Select installation profile. | Overrides InstallerTestBase::setUpProfile | ||
InstallerTest::setUpSettings | protected | function | Installer step: Configure settings. | Overrides InstallerTestBase::setUpSettings | ||
InstallerTest::setUpSite | protected | function | Final installer step: Configure site. | Overrides InstallerTestBase::setUpSite | ||
InstallerTest::testInstalled | public | function | Confirms that the installation succeeded. | |||
InstallerTest::testInstaller | public | function | Ensures that the user page is available after installation. | |||
InstallerTest::visitInstaller | protected | function | Visits the interactive installer. | Overrides InstallerTestBase::visitInstaller | ||
InstallerTestBase::$isInstalled | protected | property | Whether the installer has completed. | |||
InstallerTestBase::$langcode | protected | property | The language code in which to install Drupal. | 9 | ||
InstallerTestBase::$parameters | protected | property | Additional parameters to use for installer screens. | |||
InstallerTestBase::$profile | protected | property | The installation profile to install. | Overrides BrowserTestBase::$profile | 16 | |
InstallerTestBase::$settings | protected | property | Custom settings.php values to write for a test run. | |||
InstallerTestBase::$translations | protected | property | A string translation map used for translated installer screens. | |||
InstallerTestBase::initFrontPage | protected | function | Visits the front page when initializing Mink. | Overrides BrowserTestBase::initFrontPage | ||
InstallerTestBase::installDrupal | public | function | We are testing the installer, so set up a minimal environment for that. | Overrides BrowserTestBase::installDrupal | ||
InstallerTestBase::installParameters | protected | function | Returns the parameters that will be used when the test installs Drupal. | Overrides FunctionalTestSetupTrait::installParameters | 4 | |
InstallerTestBase::refreshVariables | protected | function | FunctionalTestSetupTrait::refreshVariables() tries to operate on persistent storage, which is only available after the installer completed. |
Overrides RefreshVariablesTrait::refreshVariables | ||
InstallerTestBase::setUp | protected | function | Overrides BrowserTestBase::setUp | 1 | ||
InstallerTestBase::setUpRequirementsProblem | protected | function | Installer step: Requirements problem. | 6 | ||
NodeCreationTrait::createNode | protected | function | Creates a node based on default settings. | Aliased as: drupalCreateNode | ||
NodeCreationTrait::getNodeByTitle | public | function | Get a node from the database based on its title. | Aliased as: drupalGetNodeByTitle | ||
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | |||
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | |||
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | |||
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |||
RequirementsPageTrait::assertErrorSummaries | protected | function | Asserts the given error summaries are present on the page. | |||
RequirementsPageTrait::assertRequirementSummaries | protected | function | Asserts the given requirements section summaries are present on the page. | |||
RequirementsPageTrait::assertWarningSummaries | protected | function | Asserts the given warning summaries are present on the page. | |||
RequirementsPageTrait::continueOnExpectedWarnings | protected | function | Continues installation when the expected warnings are found. | |||
RequirementsPageTrait::updateRequirementsProblem | protected | function | Handles the update requirements page. | |||
SessionTestTrait::$sessionName | protected | property | The name of the session cookie. | |||
SessionTestTrait::generateSessionName | protected | function | Generates a session cookie name. | |||
SessionTestTrait::getSessionName | protected | function | Returns the session name in use on the child site. | |||
StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | |||
TestRequirementsTrait::getDrupalRoot | protected static | function | Returns the Drupal root directory. | |||
TestSetupTrait::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | 3 | ||
TestSetupTrait::$container | protected | property | The dependency injection container used in the test. | |||
TestSetupTrait::$databasePrefix | protected | property | The database prefix of this test run. | |||
TestSetupTrait::$kernel | protected | property | The DrupalKernel instance used in the test. | |||
TestSetupTrait::$originalSite | protected | property | The site directory of the original parent site. | |||
TestSetupTrait::$privateFilesDirectory | protected | property | The private file directory for the test environment. | |||
TestSetupTrait::$publicFilesDirectory | protected | property | The public file directory for the test environment. | |||
TestSetupTrait::$root | protected | property | The app root. | |||
TestSetupTrait::$siteDirectory | protected | property | The site directory of this test run. | |||
TestSetupTrait::$strictConfigSchema | protected | property | Set to TRUE to strict check all configuration saved. | 4 | ||
TestSetupTrait::$tempFilesDirectory | protected | property | The temporary file directory for the test environment. | |||
TestSetupTrait::$testId | protected | property | The test run ID. | |||
TestSetupTrait::changeDatabasePrefix | protected | function | Changes the database connection to the prefixed one. | |||
TestSetupTrait::getConfigSchemaExclusions | protected | function | Gets the config schema exclusions for this test. | |||
TestSetupTrait::prepareDatabasePrefix | protected | function | Generates a database prefix for running tests. | 1 | ||
UiHelperTrait::$loggedInUser | protected | property | The current user logged in using the Mink controlled browser. | |||
UiHelperTrait::$maximumMetaRefreshCount | protected | property | The number of meta refresh redirects to follow, or NULL if unlimited. | |||
UiHelperTrait::$metaRefreshCount | protected | property | The number of meta refresh redirects followed during ::drupalGet(). | |||
UiHelperTrait::$useOneTimeLoginLinks | protected | property | Use one-time login links instead of submitting the login form. | 3 | ||
UiHelperTrait::assertSession | public | function | Returns WebAssert object. | 1 | ||
UiHelperTrait::buildUrl | protected | function | Builds an absolute URL from a system path or a URL object. | |||
UiHelperTrait::checkForMetaRefresh | protected | function | Checks for meta refresh tag and if found call drupalGet() recursively. | |||
UiHelperTrait::click | protected | function | Clicks the element with the given CSS selector. | |||
UiHelperTrait::clickLink | protected | function | Follows a link by complete name. | |||
UiHelperTrait::cssSelect | protected | function | Searches elements using a CSS selector in the raw content. | |||
UiHelperTrait::cssSelectToXpath | protected | function | Translates a CSS expression to its XPath equivalent. | |||
UiHelperTrait::drupalGet | protected | function | Retrieves a Drupal path or an absolute path. | 3 | ||
UiHelperTrait::drupalLogin | protected | function | Logs in a user using the Mink controlled browser. | |||
UiHelperTrait::drupalLogout | protected | function | Logs a user out of the Mink controlled browser and confirms. | |||
UiHelperTrait::drupalResetSession | protected | function | Resets the current active session back to Anonymous session. | |||
UiHelperTrait::drupalUserIsLoggedIn | protected | function | Returns whether a given user account is logged in. | |||
UiHelperTrait::getAbsoluteUrl | protected | function | Takes a path and returns an absolute path. | |||
UiHelperTrait::getTextContent | protected | function | Retrieves the plain-text content from the current page. | |||
UiHelperTrait::getUrl | protected | function | Get the current URL from the browser. | |||
UiHelperTrait::isTestUsingGuzzleClient | protected | function | Determines if test is using DrupalTestBrowser. | |||
UiHelperTrait::prepareRequest | protected | function | Prepare for a request to testing site. | 1 | ||
UiHelperTrait::submitForm | protected | function | Fills and submits a form. | |||
UserCreationTrait::checkPermissions | protected | function | Checks whether a given list of permission names is valid. | |||
UserCreationTrait::createAdminRole | protected | function | Creates an administrative role. | |||
UserCreationTrait::createRole | protected | function | Creates a role with specified permissions. | Aliased as: drupalCreateRole | ||
UserCreationTrait::createUser | protected | function | Create a user with a given set of permissions. | Aliased as: drupalCreateUser | ||
UserCreationTrait::grantPermissions | protected | function | Grant permissions to a user role. | |||
UserCreationTrait::setCurrentUser | protected | function | Switch the current logged in user. | |||
UserCreationTrait::setUpCurrentUser | protected | function | Creates a random user account and sets it as current user. | |||
XdebugRequestTrait::extractCookiesFromRequest | protected | function | Adds xdebug cookies, from request setup. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.