Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Test;
Chris@0: 
Chris@0: use Drupal\Core\Database\Database;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides a trait for shared test setup functionality.
Chris@0:  */
Chris@0: trait TestSetupTrait {
Chris@0: 
Chris@0:   /**
Chris@0:    * An array of config object names that are excluded from schema checking.
Chris@0:    *
Chris@0:    * @var string[]
Chris@0:    */
Chris@0:   protected static $configSchemaCheckerExclusions = [
Chris@0:     // Following are used to test lack of or partial schema. Where partial
Chris@0:     // schema is provided, that is explicitly tested in specific tests.
Chris@0:     'config_schema_test.noschema',
Chris@0:     'config_schema_test.someschema',
Chris@0:     'config_schema_test.schema_data_types',
Chris@0:     'config_schema_test.no_schema_data_types',
Chris@0:     // Used to test application of schema to filtering of configuration.
Chris@0:     'config_test.dynamic.system',
Chris@0:   ];
Chris@0: 
Chris@0:   /**
Chris@0:    * The dependency injection container used in the test.
Chris@0:    *
Chris@0:    * @var \Symfony\Component\DependencyInjection\ContainerInterface
Chris@0:    */
Chris@0:   protected $container;
Chris@0: 
Chris@0:   /**
Chris@0:    * The site directory of this test run.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $siteDirectory = NULL;
Chris@0: 
Chris@0:   /**
Chris@0:    * The public file directory for the test environment.
Chris@0:    *
Chris@0:    * @see \Drupal\simpletest\TestBase::prepareEnvironment()
Chris@0:    * @see \Drupal\Tests\BrowserTestBase::prepareEnvironment()
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $publicFilesDirectory;
Chris@0: 
Chris@0:   /**
Chris@0:    * The site directory of the original parent site.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $originalSite;
Chris@0: 
Chris@0:   /**
Chris@0:    * The private file directory for the test environment.
Chris@0:    *
Chris@0:    * @see \Drupal\simpletest\TestBase::prepareEnvironment()
Chris@0:    * @see \Drupal\Tests\BrowserTestBase::prepareEnvironment()
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $privateFilesDirectory;
Chris@0: 
Chris@0:   /**
Chris@0:    * The original installation profile.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $originalProfile;
Chris@0: 
Chris@0:   /**
Chris@0:    * Set to TRUE to strict check all configuration saved.
Chris@0:    *
Chris@0:    * @see \Drupal\Core\Config\Testing\ConfigSchemaChecker
Chris@0:    *
Chris@0:    * @var bool
Chris@0:    */
Chris@0:   protected $strictConfigSchema = TRUE;
Chris@0: 
Chris@0:   /**
Chris@0:    * The DrupalKernel instance used in the test.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\DrupalKernel
Chris@0:    */
Chris@0:   protected $kernel;
Chris@0: 
Chris@0:   /**
Chris@0:    * The temporary file directory for the test environment.
Chris@0:    *
Chris@0:    * This value has to match the temporary directory created in
Chris@0:    * install_base_system() for test installs.
Chris@0:    *
Chris@0:    * @see \Drupal\simpletest\TestBase::prepareEnvironment()
Chris@0:    * @see \Drupal\Tests\BrowserTestBase::prepareEnvironment()
Chris@0:    * @see install_base_system()
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $tempFilesDirectory;
Chris@0: 
Chris@0:   /**
Chris@0:    * The test run ID.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $testId;
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns the database connection to the site running Simpletest.
Chris@0:    *
Chris@0:    * @return \Drupal\Core\Database\Connection
Chris@0:    *   The database connection to use for inserting assertions.
Chris@0:    */
Chris@0:   public static function getDatabaseConnection() {
Chris@0:     return TestDatabase::getConnection();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Generates a database prefix for running tests.
Chris@0:    *
Chris@0:    * The database prefix is used by prepareEnvironment() to setup a public files
Chris@0:    * directory for the test to be run, which also contains the PHP error log,
Chris@0:    * which is written to in case of a fatal error. Since that directory is based
Chris@0:    * on the database prefix, all tests (even unit tests) need to have one, in
Chris@0:    * order to access and read the error log.
Chris@0:    *
Chris@0:    * The generated database table prefix is used for the Drupal installation
Chris@0:    * being performed for the test. It is also used as user agent HTTP header
Chris@0:    * value by the cURL-based browser of WebTestBase, which is sent to the Drupal
Chris@0:    * installation of the test. During early Drupal bootstrap, the user agent
Chris@0:    * HTTP header is parsed, and if it matches, all database queries use the
Chris@0:    * database table prefix that has been generated here.
Chris@0:    *
Chris@0:    * @see \Drupal\Tests\BrowserTestBase::prepareEnvironment()
Chris@0:    * @see \Drupal\simpletest\WebTestBase::curlInitialize()
Chris@0:    * @see \Drupal\simpletest\TestBase::prepareEnvironment()
Chris@0:    * @see drupal_valid_test_ua()
Chris@0:    */
Chris@0:   protected function prepareDatabasePrefix() {
Chris@0:     $test_db = new TestDatabase();
Chris@0:     $this->siteDirectory = $test_db->getTestSitePath();
Chris@0:     $this->databasePrefix = $test_db->getDatabasePrefix();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Changes the database connection to the prefixed one.
Chris@0:    */
Chris@0:   protected function changeDatabasePrefix() {
Chris@0:     if (empty($this->databasePrefix)) {
Chris@0:       $this->prepareDatabasePrefix();
Chris@0:     }
Chris@0: 
Chris@0:     // If the test is run with argument dburl then use it.
Chris@0:     $db_url = getenv('SIMPLETEST_DB');
Chris@0:     if (!empty($db_url)) {
Chris@17:       // Ensure no existing database gets in the way. If a default database
Chris@17:       // exists already it must be removed.
Chris@17:       Database::removeConnection('default');
Chris@0:       $database = Database::convertDbUrlToConnectionInfo($db_url, isset($this->root) ? $this->root : DRUPAL_ROOT);
Chris@0:       Database::addConnectionInfo('default', 'default', $database);
Chris@0:     }
Chris@0: 
Chris@0:     // Clone the current connection and replace the current prefix.
Chris@0:     $connection_info = Database::getConnectionInfo('default');
Chris@0:     if (is_null($connection_info)) {
Chris@0:       throw new \InvalidArgumentException('There is no database connection so no tests can be run. You must provide a SIMPLETEST_DB environment variable to run PHPUnit based functional tests outside of run-tests.sh.');
Chris@0:     }
Chris@0:     else {
Chris@0:       Database::renameConnection('default', 'simpletest_original_default');
Chris@0:       foreach ($connection_info as $target => $value) {
Chris@0:         // Replace the full table prefix definition to ensure that no table
Chris@0:         // prefixes of the test runner leak into the test.
Chris@0:         $connection_info[$target]['prefix'] = [
Chris@0:           'default' => $value['prefix']['default'] . $this->databasePrefix,
Chris@0:         ];
Chris@0:       }
Chris@0:       Database::addConnectionInfo('default', 'default', $connection_info['default']);
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the config schema exclusions for this test.
Chris@0:    *
Chris@0:    * @return string[]
Chris@0:    *   An array of config object names that are excluded from schema checking.
Chris@0:    */
Chris@0:   protected function getConfigSchemaExclusions() {
Chris@0:     $class = get_class($this);
Chris@0:     $exceptions = [];
Chris@0:     while ($class) {
Chris@0:       if (property_exists($class, 'configSchemaCheckerExclusions')) {
Chris@0:         $exceptions = array_merge($exceptions, $class::$configSchemaCheckerExclusions);
Chris@0:       }
Chris@0:       $class = get_parent_class($class);
Chris@0:     }
Chris@0:     // Filter out any duplicates.
Chris@0:     return array_unique($exceptions);
Chris@0:   }
Chris@0: 
Chris@0: }