diff --git a/core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php b/core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php new file mode 100644 index 0000000..a968d37 --- /dev/null +++ b/core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php @@ -0,0 +1,448 @@ +siteDirectory; + copy(DRUPAL_ROOT . '/sites/default/default.settings.php', $directory . '/settings.php'); + + // All file system paths are created by System module during installation. + // @see system_requirements() + // @see TestBase::prepareEnvironment() + $settings['settings']['file_public_path'] = (object) [ + 'value' => $this->publicFilesDirectory, + 'required' => TRUE, + ]; + $settings['settings']['file_private_path'] = (object) [ + 'value' => $this->privateFilesDirectory, + '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, + ]; + // Add the parent profile's search path to the child site's search paths. + // @see \Drupal\Core\Extension\ExtensionDiscovery::getProfileDirectories() + $settings['conf']['simpletest.settings']['parent_profile'] = (object) [ + 'value' => $this->originalProfile, + '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 = '" . get_class($this) . "';\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 . '/sites/default/default.services.yml'; + } + // Copy the testing-specific service overrides in place. + copy($settings_services_file, $directory . '/services.yml'); + if ($this->strictConfigSchema) { + // Add a listener to validate configuration schema on save. + $yaml = new SymfonyYaml(); + $content = file_get_contents($directory . '/services.yml'); + $services = $yaml->parse($content); + $services['services']['simpletest.config_schema_checker'] = [ + 'class' => 'Drupal\Core\Config\Testing\ConfigSchemaChecker', + 'arguments' => ['@config.typed', $this->getConfigSchemaExclusions()], + '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 + * drupal_rewrite_settings(). + * + * @see drupal_rewrite_settings() + */ + 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); + drupal_rewrite_settings($settings, $filename); + } + + /** + * Changes parameters in the services.yml file. + * + * @param string $name + * The name of the parameter. + * @param string $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/2021959 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(); + + // Make sure the url generator has a request object, otherwise calls to + // $this->drupalGet() will fail. + $this->prepareRequestForGenerator(); + } + + /** + * Resets all data structures after having enabled new modules. + * + * This method is called by \Drupal\simpletest\WebTestBase::setUp() after + * enabling the requested modules. It must be called again when additional + * modules are enabled later. + */ + 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(); + } + + /** + * Refreshes in-memory configuration and state information. + * + * Useful after a page request is made that changes configuration or state in + * a different thread. + * + * In other words calling a settings page with $this->drupalPostForm() with a + * changed value would update configuration to reflect that change, but in the + * thread that made the call (thread running the test) the changed values + * would not be picked up. + * + * This method clears the cache and loads a fresh copy. + */ + protected function refreshVariables() { + // Clear the tag cache. + \Drupal::service('cache_tags.invalidator')->resetChecksums(); + foreach (Cache::getBins() as $backend) { + if (is_callable(array($backend, 'reset'))) { + $backend->reset(); + } + } + + $this->container->get('config.factory')->reset(); + $this->container->get('state')->resetCache(); + } + + /** + * 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 = array()) { + $request = Request::createFromGlobals(); + $server = $request->server->all(); + if (basename($server['SCRIPT_FILENAME']) != basename($server['SCRIPT_NAME'])) { + // We need this for when the test is executed by run-tests.sh. + // @todo Remove this once run-tests.sh has been converted to use a Request + // object. + $cwd = getcwd(); + $server['SCRIPT_FILENAME'] = $cwd . '/' . basename($server['SCRIPT_NAME']); + $base_path = rtrim($server['REQUEST_URI'], '/'); + } + else { + $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($server, $override_server_vars); + + $request = Request::create($request_path, 'GET', array(), array(), array(), $server); + // Ensure the request time is REQUEST_TIME to ensure that API calls + // in the test use the right timestamp. + $request->server->set('REQUEST_TIME', REQUEST_TIME); + $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 simpletest parent site this + // event is not fired, therefore it is necessary to updated 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'; + install_drupal($this->classLoader, $this->installParameters()); + } + + /** + * Initialize settings created during install. + */ + protected function initSettings() { + Settings::initialize(DRUPAL_ROOT, $this->siteDirectory, $this->classLoader); + 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. + // 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 and configure private and temporary files directories. + // While these could be preset/enforced in settings.php like the public + // files directory above, some tests expect them to be configurable in the + // UI. If declared in settings.php, they would no longer be configurable. + file_prepare_directory($this->privateFilesDirectory, FILE_CREATE_DIRECTORY); + file_prepare_directory($this->tempFilesDirectory, FILE_CREATE_DIRECTORY); + $config->getEditable('system.file') + ->set('path.temporary', $this->tempFilesDirectory) + ->save(); + + // 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') + ->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 (UTC+10 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() { + // Define information about the user 1 account. + $password = $this->randomMachineName(); + $this->rootUser = new UserSession(array( + 'uid' => 1, + 'name' => 'admin', + 'mail' => 'admin@example.com', + 'pass_raw' => $password, + // Support BrowserTestBase as well. + '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->prepareLegacyRequest($request); + // Force the container to be built from scratch instead of loaded from the + // disk. This forces us to not accidentally load the parent site. + return $this->kernel->rebuildContainer(); + } + + /** + * 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 = get_class($this); + $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, SafeMarkup::format('Enabled modules: %modules', ['%modules' => implode(', ', $modules)])); + } + catch (MissingDependencyException $e) { + // The exception message has all the details. + $this->fail($e->getMessage()); + } + + $this->rebuildContainer(); + } + } + + /** + * Reset and rebuild 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(); + $this->kernel->prepareLegacyRequest(\Drupal::request()); + + // 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(); + } + +} diff --git a/core/lib/Drupal/Core/Test/TestSetupTrait.php b/core/lib/Drupal/Core/Test/TestSetupTrait.php new file mode 100644 index 0000000..1094545 --- /dev/null +++ b/core/lib/Drupal/Core/Test/TestSetupTrait.php @@ -0,0 +1,208 @@ +siteDirectory = 'sites/simpletest/' . $suffix; + $this->databasePrefix = 'simpletest' . $suffix; + } while (is_dir(DRUPAL_ROOT . '/' . $this->siteDirectory)); + + // As soon as the database prefix is set, the test might start to execute. + // All assertions as well as the SimpleTest batch operations are associated + // with the testId, so the database prefix has to be associated with it. + $affected_rows = static::getDatabaseConnection() + ->update('simpletest_test_id') + ->fields(array('last_prefix' => $this->databasePrefix)) + ->condition('test_id', $this->testId) + ->execute(); + if (!$affected_rows) { + throw new \RuntimeException('Failed to set up database prefix.'); + } + } + + /** + * Changes the database connection to the prefixed one. + * + * @see TestBase::prepareEnvironment() + */ + protected function changeDatabasePrefix() { + if (empty($this->databasePrefix)) { + $this->prepareDatabasePrefix(); + } + // If the backup already exists, something went terribly wrong. + // This case is possible, because database connection info is a static + // global state construct on the Database class, which at least persists + // for all test methods executed in one PHP process. + if (Database::getConnectionInfo('simpletest_original_default')) { + throw new \RuntimeException("Bad Database connection state: 'simpletest_original_default' connection key already exists. Broken test?"); + } + + // Clone the current connection and replace the current prefix. + $connection_info = Database::getConnectionInfo('default'); + Database::renameConnection('default', 'simpletest_original_default'); + foreach ($connection_info as $target => $value) { + // Replace the full table prefix definition to ensure that no table + // prefixes of the test runner leak into the test. + $connection_info[$target]['prefix'] = array( + 'default' => $value['prefix']['default'] . $this->databasePrefix, + ); + } + Database::addConnectionInfo('default', 'default', $connection_info['default']); + } + + /** + * Gets the config schema exclusions for this test. + * + * @return string[] + * An array of config object names that are excluded from schema checking. + */ + protected function getConfigSchemaExclusions() { + $class = get_class($this); + $exceptions = []; + while ($class) { + if (property_exists($class, 'configSchemaCheckerExclusions')) { + $exceptions = array_merge($exceptions, $class::$configSchemaCheckerExclusions); + } + $class = get_parent_class($class); + } + // Filter out any duplicates. + return array_unique($exceptions); + } + +} diff --git a/core/modules/simpletest/src/TestBase.php b/core/modules/simpletest/src/TestBase.php index 944810a..89c3358 100644 --- a/core/modules/simpletest/src/TestBase.php +++ b/core/modules/simpletest/src/TestBase.php @@ -10,6 +10,7 @@ use Drupal\Core\Site\Settings; use Drupal\Core\StreamWrapper\PublicStream; use Drupal\Core\Test\TestDatabase; +use Drupal\Core\Test\TestSetupTrait; use Drupal\Core\Utility\Error; use Drupal\Tests\ConfigTestTrait; use Drupal\Tests\RandomGeneratorTrait; @@ -22,6 +23,7 @@ */ abstract class TestBase { + use TestSetupTrait; use SessionTestTrait; use RandomGeneratorTrait; use AssertHelperTrait; @@ -32,20 +34,6 @@ } /** - * The test run ID. - * - * @var string - */ - protected $testId; - - /** - * The site directory of this test run. - * - * @var string - */ - protected $siteDirectory = NULL; - - /** * The database prefix of this test run. * * @var string @@ -177,12 +165,6 @@ */ protected $originalPrefix; - /** - * The original installation profile. - * - * @var string - */ - protected $originalProfile; /** * The name of the session cookie of the test-runner. @@ -205,12 +187,6 @@ */ protected $originalShutdownCallbacks; - /** - * The site directory of the original parent site. - * - * @var string - */ - protected $originalSite; /** * The original user, before testing began. @@ -219,32 +195,6 @@ */ protected $originalUser; - /** - * The public file directory for the test environment. - * - * This is set in TestBase::prepareEnvironment(). - * - * @var string - */ - protected $publicFilesDirectory; - - /** - * The private file directory for the test environment. - * - * This is set in TestBase::prepareEnvironment(). - * - * @var string - */ - protected $privateFilesDirectory; - - /** - * The temporary file directory for the test environment. - * - * This is set in TestBase::prepareEnvironment(). - * - * @var string - */ - protected $tempFilesDirectory; /** * The translation file directory for the test environment. @@ -264,19 +214,6 @@ */ public $dieOnFail = FALSE; - /** - * The DrupalKernel instance used in the test. - * - * @var \Drupal\Core\DrupalKernel - */ - protected $kernel; - - /** - * The dependency injection container used in the test. - * - * @var \Symfony\Component\DependencyInjection\ContainerInterface - */ - protected $container; /** * The config importer that can used in a test. @@ -285,30 +222,6 @@ */ protected $configImporter; - /** - * Set to TRUE to strict check all configuration saved. - * - * @see \Drupal\Core\Config\Testing\ConfigSchemaChecker - * - * @var bool - */ - protected $strictConfigSchema = TRUE; - - /** - * An array of config object names that are excluded from schema checking. - * - * @var string[] - */ - protected static $configSchemaCheckerExclusions = array( - // Following are used to test lack of or partial schema. Where partial - // schema is provided, that is explicitly tested in specific tests. - 'config_schema_test.noschema', - 'config_schema_test.someschema', - 'config_schema_test.schema_data_types', - 'config_schema_test.no_schema_data_types', - // Used to test application of schema to filtering of configuration. - 'config_test.dynamic.system', - ); /** * HTTP authentication method (specified as a CURLAUTH_* constant). @@ -506,16 +419,6 @@ public static function deleteAssert($message_id) { } /** - * Returns the database connection to the site running Simpletest. - * - * @return \Drupal\Core\Database\Connection - * The database connection to use for inserting assertions. - */ - public static function getDatabaseConnection() { - return TestDatabase::getConnection(); - } - - /** * Cycles through backtrace until the first non-assertion method is found. * * @return @@ -1573,23 +1476,5 @@ public function getTempFilesDirectory() { return $this->tempFilesDirectory; } - /** - * Gets the config schema exclusions for this test. - * - * @return string[] - * An array of config object names that are excluded from schema checking. - */ - protected function getConfigSchemaExclusions() { - $class = get_class($this); - $exceptions = []; - while ($class) { - if (property_exists($class, 'configSchemaCheckerExclusions')) { - $exceptions = array_merge($exceptions, $class::$configSchemaCheckerExclusions); - } - $class = get_parent_class($class); - } - // Filter out any duplicates. - return array_unique($exceptions); - } } diff --git a/core/modules/simpletest/src/WebTestBase.php b/core/modules/simpletest/src/WebTestBase.php index b0f90ed..991cc6d 100644 --- a/core/modules/simpletest/src/WebTestBase.php +++ b/core/modules/simpletest/src/WebTestBase.php @@ -24,6 +24,7 @@ use Drupal\Core\Site\Settings; use Drupal\Core\StreamWrapper\PublicStream; use Drupal\Core\Test\AssertMailTrait; +use Drupal\Core\Test\FunctionalTestSetupTrait; use Drupal\Core\Url; use Drupal\system\Tests\Cache\AssertPageCacheContextsAndTagsTrait; use Symfony\Component\DependencyInjection\ContainerInterface; @@ -38,6 +39,7 @@ */ abstract class WebTestBase extends TestBase { + use FunctionalTestSetupTrait; use AssertContentTrait; use AssertPageCacheContextsAndTagsTrait; use BlockCreationTrait { @@ -118,13 +120,6 @@ */ protected $loggedInUser = FALSE; - /** - * The "#1" admin user. - * - * @var \Drupal\Core\Session\AccountInterface - */ - protected $rootUser; - /** * The current cookie file used by cURL. @@ -198,17 +193,6 @@ */ protected $metaRefreshCount = 0; - /** - * The kernel used in this test. - * - * @var \Drupal\Core\DrupalKernel - */ - protected $kernel; - - /** - * The config directories used in this test. - */ - protected $configDirectories = array(); /** * Cookies to set on curl requests. @@ -224,12 +208,6 @@ */ protected $customTranslations; - /** - * The class loader to use for installation and initialization of setup. - * - * @var \Symfony\Component\Classloader\Classloader - */ - protected $classLoader; /** * Constructor for \Drupal\simpletest\WebTestBase. @@ -569,177 +547,6 @@ protected function setUp() { $this->rebuildAll(); } - /** - * Execute the non-interactive installer. - * - * @see install_drupal() - */ - protected function doInstall() { - require_once DRUPAL_ROOT . '/core/includes/install.core.inc'; - install_drupal($this->classLoader, $this->installParameters()); - } - - /** - * 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 . '/sites/default/default.settings.php', $directory . '/settings.php'); - - // All file system paths are created by System module during installation. - // @see system_requirements() - // @see TestBase::prepareEnvironment() - $settings['settings']['file_public_path'] = (object) [ - 'value' => $this->publicFilesDirectory, - 'required' => TRUE, - ]; - $settings['settings']['file_private_path'] = (object) [ - 'value' => $this->privateFilesDirectory, - '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, - ]; - // Add the parent profile's search path to the child site's search paths. - // @see \Drupal\Core\Extension\ExtensionDiscovery::getProfileDirectories() - $settings['conf']['simpletest.settings']['parent_profile'] = (object) [ - 'value' => $this->originalProfile, - '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 = '" . get_class($this) . "';\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 . '/sites/default/default.services.yml'; - } - // Copy the testing-specific service overrides in place. - copy($settings_services_file, $directory . '/services.yml'); - if ($this->strictConfigSchema) { - // Add a listener to validate configuration schema on save. - $yaml = new SymfonyYaml(); - $content = file_get_contents($directory . '/services.yml'); - $services = $yaml->parse($content); - $services['services']['simpletest.config_schema_checker'] = [ - 'class' => 'Drupal\Core\Config\Testing\ConfigSchemaChecker', - 'arguments' => ['@config.typed', $this->getConfigSchemaExclusions()], - '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); - } - - /** - * Initialize settings created during install. - */ - protected function initSettings() { - Settings::initialize(DRUPAL_ROOT, $this->siteDirectory, $this->classLoader); - 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. - // 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 and configure private and temporary files directories. - // While these could be preset/enforced in settings.php like the public - // files directory above, some tests expect them to be configurable in the - // UI. If declared in settings.php, they would no longer be configurable. - file_prepare_directory($this->privateFilesDirectory, FILE_CREATE_DIRECTORY); - file_prepare_directory($this->tempFilesDirectory, FILE_CREATE_DIRECTORY); - $config->getEditable('system.file') - ->set('path.temporary', $this->tempFilesDirectory) - ->save(); - - // 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') - ->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 (UTC+10 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(); - } - - /** - * Reset and rebuild 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(); - $this->kernel->prepareLegacyRequest(\Drupal::request()); - - // 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 Simpletest installs Drupal. @@ -833,76 +640,6 @@ protected function restoreBatch() { $batch = $this->originalBatch; } - /** - * Initializes user 1 for the site to be installed. - */ - protected function initUserSession() { - // Define information about the user 1 account. - $this->rootUser = new UserSession(array( - 'uid' => 1, - 'name' => 'admin', - 'mail' => 'admin@example.com', - 'pass_raw' => $this->randomMachineName(), - '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->prepareLegacyRequest($request); - // Force the container to be built from scratch instead of loaded from the - // disk. This forces us to not accidentally load the parent site. - return $this->kernel->rebuildContainer(); - } - - /** - * 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 = get_class($this); - $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, SafeMarkup::format('Enabled modules: %modules', ['%modules' => implode(', ', $modules)])); - } - catch (MissingDependencyException $e) { - // The exception message has all the details. - $this->fail($e->getMessage()); - } - - $this->rebuildContainer(); - } - } /** * Returns all supported database driver installer objects. @@ -919,45 +656,6 @@ protected function getDatabaseTypes() { return $database_types; } - /** - * Rewrites the settings.php file of the test site. - * - * @param array $settings - * An array of settings to write out, in the format expected by - * drupal_rewrite_settings(). - * - * @see drupal_rewrite_settings() - */ - 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); - drupal_rewrite_settings($settings, $filename); - } - - /** - * Changes parameters in the services.yml file. - * - * @param $name - * The name of the parameter. - * @param $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); - } /** * Queues custom translations to be written to settings.php. @@ -1021,72 +719,6 @@ protected function writeCustomTranslations() { } } - /** - * 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/2021959 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(); - - // Make sure the url generator has a request object, otherwise calls to - // $this->drupalGet() will fail. - $this->prepareRequestForGenerator(); - } - - /** - * Resets all data structures after having enabled new modules. - * - * This method is called by \Drupal\simpletest\WebTestBase::setUp() after - * enabling the requested modules. It must be called again when additional - * modules are enabled later. - */ - 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(); - } - - /** - * Refreshes in-memory configuration and state information. - * - * Useful after a page request is made that changes configuration or state in - * a different thread. - * - * In other words calling a settings page with $this->drupalPostForm() with a - * changed value would update configuration to reflect that change, but in the - * thread that made the call (thread running the test) the changed values - * would not be picked up. - * - * This method clears the cache and loads a fresh copy. - */ - protected function refreshVariables() { - // Clear the tag cache. - \Drupal::service('cache_tags.invalidator')->resetChecksums(); - foreach (Cache::getBins() as $backend) { - if (is_callable(array($backend, 'reset'))) { - $backend->reset(); - } - } - - $this->container->get('config.factory')->reset(); - $this->container->get('state')->resetCache(); - } /** * Cleans up after testing. @@ -2615,59 +2247,6 @@ protected function assertNoResponse($code, $message = '', $group = 'Browser') { return $this->assertFalse($match, $message ? $message : SafeMarkup::format('HTTP response not expected @code, actual @curl_code', array('@code' => $code, '@curl_code' => $curl_code)), $group); } - /** - * 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 $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 = array()) { - $request = Request::createFromGlobals(); - $server = $request->server->all(); - if (basename($server['SCRIPT_FILENAME']) != basename($server['SCRIPT_NAME'])) { - // We need this for when the test is executed by run-tests.sh. - // @todo Remove this once run-tests.sh has been converted to use a Request - // object. - $cwd = getcwd(); - $server['SCRIPT_FILENAME'] = $cwd . '/' . basename($server['SCRIPT_NAME']); - $base_path = rtrim($server['REQUEST_URI'], '/'); - } - else { - $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($server, $override_server_vars); - - $request = Request::create($request_path, 'GET', array(), array(), array(), $server); - // Ensure the request time is REQUEST_TIME to ensure that API calls - // in the test use the right timestamp. - $request->server->set('REQUEST_TIME', REQUEST_TIME); - $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 simpletest parent site this - // event is not fired, therefore it is necessary to updated the request - // context manually here. - $this->container->get('router.request_context')->fromRequest($request); - - return $request; - } /** * Builds an a absolute URL from a system path or a URL object. diff --git a/core/tests/Drupal/Tests/BrowserTestBase.php b/core/tests/Drupal/Tests/BrowserTestBase.php index 7939069..4320810 100644 --- a/core/tests/Drupal/Tests/BrowserTestBase.php +++ b/core/tests/Drupal/Tests/BrowserTestBase.php @@ -21,7 +21,9 @@ use Drupal\Core\Session\UserSession; use Drupal\Core\Site\Settings; use Drupal\Core\StreamWrapper\StreamWrapperInterface; +use Drupal\Core\Test\FunctionalTestSetupTrait; use Drupal\Core\Test\TestRunnerKernel; +use Drupal\Core\Test\TestSetupTrait; use Drupal\Core\Url; use Drupal\Core\Test\TestDatabase; use Drupal\FunctionalTests\AssertLegacyTrait; @@ -43,6 +45,9 @@ * @ingroup testing */ abstract class BrowserTestBase extends \PHPUnit_Framework_TestCase { + + use FunctionalTestSetupTrait; + use TestSetupTrait; use AssertHelperTrait; use BlockCreationTrait { placeBlock as drupalPlaceBlock; @@ -64,20 +69,6 @@ } /** - * Class loader. - * - * @var object - */ - protected $classLoader; - - /** - * The site directory of this test run. - * - * @var string - */ - protected $siteDirectory; - - /** * The database prefix of this test run. * * @var string @@ -99,33 +90,6 @@ protected $timeLimit = 500; /** - * The public file directory for the test environment. - * - * This is set in BrowserTestBase::prepareEnvironment(). - * - * @var string - */ - protected $publicFilesDirectory; - - /** - * The private file directory for the test environment. - * - * This is set in BrowserTestBase::prepareEnvironment(). - * - * @var string - */ - protected $privateFilesDirectory; - - /** - * The temp file directory for the test environment. - * - * This is set in BrowserTestBase::prepareEnvironment(). - * - * @var string - */ - protected $tempFilesDirectory; - - /** * The translation file directory for the test environment. * * This is set in BrowserTestBase::prepareEnvironment(). @@ -135,20 +99,6 @@ protected $translationFilesDirectory; /** - * The DrupalKernel instance used in the test. - * - * @var \Drupal\Core\DrupalKernel - */ - protected $kernel; - - /** - * The dependency injection container used in the test. - * - * @var \Symfony\Component\DependencyInjection\ContainerInterface - */ - protected $container; - - /** * The config importer that can be used in a test. * * @var \Drupal\Core\Config\ConfigImporter @@ -156,31 +106,6 @@ protected $configImporter; /** - * Set to TRUE to strict check all configuration saved. - * - * @see \Drupal\Core\Config\Testing\ConfigSchemaChecker - * - * @var bool - */ - protected $strictConfigSchema = TRUE; - - /** - * An array of config object names that are excluded from schema checking. - * - * @var string[] - */ - protected static $configSchemaCheckerExclusions = array( - // Following are used to test lack of or partial schema. Where partial - // schema is provided, that is explicitly tested in specific tests. - 'config_schema_test.noschema', - 'config_schema_test.someschema', - 'config_schema_test.schema_data_types', - 'config_schema_test.no_schema_data_types', - // Used to test application of schema to filtering of configuration. - 'config_test.dynamic.system', - ); - - /** * The profile to install as a basis for testing. * * @var string @@ -195,20 +120,6 @@ protected $loggedInUser = FALSE; /** - * The root user. - * - * @var \Drupal\Core\Session\UserSession - */ - protected $rootUser; - - /** - * The config directories used in this test. - * - * @var array - */ - protected $configDirectories = array(); - - /** * An array of custom translations suitable for drupal_rewrite_settings(). * * @var array @@ -362,7 +273,7 @@ protected function initMink() { /** * Gets an instance of the default Mink driver. * - * @return Behat\Mink\Driver\DriverInterface + * @return \Behat\Mink\Driver\DriverInterface * Instance of default Mink driver. * * @throws \InvalidArgumentException @@ -977,161 +888,14 @@ protected function getOptions($select, Element $container = NULL) { * Installs Drupal into the Simpletest site. */ public function installDrupal() { - // Define information about the user 1 account. - $this->rootUser = new UserSession(array( - 'uid' => 1, - 'name' => 'admin', - 'mail' => 'admin@example.com', - 'passRaw' => $this->randomMachineName(), - )); - - // The child site derives its session name from the database prefix when - // running web tests. - $this->generateSessionName($this->databasePrefix); - - // Get parameters for install_drupal() before removing global variables. - $parameters = $this->installParameters(); - - // 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 . '/sites/default/default.settings.php', $directory . '/settings.php'); - - // All file system paths are created by System module during installation. - // @see system_requirements() - // @see TestBase::prepareEnvironment() - $settings['settings']['file_public_path'] = (object) array( - 'value' => $this->publicFilesDirectory, - 'required' => TRUE, - ); - $settings['settings']['file_private_path'] = (object) [ - 'value' => $this->privateFilesDirectory, - 'required' => TRUE, - ]; - $this->writeSettings($settings); - // Allow for test-specific overrides. - $settings_testing_file = DRUPAL_ROOT . '/' . $this->originalSiteDirectory . '/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 = '" . get_class($this) . "';\n" . 'include DRUPAL_ROOT . \'/\' . $site_path . \'/settings.testing.php\';' . "\n", FILE_APPEND); - } - - $settings_services_file = DRUPAL_ROOT . '/' . $this->originalSiteDirectory . '/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 . '/sites/default/default.services.yml'; - } - // Copy the testing-specific service overrides in place. - copy($settings_services_file, $directory . '/services.yml'); - if ($this->strictConfigSchema) { - // Add a listener to validate configuration schema on save. - $content = file_get_contents($directory . '/services.yml'); - $services = Yaml::decode($content); - $services['services']['simpletest.config_schema_checker'] = [ - 'class' => ConfigSchemaChecker::class, - 'arguments' => ['@config.typed', $this->getConfigSchemaExclusions()], - 'tags' => [['name' => 'event_subscriber']] - ]; - file_put_contents($directory . '/services.yml', Yaml::encode($services)); - } - - // Since Drupal is bootstrapped already, install_begin_request() will not - // bootstrap into DRUPAL_BOOTSTRAP_CONFIGURATION (again). Hence, we have to - // reload the newly written custom settings.php manually. - Settings::initialize(DRUPAL_ROOT, $directory, $this->classLoader); - - // Execute the non-interactive installer. - require_once DRUPAL_ROOT . '/core/includes/install.core.inc'; - install_drupal($parameters); - - // Import new settings.php written by the installer. - Settings::initialize(DRUPAL_ROOT, $directory, $this->classLoader); - 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. - // TestBase::restoreEnvironment() will delete the entire site directory. Not - // using File API; a potential error must trigger a PHP warning. - chmod($directory, 0777); - - // During tests, cacheable responses should get the debugging cacheability - // headers by default. - $this->setContainerParameter('http.response.debug_cacheability_headers', TRUE); - - $request = \Drupal::request(); - $this->kernel = DrupalKernel::createFromRequest($request, $this->classLoader, 'prod', TRUE); - $this->kernel->prepareLegacyRequest($request); - // Force the container to be built from scratch instead of loaded from the - // disk. This forces us to not accidentally load the parent site. - $container = $this->kernel->rebuildContainer(); - - $config = $container->get('config.factory'); - - // Manually create and configure private and temporary files directories. - file_prepare_directory($this->privateFilesDirectory, FILE_CREATE_DIRECTORY); - file_prepare_directory($this->tempFilesDirectory, FILE_CREATE_DIRECTORY); - // While the temporary files path could be preset/enforced in settings.php - // like the public files directory above, some tests expect it to be - // configurable in the UI. If declared in settings.php, it would no longer - // be configurable. - $config->getEditable('system.file') - ->set('path.temporary', $this->tempFilesDirectory) - ->save(); - - // 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') - ->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(); - - // Collect modules to install. - $class = get_class($this); - $modules = array(); - while ($class) { - if (property_exists($class, 'modules')) { - $modules = array_merge($modules, $class::$modules); - } - $class = get_parent_class($class); - } - if ($modules) { - $modules = array_unique($modules); - $success = $container->get('module_installer')->install($modules, TRUE); - $this->assertTrue($success, SafeMarkup::format('Enabled modules: %modules', array('%modules' => implode(', ', $modules)))); - $this->rebuildContainer(); - } - - // 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. - // Affects e.g. StreamWrapperManagerInterface::getWrappers(). - // @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(); - $this->kernel->prepareLegacyRequest($request); + $this->initUserSession(); + $this->prepareSettings(); + $this->doInstall(); + $this->initSettings(); + $container = $this->initKernel(\Drupal::request()); + $this->initConfig($container); + $this->installModulesFromClassProperty($container); + $this->rebuildAll(); } /** @@ -1166,8 +930,8 @@ protected function installParameters() { 'name' => $this->rootUser->name, 'mail' => $this->rootUser->getEmail(), 'pass' => array( - 'pass1' => $this->rootUser->passRaw, - 'pass2' => $this->rootUser->passRaw, + 'pass1' => $this->rootUser->pass_raw, + 'pass2' => $this->rootUser->pass_raw, ), ), // form_type_checkboxes_value() requires NULL instead of FALSE values @@ -1329,163 +1093,6 @@ protected function prepareEnvironment() { } /** - * Returns the database connection to the site running Simpletest. - * - * @return \Drupal\Core\Database\Connection - * The database connection to use for inserting assertions. - */ - public static function getDatabaseConnection() { - return TestDatabase::getConnection(); - } - - /** - * Rewrites the settings.php file of the test site. - * - * @param array $settings - * An array of settings to write out, in the format expected by - * drupal_rewrite_settings(). - * - * @see drupal_rewrite_settings() - */ - 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); - drupal_rewrite_settings($settings, $filename); - } - - /** - * Rebuilds \Drupal::getContainer(). - * - * Use this to build a new kernel and service container. For example, when the - * list of enabled modules is changed via the Mink controlled browser, in - * which case the test process still contains an old kernel and service - * container with an old module list. - * - * @see BrowserTestBase::prepareEnvironment() - * @see BrowserTestBase::restoreEnvironment() - * - * @todo Fix https://www.drupal.org/node/2021959 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(); - - // Make sure the url generator has a request object, otherwise calls to - // $this->drupalGet() will fail. - $this->prepareRequestForGenerator(); - } - - /** - * 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 Request - * The mocked request object. - */ - protected function prepareRequestForGenerator($clean_urls = TRUE, $override_server_vars = array()) { - $request = Request::createFromGlobals(); - $server = $request->server->all(); - if (basename($server['SCRIPT_FILENAME']) != basename($server['SCRIPT_NAME'])) { - // We need this for when the test is executed by run-tests.sh. - // @todo Remove this once run-tests.sh has been converted to use a Request - // object. - $cwd = getcwd(); - $server['SCRIPT_FILENAME'] = $cwd . '/' . basename($server['SCRIPT_NAME']); - $base_path = rtrim($server['REQUEST_URI'], '/'); - } - else { - $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($server, $override_server_vars); - - $request = Request::create($request_path, 'GET', array(), array(), array(), $server); - // Ensure the request time is REQUEST_TIME to ensure that API calls - // in the test use the right timestamp. - $request->server->set('REQUEST_TIME', REQUEST_TIME); - $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 Simpletest parent site this - // event is not fired, therefore it is necessary to updated the request - // context manually here. - $this->container->get('router.request_context')->fromRequest($request); - - return $request; - } - - /** - * Resets all data structures after having enabled new modules. - * - * This method is called by \Drupal\simpletest\BrowserTestBase::setUp() after - * enabling the requested modules. It must be called again when additional - * modules are enabled later. - */ - 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(); - } - - /** - * Refreshes in-memory configuration and state information. - * - * Useful after a page request is made that changes configuration or state in - * a different thread. - * - * In other words calling a settings page with $this->submitForm() with a - * changed value would update configuration to reflect that change, but in the - * thread that made the call (thread running the test) the changed values - * would not be picked up. - * - * This method clears the cache and loads a fresh copy. - */ - protected function refreshVariables() { - // Clear the tag cache. - $this->container->get('cache_tags.invalidator')->resetChecksums(); - // @todo Replace drupal_static() usage within classes and provide a - // proper interface for invoking reset() on a cache backend: - // https://www.drupal.org/node/2311945. - drupal_static_reset('Drupal\Core\Cache\CacheBackendInterface::tagCache'); - drupal_static_reset('Drupal\Core\Cache\DatabaseBackend::deletedTags'); - drupal_static_reset('Drupal\Core\Cache\DatabaseBackend::invalidatedTags'); - foreach (Cache::getBins() as $backend) { - if (is_callable(array($backend, 'reset'))) { - $backend->reset(); - } - } - - $this->container->get('config.factory')->reset(); - $this->container->get('state')->resetCache(); - } - - /** * Returns whether a given user account is logged in. * * @param \Drupal\Core\Session\AccountInterface $account @@ -1714,44 +1321,4 @@ public static function assertEquals($expected, $actual, $message = '', $delta = parent::assertEquals($expected, $actual, $message, $delta, $maxDepth, $canonicalize, $ignoreCase); } - /** - * Changes parameters in the services.yml file. - * - * @param string $name - * The name of the parameter. - * @param mixed $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); - } - - /** - * Gets the config schema exclusions for this test. - * - * @return string[] - * An array of config object names that are excluded from schema checking. - */ - protected function getConfigSchemaExclusions() { - $class = get_class($this); - $exceptions = []; - while ($class) { - if (property_exists($class, 'configSchemaCheckerExclusions')) { - $exceptions = array_merge($exceptions, $class::$configSchemaCheckerExclusions); - } - $class = get_parent_class($class); - } - // Filter out any duplicates. - return array_unique($exceptions); - } - }