trait FunctionalTestSetupTrait
Same name in other branches
- 9 core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php \Drupal\Core\Test\FunctionalTestSetupTrait
- 8.9.x core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php \Drupal\Core\Test\FunctionalTestSetupTrait
- 10 core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php \Drupal\Core\Test\FunctionalTestSetupTrait
Defines a trait for shared functional test setup functionality.
Hierarchy
- trait \Drupal\Core\Test\FunctionalTestSetupTrait uses \Drupal\Tests\SessionTestTrait, \Drupal\Core\Test\RefreshVariablesTrait
2 files declare their use of FunctionalTestSetupTrait
- BrowserTestBase.php in core/
tests/ Drupal/ Tests/ BrowserTestBase.php - TestSiteInstallCommand.php in core/
tests/ Drupal/ TestSite/ Commands/ TestSiteInstallCommand.php
File
-
core/
lib/ Drupal/ Core/ Test/ FunctionalTestSetupTrait.php, line 32
Namespace
Drupal\Core\TestView source
trait FunctionalTestSetupTrait {
use SessionTestTrait;
use RefreshVariablesTrait;
/**
* The "#1" admin user.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $rootUser;
/**
* The class loader to use for installation and initialization of setup.
*
* @var \Composer\Autoload\ClassLoader
*/
protected $classLoader;
/**
* The flag to set 'apcu_ensure_unique_prefix' setting.
*
* Wide use of a unique prefix can lead to problems with memory, if tests are
* run with a concurrency higher than 1. Therefore, FALSE by default.
*
* @var bool
*
* @see \Drupal\Core\Site\Settings::getApcuPrefix().
*/
protected $apcuEnsureUniquePrefix = FALSE;
/**
* Set to TRUE to make user 1 a super user.
*
* @var bool
*
* @see \Drupal\Core\Session\SuperUserAccessPolicy
*/
protected bool $usesSuperUserAccessPolicy;
/**
* Prepares site settings and services before installation.
*/
protected function prepareSettings() {
// Prepare installer settings that are not install_drupal() parameters.
// Copy and prepare an actual settings.php, so as to resemble a regular
// installation.
// Not using File API; a potential error must trigger a PHP warning.
$directory = DRUPAL_ROOT . '/' . $this->siteDirectory;
copy(DRUPAL_ROOT . '/core/assets/scaffold/files/default.settings.php', $directory . '/settings.php');
// The public file system path is created during installation. Additionally,
// during tests:
// - The temporary directory is set and created by install_base_system().
// - The private file directory is created post install by
// FunctionalTestSetupTrait::initConfig().
// @see system_requirements()
// @see TestBase::prepareEnvironment()
// @see install_base_system()
// @see \Drupal\Core\Test\FunctionalTestSetupTrait::initConfig()
$settings['settings']['file_public_path'] = (object) [
'value' => $this->publicFilesDirectory,
'required' => TRUE,
];
$settings['settings']['file_private_path'] = (object) [
'value' => $this->privateFilesDirectory,
'required' => TRUE,
];
$settings['settings']['file_temp_path'] = (object) [
'value' => $this->tempFilesDirectory,
'required' => TRUE,
];
// Save the original site directory path, so that extensions in the
// site-specific directory can still be discovered in the test site
// environment.
// @see \Drupal\Core\Extension\ExtensionDiscovery::scan()
$settings['settings']['test_parent_site'] = (object) [
'value' => $this->originalSite,
'required' => TRUE,
];
$settings['settings']['apcu_ensure_unique_prefix'] = (object) [
'value' => $this->apcuEnsureUniquePrefix,
'required' => TRUE,
];
// Disable fetching of advisories during tests to avoid outbound calls. This
// cannot be set in ::initConfig() because it would not stop these calls
// during install. Tests that need to have the security advisories
// functionality enabled should override this method and unset this
// variable.
// @see \Drupal\Tests\system\Functional\SecurityAdvisories\SecurityAdvisoryTest::writeSettings()
$settings['config']['system.advisories']['enabled'] = (object) [
'value' => FALSE,
'required' => TRUE,
];
$this->writeSettings($settings);
// Allow for test-specific overrides.
$settings_testing_file = DRUPAL_ROOT . '/' . $this->originalSite . '/settings.testing.php';
if (file_exists($settings_testing_file)) {
// Copy the testing-specific settings.php overrides in place.
copy($settings_testing_file, $directory . '/settings.testing.php');
// Add the name of the testing class to settings.php and include the
// testing specific overrides.
file_put_contents($directory . '/settings.php', "\n\$test_class = '" . static::class . "';\n" . 'include DRUPAL_ROOT . \'/\' . $site_path . \'/settings.testing.php\';' . "\n", FILE_APPEND);
}
$settings_services_file = DRUPAL_ROOT . '/' . $this->originalSite . '/testing.services.yml';
if (!file_exists($settings_services_file)) {
// Otherwise, use the default services as a starting point for overrides.
$settings_services_file = DRUPAL_ROOT . '/core/assets/scaffold/files/default.services.yml';
}
// Put the testing-specific service overrides in place.
$yaml = new SymfonyYaml();
$content = file_get_contents($settings_services_file);
// Disable session garbage collection since test environments do not last
// long enough to have stale sessions. This prevents random delete queries
// from running during tests.
$services = $yaml->parse($content);
$services['parameters']['session.storage.options']['gc_probability'] = 0;
// Disable the super user access policy so that we are sure our tests check
// for the right permissions.
if (!isset($this->usesSuperUserAccessPolicy)) {
$test_file_name = (new \ReflectionClass($this))->getFileName();
// @todo Decide in https://www.drupal.org/project/drupal/issues/3437926
// how to remove this fallback behavior.
$this->usesSuperUserAccessPolicy = !str_starts_with($test_file_name, $this->root . DIRECTORY_SEPARATOR . 'core');
}
$services['parameters']['security.enable_super_user'] = $this->usesSuperUserAccessPolicy;
if ($this->strictConfigSchema) {
// Add a listener to validate configuration schema on save.
$test_file_name = (new \ReflectionClass($this))->getFileName();
// @todo Decide in https://www.drupal.org/project/drupal/issues/3395099 when/how to trigger deprecation errors or even failures for contrib modules.
$is_core_test = str_starts_with($test_file_name, DRUPAL_ROOT . DIRECTORY_SEPARATOR . 'core');
$services['services']['testing.config_schema_checker'] = [
'class' => ConfigSchemaChecker::class,
'arguments' => [
'@config.typed',
$this->getConfigSchemaExclusions(),
$is_core_test,
],
'tags' => [
[
'name' => 'event_subscriber',
],
],
];
}
file_put_contents($directory . '/services.yml', $yaml->dump($services));
// Since Drupal is bootstrapped already, install_begin_request() will not
// bootstrap again. Hence, we have to reload the newly written custom
// settings.php manually.
Settings::initialize(DRUPAL_ROOT, $this->siteDirectory, $this->classLoader);
}
/**
* Rewrites the settings.php file of the test site.
*
* @param array $settings
* An array of settings to write out, in the format expected by
* SettingsEditor::rewrite().
*
* @see \Drupal\Core\Site\SettingsEditor::rewrite()
*/
protected function writeSettings(array $settings) {
include_once DRUPAL_ROOT . '/core/includes/install.inc';
$filename = $this->siteDirectory . '/settings.php';
// system_requirements() removes write permissions from settings.php
// whenever it is invoked.
// Not using File API; a potential error must trigger a PHP warning.
chmod($filename, 0666);
SettingsEditor::rewrite($filename, $settings);
}
/**
* Changes parameters in the services.yml file.
*
* @param string $name
* The name of the parameter.
* @param string|array|bool $value
* The value of the parameter.
*/
protected function setContainerParameter($name, $value) {
$filename = $this->siteDirectory . '/services.yml';
chmod($filename, 0666);
$services = Yaml::decode(file_get_contents($filename));
$services['parameters'][$name] = $value;
file_put_contents($filename, Yaml::encode($services));
// Ensure that the cache is deleted for the yaml file loader.
$file_cache = FileCacheFactory::get('container_yaml_loader');
$file_cache->delete($filename);
}
/**
* Rebuilds \Drupal::getContainer().
*
* Use this to update the test process's kernel with a new service container.
* For example, when the list of enabled modules is changed via the internal
* browser the test process's kernel has a service container with an out of
* date module list.
*
* @see TestBase::prepareEnvironment()
* @see TestBase::restoreEnvironment()
*
* @todo Fix https://www.drupal.org/node/2941757 so that module enable/disable
* changes are immediately reflected in \Drupal::getContainer(). Until then,
* tests can invoke this workaround when requiring services from newly
* enabled modules to be immediately available in the same request.
*/
protected function rebuildContainer() {
// Rebuild the kernel and bring it back to a fully bootstrapped state.
$this->container = $this->kernel
->rebuildContainer();
}
/**
* Resets all data structures after having enabled new modules.
*
* This method is called by FunctionalTestSetupTrait::rebuildAll() after
* enabling the requested modules. It must be called again when additional
* modules are enabled later.
*
* @see \Drupal\Core\Test\FunctionalTestSetupTrait::rebuildAll()
* @see \Drupal\Tests\BrowserTestBase::installDrupal()
*/
protected function resetAll() {
// Clear all database and static caches and rebuild data structures.
drupal_flush_all_caches();
$this->container = \Drupal::getContainer();
// Reset static variables and reload permissions.
$this->refreshVariables();
}
/**
* Creates a mock request and sets it on the generator.
*
* This is used to manipulate how the generator generates paths during tests.
* It also ensures that calls to $this->drupalGet() will work when running
* from run-tests.sh because the URL generator no longer looks at the global
* variables that are set there but relies on getting this information from a
* request object.
*
* @param bool $clean_urls
* Whether to mock the request using clean URLs.
* @param array $override_server_vars
* An array of server variables to override.
*
* @return \Symfony\Component\HttpFoundation\Request
* The mocked request object.
*/
protected function prepareRequestForGenerator($clean_urls = TRUE, $override_server_vars = []) {
$request = Request::createFromGlobals();
$request->setSession(new Session(new MockArraySessionStorage()));
$base_path = $request->getBasePath();
if ($clean_urls) {
$request_path = $base_path ? $base_path . '/user' : 'user';
}
else {
$request_path = $base_path ? $base_path . '/index.php/user' : '/index.php/user';
}
$server = array_merge($request->server
->all(), $override_server_vars);
$request = Request::create($request_path, 'GET', [], [], [], $server);
$request->setSession(new Session(new MockArraySessionStorage()));
// Ensure the request time is \Drupal::time()->getRequestTime() to ensure
// that API calls in the test use the right timestamp.
$request->server
->set('REQUEST_TIME', \Drupal::time()->getRequestTime());
$this->container
->get('request_stack')
->push($request);
// The request context is normally set by the router_listener from within
// its KernelEvents::REQUEST listener. In the parent site this event is not
// fired, therefore it is necessary to update the request context manually
// here.
$this->container
->get('router.request_context')
->fromRequest($request);
return $request;
}
/**
* Execute the non-interactive installer.
*
* @see install_drupal()
*/
protected function doInstall() {
require_once DRUPAL_ROOT . '/core/includes/install.core.inc';
$parameters = $this->installParameters();
// Simulate a real install which does not start with the any connections set
// in \Drupal\Core\Database\Database::$connections.
Database::removeConnection('default');
install_drupal($this->classLoader, $parameters);
}
/**
* Initialize settings created during install.
*/
protected function initSettings() {
Settings::initialize(DRUPAL_ROOT, $this->siteDirectory, $this->classLoader);
// 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.
// TestBase::restoreEnvironment() will delete the entire site directory.
// Not using File API; a potential error must trigger a PHP warning.
chmod(DRUPAL_ROOT . '/' . $this->siteDirectory, 0777);
// During tests, cacheable responses should get the debugging cacheability
// headers by default.
$this->setContainerParameter('http.response.debug_cacheability_headers', TRUE);
}
/**
* Initialize various configurations post-installation.
*
* @param \Symfony\Component\DependencyInjection\ContainerInterface $container
* The container.
*/
protected function initConfig(ContainerInterface $container) {
$config = $container->get('config.factory');
// Manually create the private directory.
\Drupal::service('file_system')->prepareDirectory($this->privateFilesDirectory, FileSystemInterface::CREATE_DIRECTORY);
// Manually configure the test mail collector implementation to prevent
// tests from sending out emails and collect them in state instead.
// While this should be enforced via settings.php prior to installation,
// some tests expect to be able to test mail system implementations.
$config->getEditable('system.mail')
->set('interface.default', 'test_mail_collector')
->set('mailer_dsn', [
'scheme' => 'null',
'host' => 'null',
'user' => NULL,
'password' => NULL,
'port' => NULL,
'options' => [],
])
->save();
// By default, verbosely display all errors and disable all production
// environment optimizations for all tests to avoid needless overhead and
// ensure a sane default experience for test authors.
// @see https://www.drupal.org/node/2259167
$config->getEditable('system.logging')
->set('error_level', 'verbose')
->save();
$config->getEditable('system.performance')
->set('css.preprocess', FALSE)
->set('js.preprocess', FALSE)
->save();
// Set an explicit time zone to not rely on the system one, which may vary
// from setup to setup. The Australia/Sydney time zone is chosen so all
// tests are run using an edge case scenario (UTC10 and DST). This choice
// is made to prevent time zone related regressions and reduce the
// fragility of the testing system in general.
$config->getEditable('system.date')
->set('timezone.default', 'Australia/Sydney')
->save();
}
/**
* Initializes user 1 for the site to be installed.
*/
protected function initUserSession() {
$password = $this->randomMachineName();
// Define information about the user 1 account.
$this->rootUser = new UserSession([
'uid' => 1,
'name' => 'admin',
'mail' => 'admin@example.com',
'pass_raw' => $password,
'passRaw' => $password,
'timezone' => date_default_timezone_get(),
]);
// The child site derives its session name from the database prefix when
// running web tests.
$this->generateSessionName($this->databasePrefix);
}
/**
* Initializes the kernel after installation.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* Request object.
*
* @return \Symfony\Component\DependencyInjection\ContainerInterface
* The container.
*/
protected function initKernel(Request $request) {
$this->kernel = DrupalKernel::createFromRequest($request, $this->classLoader, 'prod', TRUE);
$this->kernel
->boot();
// Add our request to the stack and route context.
$request->attributes
->set(RouteObjectInterface::ROUTE_OBJECT, new Route('<none>'));
$request->attributes
->set(RouteObjectInterface::ROUTE_NAME, '<none>');
$this->kernel
->preHandle($request);
return $this->kernel
->getContainer();
}
/**
* Installs the default theme defined by `static::$defaultTheme` when needed.
*
* To install a test theme outside of the testing environment, add
* @code
* $settings['extension_discovery_scan_tests'] = TRUE;
* @endcode
* to your settings.php.
*
* @param \Symfony\Component\DependencyInjection\ContainerInterface $container
* The container.
*
* @throws \Exception
* If the test case does not initialize default theme.
*/
protected function installDefaultThemeFromClassProperty(ContainerInterface $container) {
// Use the install profile to determine the default theme if configured and
// not already specified.
$profile = $container->getParameter('install_profile');
if (!empty($profile)) {
$default_sync_path = $container->get('extension.list.profile')
->getPath($profile) . '/config/sync';
$profile_config_storage = new FileStorage($default_sync_path, StorageInterface::DEFAULT_COLLECTION);
if (!isset($this->defaultTheme) && $profile_config_storage->exists('system.theme')) {
$this->defaultTheme = $profile_config_storage->read('system.theme')['default'];
}
$default_install_path = $container->get('extension.list.profile')
->getPath($profile) . '/' . InstallStorage::CONFIG_INSTALL_DIRECTORY;
$profile_config_storage = new FileStorage($default_install_path, StorageInterface::DEFAULT_COLLECTION);
if (!isset($this->defaultTheme) && $profile_config_storage->exists('system.theme')) {
$this->defaultTheme = $profile_config_storage->read('system.theme')['default'];
}
}
// Require a default theme to be specified at this point.
if (!isset($this->defaultTheme)) {
throw new \Exception('Drupal\\Tests\\BrowserTestBase::$defaultTheme is required. See https://www.drupal.org/node/3083055, which includes recommendations on which theme to use.');
}
// Ensure the default theme is installed.
$container->get('theme_installer')
->install([
$this->defaultTheme,
], TRUE);
$system_theme_config = $container->get('config.factory')
->getEditable('system.theme');
if ($system_theme_config->get('default') !== $this->defaultTheme) {
$system_theme_config->set('default', $this->defaultTheme)
->save();
}
}
/**
* Install modules defined by `static::$modules`.
*
* To install test modules outside of the testing environment, add
* @code
* $settings['extension_discovery_scan_tests'] = TRUE;
* @endcode
* to your settings.php.
*
* @param \Symfony\Component\DependencyInjection\ContainerInterface $container
* The container.
*/
protected function installModulesFromClassProperty(ContainerInterface $container) {
$class = static::class;
$modules = [];
while ($class) {
if (property_exists($class, 'modules')) {
$modules = array_merge($modules, $class::$modules);
}
$class = get_parent_class($class);
}
if ($modules) {
$modules = array_unique($modules);
try {
$success = $container->get('module_installer')
->install($modules, TRUE);
$this->assertTrue($success, 'Enabled modules: ' . implode(', ', $modules));
} catch (MissingDependencyException $e) {
// The exception message has all the details.
$this->fail($e->getMessage());
}
// The container was already rebuilt by the ModuleInstaller.
$this->container = \Drupal::getContainer();
}
}
/**
* Resets and rebuilds the environment after setup.
*/
protected function rebuildAll() {
// Reset/rebuild all data structures after enabling the modules, primarily
// to synchronize all data structures and caches between the test runner and
// the child site.
// @see \Drupal\Core\DrupalKernel::bootCode()
// @todo Test-specific setUp() methods may set up further fixtures; find a
// way to execute this after setUp() is done, or to eliminate it entirely.
$this->resetAll();
// Explicitly call register() again on the container registered in \Drupal.
// @todo This should already be called through
// DrupalKernel::prepareLegacyRequest() -> DrupalKernel::boot() but that
// appears to be calling a different container.
$this->container
->get('stream_wrapper_manager')
->register();
}
/**
* Returns the parameters that will be used when the test installs Drupal.
*
* @see install_drupal()
* @see install_state_defaults()
*
* @return array
* Array of parameters for use in install_drupal().
*/
protected function installParameters() {
$formInput = Database::getConnectionInfo()['default'];
$driverName = $formInput['driver'];
$driverNamespace = $formInput['namespace'];
unset($formInput['driver']);
unset($formInput['namespace']);
unset($formInput['autoload']);
unset($formInput['pdo']);
unset($formInput['init_commands']);
unset($formInput['isolation_level']);
// Remove database connection info that is not used by SQLite.
if ($driverName === "sqlite") {
unset($formInput['username']);
unset($formInput['password']);
unset($formInput['host']);
unset($formInput['port']);
}
$parameters = [
'interactive' => FALSE,
'parameters' => [
'profile' => $this->profile,
'langcode' => 'en',
],
'forms' => [
'install_settings_form' => [
'driver' => $driverNamespace,
$driverNamespace => $formInput,
],
'install_configure_form' => [
'site_name' => 'Drupal',
'site_mail' => 'simpletest@example.com',
'account' => [
'name' => $this->rootUser->name,
'mail' => $this->rootUser
->getEmail(),
'pass' => [
'pass1' => $this->rootUser->pass_raw ?? $this->rootUser->passRaw,
'pass2' => $this->rootUser->pass_raw ?? $this->rootUser->passRaw,
],
],
// \Drupal\Core\Render\Element\Checkboxes::valueCallback() requires
// NULL instead of FALSE values for programmatic form submissions to
// disable a checkbox.
'enable_update_status_module' => NULL,
'enable_update_status_emails' => NULL,
],
],
];
// If we only have one db driver available, we cannot set the driver.
if (count($this->getDatabaseTypes()) == 1) {
unset($parameters['forms']['install_settings_form']['driver']);
}
return $parameters;
}
/**
* Sets up the base URL based upon the environment variable.
*
* @throws \Exception
* Thrown when no SIMPLETEST_BASE_URL environment variable is provided or uses an invalid scheme.
*/
protected function setupBaseUrl() {
global $base_url;
// Get and set the domain of the environment we are running our test
// coverage against.
$base_url = getenv('SIMPLETEST_BASE_URL');
if (!$base_url) {
throw new \Exception('You must provide a SIMPLETEST_BASE_URL environment variable to run some PHPUnit based functional tests.');
}
// Setup $_SERVER variable.
$parsed_url = parse_url($base_url);
$host = $parsed_url['host'] . (isset($parsed_url['port']) ? ':' . $parsed_url['port'] : '');
$path = isset($parsed_url['path']) ? rtrim(rtrim($parsed_url['path']), '/') : '';
$port = $parsed_url['port'] ?? 80;
$valid_url_schemes = [
'http',
'https',
];
if (!in_array(strtolower($parsed_url['scheme']), $valid_url_schemes, TRUE)) {
throw new \Exception('You must provide valid scheme for the SIMPLETEST_BASE_URL environment variable. Valid schema are: http, https.');
}
$this->baseUrl = $base_url;
// If the passed URL schema is 'https' then setup the $_SERVER variables
// properly so that testing will run under HTTPS.
if ($parsed_url['scheme'] === 'https') {
$_SERVER['HTTPS'] = 'on';
}
$_SERVER['HTTP_HOST'] = $host;
$_SERVER['REMOTE_ADDR'] = '127.0.0.1';
$_SERVER['SERVER_ADDR'] = '127.0.0.1';
$_SERVER['SERVER_PORT'] = $port;
$_SERVER['SERVER_SOFTWARE'] = NULL;
$_SERVER['SERVER_NAME'] = 'localhost';
$_SERVER['REQUEST_URI'] = $path . '/';
$_SERVER['REQUEST_METHOD'] = 'GET';
$_SERVER['SCRIPT_NAME'] = $path . '/index.php';
$_SERVER['SCRIPT_FILENAME'] = $path . '/index.php';
$_SERVER['PHP_SELF'] = $path . '/index.php';
$_SERVER['HTTP_USER_AGENT'] = 'Drupal command line';
}
/**
* Prepares the current environment for running the test.
*
* Also sets up new resources for the testing environment, such as the public
* filesystem and configuration directories.
*/
protected function prepareEnvironment() {
// Bootstrap Drupal so we can use Drupal's built in functions.
$this->classLoader = (require __DIR__ . '/../../../../../autoload.php');
$request = Request::createFromGlobals();
$kernel = TestRunnerKernel::createFromRequest($request, $this->classLoader);
$kernel->boot();
$kernel->preHandle($request);
$this->prepareDatabasePrefix();
$this->originalSite = $kernel->findSitePath($request);
// Create test directory ahead of installation so fatal errors and debug
// information can be logged during installation process.
\Drupal::service('file_system')->prepareDirectory($this->siteDirectory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
// Prepare filesystem directory paths.
$this->publicFilesDirectory = $this->siteDirectory . '/files';
$this->privateFilesDirectory = $this->siteDirectory . '/private';
$this->tempFilesDirectory = $this->siteDirectory . '/temp';
$this->translationFilesDirectory = $this->siteDirectory . '/translations';
// Ensure the configImporter is refreshed for each test.
$this->configImporter = NULL;
// Unregister all custom stream wrappers of the parent site.
$wrappers = \Drupal::service('stream_wrapper_manager')->getWrappers(StreamWrapperInterface::ALL);
foreach ($wrappers as $scheme => $info) {
stream_wrapper_unregister($scheme);
}
// Reset statics.
drupal_static_reset();
$this->container = NULL;
// Unset globals.
unset($GLOBALS['config']);
unset($GLOBALS['conf']);
// Log fatal errors.
ini_set('log_errors', 1);
ini_set('error_log', DRUPAL_ROOT . '/' . $this->siteDirectory . '/error.log');
// Change the database prefix.
$this->changeDatabasePrefix();
// After preparing the environment and changing the database prefix, we are
// in a valid test environment.
drupal_valid_test_ua($this->databasePrefix);
// Reset settings.
new Settings([
// For performance, simply use the database prefix as hash salt.
'hash_salt' => $this->databasePrefix,
]);
Environment::setTimeLimit($this->timeLimit);
// Save and clean the shutdown callbacks array because it is static cached
// and will be changed by the test run. Otherwise it will contain callbacks
// from both environments and the testing environment will try to call the
// handlers defined by the original one.
$callbacks =& drupal_register_shutdown_function();
$this->originalShutdownCallbacks = $callbacks;
$callbacks = [];
}
/**
* Returns all supported database driver installer objects.
*
* This wraps DatabaseDriverList::getInstallableList() for use without a
* current container.
*
* @return \Drupal\Core\Database\Install\Tasks[]
* An array of available database driver installer objects.
*/
protected function getDatabaseTypes() {
if (isset($this->originalContainer) && $this->originalContainer) {
\Drupal::setContainer($this->originalContainer);
}
$database_types = [];
foreach (Database::getDriverList()->getInstallableList() as $name => $driver) {
$database_types[$name] = $driver->getInstallTasks();
}
if (isset($this->originalContainer) && $this->originalContainer) {
\Drupal::unsetContainer();
}
return $database_types;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
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::installParameters | protected | function | Returns the parameters that will be used when the test installs Drupal. | 8 |
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 |
RefreshVariablesTrait::refreshVariables | protected | function | Refreshes in-memory configuration and state information. | 2 |
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.